Google Ads API

The Google Ads API is the next generation of Google AdWords API. It provides you with new features and improvements over the AdWords API that make it easy for you to manage large and complex accounts. Read Migrating from AdWords to Google Ads API know how you can switch over to the new API.

Read Google Ads to know about the prerequisites and initial steps to start creating your Pipeline with this Source.


Configuring Google Ads API Connection Settings

Perform the following steps to configure your Google Ads API connection settings:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Google Ads.

  4. In the Configure your Google Ads page, click + ADD GOOGLE ADS ACCOUNT. This redirects you to the Google Ads login page.

  5. Log in to your Google Ads account.

  6. Click Allow to authorize Hevo to access your Google Ads data.

    Click Allow

  7. In the Configure your Google Ads Source page, specify the following:

    Configure Google Ads API

  • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

  • Select Accounts: The Google Ads account(s) from where you want to replicate the data.

  • Select Reports: Select one of the following report types to ingest data from your Google Ads reports.

    • Standard Reports: Hevo automatically selects all the metrics and dimensions for each Google Ads report that you want to replicate.

      For steps to configure standard reports, read Standard Reports.

    • Custom Reports: Hevo allows you to manually select the metrics and dimensions for each Google Ads report that you want to replicate.

      For steps to configure custom reports, read Custom Reports.

  • Historical Sync Duration: The duration for which past data must be ingested. Default: 1 Year.

  • Click CONTINUE.

  • Proceed to configuring the data ingestion and setting up the Destination.


Standard Reports

In case of standard reports, Hevo automatically selects all the metrics and dimensions for each Google Ads report that you want to replicate to your Destination system.

To configure standard reports, specify the following Standard Report Settings:

Standard report settings

  • Report Names: Select the check box next to each report whose data you want to replicate to the Destination system.

  • Aggregation Window: The duration for which the report’s data is aggregated. Aggregation is done on a daily basis. Default: Daily.

    • Daily: Aggregates the data present in the reports once a day daily.

    • Last 7 days: Aggregates the data present in the reports for the last 7 days on a daily basis.

    • Last 14 days: Aggregates the data present in the reports for the last 14 days on a daily basis.

    • Last 30 days: Aggregates the data present in the reports for the last 30 days on a daily basis.

  • Advanced Settings:

    • Conversion Window (in days): Specify the duration at which you want to refresh the data to capture conversions. Default: 30 days. Max value: 90. Min Value: 1.

Custom Reports

In case of custom reports, you can manually select the metrics and dimensions for each Google Ads report that you want to replicate.

To configure custom reports, specify the following Custom Report Settings:

Custom report settings

Report Name: Select the check box next to the report whose data you want to replicate to the Destination system.

  • Segments: Select the criteria for organizing the data. These are displayed based on the report you select.

  • Dimensions: Select the dimension(s) you want to replicate. These are displayed based on the segments you select.

  • Metrics: Select the metric(s) you want to replicate. These are displayed based on the dimensions you select.

  • Attributed Resources: Select the dimensions from attributed resources that you want to replicate. These are displayed based on the standard report you select.

  • Aggregation Window: Select the duration for which the report’s data is aggregated on a daily basis. Default: Daily.

    • Daily: Aggregates the data present in the reports once a day daily.

    • Last 7 days: Aggregates the data present in the reports for the last 7 days on a daily basis.

    • Last 14 days: Aggregates the data present in the reports for the last 14 days on a daily basis.

    • Last 30 days: Aggregates the data present in the reports for the last 30 days on a daily basis.

  • Advanced Settings:

    • Conversion Window (in days): Specify the duration at which you want to refresh the data to capture conversions. Default: 30 days. Max value: 90. Min Value: 1.

Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
1 Hr 15 Mins 24 Hrs 1-24

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data:

    • For Pipelines created before Release 1.63: Historical data for one year is ingested. In case of Click View report, only 90 days of historical data is fetched.

    • For Pipelines created after Release 1.63: Historical data for one year is ingested by default but can be changed as per the user’s requirement.

    From Release 1.79 onwards, Hevo ingests your historical data in reverse order, starting from the latest to the earliest. This enables you to have quicker access to the most recent data. This change applies to all new and existing Pipelines.

  • Incremental Data: Once the historical data ingestion is complete, every subsequent run of the Pipeline fetches new and updated data for the selected reports.

  • Data Refresh: Hevo refreshes the data based on the specified conversion window. For example, if the conversion window is 30, Hevo refreshes the data for the last 30 days from today.


Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination database:

