Google Ads API is returning to beta status. Please read our blog post for more details.

Reports

Overview

These pages list the resources that can be queried in the Google Ads API using GoogleAdsService.Search. The resource names are linked to to their own page. On each page, the following lists are shown:

  • Artifacts (resources, segments, or metrics) that can be used in the same SELECT clause with the resource
  • Attributed resources whose fields will not segment metrics, when included in the same SELECT and WHERE clauses of these resource fields

Presented after those lists are the tables consisting of names of resource fields, segments, and metrics that can be included in a search query, when this resource is specified in the FROM clause. Each name is linked to the table that contains its metadata:

  • category
  • data type
  • type
  • URL
  • filterable
  • selectable
  • sortable
  • repeated
Filterable
This row indicates whether the field can be used in the conditions of the WHERE clause of the GAQL query.
Selectable
This row indicates whether the field can be specified in the SELECT clause of the GAQL query.
Sortable
This row indicates whether the field can be sorted and used in the ORDER BY clause of the GAQL query.
Repeated
This row indicates whether the field is repeated, which should be handled as a list.

Reports examples

List of all resources

Resource types
account_budget An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in 'pending_proposal'. Effective details about the budget are found in fields prefixed 'approved_', 'adjusted_' and those without a prefix. Since some effective details may differ from what the user had originally requested (e.g. spending limit), these differences are juxtaposed via 'proposed_', 'approved_', and possibly 'adjusted_' fields. This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pending_proposal. Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the 'approved' and 'adjusted' fields, which would otherwise be identical.
account_budget_proposal An account-level budget proposal. All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, e.g. spending limits. Please note that the proposal type (proposal_type) changes which fields are required and which must remain empty.
ad_group An ad group.
ad_group_ad An ad group ad.
ad_group_ad_asset_view A link between an AdGroupAd and an Asset.
ad_group_ad_label A relationship between an ad group ad and a label.
ad_group_audience_view An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level.
ad_group_bid_modifier Represents an ad group bid modifier.
ad_group_criterion An ad group criterion.
ad_group_criterion_label A relationship between an ad group criterion and a label.
ad_group_criterion_simulation An ad group criterion simulation. Supported combinations of advertising channel type, criterion type, simulation type, and simulation modification method are detailed below respectively. DISPLAY KEYWORD CPC_BID UNIFORM SEARCH KEYWORD CPC_BID UNIFORM SHOPPING LISTING_GROUP CPC_BID UNIFORM
ad_group_extension_setting An ad group extension setting.
ad_group_feed An ad group feed.
ad_group_label A relationship between an ad group and a label.
ad_group_simulation An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. SEARCH CPC_BID DEFAULT SEARCH CPC_BID UNIFORM SEARCH TARGET_CPA UNIFORM DISPLAY CPC_BID DEFAULT DISPLAY CPC_BID UNIFORM DISPLAY TARGET_CPA UNIFORM VIDEO CPV_BID DEFAULT VIDEO CPV_BID UNIFORM
ad_parameter An ad parameter that is used to update numeric values (such as prices or inventory levels) in any text line of an ad (including URLs). There can be a maximum of two AdParameters per ad group criterion. (One with parameter_index = 1 and one with parameter_index = 2.) In the ad the parameters are referenced by a placeholder of the form "{param#:value}". E.g. "{param1:$17}"
ad_schedule_view An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.
age_range_view An age range view.
asset Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc.
bidding_strategy A bidding strategy.
billing_setup A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.
campaign A campaign.
campaign_audience_view A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level.
campaign_bid_modifier Represents a bid-modifiable only criterion at the campaign level.
campaign_budget A campaign budget.
campaign_criterion A campaign criterion.
campaign_criterion_simulation A campaign criterion simulation. Supported combinations of advertising channel type, criterion ids, simulation type and simulation modification method is detailed below respectively. SEARCH 30000,30001,30002 BID_MODIFIER UNIFORM SHOPPING 30000,30001,30002 BID_MODIFIER UNIFORM DISPLAY 30001 BID_MODIFIER UNIFORM
campaign_draft A campaign draft.
campaign_experiment An A/B experiment that compares the performance of the base campaign (the control) and a variation of that campaign (the experiment).
campaign_extension_setting A campaign extension setting.
campaign_feed A campaign feed.
campaign_label Represents a relationship between a campaign and a label.
campaign_shared_set CampaignSharedSets are used for managing the shared sets associated with a campaign.
carrier_constant A carrier criterion that can be used in campaign targeting.
change_status Describes the status of returned resource.
click_view A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions.
conversion_action A conversion action.
custom_interest A custom interest. This is a list of users by interest.
customer A customer.
customer_client A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself.
customer_client_link Represents customer client link relationship.
customer_extension_setting A customer extension setting.
customer_feed A customer feed.
customer_label Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id.
customer_manager_link Represents customer-manager link relationship.
customer_negative_criterion A negative criterion for exclusions at the customer level.
detail_placement_view A view with metrics aggregated by ad group and URL or YouTube video.
display_keyword_view A display keyword view.
distance_view A distance view with metrics aggregated by the user's distance from an advertiser's location extensions. Each DistanceBucket includes all impressions that fall within its distance and a single impression will contribute to the metrics for all DistanceBuckets that include the user's distance.
domain_category A category generated automatically by crawling a domain. If a campaign uses the DynamicSearchAdsSetting, then domain categories will be generated for the domain. The categories can be targeted using WebpageConditionInfo. See: https://support.google.com/google-ads/answer/2471185
dynamic_search_ads_search_term_view A dynamic search ads search term view.
expanded_landing_page_view A landing page view with metrics aggregated at the expanded final URL level.
extension_feed_item An extension feed item.
feed A feed.
feed_item A feed item.
feed_item_target A feed item target.
feed_mapping A feed mapping.
feed_placeholder_view A feed placeholder view.
gender_view A gender view.
geo_target_constant A geo target constant.
geographic_view A geographic view. Geographic View includes all metrics aggregated at the country level, one row per country. It reports metrics at either actual physical location of the user or an area of interest. If other segment fields are used, you may get more than one row per country.
group_placement_view A group placement view.
hotel_group_view A hotel group view.
hotel_performance_view A hotel performance view.
keyword_plan A Keyword Planner plan. Max number of saved keyword plans: 10000. It's possible to remove plans if limit is reached.
keyword_plan_ad_group A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.
keyword_plan_campaign A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1.
keyword_plan_keyword A Keyword Plan ad group keyword. Max number of keyword plan keywords per plan: 2500.
keyword_plan_negative_keyword A Keyword Plan negative keyword. Max number of keyword plan negative keywords per plan: 1000.
keyword_view A keyword view.
label A label.
landing_page_view A landing page view with metrics aggregated at the unexpanded final URL level.
language_constant A language.
location_view A location view summarizes the performance of campaigns by Location criteria.
managed_placement_view A managed placement view.
media_file A media file.
metrics The percent of your ad impressions that are shown as the very first ad above the organic search results.
mobile_app_category_constant A mobile application category constant.
mobile_device_constant A mobile device constant.
mutate_job A list of mutates being processed asynchronously. The mutates are uploaded by the user. The mutates themselves aren't readable and the results of the job can only be read using MutateJobService.ListMutateJobResults.
operating_system_version_constant A mobile operating system version or a range of versions, depending on `operator_type`. List of available mobile platforms at https://developers.google.com/adwords/api/docs/appendix/codes-formats#mobile-platforms
paid_organic_search_term_view A paid organic search term view providing a view of search stats across ads and organic listings aggregated by search term at the ad group level.
parental_status_view A parental status view.
product_bidding_category_constant A Product Bidding Category.
product_group_view A product group view.
recommendation A recommendation.
remarketing_action A remarketing action. A snippet of JavaScript code that will collect the product id and the type of page people visited (product page, shopping cart page, purchase page, general site visit) on an advertiser's website.
search_term_view A search term view with metrics aggregated by search term at the ad group level.
segments Ad network type.
shared_criterion A criterion belonging to a shared set.
shared_set SharedSets are used for sharing criterion exclusions across multiple campaigns.
shopping_performance_view Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.
topic_constant Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs").
topic_view A topic view.
user_interest A user interest: a particular interest-based vertical to be targeted.
user_list A user list. This is a list of users a customer may target.
user_location_view A user location view. User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.
video A video.