Articles in this section

Migrate your Google Ads API endpoints

Naga Sri Hari Gonaboyina
Updated

Google Ads has released API v10 and deprecated the previous version endpoints. Hence, it is recommended and required to make changes to your Google Ads connector and flow steps that use the deprecated APIs.

As part of this migration, Celigo has added the Version field in the integrator.io > Google Ads connection page. This enhancement will go live with 2022.R2 maintenance release, scheduled for June 21, 2022.

This article explains how to migrate the Google Ads connections and flows from the deprecated API endpoints to the new API endpoints.

Google Ads documentation: Deprecation and sunset
Additional reference:  Set up a connection to Google Ads

New connector settings

To update your Google Ads connection, you must edit your connection to provide the Google Ads API Version that you are integrating with.

Note: Whenever you modify a connection, you have to re-enter the secure fields, such as the Developer token. Hence, it is recommended to have that information on hand before you attempt to save the connection.

Removed GET methods

In the latest version, the GET methods are not supported. You must now use the Search endpoint instead of the GET method.

The following GET endpoints were removed from the Google Ads flow steps (exports and lookups):

  • Get Campaign by ID
  • Get Custom Audience by ID
  • Get Campaign Budget by ID

If you are using these deprecated endpoints in exports, you have to replace them with the Search by Query endpoint, as described below.


Note: Before migrating, ensure to retrieve your campaign ID.

  1. Sign in to your integrator.io account.
  2. Navigate to Resources > Connections.
  3. Search for an existing Google Ads connection, from the Actions overflow ... menu, select Edit connection.
  4. In Application details > Version, enter your Google Ads API version and all the required authentication settings. For detailed information on how to set up a connection to Google Ads, see Set up a connection to Google Ads.
  5. Click Save & authorize.
  6. Navigate to the flow where you have used the Get Campaign by ID endpoint in the export.
  7. Open and edit Export.
  8. In What would you like to export?, from the API Name drop-down list, select Search.
  9. From the Operation drop-down list, select Search by Query.
  10. In Configure body parameters, click Launch.
API_name.png
  1. To get all the standard fields, paste the following query and replace {{your campaign ID}} with your Google Ads campaign ID. For example, if your campaign ID is 123456, replace the WHERE clause in the query as WHERE campaign.id = 123456.

Tip: You can easily identify the WHERE clause at the end of the following query.

SELECT campaign.campaign_budget, campaign.id, campaign.name, 
campaign.ad_serving_optimization_status, 
campaign.network_settings.target_google_search, 
campaign.network_settings.target_search_network, 
campaign.network_settings.target_content_network, 
campaign.network_settings.target_partner_search_network, 
campaign.advertising_channel_type, campaign.status, campaign.experiment_type, 
campaign.serving_status, campaign.advertising_channel_sub_type, 
campaign.app_campaign_setting.app_id, campaign.app_campaign_setting.app_store, 
campaign.app_campaign_setting.bidding_strategy_goal_type, 
campaign.base_campaign, campaign.bidding_strategy, campaign.bidding_strategy_type, 
campaign.commission.commission_rate_micros, 
campaign.dynamic_search_ads_setting.domain_name, 
campaign.dynamic_search_ads_setting.feeds, 
campaign.dynamic_search_ads_setting.language_code, 
campaign.dynamic_search_ads_setting.use_supplied_urls_only, 
campaign.end_date, campaign.excluded_parent_asset_field_types, 
campaign.final_url_suffix, campaign.frequency_caps, 
campaign.geo_target_type_setting.negative_geo_target_type, 
campaign.geo_target_type_setting.positive_geo_target_type, 
campaign.hotel_setting.hotel_center_id, campaign.labels, 
campaign.local_campaign_setting.location_source_type, 
campaign.manual_cpc.enhanced_cpc_enabled, campaign.manual_cpm, 
campaign.manual_cpv, campaign.maximize_conversion_value.target_roas, 
campaign.maximize_conversions.target_cpa, 
campaign.optimization_goal_setting.optimization_goal_types, 
campaign.optimization_score, campaign.payment_mode, 
campaign.percent_cpc.cpc_bid_ceiling_micros, 
campaign.percent_cpc.enhanced_cpc_enabled,
campaign.real_time_bidding_setting.opt_in, campaign.resource_name,
campaign.selective_optimization.conversion_actions, 
campaign.shopping_setting.campaign_priority, campaign.shopping_setting.enable_local,
campaign.shopping_setting.merchant_id, campaign.shopping_setting.sales_country,
campaign.start_date, campaign.target_cpa.cpc_bid_ceiling_micros, 
campaign.target_cpa.cpc_bid_floor_micros, campaign.target_cpa.target_cpa_micros,
campaign.target_cpm, campaign.target_impression_share.cpc_bid_ceiling_micros,
campaign.target_impression_share.location, 
campaign.target_impression_share.location_fraction_micros,
campaign.target_roas.cpc_bid_ceiling_micros, 
campaign.target_roas.cpc_bid_floor_micros, campaign.target_roas.target_roas,
campaign.target_spend.cpc_bid_ceiling_micros, 
campaign.target_spend.target_spend_micros, 
campaign.targeting_setting.target_restrictions, 
campaign.tracking_setting.tracking_url, campaign.tracking_url_template,
campaign.url_custom_parameters, campaign.vanity_pharma.vanity_pharma_display_url_mode, 
campaign.vanity_pharma.vanity_pharma_text, 
campaign.video_brand_safety_suitability 
FROM campaign WHERE campaign.id = {{your campaign ID}}
  1. Click Save & close.