Report Primary Key
Ad Group ad_group.resource_name
Ad Group Ad ad_group_ad.resource_name
Ad Group Ad Asset View ad_group_ad_asset_view.resource_name
Ad Group Asset ad_group_asset.resource_name
Ad Group Audience View ad_group_audience_view.resource_name
Ad Schedule View ad_schedule_view.resource_name
Age Range View age_range_view.resource_name
Asset Field Type View asset_field_type_view.resource_name
Bidding Strategy bidding_strategy.resource_name
Campaign campaign.resource_name
Campagin Asset campagin_asset.resource_name
Campaign Audience View campaign_audience_view.resource_name
Campaign Budget campaign_budget.resource_name
Click View click_view.resource_name
Customer customer.resource_name
Customer Asset customer_asset.resource_name
Detail Placement View detail_placement_view.resource_name
Display Keyword View display_keyword_view.resource_name
Distance View distance_view.resource_name
Dynamic Search Ads Search Term View dynamic_search_ads_search_term_view.resource_name
Expanded Landing Page View expanded_landing_page_view.resource_name
Extension Feed Item extension_feed_item.resource_name
Feed Item feed_item.resource_name
Feed Placeholder View feed_placeholder_view.resource_name
Gender View gender_view.resource_name
Geographic View geographic_view.resource_name
Group Placement View group_placement_view.resource_name
Hotel Group View hotel_group_view.resource_name
Hotel Performance View hotel_performance_view.resource_name
Hotel Reconciliation hotel_reconciliation.resource_name
Income Range View income_range_view.resource_name
Keyword View keyword_view.resource_name
Landing Page View landing_page_view.resource_name
Location View location_view.resource_name
Managed Placement View managed_placement_view.resource_name
Parental Status View parental_status_view.resource_name
Product Group View product_group_view.resource_name
Search Term View search_term_view.resource_name
Shopping Performance View shopping_performance_view.resource_name
Smart Campaign Search Term View smart_campaign_search_term_view.resource_name
Topic View topic_view.resource_name
User Location View user_location_view.resource_name
Video video.resource_name
Webpage View webpage_view.resource_name

Reports: Hevo attaches the following fields to all the report Events ingested from Google Ads API:

  • __hevo_report_date: The starting date of the time period for which the report is generated. If the aggregation window is 7 and the report data is generated for May 9 to May 15, then the __hevo_report_date is May 9.

  • __hevo_id: The unique id of the Google Ads Event. Hevo derives this by hashing Google Ads data’s primary key columns along with __hevo_report_date and resource_name.


Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Refer to Google Ads API reports for the complete list. All the reports except the ones mentioned below are available.

The following reports are not available: CAMPAIGN_BID_MODIFIER, CONVERSION_ACTION, CALL_VIEW, CAMPAIGN_CRITERION, CAMPAIGN_SHARED_SET, FEED_ITEM_TARGET, LABEL, SHARED_CRITERION, SHARED_SET, ASSET_GROUP_PRODUCT_GROUP_VIEW.


Source Considerations

  • Google Ads does not support custom metrics and custom dimensions in the reports.

Limitations

  • Hevo currently does not support replication of the following metrics:

    • optimization_score_uplift

    • optimization_score_url

    This is because these are incompatible with the segment, date.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Feb-21-2022 1.82 New document.
Last updated on 21 Jun 2022