Note: The example Google Ads query shown above is only for comprehensiveness.  You can limit it to columns that your flow requires by building the query in Google Ads query builder by selecting all the required fields for your response.

  1. Open Export.
  2. In General > Form view, select HTTP.
HTTP.png
  1. Scroll down and expand Non-standard API response patterns.
  2. In Path to records in HTTP response body, paste results[0].campaign.
  3. Click Save & close.
Paste.png
  1. Open Export and click Preview to see the same response as the former Get Campaign by ID endpoint.

Note: Before migrating, ensure to retrieve your audience ID.

  1. Sign in to your integrator.io account.
  2. Navigate to Resources > Connections.
  3. Search for an existing Google Ads connection, from the Actions overflow ... menu, select Edit connection.
  4. In Application details > Version, enter your Google Ads API version and all the required authentication settings. For detailed information on how to set up a connection to Google Ads, see Set up a connection to Google Ads.
  5. Click Save & authorize.
  6. Navigate to the flow where you have used the Get Custom Audience by ID endpoint in the export.
  7. Open and edit Export.
  8. In What would you like to export?, from the API Name drop-down list, select Search.
  9. From the Operation drop-down list, select Search by Query.
  10. In Configure body parameters, click Launch.
API_name.png
  1. To get all the standard fields, paste the following query and replace {{Your Custom Audience ID}} with your Google Ads custom audience ID. For example, if your audience ID is 123456, replace the WHERE clause in the query as WHERE custom_audience.id = 123456.

Tip: You can easily identify the WHERE clause at the end of the following query.

SELECT custom_audience.description, custom_audience.id, 
custom_audience.members, custom_audience.name, custom_audience.resource_name, 
custom_audience.status, custom_audience.type
FROM custom_audience WHERE custom_audience.id = {{Your Custom Audience ID}}
  1. Click Save & close.

Note: The example Google Ads query shown above is only for comprehensiveness.  You can limit it to columns that your flow requires by building the query in Google Ads query builder by selecting all the required fields for your response.

  1. Open Export.
  2. In General > Form view, select HTTP.
HTTP.png
  1. Scroll down and expand Non-standard API response patterns.
  2. In Path to records in HTTP response body, paste results[0].customAudience.
  3. Click Save & close.
Aud.png
  1. Open Export and click Preview to see the same response as the former Get Custom Audience by ID endpoint.

Note: Before migrating, ensure to retrieve your campaign budget ID.

  1. Sign in to your integrator.io account.
  2. Navigate to Resources > Connections.
  3. Search for an existing Google Ads connection, from the Actions overflow ... menu, select Edit connection.
  4. In Application details > Version, enter your Google Ads API version and all the required authentication settings. For detailed information on how to set up a connection to Google Ads, see Set up a connection to Google Ads.
  5. Click Save & authorize.
  6. Navigate to the flow where you have used the Get Campaign Budget by ID endpoint in the export.
  7. Open and edit Export.
  8. In What would you like to export?, from the API Name drop-down list, select Search.
  9. From the Operation drop-down list, select Search by Query.
  10. In Configure body parameters, click Launch.
API_name.png
  1. To get all the standard fields, paste the following query and replace {{Your Campaign Budget ID}} with your Google Ads campaign budget ID. For example, if your campaign budget ID is 123456, replace the WHERE clause in the query as WHERE campaign_budget.id = 123456.

Tip: You can easily identify the WHERE clause at the end of the following query.

SELECT campaign_budget.amount_micros, campaign_budget.delivery_method, 
campaign_budget.explicitly_shared, campaign_budget.has_recommended_budget, 
campaign_budget.id, campaign_budget.name, campaign_budget.period, 
campaign_budget.recommended_budget_amount_micros, 
campaign_budget.recommended_budget_estimated_change_weekly_clicks, 
campaign_budget.recommended_budget_estimated_change_weekly_cost_micros, 
campaign_budget.recommended_budget_estimated_change_weekly_interactions, 
campaign_budget.recommended_budget_estimated_change_weekly_views,
campaign_budget.reference_count, campaign_budget.resource_name, 
campaign_budget.status, campaign_budget.type, 
campaign_budget.total_amount_micros FROM campaign_budget 
WHERE campaign_budget.id = {{Your Campaign Budget ID}}
  1. Click Save & close.

Note: The example Google Ads query shown above is only for comprehensiveness.  You can limit it to columns that your flow requires by building the query in Google Ads query builder by selecting all the required fields for your response.

  1. Open Export.
  2. In General > Form view, select HTTP.
HTTP.png
  1. Scroll down and expand Non-standard API response patterns.
  2. In Path to records in HTTP response body, paste results[0].campaignBudget.
  3. Click Save & close.
Budget.png
  1. Open Export and click Preview to see the same response as the former Get Campaign Budget by ID endpoint.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.