Google Ads API Reference
The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_
in their names. Public API procedures do not have such prefix in their names.
Performance_AdGroup
Ad group
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_by_conversion_date |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_by_conversion_date |
double |
The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
average_page_views |
double |
Average number of pages viewed per session |
average_time_on_site |
double |
Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics |
bounce_rate |
double |
Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics |
clicks |
long |
The number of clicks |
content_impression_share |
double |
The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
content_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_by_conversion_date |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_by_conversion_date |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_per_current_model_attributed_conversion |
double |
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
current_model_attributed_conversions |
double |
Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_value |
double |
The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
percent_new_visitors |
double |
Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics |
phone_calls |
long |
Number of offline phone calls |
phone_impressions |
long |
Number of offline phone impressions |
phone_through_rate |
double |
Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions) |
relative_ctr |
double |
Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites |
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826for details. Any value below 0.1 is reported as 0.0999 |
search_budget_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_budget_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_exact_match_impression_share |
double |
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_rank_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_top_impression_share |
double |
The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_all_conversions_by_conversion_date |
double |
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
value_per_conversions_by_conversion_date |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_current_model_attributed_conversion |
double |
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_rotation_mode |
string |
The ad rotation mode of the ad group |
audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
campaign |
string |
Immutable. The campaign to which the ad group belongs |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers... |
CREATE VIEW google_ads_api_examples.example_Performance_AdGroup AS SELECT * FROM ( CALL google_ads_api.Performance_AdGroup ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_AdGroupAd
Ad group ad
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_by_conversion_date |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_by_conversion_date |
double |
The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
average_page_views |
double |
Average number of pages viewed per session |
average_time_on_site |
double |
Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics |
bounce_rate |
double |
Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_by_conversion_date |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_by_conversion_date |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_per_current_model_attributed_conversion |
double |
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
current_model_attributed_conversions |
double |
Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_value |
double |
The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
percent_new_visitors |
double |
Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_all_conversions_by_conversion_date |
double |
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
value_per_conversions_by_conversion_date |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_current_model_attributed_conversion |
double |
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
action_items |
string |
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines." |
ad_added_by_google_ads |
boolean |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing |
ad_app_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_app_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_app_ad_html5_media_bundles |
string |
List of media bundle assets that may be used with the ad |
ad_app_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_app_ad_mandatory_ad_text |
string |
Mandatory ad text |
ad_app_ad_youtube_videos |
string |
List of YouTube video assets that may be displayed with the ad |
ad_app_engagement_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_app_engagement_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_app_engagement_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_app_engagement_ad_videos |
string |
List of video assets that may be displayed with the ad |
ad_app_pre_registration_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_app_pre_registration_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_app_pre_registration_ad_images |
string |
List of image asset IDs whose images may be displayed with the ad |
ad_app_pre_registration_ad_youtube_videos |
string |
List of YouTube video asset IDs whose videos may be displayed with the ad |
ad_call_ad_business_name |
string |
The business name in the ad |
ad_call_ad_call_tracked |
boolean |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions |
ad_call_ad_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored |
ad_call_ad_conversion_reporting_state |
string |
The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled |
ad_call_ad_country_code |
string |
The country code in the ad |
ad_call_ad_description1 |
string |
The first line of the ad's description |
ad_call_ad_description2 |
string |
The second line of the ad's description |
ad_call_ad_disable_call_conversion |
boolean |
Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored |
ad_call_ad_headline1 |
string |
First headline in the ad |
ad_call_ad_headline2 |
string |
Second headline in the ad |
ad_call_ad_path1 |
string |
First part of text that can be appended to the URL in the ad. Optional |
ad_call_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional |
ad_call_ad_phone_number |
string |
The phone number in the ad |
ad_call_ad_phone_number_verification_url |
string |
The URL to be used for phone number verification |
ad_device_preference |
string |
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types |
ad_display_upload_ad_display_upload_product_type |
string |
The product type of this ad. See comments on the enum for details |
ad_display_upload_ad_media_bundle |
string |
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898for more information |
ad_display_url |
string |
The URL that appears in the ad description for some ad formats |
ad_expanded_dynamic_search_ad_description |
string |
The description of the ad |
ad_expanded_dynamic_search_ad_description2 |
string |
The second description of the ad |
ad_expanded_text_ad_description |
string |
The description of the ad |
ad_expanded_text_ad_description2 |
string |
The second description of the ad |
ad_expanded_text_ad_headline_part1 |
string |
The first part of the ad's headline |
ad_expanded_text_ad_headline_part2 |
string |
The second part of the ad's headline |
ad_expanded_text_ad_headline_part3 |
string |
The third part of the ad's headline |
ad_expanded_text_ad_path1 |
string |
The text that can appear alongside the ad's displayed URL |
ad_expanded_text_ad_path2 |
string |
Additional text that can appear alongside the ad's displayed URL |
ad_final_app_urls |
string |
A list of final app URLs that will be used on mobile if the user has the specific app installed |
ad_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects for the ad |
ad_final_url_suffix |
string |
The suffix to use when constructing a final URL |
ad_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group |
string |
Immutable. The ad group to which the ad belongs |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_hotel_ad |
string |
Details pertaining to a hotel ad |
ad_id |
long |
Output only. The ID of the ad |
ad_image_ad_image_url |
string |
URL of the full size image |
ad_image_ad_mime_type |
string |
The mime type of the image |
ad_image_ad_name |
string |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty |
ad_image_ad_pixel_height |
long |
Height in pixels of the full size image |
ad_image_ad_pixel_width |
long |
Width in pixels of the full size image |
ad_image_ad_preview_image_url |
string |
URL of the preview size image |
ad_image_ad_preview_pixel_height |
long |
Height in pixels of the preview size image |
ad_image_ad_preview_pixel_width |
long |
Width in pixels of the preview size image |
ad_legacy_app_install_ad |
string |
Immutable. Details pertaining to a legacy app install ad |
ad_legacy_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_legacy_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_legacy_responsive_display_ad_business_name |
string |
The business name in the ad |
ad_legacy_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad |
ad_legacy_responsive_display_ad_description |
string |
The description of the ad |
ad_legacy_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_legacy_responsive_display_ad_logo_image |
string |
The MediaFile resource name of the logo image used in the ad |
ad_legacy_responsive_display_ad_long_headline |
string |
The long version of the ad's headline |
ad_legacy_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_legacy_responsive_display_ad_marketing_image |
string |
The MediaFile resource name of the marketing image used in the ad |
ad_legacy_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_legacy_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_legacy_responsive_display_ad_short_headline |
string |
The short version of the ad's headline |
ad_legacy_responsive_display_ad_square_logo_image |
string |
The MediaFile resource name of the square logo image used in the ad |
ad_legacy_responsive_display_ad_square_marketing_image |
string |
The MediaFile resource name of the square marketing image used in the ad |
ad_local_ad_call_to_actions |
string |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified |
ad_local_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified |
ad_local_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified |
ad_local_ad_logo_images |
string |
List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified |
ad_local_ad_marketing_images |
string |
List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified |
ad_local_ad_path1 |
string |
First part of optional text that can be appended to the URL in the ad |
ad_local_ad_path2 |
string |
Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_local_ad_videos |
string |
List of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified |
ad_name |
string |
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd |
ad_resource_name |
string |
Immutable. The resource name of the ad. Ad resource names have the form: customers/customer_id/ads/ad_id |
ad_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_responsive_display_ad_business_name |
string |
The advertiser/brand name. Maximum display width is 25 |
ad_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad. Maximum display width is 30 |
ad_responsive_display_ad_control_spec_enable_asset_enhancements |
boolean |
Whether the advertiser has opted into the asset enhancements feature |
ad_responsive_display_ad_control_spec_enable_autogen_video |
boolean |
Whether the advertiser has opted into auto-gen video feature |
ad_responsive_display_ad_descriptions |
string |
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified |
ad_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_responsive_display_ad_headlines |
string |
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified |
ad_responsive_display_ad_logo_images |
string |
Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_responsive_display_ad_long_headline |
string |
A required long format headline. The maximum length is 90 characters |
ad_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_responsive_display_ad_marketing_images |
string |
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15 |
ad_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_responsive_display_ad_square_logo_images |
string |
Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_responsive_display_ad_square_marketing_images |
string |
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15 |
ad_responsive_display_ad_youtube_videos |
string |
Optional YouTube videos for the ad. A maximum of 5 videos can be specified |
ad_responsive_search_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_responsive_search_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_responsive_search_ad_path1 |
string |
First part of text that can be appended to the URL in the ad |
ad_responsive_search_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_shopping_comparison_listing_ad_headline |
string |
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters |
ad_shopping_product_ad |
string |
Details pertaining to a Shopping product ad |
ad_shopping_smart_ad |
string |
Details pertaining to a Smart Shopping ad |
ad_smart_campaign_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified |
ad_smart_campaign_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified |
ad_strength |
string |
Output only. Overall ad strength for this ad group ad |
ad_system_managed_resource_source |
string |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only |
ad_text_ad_description1 |
string |
The first line of the ad's description |
ad_text_ad_description2 |
string |
The second line of the ad's description |
ad_text_ad_headline |
string |
The headline of the ad |
ad_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_type |
string |
Output only. The type of ad |
ad_url_collections |
string |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad |
ad_url_custom_parameters |
string |
The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations |
ad_video_ad_bumper_companion_banner_asset |
string |
The Asset resource name of this image |
ad_video_ad_in_feed_description1 |
string |
First text line for the ad |
ad_video_ad_in_feed_description2 |
string |
Second text line for the ad |
ad_video_ad_in_feed_headline |
string |
The headline of the ad |
ad_video_ad_in_feed_thumbnail |
string |
Video thumbnail image to use |
ad_video_ad_in_stream_action_button_label |
string |
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise |
ad_video_ad_in_stream_action_headline |
string |
Additional text displayed with... |
CREATE VIEW google_ads_api_examples.example_Performance_AdGroupAd AS SELECT * FROM ( CALL google_ads_api.Performance_AdGroupAd ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x |
Performance_AdGroupAdAsset
Ad group ad asset view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad |
string |
Output only. The ad group ad to which the asset is linked |
ad_group_ad_action_items |
string |
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines." |
ad_group_ad_ad_added_by_google_ads |
boolean |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing |
ad_group_ad_ad_app_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_ad_html5_media_bundles |
string |
List of media bundle assets that may be used with the ad |
ad_group_ad_ad_app_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_ad_mandatory_ad_text |
string |
Mandatory ad text |
ad_group_ad_ad_app_ad_youtube_videos |
string |
List of YouTube video assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_engagement_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_engagement_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_videos |
string |
List of video assets that may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_images |
string |
List of image asset IDs whose images may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_youtube_videos |
string |
List of YouTube video asset IDs whose videos may be displayed with the ad |
ad_group_ad_ad_call_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_call_ad_call_tracked |
boolean |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions |
ad_group_ad_ad_call_ad_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored |
ad_group_ad_ad_call_ad_conversion_reporting_state |
string |
The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled |
ad_group_ad_ad_call_ad_country_code |
string |
The country code in the ad |
ad_group_ad_ad_call_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_call_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_call_ad_disable_call_conversion |
boolean |
Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored |
ad_group_ad_ad_call_ad_headline1 |
string |
First headline in the ad |
ad_group_ad_ad_call_ad_headline2 |
string |
Second headline in the ad |
ad_group_ad_ad_call_ad_path1 |
string |
First part of text that can be appended to the URL in the ad. Optional |
ad_group_ad_ad_call_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional |
ad_group_ad_ad_call_ad_phone_number |
string |
The phone number in the ad |
ad_group_ad_ad_call_ad_phone_number_verification_url |
string |
The URL to be used for phone number verification |
ad_group_ad_ad_device_preference |
string |
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types |
ad_group_ad_ad_display_upload_ad_display_upload_product_type |
string |
The product type of this ad. See comments on the enum for details |
ad_group_ad_ad_display_upload_ad_media_bundle |
string |
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898for more information |
ad_group_ad_ad_display_url |
string |
The URL that appears in the ad description for some ad formats |
ad_group_ad_ad_expanded_dynamic_search_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_dynamic_search_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_text_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_headline_part1 |
string |
The first part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part2 |
string |
The second part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part3 |
string |
The third part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_path1 |
string |
The text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_expanded_text_ad_path2 |
string |
Additional text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_final_app_urls |
string |
A list of final app URLs that will be used on mobile if the user has the specific app installed |
ad_group_ad_ad_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_final_url_suffix |
string |
The suffix to use when constructing a final URL |
ad_group_ad_ad_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_group |
string |
Immutable. The ad group to which the ad belongs |
ad_group_ad_ad_hotel_ad |
string |
Details pertaining to a hotel ad |
ad_group_ad_ad_id |
long |
Output only. The ID of the ad |
ad_group_ad_ad_image_ad_image_url |
string |
URL of the full size image |
ad_group_ad_ad_image_ad_mime_type |
string |
The mime type of the image |
ad_group_ad_ad_image_ad_name |
string |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty |
ad_group_ad_ad_image_ad_pixel_height |
long |
Height in pixels of the full size image |
ad_group_ad_ad_image_ad_pixel_width |
long |
Width in pixels of the full size image |
ad_group_ad_ad_image_ad_preview_image_url |
string |
URL of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_height |
long |
Height in pixels of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_width |
long |
Width in pixels of the preview size image |
ad_group_ad_ad_legacy_app_install_ad |
string |
Immutable. Details pertaining to a legacy app install ad |
ad_group_ad_ad_legacy_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_legacy_responsive_display_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad |
ad_group_ad_ad_legacy_responsive_display_ad_description |
string |
The description of the ad |
ad_group_ad_ad_legacy_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_legacy_responsive_display_ad_logo_image |
string |
The MediaFile resource name of the logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_long_headline |
string |
The long version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_marketing_image |
string |
The MediaFile resource name of the marketing image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_legacy_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_legacy_responsive_display_ad_short_headline |
string |
The short version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_square_logo_image |
string |
The MediaFile resource name of the square logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_square_marketing_image |
string |
The MediaFile resource name of the square marketing image used in the ad |
ad_group_ad_ad_local_ad_call_to_actions |
string |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified |
ad_group_ad_ad_local_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified |
ad_group_ad_ad_local_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified |
ad_group_ad_ad_local_ad_logo_images |
string |
List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified |
ad_group_ad_ad_local_ad_marketing_images |
string |
List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified |
ad_group_ad_ad_local_ad_path1 |
string |
First part of optional text that can be appended to the URL in the ad |
ad_group_ad_ad_local_ad_path2 |
string |
Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_local_ad_videos |
string |
List of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified |
ad_group_ad_ad_name |
string |
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd |
ad_group_ad_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad resource names have the form: customers/customer_id/ads/ad_id |
ad_group_ad_ad_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_responsive_display_ad_business_name |
string |
The advertiser/brand name. Maximum display width is 25 |
ad_group_ad_ad_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad. Maximum display width is 30 |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_asset_enhancements |
boolean |
Whether the advertiser has opted into the asset enhancements feature |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_autogen_video |
boolean |
Whether the advertiser has opted into auto-gen video feature |
ad_group_ad_ad_responsive_display_ad_descriptions |
string |
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_responsive_display_ad_headlines |
string |
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_logo_images |
string |
Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_long_headline |
string |
A required long format headline. The maximum length is 90 characters |
ad_group_ad_ad_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_marketing_images |
string |
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_responsive_display_ad_square_logo_images |
string |
Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_square_marketing_images |
string |
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_youtube_videos |
string |
Optional YouTube videos for the ad. A maximum of 5 videos can be specified |
ad_group_ad_ad_responsive_search_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_responsive_search_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_responsive_search_ad_path1 |
string |
First part of text that can be appended to the URL in the ad |
ad_group_ad_ad_responsive_search_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_shopping_comparison_listing_ad_headline |
string |
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters |
ad_group_ad_ad_shopping_product_ad |
string |
Details pertaining to a Shopping product ad |
ad_group_ad_ad_shopping_smart_ad |
string |
Details pertaining to a Smart Shopping ad |
ad_group_ad_ad_smart_campaign_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified |
ad_group_ad_ad_smart_campaign_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified |
ad_group_ad_ad_strength |
string |
Output only. Overall ad strength for this ad group ad |
ad_group_ad_ad_system_managed_resource_source |
string |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only |
ad_group_ad_ad_text_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_text_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_text_ad_headline |
string |
The headline of the ad |
ad_group_ad_ad_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_ad_ad_type |
string |
Output only. The type of ad |
ad_group_ad_ad_url_collections |
string |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad |
ad_group_ad_ad_url_custom_parameters |
string |
The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations |
ad_group_ad_ad_video_ad_bumper_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_in_feed_description1 |
string |
First text line for the ad |
ad_group_ad_ad_video_ad_in_feed_description2 |
string |
Second text line for the ad |
ad_group_ad_ad_video_ad_in_feed_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_in_feed_thumbnail |
string |
Video thumbnail image to use |
ad_group_ad_ad_video_ad_in_stream_action_button_label |
string |
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise |
ad_group_ad_ad_video_ad_in_stream_action_headline |
string |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_in_stream_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_non_skippable_action_button_label |
string |
Label on the "Call To Action" button taking the user to the video ad's final URL |
ad_group_ad_ad_video_ad_non_skippable_action_headline |
string |
Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_non_skippable_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_out_stream_description |
string |
The description line |
ad_group_ad_ad_video_ad_out_stream_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_video_asset |
string |
The Asset resource name of this video |
ad_group_ad_ad_video_responsive_ad_call_to_actions |
string |
List of text assets used for the button, e.g. the "Call To Action" button. Currently, only a single value for the button is supported |
ad_group_ad_ad_video_responsive_ad_companion_banners |
string |
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported |
ad_group_ad_ad_video_responsive_ad_descriptions |
string |
List of text assets used for the description. Currently, only a single value for the description is supported |
ad_group_ad_ad_video_responsive_ad_headlines |
string |
List of text assets used for the short headline, e.g. the "Call To Action" banner. Currently, only a single value for the short headline is supported |
ad_group_ad_ad_video_responsive_ad_long_headlines |
string |
List of text assets used for the long headline. Currently, only a single value for the long headline is supported |
ad_group_ad_ad_video_responsive_ad_videos |
string |
List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported |
ad_group_ad_labels |
string |
Output only. The resource names of labels attached to this ad group ad |
ad_group_ad_policy_summary_approval_status |
string |
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries |
ad_group_ad_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this ad |
ad_group_ad_policy_summary_review_status |
string |
Output only. Where in the review process this ad is |
ad_group_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/customer_id/adGroupAds/ad_group_id~ad_id |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_ad_status |
string |
The status of the ad |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
asset |
string |
Output only. The asset which is linked to the ad group ad |
asset_book_on_google_asset |
string |
A book on google asset |
asset_call_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_call_asset_call_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION |
asset_call_asset_call_conversion_reporting_state |
string |
Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion |
asset_call_asset_country_code |
string |
Required. Two-letter country code of the phone number. Examples: 'US', 'us' |
asset_call_asset_phone_number |
string |
Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890' |
asset_call_to_action_asset_call_to_action |
string |
Call to action |
asset_callout_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_callout_asset_callout_text |
string |
Required. The callout text. The length of this string should be between 1 and 25, inclusive |
asset_callout_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_callout_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_dynamic_education_asset_address |
string |
School address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403 |
asset_dynamic_education_asset_android_app_link |
string |
Android deep link, e.g. android-app://com.example.android/http/example.com/gizmos?1234 |
asset_dynamic_education_asset_contextual_keywords |
string |
Contextual keywords, e.g. Nursing certification, Health, Mountain View |
asset_dynamic_education_asset_image_url |
string |
Image url, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset |
asset_dynamic_education_asset_ios_app_link |
string |
iOS deep link, e.g. exampleApp://content/page |
asset_dynamic_education_asset_ios_app_store_id |
long |
iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present |
asset_dynamic_education_asset_location_id |
string |
Location ID which can be any sequence of letters and digits and must be unique |
asset_dynamic_education_asset_program_description |
string |
Program description, e.g. Nursing Certification |
asset_dynamic_education_asset_program_id |
string |
Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required |
asset_dynamic_education_asset_program_name |
string |
Required. Program name, e.g. Nursing. Required |
asset_dynamic_education_asset_school_name |
string |
School name, e.g. Mountain View School of Nursing |
asset_dynamic_education_asset_similar_program_ids |
string |
Similar program IDs |
asset_dynamic_education_asset_subject |
string |
Subject of study, e.g. Health |
asset_dynamic_education_asset_thumbnail_image_url |
string |
Thumbnail image url, e.g. http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset |
asset_f... |
||
CREATE VIEW google_ads_api_examples.example_Performance_AdGroupAdAsset AS SELECT * FROM ( CALL google_ads_api.Performance_AdGroupAdAsset ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x |
Performance_AdGroupAdAssetCombination
Ad group ad asset combination view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
slot |
string |
Position of the ad |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
ad_group_ad_action_items |
string |
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines." |
ad_group_ad_ad_added_by_google_ads |
boolean |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing |
ad_group_ad_ad_app_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_ad_html5_media_bundles |
string |
List of media bundle assets that may be used with the ad |
ad_group_ad_ad_app_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_ad_mandatory_ad_text |
string |
Mandatory ad text |
ad_group_ad_ad_app_ad_youtube_videos |
string |
List of YouTube video assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_engagement_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_engagement_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_videos |
string |
List of video assets that may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_images |
string |
List of image asset IDs whose images may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_youtube_videos |
string |
List of YouTube video asset IDs whose videos may be displayed with the ad |
ad_group_ad_ad_call_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_call_ad_call_tracked |
boolean |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions |
ad_group_ad_ad_call_ad_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored |
ad_group_ad_ad_call_ad_conversion_reporting_state |
string |
The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled |
ad_group_ad_ad_call_ad_country_code |
string |
The country code in the ad |
ad_group_ad_ad_call_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_call_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_call_ad_disable_call_conversion |
boolean |
Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored |
ad_group_ad_ad_call_ad_headline1 |
string |
First headline in the ad |
ad_group_ad_ad_call_ad_headline2 |
string |
Second headline in the ad |
ad_group_ad_ad_call_ad_path1 |
string |
First part of text that can be appended to the URL in the ad. Optional |
ad_group_ad_ad_call_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional |
ad_group_ad_ad_call_ad_phone_number |
string |
The phone number in the ad |
ad_group_ad_ad_call_ad_phone_number_verification_url |
string |
The URL to be used for phone number verification |
ad_group_ad_ad_device_preference |
string |
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types |
ad_group_ad_ad_display_upload_ad_display_upload_product_type |
string |
The product type of this ad. See comments on the enum for details |
ad_group_ad_ad_display_upload_ad_media_bundle |
string |
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898for more information |
ad_group_ad_ad_display_url |
string |
The URL that appears in the ad description for some ad formats |
ad_group_ad_ad_expanded_dynamic_search_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_dynamic_search_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_text_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_headline_part1 |
string |
The first part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part2 |
string |
The second part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part3 |
string |
The third part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_path1 |
string |
The text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_expanded_text_ad_path2 |
string |
Additional text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_final_app_urls |
string |
A list of final app URLs that will be used on mobile if the user has the specific app installed |
ad_group_ad_ad_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_final_url_suffix |
string |
The suffix to use when constructing a final URL |
ad_group_ad_ad_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_group |
string |
Immutable. The ad group to which the ad belongs |
ad_group_ad_ad_hotel_ad |
string |
Details pertaining to a hotel ad |
ad_group_ad_ad_id |
long |
Output only. The ID of the ad |
ad_group_ad_ad_image_ad_image_url |
string |
URL of the full size image |
ad_group_ad_ad_image_ad_mime_type |
string |
The mime type of the image |
ad_group_ad_ad_image_ad_name |
string |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty |
ad_group_ad_ad_image_ad_pixel_height |
long |
Height in pixels of the full size image |
ad_group_ad_ad_image_ad_pixel_width |
long |
Width in pixels of the full size image |
ad_group_ad_ad_image_ad_preview_image_url |
string |
URL of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_height |
long |
Height in pixels of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_width |
long |
Width in pixels of the preview size image |
ad_group_ad_ad_legacy_app_install_ad |
string |
Immutable. Details pertaining to a legacy app install ad |
ad_group_ad_ad_legacy_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_legacy_responsive_display_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad |
ad_group_ad_ad_legacy_responsive_display_ad_description |
string |
The description of the ad |
ad_group_ad_ad_legacy_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_legacy_responsive_display_ad_logo_image |
string |
The MediaFile resource name of the logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_long_headline |
string |
The long version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_marketing_image |
string |
The MediaFile resource name of the marketing image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_legacy_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_legacy_responsive_display_ad_short_headline |
string |
The short version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_square_logo_image |
string |
The MediaFile resource name of the square logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_square_marketing_image |
string |
The MediaFile resource name of the square marketing image used in the ad |
ad_group_ad_ad_local_ad_call_to_actions |
string |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified |
ad_group_ad_ad_local_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified |
ad_group_ad_ad_local_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified |
ad_group_ad_ad_local_ad_logo_images |
string |
List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified |
ad_group_ad_ad_local_ad_marketing_images |
string |
List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified |
ad_group_ad_ad_local_ad_path1 |
string |
First part of optional text that can be appended to the URL in the ad |
ad_group_ad_ad_local_ad_path2 |
string |
Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_local_ad_videos |
string |
List of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified |
ad_group_ad_ad_name |
string |
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd |
ad_group_ad_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad resource names have the form: customers/customer_id/ads/ad_id |
ad_group_ad_ad_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_responsive_display_ad_business_name |
string |
The advertiser/brand name. Maximum display width is 25 |
ad_group_ad_ad_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad. Maximum display width is 30 |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_asset_enhancements |
boolean |
Whether the advertiser has opted into the asset enhancements feature |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_autogen_video |
boolean |
Whether the advertiser has opted into auto-gen video feature |
ad_group_ad_ad_responsive_display_ad_descriptions |
string |
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_responsive_display_ad_headlines |
string |
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_logo_images |
string |
Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_long_headline |
string |
A required long format headline. The maximum length is 90 characters |
ad_group_ad_ad_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_marketing_images |
string |
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_responsive_display_ad_square_logo_images |
string |
Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_square_marketing_images |
string |
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_youtube_videos |
string |
Optional YouTube videos for the ad. A maximum of 5 videos can be specified |
ad_group_ad_ad_responsive_search_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_responsive_search_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_responsive_search_ad_path1 |
string |
First part of text that can be appended to the URL in the ad |
ad_group_ad_ad_responsive_search_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_shopping_comparison_listing_ad_headline |
string |
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters |
ad_group_ad_ad_shopping_product_ad |
string |
Details pertaining to a Shopping product ad |
ad_group_ad_ad_shopping_smart_ad |
string |
Details pertaining to a Smart Shopping ad |
ad_group_ad_ad_smart_campaign_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified |
ad_group_ad_ad_smart_campaign_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified |
ad_group_ad_ad_strength |
string |
Output only. Overall ad strength for this ad group ad |
ad_group_ad_ad_system_managed_resource_source |
string |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only |
ad_group_ad_ad_text_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_text_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_text_ad_headline |
string |
The headline of the ad |
ad_group_ad_ad_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_ad_ad_type |
string |
Output only. The type of ad |
ad_group_ad_ad_url_collections |
string |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad |
ad_group_ad_ad_url_custom_parameters |
string |
The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations |
ad_group_ad_ad_video_ad_bumper_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_in_feed_description1 |
string |
First text line for the ad |
ad_group_ad_ad_video_ad_in_feed_description2 |
string |
Second text line for the ad |
ad_group_ad_ad_video_ad_in_feed_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_in_feed_thumbnail |
string |
Video thumbnail image to use |
ad_group_ad_ad_video_ad_in_stream_action_button_label |
string |
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise |
ad_group_ad_ad_video_ad_in_stream_action_headline |
string |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_in_stream_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_non_skippable_action_button_label |
string |
Label on the "Call To Action" button taking the user to the video ad's final URL |
ad_group_ad_ad_video_ad_non_skippable_action_headline |
string |
Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_non_skippable_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_out_stream_description |
string |
The description line |
ad_group_ad_ad_video_ad_out_stream_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_video_asset |
string |
The Asset resource name of this video |
ad_group_ad_ad_video_responsive_ad_call_to_actions |
string |
List of text assets used for the button, e.g. the "Call To Action" button. Currently, only a single value for the button is supported |
ad_group_ad_ad_video_responsive_ad_companion_banners |
string |
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported |
ad_group_ad_ad_video_responsive_ad_descriptions |
string |
List of text assets used for the description. Currently, only a single value for the description is supported |
ad_group_ad_ad_video_responsive_ad_headlines |
string |
List of text assets used for the short headline, e.g. the "Call To Action" banner. Currently, only a single value for the short headline is supported |
ad_group_ad_ad_video_responsive_ad_long_headlines |
string |
List of text assets used for the long headline. Currently, only a single value for the long headline is supported |
ad_group_ad_ad_video_responsive_ad_videos |
string |
List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported |
ad_group_ad_labels |
string |
Output only. The resource names of labels attached to this ad group ad |
ad_group_ad_policy_summary_approval_status |
string |
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries |
ad_group_ad_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this ad |
ad_group_ad_policy_summary_review_status |
string |
Output only. Where in the review process this ad is |
ad_group_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/customer_id/adGroupAds/ad_group_id~ad_id |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_ad_status |
string |
The status of the ad |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are sp... |
CREATE VIEW google_ads_api_examples.example_Performance_AdGroupAdAssetCombination AS SELECT * FROM ( CALL google_ads_api.Performance_AdGroupAdAssetCombination ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_AdGroupAsset
Ad group asset
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
phone_calls |
long |
Number of offline phone calls |
phone_impressions |
long |
Number of offline phone impressions |
phone_through_rate |
double |
Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions) |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
ad_group |
string |
Required. Immutable. The ad group to which the asset is linked |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
asset |
string |
Required. Immutable. The asset which is linked to the ad group |
asset_book_on_google_asset |
string |
A book on google asset |
asset_call_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_call_asset_call_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION |
asset_call_asset_call_conversion_reporting_state |
string |
Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion |
asset_call_asset_country_code |
string |
Required. Two-letter country code of the phone number. Examples: 'US', 'us' |
asset_call_asset_phone_number |
string |
Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890' |
asset_call_to_action_asset_call_to_action |
string |
Call to action |
asset_callout_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_callout_asset_callout_text |
string |
Required. The callout text. The length of this string should be between 1 and 25, inclusive |
asset_callout_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_callout_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_dynamic_education_asset_address |
string |
School address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403 |
asset_dynamic_education_asset_android_app_link |
string |
Android deep link, e.g. android-app://com.example.android/http/example.com/gizmos?1234 |
asset_dynamic_education_asset_contextual_keywords |
string |
Contextual keywords, e.g. Nursing certification, Health, Mountain View |
asset_dynamic_education_asset_image_url |
string |
Image url, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset |
asset_dynamic_education_asset_ios_app_link |
string |
iOS deep link, e.g. exampleApp://content/page |
asset_dynamic_education_asset_ios_app_store_id |
long |
iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present |
asset_dynamic_education_asset_location_id |
string |
Location ID which can be any sequence of letters and digits and must be unique |
asset_dynamic_education_asset_program_description |
string |
Program description, e.g. Nursing Certification |
asset_dynamic_education_asset_program_id |
string |
Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required |
asset_dynamic_education_asset_program_name |
string |
Required. Program name, e.g. Nursing. Required |
asset_dynamic_education_asset_school_name |
string |
School name, e.g. Mountain View School of Nursing |
asset_dynamic_education_asset_similar_program_ids |
string |
Similar program IDs |
asset_dynamic_education_asset_subject |
string |
Subject of study, e.g. Health |
asset_dynamic_education_asset_thumbnail_image_url |
string |
Thumbnail image url, e.g. http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset |
asset_final_mobile_urls |
string |
A list of possible final mobile URLs after all cross domain redirects |
asset_final_url_suffix |
string |
URL template for appending params to landing page URLs served with parallel tracking |
asset_final_urls |
string |
A list of possible final URLs after all cross domain redirects |
asset_hotel_callout_asset_language_code |
string |
Required. The language of the hotel callout. Represented as BCP 47 language tag |
asset_hotel_callout_asset_text |
string |
Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive |
asset_id |
long |
Output only. The ID of the asset |
asset_image_asset_file_size |
long |
File size of the image asset in bytes |
asset_image_asset_full_size_height_pixels |
long |
Height of the image |
asset_image_asset_full_size_url |
string |
A URL that returns the image with this height and width |
asset_image_asset_full_size_width_pixels |
long |
Width of the image |
asset_image_asset_mime_type |
string |
MIME type of the image asset |
asset_lead_form_asset_background_image_asset |
string |
Asset resource name of the background image. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%) |
asset_lead_form_asset_business_name |
string |
Required. The name of the business being advertised |
asset_lead_form_asset_call_to_action_description |
string |
Required. Text giving a clear value proposition of what users expect once they expand the form |
asset_lead_form_asset_call_to_action_type |
string |
Required. Pre-defined display text that encourages user to expand the form |
asset_lead_form_asset_custom_disclosure |
string |
Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only |
asset_lead_form_asset_delivery_methods |
string |
Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured |
asset_lead_form_asset_description |
string |
Required. Detailed description of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_desired_intent |
string |
Desired intent for the lead form, e.g. more volume or more qualified |
asset_lead_form_asset_fields |
string |
Ordered list of input fields |
asset_lead_form_asset_headline |
string |
Required. Headline of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_post_submit_call_to_action_type |
string |
Pre-defined display text that encourages user action after the form is submitted |
asset_lead_form_asset_post_submit_description |
string |
Detailed description shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_post_submit_headline |
string |
Headline of text shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_privacy_policy_url |
string |
Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business |
asset_mobile_app_asset_app_id |
string |
Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS |
asset_mobile_app_asset_app_store |
string |
Required. The application store that distributes this specific app |
asset_mobile_app_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_mobile_app_asset_link_text |
string |
Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive |
asset_mobile_app_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_name |
string |
Optional name of the asset |
asset_page_feed_asset_labels |
string |
Labels used to group the page urls |
asset_page_feed_asset_page_url |
string |
Required. The webpage that advertisers want to target |
asset_policy_summary_approval_status |
string |
Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries |
asset_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this asset |
asset_policy_summary_review_status |
string |
Output only. Where in the review process this asset is |
asset_price_asset_language_code |
string |
Required. The language of the price asset. Represented as BCP 47 language tag |
asset_price_asset_price_offerings |
string |
The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive |
asset_price_asset_price_qualifier |
string |
The price qualifier of the price asset |
asset_price_asset_type |
string |
Required. The type of the price asset |
asset_promotion_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_promotion_asset_discount_modifier |
string |
A modifier for qualification of the discount |
asset_promotion_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_promotion_asset_language_code |
string |
The language of the promotion. Represented as BCP 47 language tag |
asset_promotion_asset_money_amount_off_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_money_amount_off_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_occasion |
string |
The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion |
asset_promotion_asset_orders_over_amount_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_orders_over_amount_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_percent_off |
long |
Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required |
asset_promotion_asset_promotion_code |
string |
A code the user should use in order to be eligible for the promotion |
asset_promotion_asset_promotion_target |
string |
Required. A freeform description of what the promotion is targeting |
asset_promotion_asset_redemption_end_date |
date |
Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_redemption_start_date |
date |
Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_resource_name |
string |
Immutable. The resource name of the asset. Asset resource names have the form: customers/customer_id/assets/asset_id} |
asset_sitelink_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_sitelink_asset_description1 |
string |
First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set |
asset_sitelink_asset_description2 |
string |
Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set |
asset_sitelink_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_sitelink_asset_link_text |
string |
Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive |
asset_sitelink_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_structured_snippet_asset_header |
string |
Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers |
asset_structured_snippet_asset_values |
string |
Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive |
asset_text_asset_text |
string |
Text content of the text asset |
asset_tracking_url_template |
string |
URL template for constructing a tracking URL |
asset_type |
string |
Output only. Type of the asset |
asset_url_custom_parameters |
string |
A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls |
asset_youtube_video_asset_youtube_video_id |
string |
YouTube video id. This is the 11 character string value used in the YouTube video URL |
asset_youtube_video_asset_youtube_video_title |
string |
YouTube video title |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_t... |
CREATE VIEW google_ads_api_examples.example_Performance_AdGroupAsset AS SELECT * FROM ( CALL google_ads_api.Performance_AdGroupAsset ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_AdSchedule
Ad schedule view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_criterion_ad_schedule_day_of_week |
string |
Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_end_hour |
integer |
Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_end_minute |
string |
Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_start_hour |
integer |
Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_start_minute |
string |
Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_age_range_type |
string |
Type of the age range |
campaign_criterion_bid_modifier |
float |
The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type |
campaign_criterion_campaign |
string |
Immutable. The campaign to which the criterion belongs |
campaign_criterion_carrier_carrier_constant |
string |
The Carrier constant resource name |
campaign_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
campaign_criterion_content_label_type |
string |
Content label type, required for CREATE operations |
campaign_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored during mutate |
campaign_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
campaign_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
campaign_criterion_device_type |
string |
Type of the device |
campaign_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
campaign_criterion_gender_type |
string |
Type of the gender |
campaign_criterion_income_range_type |
string |
Type of the income range |
campaign_criterion_ip_block_ip_address |
string |
The IP address of this IP block |
campaign_criterion_keyword_match_type |
string |
The match type of the keyword |
campaign_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
campaign_criterion_keyword_theme_free_form_keyword_theme |
string |
Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis |
campaign_criterion_keyword_theme_keyword_theme_constant |
string |
The resource name of a Smart Campaign keyword theme constant. keywordThemeConstants/<keyword_theme_id>~<sub_keyword_theme_id> |
campaign_criterion_language_language_constant |
string |
The language constant resource name |
campaign_criterion_listing_scope_dimensions |
string |
Scope of the campaign criterion |
campaign_criterion_location_geo_target_constant |
string |
The geo target constant resource name |
campaign_criterion_location_group |
string |
Immutable. Location Group |
campaign_criterion_location_group_feed |
string |
Feed specifying locations for targeting. This is required and must be set in CREATE operations |
campaign_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
campaign_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "<platform>-<platform_native_id>", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
campaign_criterion_mobile_application_name |
string |
Name of this mobile application |
campaign_criterion_mobile_device_mobile_device_constant |
string |
The mobile device constant resource name |
campaign_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion |
campaign_criterion_operating_system_version_operating_system_version_constant |
string |
The operating system version constant resource name |
campaign_criterion_parental_status_type |
string |
Type of the parental status |
campaign_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
campaign_criterion_proximity_address_city_name |
string |
Name of the city |
campaign_criterion_proximity_address_country_code |
string |
Country code |
campaign_criterion_proximity_address_postal_code |
string |
Postal code |
campaign_criterion_proximity_address_province_code |
string |
Province or state code |
campaign_criterion_proximity_address_province_name |
string |
Province or state name |
campaign_criterion_proximity_address_street_address |
string |
Street address line 1 |
campaign_criterion_proximity_geo_point_latitude_in_micro_degrees |
integer |
Micro degrees for the latitude |
campaign_criterion_proximity_geo_point_longitude_in_micro_degrees |
integer |
Micro degrees for the longitude |
campaign_criterion_proximity_radius |
double |
The radius of the proximity |
campaign_criterion_proximity_radius_units |
string |
The unit of measurement of the radius. Default is KILOMETERS |
campaign_criterion_resource_name |
string |
Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: customers/customer_id/campaignCriteria/<campaign_id>/<criterion_id> |
campaign_criterion_status |
string |
The status of the criterion |
campaign_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
campaign_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
campaign_criterion_type |
string |
Output only. The type of the criterion |
campaign_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
campaign_criterion_user_list_user_list |
string |
The User List resource name |
campaign_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
campaign_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
campaign_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
campaign_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/<campaign_id> |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
resource_name |
string |
Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: customers/customer_id/adScheduleViews/<campaign_id>/<criterion_id> |
campaign_criterion_local_service_id_service_id |
string |
The criterion resource name |
campaign_discovery_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_c... |
CREATE VIEW google_ads_api_examples.example_Performance_AdSchedule AS SELECT * FROM ( CALL google_ads_api.Performance_AdSchedule ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_AgeRange
Age range view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform}-platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id~criterion_id |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campai... |
CREATE VIEW google_ads_api_examples.example_Performance_AgeRange AS SELECT * FROM ( CALL google_ads_api.Performance_AgeRange ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_AssetFieldType
Asset field type view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
phone_calls |
long |
Number of offline phone calls |
phone_impressions |
long |
Number of offline phone impressions |
phone_through_rate |
double |
Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions) |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
field_type |
string |
Output only. The asset field type of the asset field type view |
resource_name |
string |
Output only. The resource name of the asset field type view. Asset field type view resource names have the form: customers/customer_id/assetFieldTypeViews/field_type} |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Customer customer agreement setting accepted lead form terms |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
Ad group ad fixed CPM bidding strategy |
ad_group_primary_status |
string |
Ad group primary status |
ad_group_primary_status_reasons |
string |
Ad group primary status reasons |
ad_group_target_cpv_micros |
long |
Ad group ad target CPM is an automated bidding strategy that sets bids to optimize performance given the target CPM you set |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Campaign demand gen campaign settings upgraded targeting |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
ad_group_exclude_demographic_expansion |
boolean |
When this value is true, demographics will be excluded from the types of targeting |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_AssetFieldType AS SELECT * FROM ( CALL google_ads_api.Performance_AssetFieldType ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_AssetGroupProductGroup
Asset group product group view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
asset_group_campaign |
string |
Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group |
asset_group_final_mobile_urls |
string |
A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out |
asset_group_final_urls |
string |
A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out |
asset_group_id |
long |
Output only. The ID of the asset group |
asset_group_listing_group_filter_asset_group |
string |
Immutable. The asset group which this asset group listing group filter is part of |
asset_group_listing_group_filter_case_value_product_brand_value |
string |
String value of the product brand |
asset_group_listing_group_filter_case_value_product_channel_channel |
string |
Value of the locality |
asset_group_listing_group_filter_case_value_product_condition_condition |
string |
Value of the condition |
asset_group_listing_group_filter_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
asset_group_listing_group_filter_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
asset_group_listing_group_filter_case_value_product_item_id_value |
string |
Value of the id |
asset_group_listing_group_filter_case_value_product_type_level |
string |
Level of the type |
asset_group_listing_group_filter_case_value_product_type_value |
string |
Value of the type |
asset_group_listing_group_filter_id |
long |
Output only. The ID of the ListingGroupFilter |
asset_group_listing_group_filter_parent_listing_group_filter |
string |
Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node |
asset_group_listing_group_filter_resource_name |
string |
Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: customers/customer_id/assetGroupListingGroupFilters/<asset_group_id>/<listing_group_filter_id> |
asset_group_listing_group_filter_type |
string |
Immutable. Type of a listing group filter node |
asset_group_name |
string |
Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign |
asset_group_path1 |
string |
First part of text that may appear appended to the url displayed in the ad |
asset_group_path2 |
string |
Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set |
asset_group_resource_name |
string |
Immutable. The resource name of the asset group. Asset group resource names have the form: customers/customer_id/assetGroups/<asset_group_id> |
asset_group_status |
string |
The status of the asset group |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/<campaign_id> |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
resource_name |
string |
Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form: customers/customer_id/assetGroupProductGroupViews/<asset_group_id>~<listing_group_filter_id> |
asset_group_listing_group_filter_path |
string |
A listing group filter tree node in an asset group |
asset_group_primary_status |
string |
The primary status of the asset group |
asset_group_primary_status_reasons |
string |
Provides reasons into why an asset group is not serving or not serving optimally |
campaign_discovery_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Customer customer agreement setting accepted lead form terms |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
asset_group_listing_group_filter_case_value_product_category_category_id |
long |
ID of the product category |
asset_group_listing_group_filter_case_value_product_category_level |
string |
Level of the product category |
asset_group_listing_group_filter_case_value_webpage_conditions |
string |
The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering |
asset_group_listing_group_filter_listing_source |
string |
The source of listings filtered by this listing group filter |
average_cart_size |
double |
The average number of products in each order attributed to your ads |
average_order_value_micros |
double |
The average revenue you made per order attributed to your ads |
campaign_asset_automation_settings |
string |
|
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
cost_of_goods_sold_micros |
long |
The total cost of the products you sold in orders attributed to your ads |
cross_sell_cost_of_goods_sold_micros |
long |
The total cost of products sold as a result of advertising a different product |
cross_sell_gross_profit_micros |
double |
The profit you made from products sold as a result of advertising a different product, minus cost of goods sold |
cross_sell_revenue_micros |
double |
The total amount you made from products sold as a result of advertising a different product |
cross_sell_units_sold |
double |
The total number of products sold as a result of advertising a different product |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
gross_profit_margin |
double |
The percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold |
gross_profit_micros |
double |
The profit you made from orders attributed to your ads minus the cost of goods sold |
lead_cost_of_goods_sold_micros |
long |
The total cost of products sold as a result of advertising the same product |
lead_gross_profit_micros |
long |
The profit you made from products sold as a result of advertising the same product, minus cost of goods sold |
lead_revenue_micros |
long |
The total amount you made from products sold as a result of advertising the same product |
lead_units_sold |
double |
The total number of products sold as a result of advertising the same product |
orders |
double |
The total number of purchase conversions you received attributed to your ads |
revenue_micros |
long |
The total amount you made from orders attributed to your ads |
units_sold |
double |
Units sold is the total number of products sold from orders attributed to your ads |
CREATE VIEW google_ads_api_examples.example_Performance_AssetGroupProductGroup AS SELECT * FROM ( CALL google_ads_api.Performance_AssetGroupProductGroup ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_BiddingStrategy
Bidding strategy
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
campaign_count |
long |
Output only. The number of campaigns attached to this bidding strategy. This field is read-only |
currency_code |
string |
Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
effective_currency_code |
string |
Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only |
enhanced_cpc |
string |
A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely |
id |
long |
Output only. The ID of the bidding strategy |
maximize_conversion_value_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
maximize_conversion_value_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
maximize_conversions_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
maximize_conversions_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
name |
string |
The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed) |
non_removed_campaign_count |
long |
Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only |
resource_name |
string |
Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: customers/customer_id/biddingStrategies/<bidding_strategy_id> |
status |
string |
Output only. The status of the bidding strategy. This field is read-only |
target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
target_impression_share_location |
string |
The targeted location on the search results page |
target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
type |
string |
Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only |
average_target_cpa_micros |
long |
The average Target CPA |
average_target_roas |
double |
The average Target CPA |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Customer customer agreement setting accepted lead form terms |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
CREATE VIEW google_ads_api_examples.example_Performance_BiddingStrategy AS SELECT * FROM ( CALL google_ads_api.Performance_BiddingStrategy ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Campaign
Campaign
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_by_conversion_date |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_by_conversion_date |
double |
The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
average_page_views |
double |
Average number of pages viewed per session |
average_time_on_site |
double |
Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics |
bounce_rate |
double |
Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics |
clicks |
long |
The number of clicks |
content_budget_lost_impression_share |
double |
The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
content_impression_share |
double |
The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
content_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_by_conversion_date |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_by_conversion_date |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_per_current_model_attributed_conversion |
double |
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
current_model_attributed_conversions |
double |
Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_from_interactions_rate |
double |
Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_from_interactions_value_per_interaction |
double |
The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_value |
double |
The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_value_per_cost |
double |
The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
invalid_click_rate |
double |
The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period |
invalid_clicks |
long |
Number of clicks Google considers illegitimate and doesn't charge you for |
percent_new_visitors |
double |
Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics |
phone_calls |
long |
Number of offline phone calls |
phone_impressions |
long |
Number of offline phone impressions |
phone_through_rate |
double |
Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions) |
relative_ctr |
double |
Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites |
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826for details. Any value below 0.1 is reported as 0.0999 |
search_budget_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_budget_lost_impression_share |
double |
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_budget_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_click_share |
double |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_exact_match_impression_share |
double |
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_rank_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_top_impression_share |
double |
The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_all_conversions_by_conversion_date |
double |
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
value_per_conversions_by_conversion_date |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_current_model_attributed_conversion |
double |
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
accessible_bidding_strategy_id |
long |
Output only. The ID of the bidding strategy |
accessible_bidding_strategy_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
accessible_bidding_strategy_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
accessible_bidding_strategy_name |
string |
Output only. The name of the bidding strategy |
accessible_bidding_strategy_owner_customer_id |
long |
Output only. The ID of the Customer which owns the bidding strategy |
accessible_bidding_strategy_owner_descriptive_name |
string |
Output only. descriptive_name of the Customer which owns the bidding strategy |
accessible_bidding_strategy_resource_name |
string |
Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: customers/customer_id/accessibleBiddingStrategies/bidding_strategy_id} |
accessible_bidding_strategy_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
accessible_bidding_strategy_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
accessible_bidding_strategy_target_impression_share_location |
string |
The targeted location on the search results page |
accessible_bidding_strategy_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
accessible_bidding_strategy_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
accessible_bidding_strategy_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
accessible_bidding_strategy_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
accessible_bidding_strategy_type |
string |
Output only. The type of the bidding strategy |
ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
bidding_strategy_campaign_count |
long |
Output only. The number of campaigns attached to this bidding strategy. This field is read-only |
bidding_strategy_currency_code |
string |
Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy |
bidding_strategy_effective_currency_code |
string |
Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only |
bidding_strategy_enhanced_cpc |
string |
A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely |
bidding_strategy_id |
long |
Output only. The ID of the bidding strategy |
bidding_strategy_maximize_conversion_value_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversion_value_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
bidding_strategy_maximize_conversions_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversions_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
bidding_strategy_name |
string |
The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed) |
bidding_strategy_non_removed_campaign_count |
long |
Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only |
bidding_strategy_resource_name |
string |
Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: customers/customer_id/biddingStrategies/bidding_strategy_id} |
bidding_strategy_status |
string |
Output only. The status of the bidding strategy. This field is read-only |
bidding_strategy_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
bidding_strategy_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
bidding_strategy_target_impression_share_location |
string |
The targeted location on the search results page |
bidding_strategy_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
bidding_strategy_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
bidding_strategy_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
bidding_strategy_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
bidding_strategy_type_1 |
string |
Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only |
campaign_budget |
string |
The budget of the campaign |
campaign_budget_amount_micros |
long |
The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount |
campaign_budget_delivery_method |
string |
The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation |
campaign_budget_explicitly_shared |
boolean |
Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared |
campaign_budget_has_recommended_budget |
boolean |
Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only |
campaign_budget_id |
long |
Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results |
campaign_budget_name |
string |
The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed) |
campaign_budget_period |
string |
Immutable. Period over which to spend the budget. Defaults to DAILY if not specified |
campaign_budget_recommended_budget_amount_micros |
long |
Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only |
campaign_budget_recommended_budget_estimated_change_weekly_clicks |
long |
Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only |
campaign_budget_recommended_budget_estimated_change_weekly_cost_micros |
long |
Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only |
campaign_budget_recommended_budget_estimated_change_weekly_interactions |
long |
Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only |
campaign_budget_recommended_budget_estimated_change_weekly_views |
long |
Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only |
campaign_budget_reference_count |
long |
Output only. The number of campaigns actively using the budget. This field is read-only |
campaign_budget_resource_name |
string |
Immutable. The resource name of the campaign budge... |
CREATE VIEW google_ads_api_examples.example_Performance_Campaign AS SELECT * FROM ( CALL google_ads_api.Performance_Campaign ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_CampaignAggregateAsset
Campaign aggregate asset
Parameter
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
asset |
string |
Immutable. The asset which is linked to the campaign |
asset_source |
string |
Source of the asset link |
campaign |
string |
Campaign in which the asset served |
field_type |
string |
FieldType of the asset |
resource_name |
string |
The resource name of the campaign aggregate asset view |
asset_book_on_google_asset |
string |
A book on google asset |
asset_call_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_call_asset_call_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION |
asset_call_asset_call_conversion_reporting_state |
string |
Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion |
asset_call_asset_country_code |
string |
Required. Two-letter country code of the phone number. Examples: 'US', 'us' |
asset_call_asset_phone_number |
string |
Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890' |
asset_call_to_action_asset_call_to_action |
string |
Call to action |
asset_callout_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_callout_asset_callout_text |
string |
Required. The callout text. The length of this string should be between 1 and 25, inclusive |
asset_callout_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_callout_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_demand_gen_carousel_card_asset_call_to_action_text |
string |
A Demand Gen Carousel Card asset. Call to action text. |
asset_demand_gen_carousel_card_asset_headline |
string |
A Demand Gen Carousel Card asset. Headline of the carousel card |
asset_demand_gen_carousel_card_asset_marketing_image_asset |
string |
A Demand Gen Carousel Card asset. Asset resource name of the associated 1.91:1 marketing image |
asset_demand_gen_carousel_card_asset_portrait_marketing_image_asset |
string |
A Demand Gen Carousel Card asset. Asset resource name of the associated 4:5 portrait marketing image |
asset_demand_gen_carousel_card_asset_square_marketing_image_asset |
string |
A Demand Gen Carousel Card asset. Asset resource name of the associated square marketing image |
asset_dynamic_custom_asset_android_app_link |
string |
Android deep link |
asset_dynamic_custom_asset_contextual_keywords |
string |
Contextual keywords |
asset_dynamic_custom_asset_formatted_price |
string |
Formatted price which can be any characters |
asset_dynamic_custom_asset_formatted_sale_price |
string |
Formatted sale price which can be any characters |
asset_dynamic_custom_asset_id |
string |
ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag |
asset_dynamic_custom_asset_id2 |
string |
ID2 which can be any sequence of letters and digits |
asset_dynamic_custom_asset_image_url |
string |
Image URL |
asset_dynamic_custom_asset_ios_app_link |
string |
iOS deep link, |
asset_dynamic_custom_asset_ios_app_store_id |
long |
iOS app store ID |
asset_dynamic_custom_asset_item_address |
string |
Item address which can be specified in one of the following formats |
asset_dynamic_custom_asset_item_category |
string |
Item category |
asset_dynamic_custom_asset_item_description |
string |
Item description |
asset_dynamic_custom_asset_item_subtitle |
string |
Item subtitle |
asset_dynamic_custom_asset_item_title |
string |
Item title |
asset_dynamic_custom_asset_price |
string |
Price which can be number followed by the alphabetic currency code |
asset_dynamic_custom_asset_sale_price |
string |
Sale price which can be number followed by the alphabetic currency code |
asset_dynamic_custom_asset_similar_ids |
string |
Similar IDs |
asset_dynamic_education_asset_address |
string |
School address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403 |
asset_dynamic_education_asset_android_app_link |
string |
Android deep link, e.g. android-app://com.example.android/http/example.com/gizmos?1234 |
asset_dynamic_education_asset_contextual_keywords |
string |
Contextual keywords, e.g. Nursing certification, Health, Mountain View |
asset_dynamic_education_asset_image_url |
string |
Image url, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset |
asset_dynamic_education_asset_ios_app_link |
string |
iOS deep link, e.g. exampleApp://content/page |
asset_dynamic_education_asset_ios_app_store_id |
long |
iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present |
asset_dynamic_education_asset_location_id |
string |
Location ID which can be any sequence of letters and digits and must be unique |
asset_dynamic_education_asset_program_description |
string |
Program description, e.g. Nursing Certification |
asset_dynamic_education_asset_program_id |
string |
Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required |
asset_dynamic_education_asset_program_name |
string |
Required. Program name, e.g. Nursing. Required |
asset_dynamic_education_asset_school_name |
string |
School name, e.g. Mountain View School of Nursing |
asset_dynamic_education_asset_similar_program_ids |
string |
Similar program IDs |
asset_dynamic_education_asset_subject |
string |
Subject of study, e.g. Health |
asset_dynamic_education_asset_thumbnail_image_url |
string |
Thumbnail image url, e.g. http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset |
asset_dynamic_flights_asset_android_app_link |
string |
Android deep link |
asset_dynamic_flights_asset_custom_mapping |
string |
A custom field which can be multiple key to values mapping separated by delimiters |
asset_dynamic_flights_asset_destination_id |
string |
Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag |
asset_dynamic_flights_asset_destination_name |
string |
Destination name |
asset_dynamic_flights_asset_flight_description |
string |
Flight description |
asset_dynamic_flights_asset_flight_price |
string |
Flight price which can be number followed by the alphabetic currency code |
asset_dynamic_flights_asset_flight_sale_price |
string |
Flight sale price which can be number followed by the alphabetic currency code |
asset_dynamic_flights_asset_formatted_price |
string |
Formatted price which can be any characters |
asset_dynamic_flights_asset_formatted_sale_price |
string |
Formatted sale price which can be any characters |
asset_dynamic_flights_asset_image_url |
string |
Image URL |
asset_dynamic_flights_asset_ios_app_link |
string |
iOS deep link |
asset_dynamic_flights_asset_ios_app_store_id |
long |
iOS app store ID |
asset_dynamic_flights_asset_origin_id |
string |
Origin ID which can be any sequence of letters and digits |
asset_dynamic_flights_asset_origin_name |
string |
Origin name |
asset_dynamic_flights_asset_similar_destination_ids |
string |
Similar destination IDs |
asset_dynamic_hotels_and_rentals_asset_address |
string |
Address which can be specified in one of the following formats |
asset_dynamic_hotels_and_rentals_asset_android_app_link |
string |
Android deep link |
asset_dynamic_hotels_and_rentals_asset_category |
string |
Category |
asset_dynamic_hotels_and_rentals_asset_contextual_keywords |
string |
Contextual keywords |
asset_dynamic_hotels_and_rentals_asset_description |
string |
Description |
asset_dynamic_hotels_and_rentals_asset_destination_name |
string |
Destination name |
asset_dynamic_hotels_and_rentals_asset_formatted_price |
string |
Formatted price which can be any characters |
asset_dynamic_hotels_and_rentals_asset_formatted_sale_price |
string |
Formatted sale price which can be any characters |
asset_dynamic_hotels_and_rentals_asset_image_url |
string |
Image URL |
asset_dynamic_hotels_and_rentals_asset_ios_app_link |
string |
iOS deep link |
asset_dynamic_hotels_and_rentals_asset_ios_app_store_id |
long |
iOS app store ID |
asset_dynamic_hotels_and_rentals_asset_price |
string |
Price which can be number followed by the alphabetic currency code |
asset_dynamic_hotels_and_rentals_asset_property_id |
string |
Property ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag |
asset_dynamic_hotels_and_rentals_asset_property_name |
string |
Property name |
asset_dynamic_hotels_and_rentals_asset_sale_price |
string |
ISO 4217 standard. Use '.' as the decimal mark |
asset_dynamic_hotels_and_rentals_asset_similar_property_ids |
string |
Similar property IDs |
asset_dynamic_hotels_and_rentals_asset_star_rating |
long |
Star rating |
asset_dynamic_jobs_asset_address |
string |
Address which can be specified in one of the following formats |
asset_dynamic_jobs_asset_android_app_link |
string |
Android deep link |
asset_dynamic_jobs_asset_contextual_keywords |
string |
Contextual keywords |
asset_dynamic_jobs_asset_description |
string |
Description |
asset_dynamic_jobs_asset_image_url |
string |
Image URL |
asset_dynamic_jobs_asset_ios_app_link |
string |
iOS deep link |
asset_dynamic_jobs_asset_ios_app_store_id |
long |
iOS app store ID |
asset_dynamic_jobs_asset_job_category |
string |
Job category |
asset_dynamic_jobs_asset_job_id |
string |
Job ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag |
asset_dynamic_jobs_asset_job_subtitle |
string |
Job subtitle |
asset_dynamic_jobs_asset_job_title |
string |
Job title |
asset_dynamic_jobs_asset_location_id |
string |
Location ID which can be any sequence of letters and digits |
asset_dynamic_jobs_asset_salary |
string |
Salary |
asset_dynamic_jobs_asset_similar_job_ids |
string |
Similar job IDs |
asset_dynamic_local_asset_address |
string |
Address which can be specified in one of the formats |
asset_dynamic_local_asset_android_app_link |
string |
Android deep link |
asset_dynamic_local_asset_category |
string |
Category |
asset_dynamic_local_asset_contextual_keywords |
string |
Contextual keywords |
asset_dynamic_local_asset_deal_id |
string |
Deal ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag |
asset_dynamic_local_asset_deal_name |
string |
Deal name |
asset_dynamic_local_asset_description |
string |
Description |
asset_dynamic_local_asset_formatted_price |
string |
Formatted price which can be any characters |
asset_dynamic_local_asset_formatted_sale_price |
string |
Formatted sale price which can be any characters |
asset_dynamic_local_asset_image_url |
string |
Image URL |
asset_dynamic_local_asset_ios_app_link |
string |
iOS deep link |
asset_dynamic_local_asset_ios_app_store_id |
long |
iOS app store ID |
asset_dynamic_local_asset_price |
string |
Price which can be a number followed by the alphabetic currency code |
asset_dynamic_local_asset_sale_price |
string |
Sale price which can be number followed by the alphabetic currency code |
asset_dynamic_local_asset_similar_deal_ids |
string |
Similar deal IDs |
asset_dynamic_local_asset_subtitle |
string |
Subtitle |
asset_dynamic_real_estate_asset_address |
string |
Address which can be specified in one of the formats |
asset_dynamic_real_estate_asset_android_app_link |
string |
Android deep link |
asset_dynamic_real_estate_asset_city_name |
string |
City name |
asset_dynamic_real_estate_asset_contextual_keywords |
string |
Contextual keywords |
asset_dynamic_real_estate_asset_description |
string |
Description |
asset_dynamic_real_estate_asset_formatted_price |
string |
Formatted price which can be any characters |
asset_dynamic_real_estate_asset_image_url |
string |
Image URL |
asset_dynamic_real_estate_asset_ios_app_link |
string |
iOS deep link |
asset_dynamic_real_estate_asset_ios_app_store_id |
long |
iOS app store ID |
asset_dynamic_real_estate_asset_listing_id |
string |
Listing ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag |
asset_dynamic_real_estate_asset_listing_name |
string |
Listing name |
asset_dynamic_real_estate_asset_listing_type |
string |
Listing type |
asset_dynamic_real_estate_asset_price |
string |
Price which can be number followed by the alphabetic currency code |
asset_dynamic_real_estate_asset_property_type |
string |
Property type |
asset_dynamic_real_estate_asset_similar_listing_ids |
string |
Similar listing IDs |
asset_dynamic_travel_asset_android_app_link |
string |
Android deep link |
asset_dynamic_travel_asset_category |
string |
Category |
asset_dynamic_travel_asset_contextual_keywords |
string |
Contextual keywords |
asset_dynamic_travel_asset_destination_address |
string |
Destination address which can be specified in one of the following formats |
asset_dynamic_travel_asset_destination_id |
string |
Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag |
asset_dynamic_travel_asset_destination_name |
string |
Destination name |
asset_dynamic_travel_asset_formatted_price |
string |
Formatted price which can be any characters |
asset_dynamic_travel_asset_formatted_sale_price |
string |
Formatted sale price which can be any characters |
asset_dynamic_travel_asset_image_url |
string |
Image URL |
asset_dynamic_travel_asset_ios_app_link |
string |
iOS deep link |
asset_dynamic_travel_asset_ios_app_store_id |
long |
iOS app store ID |
asset_dynamic_travel_asset_origin_id |
string |
Origin ID which can be any sequence of letters and digits |
asset_dynamic_travel_asset_origin_name |
string |
Origin name, |
asset_dynamic_travel_asset_price |
string |
Price which can be a number followed by the alphabetic currency code |
asset_dynamic_travel_asset_sale_price |
string |
Sale price which can be a number followed by the alphabetic currency code |
asset_dynamic_travel_asset_similar_destination_ids |
string |
Similar destination IDs |
asset_dynamic_travel_asset_title |
string |
Title |
asset_field_type_policy_summaries |
string |
Policy information for the asset for each FieldType |
asset_final_mobile_urls |
string |
A list of possible final mobile URLs after all cross domain redirects |
asset_final_url_suffix |
string |
URL template for appending params to landing page |
asset_final_urls |
string |
A list of possible final URLs after all cross domain redirects |
asset_hotel_callout_asset_language_code |
string |
The language of the hotel callout |
asset_hotel_callout_asset_text |
string |
The text of the hotel callout asset |
asset_hotel_property_asset_hotel_address |
string |
Address of the hotel |
asset_hotel_property_asset_hotel_name |
string |
Name of the hotel |
asset_hotel_property_asset_place_id |
string |
Place IDs uniquely identify a place in the Google Places database and on Google Maps |
asset_id |
long |
The ID of the asset |
asset_image_asset_file_size |
long |
File size of the image asset in bytes |
asset_image_asset_full_size_height_pixels |
long |
Height of the image |
asset_image_asset_full_size_url |
string |
A URL that returns the image with this height and width |
asset_image_asset_full_size_width_pixels |
long |
Width of the image |
asset_image_asset_mime_type |
string |
MIME type of the image asset |
asset_lead_form_asset_background_image_asset |
string |
Asset resource name of the background image. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%) |
asset_lead_form_asset_business_name |
string |
Required. The name of the business being advertised |
asset_lead_form_asset_call_to_action_description |
string |
Required. Text giving a clear value proposition of what users expect once they expand the form |
asset_lead_form_asset_call_to_action_type |
string |
Required. Pre-defined display text that encourages user to expand the form |
asset_lead_form_asset_custom_disclosure |
string |
Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only |
asset_lead_form_asset_custom_question_fields |
string |
Ordered list of custom question fields |
asset_lead_form_asset_delivery_methods |
string |
Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured |
asset_lead_form_asset_description |
string |
Required. Detailed description of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_desired_intent |
string |
Desired intent for the lead form, e.g. more volume or more qualified |
asset_lead_form_asset_fields |
string |
Ordered list of input fields |
asset_lead_form_asset_headline |
string |
Required. Headline of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_post_submit_call_to_action_type |
string |
Pre-defined display text that encourages user action after the form is submitted |
asset_lead_form_asset_post_submit_description |
string |
Detailed description shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_post_submit_headline |
string |
Headline of text shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_privacy_policy_url |
string |
Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business |
asset_location_asset_business_profile_locations |
string |
The list of business locations for the customer |
asset_location_asset_location_ownership_type |
string |
The type of location ownership |
asset_location_asset_place_id |
string |
Place IDs uniquely identify a place in the Google Places database and on Google Maps |
asset_mobile_app_asset_app_id |
string |
Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS |
asset_mobile_app_asset_app_store |
string |
Required. The application store that distributes this specific app |
asset_mobile_app_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_mobile_app_asset_link_text |
string |
Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive |
asset_mobile_app_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_name |
string |
Optional name of the asset |
asset_page_feed_asset_labels |
string |
Labels used to group the page urls |
asset_page_feed_asset_page_url |
string |
Required. The webpage that advertisers want to target |
asset_policy_summary_approval_status |
string |
Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries |
asset_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this asset |
asset_policy_summary_review_status |
string |
Output only. Where in the review process this asset is |
asset_price_asset_language_code |
string |
Required. The language of the price asset. Represented as BCP 47 language tag |
asset_price_asset_price_offerings |
string |
The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive |
asset_price_asset_price_qualifier |
string |
The price qualifier of the price asset |
asset_price_asset_type |
string |
Required. The type of the price asset |
asset_promotion_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_promotion_asset_discount_modifier |
string |
A modifier for qualification of the discount |
asset_promotion_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_promotion_asset_language_code |
string |
The language of the promotion. Represented as BCP 47 language tag |
asset_promotion_asset_money_amount_off_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_money_amount_off_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_occasion |
string |
The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion |
asset_promotion_asset_orders_over_amount_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_orders_over_amount_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_percent_off |
long |
Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required |
asset_promotion_asset_promotion_code |
string |
A code the user should use in order to be eligible for the promotion |
asset_promotion_asset_promotion_target |
string |
Required. A freeform description of what the promotion is targeting |
asset_promotion_asset_redemption_end_date |
date |
Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_redemption_start_date |
date |
Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_resource_name |
string |
Immutable. The resource name of the asset. Asset resource names have the form: customers/customer_id/assets/asset_id} |
asset_sitelink_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_sitelink_asset_description1 |
string |
First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set |
asset_sitelink_asset_description2 |
string |
Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set |
asset_sitelink_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_sitelink_asset_link_text |
string |
Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive |
asset_sitelink_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_source_1 |
string |
Source of the asset |
asset_structured_snippet_asset_header |
string |
Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers |
asset_structured_snippet_asset_values |
string |
Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive |
asset_text_asset_text |
string |
Text content of the text asset |
asset_tracking_url_template |
string |
URL template for constructing a tracking URL |
asset_type |
string |
Output only. Type of the asset |
asset_url_custom_parameters |
string |
A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls |
asset_youtube_video_asset_youtube_video_id |
string |
YouTube video id. This is the 11 character string value used in the YouTube video URL |
asset_youtube_video_asset_youtube_video_title |
string |
YouTube video title |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_system_status |
string |
The system status of bidding strategy |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_campaign_group |
string |
The campaign group this campaign belongs to |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_excluded_parent_asset_set_types |
string |
The asset set types that should be excluded from this campaign |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_fixed_cpm_goal |
string |
campaign_fixed_cpm_goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
campaign_fixed_cpm_target_frequency_info_target_count |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
campaign_fixed_cpm_target_frequency_info_time_unit |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_keyword_match_type |
string |
Keyword match type of Campaign |
campaign_labels |
string |
The resource names of labels attached to this campaign |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_local_campaign_setting_location_source_type |
string |
campaign_local_campaign_setting_location_source_type |
campaign_local_services_campaign_settings_category_bids |
string |
Categorical level bids associated with MANUAL_CPA bidding strategy |
campaign_manual_cpa |
string |
Standard Manual CPA bidding strategy |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on pa... |
CREATE VIEW google_ads_api_examples.example_Performance_CampaignAggregateAsset AS SELECT * FROM ( CALL google_ads_api.Performance_CampaignAggregateAsset ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x;;
Performance_CampaignAsset
Campaign asset
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
phone_calls |
long |
Number of offline phone calls |
phone_impressions |
long |
Number of offline phone impressions |
phone_through_rate |
double |
Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions) |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
asset |
string |
Immutable. The asset which is linked to the campaign |
asset_book_on_google_asset |
string |
A book on google asset |
asset_call_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_call_asset_call_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION |
asset_call_asset_call_conversion_reporting_state |
string |
Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion |
asset_call_asset_country_code |
string |
Required. Two-letter country code of the phone number. Examples: 'US', 'us' |
asset_call_asset_phone_number |
string |
Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890' |
asset_call_to_action_asset_call_to_action |
string |
Call to action |
asset_callout_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_callout_asset_callout_text |
string |
Required. The callout text. The length of this string should be between 1 and 25, inclusive |
asset_callout_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_callout_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_dynamic_education_asset_address |
string |
School address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403 |
asset_dynamic_education_asset_android_app_link |
string |
Android deep link, e.g. android-app://com.example.android/http/example.com/gizmos?1234 |
asset_dynamic_education_asset_contextual_keywords |
string |
Contextual keywords, e.g. Nursing certification, Health, Mountain View |
asset_dynamic_education_asset_image_url |
string |
Image url, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset |
asset_dynamic_education_asset_ios_app_link |
string |
iOS deep link, e.g. exampleApp://content/page |
asset_dynamic_education_asset_ios_app_store_id |
long |
iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present |
asset_dynamic_education_asset_location_id |
string |
Location ID which can be any sequence of letters and digits and must be unique |
asset_dynamic_education_asset_program_description |
string |
Program description, e.g. Nursing Certification |
asset_dynamic_education_asset_program_id |
string |
Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required |
asset_dynamic_education_asset_program_name |
string |
Required. Program name, e.g. Nursing. Required |
asset_dynamic_education_asset_school_name |
string |
School name, e.g. Mountain View School of Nursing |
asset_dynamic_education_asset_similar_program_ids |
string |
Similar program IDs |
asset_dynamic_education_asset_subject |
string |
Subject of study, e.g. Health |
asset_dynamic_education_asset_thumbnail_image_url |
string |
Thumbnail image url, e.g. http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset |
asset_final_mobile_urls |
string |
A list of possible final mobile URLs after all cross domain redirects |
asset_final_url_suffix |
string |
URL template for appending params to landing page URLs served with parallel tracking |
asset_final_urls |
string |
A list of possible final URLs after all cross domain redirects |
asset_hotel_callout_asset_language_code |
string |
Required. The language of the hotel callout. Represented as BCP 47 language tag |
asset_hotel_callout_asset_text |
string |
Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive |
asset_id |
long |
Output only. The ID of the asset |
asset_image_asset_file_size |
long |
File size of the image asset in bytes |
asset_image_asset_full_size_height_pixels |
long |
Height of the image |
asset_image_asset_full_size_url |
string |
A URL that returns the image with this height and width |
asset_image_asset_full_size_width_pixels |
long |
Width of the image |
asset_image_asset_mime_type |
string |
MIME type of the image asset |
asset_lead_form_asset_background_image_asset |
string |
Asset resource name of the background image. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%) |
asset_lead_form_asset_business_name |
string |
Required. The name of the business being advertised |
asset_lead_form_asset_call_to_action_description |
string |
Required. Text giving a clear value proposition of what users expect once they expand the form |
asset_lead_form_asset_call_to_action_type |
string |
Required. Pre-defined display text that encourages user to expand the form |
asset_lead_form_asset_custom_disclosure |
string |
Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only |
asset_lead_form_asset_delivery_methods |
string |
Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured |
asset_lead_form_asset_description |
string |
Required. Detailed description of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_desired_intent |
string |
Desired intent for the lead form, e.g. more volume or more qualified |
asset_lead_form_asset_fields |
string |
Ordered list of input fields |
asset_lead_form_asset_headline |
string |
Required. Headline of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_post_submit_call_to_action_type |
string |
Pre-defined display text that encourages user action after the form is submitted |
asset_lead_form_asset_post_submit_description |
string |
Detailed description shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_post_submit_headline |
string |
Headline of text shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_privacy_policy_url |
string |
Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business |
asset_mobile_app_asset_app_id |
string |
Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS |
asset_mobile_app_asset_app_store |
string |
Required. The application store that distributes this specific app |
asset_mobile_app_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_mobile_app_asset_link_text |
string |
Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive |
asset_mobile_app_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_name |
string |
Optional name of the asset |
asset_page_feed_asset_labels |
string |
Labels used to group the page urls |
asset_page_feed_asset_page_url |
string |
Required. The webpage that advertisers want to target |
asset_policy_summary_approval_status |
string |
Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries |
asset_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this asset |
asset_policy_summary_review_status |
string |
Output only. Where in the review process this asset is |
asset_price_asset_language_code |
string |
Required. The language of the price asset. Represented as BCP 47 language tag |
asset_price_asset_price_offerings |
string |
The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive |
asset_price_asset_price_qualifier |
string |
The price qualifier of the price asset |
asset_price_asset_type |
string |
Required. The type of the price asset |
asset_promotion_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_promotion_asset_discount_modifier |
string |
A modifier for qualification of the discount |
asset_promotion_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_promotion_asset_language_code |
string |
The language of the promotion. Represented as BCP 47 language tag |
asset_promotion_asset_money_amount_off_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_money_amount_off_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_occasion |
string |
The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion |
asset_promotion_asset_orders_over_amount_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_orders_over_amount_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_percent_off |
long |
Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required |
asset_promotion_asset_promotion_code |
string |
A code the user should use in order to be eligible for the promotion |
asset_promotion_asset_promotion_target |
string |
Required. A freeform description of what the promotion is targeting |
asset_promotion_asset_redemption_end_date |
date |
Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_redemption_start_date |
date |
Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_resource_name |
string |
Immutable. The resource name of the asset. Asset resource names have the form: customers/customer_id/assets/asset_id} |
asset_sitelink_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_sitelink_asset_description1 |
string |
First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set |
asset_sitelink_asset_description2 |
string |
Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set |
asset_sitelink_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_sitelink_asset_link_text |
string |
Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive |
asset_sitelink_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_structured_snippet_asset_header |
string |
Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers |
asset_structured_snippet_asset_values |
string |
Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive |
asset_text_asset_text |
string |
Text content of the text asset |
asset_tracking_url_template |
string |
URL template for constructing a tracking URL |
asset_type |
string |
Output only. Type of the asset |
asset_url_custom_parameters |
string |
A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls |
asset_youtube_video_asset_youtube_video_id |
string |
YouTube video id. This is the 11 character string value used in the YouTube video URL |
asset_youtube_video_asset_youtube_video_title |
string |
YouTube video title |
campaign |
string |
Immutable. The campaign to which the asset is linked |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
lo... |
CREATE VIEW google_ads_api_examples.example_Performance_CampaignAsset AS SELECT * FROM ( CALL google_ads_api.Performance_CampaignAsset ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_CampaignBudget
Campaign budget
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
budget_campaign_association_status_campaign |
string |
The campaign resource name |
budget_campaign_association_status_status |
string |
Budget campaign association status |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
amount_micros |
long |
The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
delivery_method |
string |
The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation |
explicitly_shared |
boolean |
Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared |
has_recommended_budget |
boolean |
Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only |
id |
long |
Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results |
name |
string |
The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed) |
period |
string |
Immutable. Period over which to spend the budget. Defaults to DAILY if not specified |
recommended_budget_amount_micros |
long |
Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only |
recommended_budget_estimated_change_weekly_clicks |
long |
Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only |
recommended_budget_estimated_change_weekly_cost_micros |
long |
Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only |
recommended_budget_estimated_change_weekly_interactions |
long |
Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only |
recommended_budget_estimated_change_weekly_views |
long |
Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only |
reference_count |
long |
Output only. The number of campaigns actively using the budget. This field is read-only |
resource_name |
string |
Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: customers/customer_id/campaignBudgets/campaign_budget_id} |
status |
string |
Output only. The status of this campaign budget. This field is read-only |
total_amount_micros |
long |
The lifetime amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit |
type |
string |
Immutable. The type of the campaign budget |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Customer customer agreement setting accepted lead form terms |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
|
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_CampaignBudget AS SELECT * FROM ( CALL google_ads_api.Performance_CampaignBudget ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Click
Click view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
click_type |
string |
Click type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
device |
string |
Device to which metrics apply |
slot |
string |
Position of the ad |
clicks |
long |
The number of clicks |
ad_group_ad |
string |
Output only. The associated ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
area_of_interest_city |
string |
The city location criterion associated with the impression |
area_of_interest_country |
string |
The country location criterion associated with the impression |
area_of_interest_metro |
string |
The metro location criterion associated with the impression |
area_of_interest_most_specific |
string |
The most specific location criterion associated with the impression |
area_of_interest_region |
string |
The region location criterion associated with the impression |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_location_target |
string |
Output only. The associated campaign location target, if one exists |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
gclid |
string |
Output only. The Google Click ID |
keyword |
string |
Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel |
keyword_info_match_type |
string |
The match type of the keyword |
keyword_info_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
location_of_presence_city |
string |
The city location criterion associated with the impression |
location_of_presence_country |
string |
The country location criterion associated with the impression |
location_of_presence_metro |
string |
The metro location criterion associated with the impression |
location_of_presence_most_specific |
string |
The most specific location criterion associated with the impression |
location_of_presence_region |
string |
The region location criterion associated with the impression |
page_number |
long |
Output only. Page number in search results where the ad was shown |
resource_name |
string |
Output only. The resource name of the click view. Click view resource names have the form: customers/customer_id/clickViews/date (yyyy-MM-dd)}~gclid} |
user_list |
string |
Output only. The associated user list, if one exists |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Customer customer agreement setting accepted lead form terms |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
|
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
Ad group ad fixed CPM bidding strategy |
ad_group_primary_status |
string |
Ad group primary status |
ad_group_primary_status_reasons |
string |
Ad group primary status reasons |
ad_group_target_cpv_micros |
long |
Ad group ad target CPM is an automated bidding strategy that sets bids to optimize performance given the target CPM you set |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
ad_group_exclude_demographic_expansion |
boolean |
When this value is true, demographics will be excluded from the types of targeting |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_Click AS SELECT * FROM ( CALL google_ads_api.Performance_Click ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Customer
Customer
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_by_conversion_date |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_by_conversion_date |
double |
The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
content_budget_lost_impression_share |
double |
The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
content_impression_share |
double |
The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
content_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_by_conversion_date |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_by_conversion_date |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
invalid_click_rate |
double |
The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period |
invalid_clicks |
long |
Number of clicks Google considers illegitimate and doesn't charge you for |
search_budget_lost_impression_share |
double |
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_exact_match_impression_share |
double |
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_all_conversions_by_conversion_date |
double |
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
value_per_conversions_by_conversion_date |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
final_url_suffix |
string |
The URL template for appending params to the final URL |
has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
id |
long |
Output only. The ID of the customer |
manager |
boolean |
Output only. Whether the customer is a manager |
optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/id |
status |
string |
Output only. The status of the customer |
test_account |
boolean |
Output only. Whether the customer is a test account |
time_zone |
string |
Immutable. The local timezone ID of the customer |
tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
all_new_customer_lifetime_value |
double |
All of new customers' lifetime conversion value |
customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
new_customer_lifetime_value |
double |
All of new customers' lifetime conversion value |
average_cart_size |
double |
The average number of products in each order attributed to your ads |
average_order_value_micros |
double |
The average revenue you made per order attributed to your ads |
cost_of_goods_sold_micros |
long |
The total cost of the products you sold in orders attributed to your ads |
cross_sell_cost_of_goods_sold_micros |
long |
The total cost of products sold as a result of advertising a different product |
cross_sell_gross_profit_micros |
double |
The profit you made from products sold as a result of advertising a different product, minus cost of goods sold |
cross_sell_revenue_micros |
double |
The total amount you made from products sold as a result of advertising a different product |
cross_sell_units_sold |
double |
The total number of products sold as a result of advertising a different product |
gross_profit_margin |
double |
The percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold |
gross_profit_micros |
double |
The profit you made from orders attributed to your ads minus the cost of goods sold |
lead_cost_of_goods_sold_micros |
long |
The total cost of products sold as a result of advertising the same product |
lead_gross_profit_micros |
long |
The profit you made from products sold as a result of advertising the same product, minus cost of goods sold |
lead_revenue_micros |
long |
The total amount you made from products sold as a result of advertising the same product |
lead_units_sold |
double |
The total number of products sold as a result of advertising the same product |
local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
orders |
double |
The total number of purchase conversions you received attributed to your ads |
revenue_micros |
long |
The total amount you made from orders attributed to your ads |
sk_ad_network_installs |
long |
The number of iOS Store Kit Ad Network conversions |
sk_ad_network_total_conversions |
long |
The total number of iOS Store Kit Ad Network conversions |
units_sold |
double |
Units sold is the total number of products sold from orders attributed to your ads |
general_invalid_click_rate |
double |
The percentage of clicks that have been filtered out of your total number of clicks due to being general invalid clicks |
general_invalid_clicks |
long |
Number of general invalid clicks |
CREATE VIEW google_ads_api_examples.example_Performance_Customer AS SELECT * FROM ( CALL google_ads_api.Performance_Customer ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_CustomerAsset
Customer asset
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
phone_calls |
long |
Number of offline phone calls |
phone_impressions |
long |
Number of offline phone impressions |
phone_through_rate |
double |
Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions) |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
asset |
string |
Required. Immutable. The asset which is linked to the customer |
asset_book_on_google_asset |
string |
A book on google asset |
asset_call_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_call_asset_call_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION |
asset_call_asset_call_conversion_reporting_state |
string |
Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion |
asset_call_asset_country_code |
string |
Required. Two-letter country code of the phone number. Examples: 'US', 'us' |
asset_call_asset_phone_number |
string |
Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890' |
asset_call_to_action_asset_call_to_action |
string |
Call to action |
asset_callout_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_callout_asset_callout_text |
string |
Required. The callout text. The length of this string should be between 1 and 25, inclusive |
asset_callout_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_callout_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_dynamic_education_asset_address |
string |
School address which can be specified in one of the following formats. (1) City, state, code, country, e.g. Mountain View, CA, USA. (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403 |
asset_dynamic_education_asset_android_app_link |
string |
Android deep link, e.g. android-app://com.example.android/http/example.com/gizmos?1234 |
asset_dynamic_education_asset_contextual_keywords |
string |
Contextual keywords, e.g. Nursing certification, Health, Mountain View |
asset_dynamic_education_asset_image_url |
string |
Image url, e.g. http://www.example.com/image.png. The image will not be uploaded as image asset |
asset_dynamic_education_asset_ios_app_link |
string |
iOS deep link, e.g. exampleApp://content/page |
asset_dynamic_education_asset_ios_app_store_id |
long |
iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present |
asset_dynamic_education_asset_location_id |
string |
Location ID which can be any sequence of letters and digits and must be unique |
asset_dynamic_education_asset_program_description |
string |
Program description, e.g. Nursing Certification |
asset_dynamic_education_asset_program_id |
string |
Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required |
asset_dynamic_education_asset_program_name |
string |
Required. Program name, e.g. Nursing. Required |
asset_dynamic_education_asset_school_name |
string |
School name, e.g. Mountain View School of Nursing |
asset_dynamic_education_asset_similar_program_ids |
string |
Similar program IDs |
asset_dynamic_education_asset_subject |
string |
Subject of study, e.g. Health |
asset_dynamic_education_asset_thumbnail_image_url |
string |
Thumbnail image url, e.g. http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset |
asset_final_mobile_urls |
string |
A list of possible final mobile URLs after all cross domain redirects |
asset_final_url_suffix |
string |
URL template for appending params to landing page URLs served with parallel tracking |
asset_final_urls |
string |
A list of possible final URLs after all cross domain redirects |
asset_hotel_callout_asset_language_code |
string |
Required. The language of the hotel callout. Represented as BCP 47 language tag |
asset_hotel_callout_asset_text |
string |
Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive |
asset_id |
long |
Output only. The ID of the asset |
asset_image_asset_file_size |
long |
File size of the image asset in bytes |
asset_image_asset_full_size_height_pixels |
long |
Height of the image |
asset_image_asset_full_size_url |
string |
A URL that returns the image with this height and width |
asset_image_asset_full_size_width_pixels |
long |
Width of the image |
asset_image_asset_mime_type |
string |
MIME type of the image asset |
asset_lead_form_asset_background_image_asset |
string |
Asset resource name of the background image. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%) |
asset_lead_form_asset_business_name |
string |
Required. The name of the business being advertised |
asset_lead_form_asset_call_to_action_description |
string |
Required. Text giving a clear value proposition of what users expect once they expand the form |
asset_lead_form_asset_call_to_action_type |
string |
Required. Pre-defined display text that encourages user to expand the form |
asset_lead_form_asset_custom_disclosure |
string |
Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only |
asset_lead_form_asset_delivery_methods |
string |
Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured |
asset_lead_form_asset_description |
string |
Required. Detailed description of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_desired_intent |
string |
Desired intent for the lead form, e.g. more volume or more qualified |
asset_lead_form_asset_fields |
string |
Ordered list of input fields |
asset_lead_form_asset_headline |
string |
Required. Headline of the expanded form to describe what the form is asking for or facilitating |
asset_lead_form_asset_post_submit_call_to_action_type |
string |
Pre-defined display text that encourages user action after the form is submitted |
asset_lead_form_asset_post_submit_description |
string |
Detailed description shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_post_submit_headline |
string |
Headline of text shown after form submission that describes how the advertiser will follow up with the user |
asset_lead_form_asset_privacy_policy_url |
string |
Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business |
asset_mobile_app_asset_app_id |
string |
Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS |
asset_mobile_app_asset_app_store |
string |
Required. The application store that distributes this specific app |
asset_mobile_app_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_mobile_app_asset_link_text |
string |
Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive |
asset_mobile_app_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_name |
string |
Optional name of the asset |
asset_page_feed_asset_labels |
string |
Labels used to group the page urls |
asset_page_feed_asset_page_url |
string |
Required. The webpage that advertisers want to target |
asset_policy_summary_approval_status |
string |
Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries |
asset_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this asset |
asset_policy_summary_review_status |
string |
Output only. Where in the review process this asset is |
asset_price_asset_language_code |
string |
Required. The language of the price asset. Represented as BCP 47 language tag |
asset_price_asset_price_offerings |
string |
The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive |
asset_price_asset_price_qualifier |
string |
The price qualifier of the price asset |
asset_price_asset_type |
string |
Required. The type of the price asset |
asset_promotion_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_promotion_asset_discount_modifier |
string |
A modifier for qualification of the discount |
asset_promotion_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_promotion_asset_language_code |
string |
The language of the promotion. Represented as BCP 47 language tag |
asset_promotion_asset_money_amount_off_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_money_amount_off_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_occasion |
string |
The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion |
asset_promotion_asset_orders_over_amount_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
asset_promotion_asset_orders_over_amount_currency_code |
string |
Three-character ISO 4217 currency code |
asset_promotion_asset_percent_off |
long |
Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required |
asset_promotion_asset_promotion_code |
string |
A code the user should use in order to be eligible for the promotion |
asset_promotion_asset_promotion_target |
string |
Required. A freeform description of what the promotion is targeting |
asset_promotion_asset_redemption_end_date |
date |
Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_redemption_start_date |
date |
Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format |
asset_promotion_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_resource_name |
string |
Immutable. The resource name of the asset. Asset resource names have the form: customers/customer_id/assets/asset_id} |
asset_sitelink_asset_ad_schedule_targets |
string |
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total |
asset_sitelink_asset_description1 |
string |
First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set |
asset_sitelink_asset_description2 |
string |
Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set |
asset_sitelink_asset_end_date |
date |
Last date of when this asset is effective and still serving, in yyyy-MM-dd format |
asset_sitelink_asset_link_text |
string |
Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive |
asset_sitelink_asset_start_date |
date |
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format |
asset_structured_snippet_asset_header |
string |
Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers |
asset_structured_snippet_asset_values |
string |
Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive |
asset_text_asset_text |
string |
Text content of the text asset |
asset_tracking_url_template |
string |
URL template for constructing a tracking URL |
asset_type |
string |
Output only. Type of the asset |
asset_url_custom_parameters |
string |
A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls |
asset_youtube_video_asset_youtube_video_id |
string |
YouTube video id. This is the 11 character string value used in the YouTube video URL |
asset_youtube_video_asset_youtube_video_title |
string |
YouTube video title |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be gre... |
CREATE VIEW google_ads_api_examples.example_Performance_CustomerAsset AS SELECT * FROM ( CALL google_ads_api.Performance_CustomerAsset ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_DetailPlacement
Detail placement view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
display_name |
string |
Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps |
group_placement_target_url |
string |
Output only. URL of the group placement, e.g. domain, link to the mobile application in app store, or a YouTube channel URL |
placement |
string |
Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID |
placement_type |
string |
Output only. Type of the placement, e.g. Website, YouTube Video, and Mobile Application |
resource_name |
string |
Output only. The resource name of the detail placement view. Detail placement view resource names have the form: customers/customer_id/detailPlacementViews/ad_group_id~base64_placement |
target_url |
string |
Output only. URL of the placement, e.g. website, link to the mobile application in app store, or a YouTube video URL |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
|
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
Ad group ad fixed CPM bidding strategy |
ad_group_primary_status |
string |
Ad group primary status |
ad_group_primary_status_reasons |
string |
Ad group primary status reasons |
ad_group_target_cpv_micros |
long |
Ad group ad target CPM is an automated bidding strategy that sets bids to optimize performance given the target CPM you set |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine i... |
CREATE VIEW google_ads_api_examples.example_Performance_DetailPlacement AS SELECT * FROM ( CALL google_ads_api.Performance_DetailPlacement ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_DisplayKeyword
Display keyword view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id~criterion_id |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that c... |
CREATE VIEW google_ads_api_examples.example_Performance_DisplayKeyword AS SELECT * FROM ( CALL google_ads_api.Performance_DisplayKeyword ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Distance
Distance view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id} |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
distance_bucket |
string |
Output only. Grouping of user distance from location extensions |
metric_system |
boolean |
Output only. True if the DistanceBucket is using the metric system, false otherwise |
resource_name |
string |
Output only. The resource name of the distance view. Distance view resource names have the form: customers/customer_id/distanceViews/1~distance_bucket |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_Distance AS SELECT * FROM ( CALL google_ads_api.Performance_Distance ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_DynamicSearchAdsSearchTerm
Dynamic search ads search term view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
webpage |
string |
Resource name of the ad group criterion that represents webpage criterion |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
has_matching_keyword |
boolean |
Output only. True if query is added to targeted keywords. This field is read-only |
has_negative_keyword |
boolean |
Output only. True if query matches a negative keyword. This field is read-only |
has_negative_url |
boolean |
Output only. True if query matches a negative url. This field is read-only |
headline |
string |
Output only. The dynamically generated headline of the Dynamic Search Ad. This field is read-only |
landing_page |
string |
Output only. The dynamically selected landing page URL of the impression. This field is read-only |
page_url |
string |
Output only. The URL of page feed item served for the impression. This field is read-only |
resource_name |
string |
Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: customers/customer_id/dynamicSearchAdsSearchTermViews/ad_group_id~search_term_fingerprint}~headline_fingerprint}~landing_page_fingerprint}~page_url_fingerprint |
search_term |
string |
Output only. Search term This field is read-only |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
Ad group ad fixed CPM bidding strategy |
ad_group_primary_status |
string |
Ad group primary status |
ad_group_primary_status_reasons |
string |
Ad group primary status reasons |
ad_group_target_cpv_micros |
long |
Ad group ad target CPM is an automated bidding strategy that sets bids to optimize performance given the target CPM you set |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
ad_group_exclude_demographic_expansion |
boolean |
When this value is true, demographics will be excluded from the types of targeting |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_DynamicSearchAdsSearchTerm AS SELECT * FROM ( CALL google_ads_api.Performance_DynamicSearchAdsSearchTerm ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_ExpandedLandingPage
Expanded landing page view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_value_per_interaction |
double |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
mobile_friendly_clicks_percentage |
double |
The percentage of mobile clicks that go to a mobile-friendly page |
speed_score |
long |
A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest |
valid_accelerated_mobile_pages_clicks_percentage |
double |
The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
expanded_final_url |
string |
Output only. The final URL that clicks are directed to |
landing_page_view_resource_name |
string |
Output only. The resource name of the landing page view. Landing page view resource names have the form: customers/customer_id/landingPageViews/unexpanded_final_url_fingerprint |
landing_page_view_unexpanded_final_url |
string |
Output only. The advertiser-specified final URL |
resource_name |
string |
Output only. The resource name of the expanded landing page view. Expanded landing page view resource names have the form: customers/customer_id/expandedLandingPageViews/expanded_final_url_fingerprint |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
Ad group ad fixed CPM bidding strategy |
ad_group_primary_status |
string |
Ad group primary status |
ad_group_primary_status_reasons |
string |
Ad group primary status reasons |
ad_group_target_cpv_micros |
long |
Ad group ad target CPM is an automated bidding strategy that sets bids to optimize performance given the target CPM you set |
cam... |
CREATE VIEW google_ads_api_examples.example_Performance_ExpandedLandingPage AS SELECT * FROM ( CALL google_ads_api.Performance_ExpandedLandingPage ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_ExtensionFeedItem
Extension feed item
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device_1 |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_schedules |
string |
List of non-overlapping schedules specifying all time intervals for which the feed item may serve. There can be a maximum of 6 schedules per day |
affiliate_location_feed_item_address_line_1 |
string |
Line 1 of the business address |
affiliate_location_feed_item_address_line_2 |
string |
Line 2 of the business address |
affiliate_location_feed_item_business_name |
string |
The name of the business |
affiliate_location_feed_item_chain_id |
long |
Id of the retail chain that is advertised as a seller of your product |
affiliate_location_feed_item_chain_name |
string |
Name of chain |
affiliate_location_feed_item_city |
string |
City of the business address |
affiliate_location_feed_item_country_code |
string |
Country code of the business address |
affiliate_location_feed_item_phone_number |
string |
Phone number of the business |
affiliate_location_feed_item_postal_code |
string |
Postal code of the business address |
affiliate_location_feed_item_province |
string |
Province of the business address |
app_feed_item_app_id |
string |
The store-specific ID for the target application. This string must not be empty |
app_feed_item_app_store |
string |
The application store that the target application belongs to. This field is required |
app_feed_item_final_mobile_urls |
string |
A list of possible final mobile URLs after all cross domain redirects |
app_feed_item_final_url_suffix |
string |
URL template for appending params to landing page URLs served with parallel tracking |
app_feed_item_final_urls |
string |
A list of possible final URLs after all cross domain redirects. This list must not be empty |
app_feed_item_link_text |
string |
The visible text displayed when the link is rendered in an ad. This string must not be empty, and the length of this string should be between 1 and 25, inclusive |
app_feed_item_tracking_url_template |
string |
URL template for constructing a tracking URL. Default value is "lpurl" |
call_feed_item_call_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracking_enabled is set to true. Otherwise this field is ignored |
call_feed_item_call_conversion_reporting_state |
string |
Enum value that indicates whether this call extension uses its own call conversion setting (or just have call conversion disabled), or following the account level setting |
call_feed_item_call_conversion_tracking_disabled |
boolean |
If true, disable call conversion tracking. call_conversion_action should not be set if this is true. Optional |
call_feed_item_call_tracking_enabled |
boolean |
Indicates whether call tracking is enabled. By default, call tracking is not enabled |
call_feed_item_country_code |
string |
Uppercase two-letter country code of the advertiser's phone number. This string must not be empty |
call_feed_item_phone_number |
string |
The advertiser's phone number to append to the ad. This string must not be empty |
callout_feed_item_callout_text |
string |
The callout text. The length of this string should be between 1 and 25, inclusive |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
extension_type |
string |
Output only. The extension type of the extension feed item. This field is read-only |
hotel_callout_feed_item_language_code |
string |
The language of the hotel callout text. IETF BCP 47 compliant language code |
hotel_callout_feed_item_text |
string |
The callout text. The length of this string should be between 1 and 25, inclusive |
id |
long |
Output only. The ID of this feed item. Read-only |
image_feed_item_image_asset |
string |
Required. Resource name of the image asset |
location_feed_item_address_line_1 |
string |
Line 1 of the business address |
location_feed_item_address_line_2 |
string |
Line 2 of the business address |
location_feed_item_business_name |
string |
The name of the business |
location_feed_item_city |
string |
City of the business address |
location_feed_item_country_code |
string |
Country code of the business address |
location_feed_item_phone_number |
string |
Phone number of the business |
location_feed_item_postal_code |
string |
Postal code of the business address |
location_feed_item_province |
string |
Province of the business address |
price_feed_item_final_url_suffix |
string |
Tracking URL template for all offers of this price extension |
price_feed_item_language_code |
string |
The code of the language used for this price extension |
price_feed_item_price_offerings |
string |
The price offerings in this price extension |
price_feed_item_price_qualifier |
string |
Price qualifier for all offers of this price extension |
price_feed_item_tracking_url_template |
string |
Tracking URL template for all offers of this price extension |
price_feed_item_type |
string |
Price extension type of this extension |
promotion_feed_item_discount_modifier |
string |
Enum that modifies the qualification of the discount |
promotion_feed_item_final_mobile_urls |
string |
A list of possible final mobile URLs after all cross domain redirects |
promotion_feed_item_final_url_suffix |
string |
URL template for appending params to landing page URLs served with parallel tracking |
promotion_feed_item_final_urls |
string |
A list of possible final URLs after all cross domain redirects. This field is required |
promotion_feed_item_language_code |
string |
The language of the promotion. Represented as BCP 47 language tag |
promotion_feed_item_money_amount_off_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
promotion_feed_item_money_amount_off_currency_code |
string |
Three-character ISO 4217 currency code |
promotion_feed_item_occasion |
string |
The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion |
promotion_feed_item_orders_over_amount_amount_micros |
long |
Amount in micros. One million is equivalent to one unit |
promotion_feed_item_orders_over_amount_currency_code |
string |
Three-character ISO 4217 currency code |
promotion_feed_item_percent_off |
long |
Percentage off discount in the promotion in micros. One million is equivalent to one percent. Either this or money_off_amount is required |
promotion_feed_item_promotion_code |
string |
A code the user should use in order to be el... |
CREATE VIEW google_ads_api_examples.example_Performance_ExtensionFeedItem AS SELECT * FROM ( CALL google_ads_api.Performance_ExtensionFeedItem ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_FeedItem
Feed item
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
ad_group_ad_action_items |
string |
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines." |
ad_group_ad_ad_added_by_google_ads |
boolean |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing |
ad_group_ad_ad_app_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_ad_html5_media_bundles |
string |
List of media bundle assets that may be used with the ad |
ad_group_ad_ad_app_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_ad_mandatory_ad_text |
string |
Mandatory ad text |
ad_group_ad_ad_app_ad_youtube_videos |
string |
List of YouTube video assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_engagement_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_engagement_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_videos |
string |
List of video assets that may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_images |
string |
List of image asset IDs whose images may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_youtube_videos |
string |
List of YouTube video asset IDs whose videos may be displayed with the ad |
ad_group_ad_ad_call_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_call_ad_call_tracked |
boolean |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions |
ad_group_ad_ad_call_ad_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored |
ad_group_ad_ad_call_ad_conversion_reporting_state |
string |
The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled |
ad_group_ad_ad_call_ad_country_code |
string |
The country code in the ad |
ad_group_ad_ad_call_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_call_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_call_ad_disable_call_conversion |
boolean |
Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored |
ad_group_ad_ad_call_ad_headline1 |
string |
First headline in the ad |
ad_group_ad_ad_call_ad_headline2 |
string |
Second headline in the ad |
ad_group_ad_ad_call_ad_path1 |
string |
First part of text that can be appended to the URL in the ad. Optional |
ad_group_ad_ad_call_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional |
ad_group_ad_ad_call_ad_phone_number |
string |
The phone number in the ad |
ad_group_ad_ad_call_ad_phone_number_verification_url |
string |
The URL to be used for phone number verification |
ad_group_ad_ad_device_preference |
string |
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types |
ad_group_ad_ad_display_upload_ad_display_upload_product_type |
string |
The product type of this ad. See comments on the enum for details |
ad_group_ad_ad_display_upload_ad_media_bundle |
string |
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898for more information |
ad_group_ad_ad_display_url |
string |
The URL that appears in the ad description for some ad formats |
ad_group_ad_ad_expanded_dynamic_search_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_dynamic_search_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_text_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_headline_part1 |
string |
The first part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part2 |
string |
The second part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part3 |
string |
The third part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_path1 |
string |
The text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_expanded_text_ad_path2 |
string |
Additional text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_final_app_urls |
string |
A list of final app URLs that will be used on mobile if the user has the specific app installed |
ad_group_ad_ad_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_final_url_suffix |
string |
The suffix to use when constructing a final URL |
ad_group_ad_ad_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_group |
string |
Immutable. The ad group to which the ad belongs |
ad_group_ad_ad_hotel_ad |
string |
Details pertaining to a hotel ad |
ad_group_ad_ad_id |
long |
Output only. The ID of the ad |
ad_group_ad_ad_image_ad_image_url |
string |
URL of the full size image |
ad_group_ad_ad_image_ad_mime_type |
string |
The mime type of the image |
ad_group_ad_ad_image_ad_name |
string |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty |
ad_group_ad_ad_image_ad_pixel_height |
long |
Height in pixels of the full size image |
ad_group_ad_ad_image_ad_pixel_width |
long |
Width in pixels of the full size image |
ad_group_ad_ad_image_ad_preview_image_url |
string |
URL of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_height |
long |
Height in pixels of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_width |
long |
Width in pixels of the preview size image |
ad_group_ad_ad_legacy_app_install_ad |
string |
Immutable. Details pertaining to a legacy app install ad |
ad_group_ad_ad_legacy_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_legacy_responsive_display_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad |
ad_group_ad_ad_legacy_responsive_display_ad_description |
string |
The description of the ad |
ad_group_ad_ad_legacy_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_legacy_responsive_display_ad_logo_image |
string |
The MediaFile resource name of the logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_long_headline |
string |
The long version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_marketing_image |
string |
The MediaFile resource name of the marketing image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_legacy_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_legacy_responsive_display_ad_short_headline |
string |
The short version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_square_logo_image |
string |
The MediaFile resource name of the square logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_square_marketing_image |
string |
The MediaFile resource name of the square marketing image used in the ad |
ad_group_ad_ad_local_ad_call_to_actions |
string |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified |
ad_group_ad_ad_local_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified |
ad_group_ad_ad_local_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified |
ad_group_ad_ad_local_ad_logo_images |
string |
List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified |
ad_group_ad_ad_local_ad_marketing_images |
string |
List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified |
ad_group_ad_ad_local_ad_path1 |
string |
First part of optional text that can be appended to the URL in the ad |
ad_group_ad_ad_local_ad_path2 |
string |
Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_local_ad_videos |
string |
List of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified |
ad_group_ad_ad_name |
string |
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd |
ad_group_ad_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad resource names have the form: customers/customer_id/ads/ad_id} |
ad_group_ad_ad_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_responsive_display_ad_business_name |
string |
The advertiser/brand name. Maximum display width is 25 |
ad_group_ad_ad_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad. Maximum display width is 30 |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_asset_enhancements |
boolean |
Whether the advertiser has opted into the asset enhancements feature |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_autogen_video |
boolean |
Whether the advertiser has opted into auto-gen video feature |
ad_group_ad_ad_responsive_display_ad_descriptions |
string |
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_responsive_display_ad_headlines |
string |
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_logo_images |
string |
Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_long_headline |
string |
A required long format headline. The maximum length is 90 characters |
ad_group_ad_ad_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_marketing_images |
string |
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_responsive_display_ad_square_logo_images |
string |
Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_square_marketing_images |
string |
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_youtube_videos |
string |
Optional YouTube videos for the ad. A maximum of 5 videos can be specified |
ad_group_ad_ad_responsive_search_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_responsive_search_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_responsive_search_ad_path1 |
string |
First part of text that can be appended to the URL in the ad |
ad_group_ad_ad_responsive_search_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_shopping_comparison_listing_ad_headline |
string |
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters |
ad_group_ad_ad_shopping_product_ad |
string |
Details pertaining to a Shopping product ad |
ad_group_ad_ad_shopping_smart_ad |
string |
Details pertaining to a Smart Shopping ad |
ad_group_ad_ad_smart_campaign_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified |
ad_group_ad_ad_smart_campaign_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified |
ad_group_ad_ad_strength |
string |
Output only. Overall ad strength for this ad group ad |
ad_group_ad_ad_system_managed_resource_source |
string |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only |
ad_group_ad_ad_text_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_text_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_text_ad_headline |
string |
The headline of the ad |
ad_group_ad_ad_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_ad_ad_type |
string |
Output only. The type of ad |
ad_group_ad_ad_url_collections |
string |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad |
ad_group_ad_ad_url_custom_parameters |
string |
The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations |
ad_group_ad_ad_video_ad_bumper_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_in_feed_description1 |
string |
First text line for the ad |
ad_group_ad_ad_video_ad_in_feed_description2 |
string |
Second text line for the ad |
ad_group_ad_ad_video_ad_in_feed_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_in_feed_thumbnail |
string |
Video thumbnail image to use |
ad_group_ad_ad_video_ad_in_stream_action_button_label |
string |
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise |
ad_group_ad_ad_video_ad_in_stream_action_headline |
string |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_in_stream_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_non_skippable_action_button_label |
string |
Label on the "Call To Action" button taking the user to the video ad's final URL |
ad_group_ad_ad_video_ad_non_skippable_action_headline |
string |
Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_non_skippable_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_out_stream_description |
string |
The description line |
ad_group_ad_ad_video_ad_out_stream_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_video_asset |
string |
The Asset resource name of this video |
ad_group_ad_ad_video_responsive_ad_call_to_actions |
string |
List of text assets used for the button, e.g. the "Call To Action" button. Currently, only a single value for the button is supported |
ad_group_ad_ad_video_responsive_ad_companion_banners |
string |
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported |
ad_group_ad_ad_video_responsive_ad_descriptions |
string |
List of text assets used for the description. Currently, only a single value for the description is supported |
ad_group_ad_ad_video_responsive_ad_headlines |
string |
List of text assets used for the short headline, e.g. the "Call To Action" banner. Currently, only a single value for the short headline is supported |
ad_group_ad_ad_video_responsive_ad_long_headlines |
string |
List of text assets used for the long headline. Currently, only a single value for the long headline is supported |
ad_group_ad_ad_video_responsive_ad_videos |
string |
List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported |
ad_group_ad_labels |
string |
Output only. The resource names of labels attached to this ad group ad |
ad_group_ad_policy_summary_approval_status |
string |
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries |
ad_group_ad_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this ad |
ad_group_ad_policy_summary_review_status |
string |
Output only. Where in the review process this ad is |
ad_group_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/customer_id/adGroupAds/ad_group_id}~ad_id} |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_ad_status |
string |
The status of the ad |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
attribute_values |
string |
The feed item's attribute values |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience tar... |
CREATE VIEW google_ads_api_examples.example_Performance_FeedItem AS SELECT * FROM ( CALL google_ads_api.Performance_FeedItem ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_FeedPlaceholder
Feed placeholder view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_action_items |
string |
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines." |
ad_group_ad_ad_added_by_google_ads |
boolean |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing |
ad_group_ad_ad_app_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_ad_html5_media_bundles |
string |
List of media bundle assets that may be used with the ad |
ad_group_ad_ad_app_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_ad_mandatory_ad_text |
string |
Mandatory ad text |
ad_group_ad_ad_app_ad_youtube_videos |
string |
List of YouTube video assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_engagement_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_engagement_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_videos |
string |
List of video assets that may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_images |
string |
List of image asset IDs whose images may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_youtube_videos |
string |
List of YouTube video asset IDs whose videos may be displayed with the ad |
ad_group_ad_ad_call_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_call_ad_call_tracked |
boolean |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions |
ad_group_ad_ad_call_ad_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored |
ad_group_ad_ad_call_ad_conversion_reporting_state |
string |
The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled |
ad_group_ad_ad_call_ad_country_code |
string |
The country code in the ad |
ad_group_ad_ad_call_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_call_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_call_ad_disable_call_conversion |
boolean |
Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored |
ad_group_ad_ad_call_ad_headline1 |
string |
First headline in the ad |
ad_group_ad_ad_call_ad_headline2 |
string |
Second headline in the ad |
ad_group_ad_ad_call_ad_path1 |
string |
First part of text that can be appended to the URL in the ad. Optional |
ad_group_ad_ad_call_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional |
ad_group_ad_ad_call_ad_phone_number |
string |
The phone number in the ad |
ad_group_ad_ad_call_ad_phone_number_verification_url |
string |
The URL to be used for phone number verification |
ad_group_ad_ad_device_preference |
string |
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types |
ad_group_ad_ad_display_upload_ad_display_upload_product_type |
string |
The product type of this ad. See comments on the enum for details |
ad_group_ad_ad_display_upload_ad_media_bundle |
string |
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898for more information |
ad_group_ad_ad_display_url |
string |
The URL that appears in the ad description for some ad formats |
ad_group_ad_ad_expanded_dynamic_search_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_dynamic_search_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_text_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_headline_part1 |
string |
The first part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part2 |
string |
The second part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part3 |
string |
The third part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_path1 |
string |
The text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_expanded_text_ad_path2 |
string |
Additional text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_final_app_urls |
string |
A list of final app URLs that will be used on mobile if the user has the specific app installed |
ad_group_ad_ad_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_final_url_suffix |
string |
The suffix to use when constructing a final URL |
ad_group_ad_ad_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_group |
string |
Immutable. The ad group to which the ad belongs |
ad_group_ad_ad_hotel_ad |
string |
Details pertaining to a hotel ad |
ad_group_ad_ad_id |
long |
Output only. The ID of the ad |
ad_group_ad_ad_image_ad_image_url |
string |
URL of the full size image |
ad_group_ad_ad_image_ad_mime_type |
string |
The mime type of the image |
ad_group_ad_ad_image_ad_name |
string |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty |
ad_group_ad_ad_image_ad_pixel_height |
long |
Height in pixels of the full size image |
ad_group_ad_ad_image_ad_pixel_width |
long |
Width in pixels of the full size image |
ad_group_ad_ad_image_ad_preview_image_url |
string |
URL of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_height |
long |
Height in pixels of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_width |
long |
Width in pixels of the preview size image |
ad_group_ad_ad_legacy_app_install_ad |
string |
Immutable. Details pertaining to a legacy app install ad |
ad_group_ad_ad_legacy_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_legacy_responsive_display_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad |
ad_group_ad_ad_legacy_responsive_display_ad_description |
string |
The description of the ad |
ad_group_ad_ad_legacy_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_legacy_responsive_display_ad_logo_image |
string |
The MediaFile resource name of the logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_long_headline |
string |
The long version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_marketing_image |
string |
The MediaFile resource name of the marketing image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_legacy_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_legacy_responsive_display_ad_short_headline |
string |
The short version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_square_logo_image |
string |
The MediaFile resource name of the square logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_square_marketing_image |
string |
The MediaFile resource name of the square marketing image used in the ad |
ad_group_ad_ad_local_ad_call_to_actions |
string |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified |
ad_group_ad_ad_local_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified |
ad_group_ad_ad_local_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified |
ad_group_ad_ad_local_ad_logo_images |
string |
List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified |
ad_group_ad_ad_local_ad_marketing_images |
string |
List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified |
ad_group_ad_ad_local_ad_path1 |
string |
First part of optional text that can be appended to the URL in the ad |
ad_group_ad_ad_local_ad_path2 |
string |
Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_local_ad_videos |
string |
List of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified |
ad_group_ad_ad_name |
string |
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd |
ad_group_ad_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad resource names have the form: customers/customer_id/ads/ad_id} |
ad_group_ad_ad_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_responsive_display_ad_business_name |
string |
The advertiser/brand name. Maximum display width is 25 |
ad_group_ad_ad_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad. Maximum display width is 30 |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_asset_enhancements |
boolean |
Whether the advertiser has opted into the asset enhancements feature |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_autogen_video |
boolean |
Whether the advertiser has opted into auto-gen video feature |
ad_group_ad_ad_responsive_display_ad_descriptions |
string |
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_responsive_display_ad_headlines |
string |
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_logo_images |
string |
Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_long_headline |
string |
A required long format headline. The maximum length is 90 characters |
ad_group_ad_ad_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_marketing_images |
string |
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_responsive_display_ad_square_logo_images |
string |
Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_square_marketing_images |
string |
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_youtube_videos |
string |
Optional YouTube videos for the ad. A maximum of 5 videos can be specified |
ad_group_ad_ad_responsive_search_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_responsive_search_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_responsive_search_ad_path1 |
string |
First part of text that can be appended to the URL in the ad |
ad_group_ad_ad_responsive_search_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_shopping_comparison_listing_ad_headline |
string |
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters |
ad_group_ad_ad_shopping_product_ad |
string |
Details pertaining to a Shopping product ad |
ad_group_ad_ad_shopping_smart_ad |
string |
Details pertaining to a Smart Shopping ad |
ad_group_ad_ad_smart_campaign_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified |
ad_group_ad_ad_smart_campaign_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified |
ad_group_ad_ad_strength |
string |
Output only. Overall ad strength for this ad group ad |
ad_group_ad_ad_system_managed_resource_source |
string |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only |
ad_group_ad_ad_text_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_text_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_text_ad_headline |
string |
The headline of the ad |
ad_group_ad_ad_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_ad_ad_type |
string |
Output only. The type of ad |
ad_group_ad_ad_url_collections |
string |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad |
ad_group_ad_ad_url_custom_parameters |
string |
The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations |
ad_group_ad_ad_video_ad_bumper_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_in_feed_description1 |
string |
First text line for the ad |
ad_group_ad_ad_video_ad_in_feed_description2 |
string |
Second text line for the ad |
ad_group_ad_ad_video_ad_in_feed_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_in_feed_thumbnail |
string |
Video thumbnail image to use |
ad_group_ad_ad_video_ad_in_stream_action_button_label |
string |
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise |
ad_group_ad_ad_video_ad_in_stream_action_headline |
string |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_in_stream_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_non_skippable_action_button_label |
string |
Label on the "Call To Action" button taking the user to the video ad's final URL |
ad_group_ad_ad_video_ad_non_skippable_action_headline |
string |
Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_non_skippable_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_out_stream_description |
string |
The description line |
ad_group_ad_ad_video_ad_out_stream_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_video_asset |
string |
The Asset resource name of this video |
ad_group_ad_ad_video_responsive_ad_call_to_actions |
string |
List of text assets used for the button, e.g. the "Call To Action" button. Currently, only a single value for the button is supported |
ad_group_ad_ad_video_responsive_ad_companion_banners |
string |
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported |
ad_group_ad_ad_video_responsive_ad_descriptions |
string |
List of text assets used for the description. Currently, only a single value for the description is supported |
ad_group_ad_ad_video_responsive_ad_headlines |
string |
List of text assets used for the short headline, e.g. the "Call To Action" banner. Currently, only a single value for the short headline is supported |
ad_group_ad_ad_video_responsive_ad_long_headlines |
string |
List of text assets used for the long headline. Currently, only a single value for the long headline is supported |
ad_group_ad_ad_video_responsive_ad_videos |
string |
List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported |
ad_group_ad_labels |
string |
Output only. The resource names of labels attached to this ad group ad |
ad_group_ad_policy_summary_approval_status |
string |
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries |
ad_group_ad_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this ad |
ad_group_ad_policy_summary_review_status |
string |
Output only. Where in the review process this ad is |
ad_group_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/customer_id/adGroupAds/ad_group_id}~ad_id} |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_ad_status |
string |
The status of the ad |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this... |
CREATE VIEW google_ads_api_examples.example_Performance_FeedPlaceholder AS SELECT * FROM ( CALL google_ads_api.Performance_FeedPlaceholder ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Gender
Gender view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
bidding_strategy_campaign_count |
long |
Output only. The number of campaigns attached to this bidding strategy. This field is read-only |
bidding_strategy_currency_code |
string |
Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy |
bidding_strategy_effective_currency_code |
string |
Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only |
bidding_strategy_enhanced_cpc |
string |
A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely |
bidding_strategy_id |
long |
Output only. The ID of the bidding strategy |
bidding_strategy_maximize_conversion_value_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversion_value_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
bidding_strategy_maximize_conversions_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversions_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
bidding_strategy_name |
string |
The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed) |
bidding_strategy_non_removed_campaign_count |
long |
Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only |
bidding_strategy_resource_name |
string |
Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: customers/customer_id/biddingStrategies/bidding_strategy_id |
bidding_strategy_status |
string |
Output only. The status of the bidding strategy. This field is read-only |
bidding_strategy_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
bidding_strategy_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
bidding_strategy_target_impression_share_location |
string |
The targeted location on the search results page |
bidding_strategy_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
bidding_strategy_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
bidding_strategy_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
bidding_strategy_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
bidding_strategy_type |
string |
Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bi... |
CREATE VIEW google_ads_api_examples.example_Performance_Gender AS SELECT * FROM ( CALL google_ads_api.Performance_Gender ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Geographic
Geographic view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
country_criterion_id |
long |
Output only. Criterion Id for the country |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
location_type |
string |
Output only. Type of the geo targeting of the campaign |
resource_name |
string |
Output only. The resource name of the geographic view. Geographic view resource names have the form: customers/customer_id/geographicViews/country_criterion_id~location_type |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad |
ad_group_primary_status |
string |
Provides aggregated view into why an ad group is not serving or not serving optimally |
ad_group_primary_status_reasons |
string |
Provides reasons for why an ad group is not serving or not serving optimally |
ad_group_target_cpv_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
ad_group_exclude_demographic_expansion |
boolean |
When this value is true, demographics will be excluded from the types of targeting |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_Geographic AS SELECT * FROM ( CALL google_ads_api.Performance_Geographic ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_GroupPlacement
Group placement view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
display_name |
string |
Output only. Domain name for websites and YouTube channel name for YouTube channels |
placement |
string |
Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID |
placement_type |
string |
Output only. Type of the placement, e.g. Website, YouTube Channel, Mobile Application |
resource_name |
string |
Output only. The resource name of the group placement view. Group placement view resource names have the form: customers/customer_id/groupPlacementViews/ad_group_id}~base64_placement} |
target_url |
string |
Output only. URL of the group placement, e.g. domain, link to the mobile application in app store, or a YouTube channel URL |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad |
ad_group_primary_status |
string |
Provides aggregated view into why an ad group is not serving or not serving optimally |
ad_group_primary_status_reasons |
string |
Provides reasons for why an ad group is not serving or not serving optimally |
ad_group_target_cpv_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
... |
CREATE VIEW google_ads_api_examples.example_Performance_GroupPlacement AS SELECT * FROM ( CALL google_ads_api.Performance_GroupPlacement ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Hotel
Hotel performance view
Parameter
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
hotel_booking_window_days |
long |
Hotel booking window in days |
hotel_center_id |
long |
Hotel center ID |
hotel_check_in_date |
date |
Hotel check-in date. Formatted as yyyy-MM-dd |
hotel_check_in_day_of_week |
string |
Hotel check-in day of week |
hotel_city |
string |
Hotel city |
hotel_class |
integer |
Hotel class |
hotel_country |
string |
Hotel country |
hotel_date_selection_type |
string |
Hotel date selection type |
hotel_length_of_stay |
integer |
Hotel length of stay |
hotel_price_bucket |
string |
Hotel price bucket |
hotel_state |
string |
Hotel state |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
partner_hotel_id |
string |
Partner hotel ID |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_value_per_interaction |
double |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
hotel_average_lead_value_micros |
double |
Average lead value based on clicks |
hotel_eligible_impressions |
long |
The number of impressions that hotel partners could have had given their feed performance |
hotel_price_difference_percentage |
double |
The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826for details. Any value below 0.1 is reported as 0.0999 |
search_budget_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_budget_lost_impression_share |
double |
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_budget_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_click_share |
double |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_rank_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_top_impression_share |
double |
The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/<ad_group_id> |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/<campaign_id> |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
resource_name |
string |
Output only. The resource name of the hotel performance view. Hotel performance view resource names have the form: customers/customer_id/hotelPerformanceView |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_discovery_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
Campaign travel campaign settings travel account id |
campaign_asset_automation_settings |
string |
|
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
CREATE VIEW google_ads_api_examples.example_Performance_Hotel AS SELECT * FROM ( CALL google_ads_api.Performance_Hotel ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_HotelGroup
Hotel group view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
|
---|---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
|
day_of_week |
string |
Day of the week, e.g., MONDAY |
|
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
|
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
|
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
|
year |
integer |
Year, formatted as yyyy |
|
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
|
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
|
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
|
all_conversions_value |
double |
The value of all conversions |
|
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
|
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
|
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
|
clicks |
long |
The number of clicks |
|
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
|
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
|
conversions_from_interactions_value_per_interaction |
double |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
|
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
|
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
|
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
|
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
|
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
|
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
|
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
|
hotel_average_lead_value_micros |
double |
Average lead value based on clicks |
|
hotel_eligible_impressions |
long |
The number of impressions that hotel partners could have had given their feed performance |
|
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
|
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826for details. Any value below 0.1 is reported as 0.0999 |
|
search_budget_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
|
search_budget_lost_impression_share |
double |
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
|
search_budget_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
|
search_click_share |
double |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
|
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
|
search_rank_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
|
search_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
|
search_rank_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
|
search_top_impression_share |
double |
The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
|
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
|
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
|
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
|
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
|
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
|
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
|
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
|
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
|
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
|
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
|
ad_group_criterion_age_range_type |
string |
Type of the age range |
|
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
|
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
|
ad_group_criterion_audience_audience |
string |
The Audience resource name |
|
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
|
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
|
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
|
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
|
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
|
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
|
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
|
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
|
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
|
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
|
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
|
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
|
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
|
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
|
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
|
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
|
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
|
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
|
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
|
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
|
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
|
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
|
ad_group_criterion_gender_type |
string |
Type of the gender |
|
ad_group_criterion_income_range_type |
string |
Type of the income range |
|
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
|
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
|
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
|
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
|
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
|
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
|
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
|
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
|
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
|
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
|
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
|
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
|
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
|
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
|
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
|
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
|
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
|
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
|
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
|
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
|
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
|
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
|
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
|
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
|
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
|
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
|
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
|
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
|
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
|
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
|
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
|
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
|
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
|
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
|
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
|
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
|
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
|
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
|
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
|
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
|
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
|
ad_group_criterion_type |
string |
Output only. The type of the criterion |
|
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
|
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
|
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
|
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
|
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
|
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
|
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
|
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
|
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
|
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
|
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
|
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
|
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
|
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
|
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
|
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
|
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
|
ad_group_id |
long |
Output only. The ID of the ad group |
|
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
|
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
|
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
|
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
|
ad_group_status |
string |
The status of the ad group |
|
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
|
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
|
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
|
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
|
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
|
ad_group_type |
string |
Immutable. The type of the ad group |
|
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
|
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
|
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
|
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
|
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
|
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
|
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
|
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
|
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
|
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
|
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
|
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
|
campaign_campaign_budget |
string |
The budget of the campaign |
|
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
|
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
|
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
|
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
|
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
|
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
|
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
|
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
|
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
|
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
|
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
|
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
|
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
|
campaign_id |
long |
Output only. The ID of the campaign |
|
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
|
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
|
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
|
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
|
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
|
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
|
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
|
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
|
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
|
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
|
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
|
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
|
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
|
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
|
campaign_payment_mode |
string |
Payment mode for the campaign |
|
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
|
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
|
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
|
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id} |
|
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
|
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
|
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
|
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
|
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
... |
CREATE VIEW google_ads_api_examples.example_Performance_HotelGroup AS SELECT * FROM ( CALL google_ads_api.Performance_HotelGroup ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_HotelReconciliation
Hotel reconciliation
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
hotel_commission_rate_micros |
long |
Commission bid rate in micros. A 20% commission is represented as 200,000 |
hotel_expected_commission_cost |
double |
Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency |
value_per_conversions_by_conversion_date |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
billed |
boolean |
Output only. Whether a given booking has been billed. Once billed, a booking can't be modified |
campaign |
string |
Output only. The resource name for the Campaign associated with the conversion |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
check_in_date |
date |
Output only. Check-in date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD |
check_out_date |
date |
Output only. Check-out date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD |
commission_id |
string |
Required. Output only. The commission ID is Google's ID for this booking. Every booking event is assigned a Commission ID to help you match it to a guest stay |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
hotel_center_id |
long |
Output only. Identifier for the Hotel Center account which provides the rates for the Hotel campaign |
hotel_id |
string |
Output only. Unique identifier for the booked property, as provided in the Hotel Center feed. The hotel ID comes from the 'ID' parameter of the conversion tracking tag |
order_id |
string |
Output only. The order ID is the identifier for this booking as provided in the 'transaction_id' parameter of the conversion tracking tag |
reconciled_value_micros |
long |
Required. Output only. Reconciled value is the final value of a booking as paid by the guest. If original booking value changes for any reason, such as itinerary changes or room upsells, the reconciled value should be the full final amount collected. If a booking is canceled, the reconciled value should include the value of any cancellation fees or non-refundable nights charged. Value is in millionths of the base unit currency. For example, $12.35 would be represented as 12350000. Currency unit is in the default customer currency |
resource_name |
string |
Immutable. The resource name of the hotel reconciliation. Hotel reconciliation resource names have the form: customers/customer_id/hotelReconciliations/commission_id |
status |
string |
Required. Output only. Current status of a booking with regards to reconciliation and billing. Bookings should be reconciled within 45 days after the check-out date. Any booking not reconciled within 45 days will be billed at its original value |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Campaign listing type |
campaign_shopping_setting_advertising_partner_ids |
string |
Campaign shopping setting advertising partner ids |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Campaign target_cpm_target frequency goal target count |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Campaign target cpm target frequency goal time unit |
campaign_travel_campaign_settings_travel_account_id |
long |
Campaign travel campaign settings travel account id |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_HotelReconciliation AS SELECT * FROM ( CALL google_ads_api.Performance_HotelReconciliation ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_IncomeRange
Income range view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new ... |
CREATE VIEW google_ads_api_examples.example_Performance_IncomeRange AS SELECT * FROM ( CALL google_ads_api.Performance_IncomeRange ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Keyword
Keyword view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_by_conversion_date |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_by_conversion_date |
double |
The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
average_page_views |
double |
Average number of pages viewed per session |
average_time_on_site |
double |
Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics |
bounce_rate |
double |
Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_by_conversion_date |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_by_conversion_date |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_per_current_model_attributed_conversion |
double |
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
current_model_attributed_conversions |
double |
Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_value |
double |
The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
percent_new_visitors |
double |
Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics |
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826for details. Any value below 0.1 is reported as 0.0999 |
search_budget_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_budget_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_click_share |
double |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_exact_match_impression_share |
double |
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_rank_lost_absolute_top_impression_share |
double |
The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_impression_share |
double |
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_rank_lost_top_impression_share |
double |
The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001 |
search_top_impression_share |
double |
The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_all_conversions_by_conversion_date |
double |
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
value_per_conversions_by_conversion_date |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/google-ads/answer/9549009 |
value_per_current_model_attributed_conversion |
double |
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application st... |
CREATE VIEW google_ads_api_examples.example_Performance_Keyword AS SELECT * FROM ( CALL google_ads_api.Performance_Keyword ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_LandingPage
Landing page view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_value_per_interaction |
double |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
mobile_friendly_clicks_percentage |
double |
The percentage of mobile clicks that go to a mobile-friendly page |
speed_score |
long |
A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest |
valid_accelerated_mobile_pages_clicks_percentage |
double |
The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
expanded_landing_page_view_expanded_final_url |
string |
Output only. The final URL that clicks are directed to |
expanded_landing_page_view_resource_name |
string |
Output only. The resource name of the expanded landing page view. Expanded landing page view resource names have the form: customers/customer_id/expandedLandingPageViews/expanded_final_url_fingerprint |
resource_name |
string |
Output only. The resource name of the landing page view. Landing page view resource names have the form: customers/customer_id/landingPageViews/unexpanded_final_url_fingerprint |
unexpanded_final_url |
string |
Output only. The advertiser-specified final URL |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Campaign listing type |
campaign_shopping_setting_advertising_partner_ids |
string |
Campaign shopping setting advertising partner ids |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Campaign target_cpm_target frequency goal target count |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Campaign target cpm target frequency goal time unit |
campaign_travel_campaign_settings_travel_account_id |
long |
Campaign travel campaign settings travel account id |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad |
ad_group_primary_status |
string |
Provides aggregated view into why an ad group is not serving or not serving optimally |
ad_group_primary_status_reasons |
string |
Provides reasons for why an ad group is not serving or not serving optimally |
ad_group_target_cpv_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times ... |
CREATE VIEW google_ads_api_examples.example_Performance_LandingPage AS SELECT * FROM ( CALL google_ads_api.Performance_LandingPage ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_LocalServicesEmployee
Local_services_employee
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
category_ids |
string |
Category of the employee |
creation_date_time |
timestamp |
Timestamp of employee creation |
email_address |
string |
Email address of the employee |
fellowships |
string |
The institutions where the employee has completed their fellowship |
first_name |
string |
First name of the employee |
id |
long |
The ID of the employee |
job_title |
string |
Job title for this employee, such as "Senior partner" in legal verticals |
languages_spoken |
string |
Languages that the employee speaks |
last_name |
string |
Last name of the employee |
middle_name |
string |
Middle name of the employee |
national_provider_id_number |
string |
NPI id associated with the employee |
residencies |
string |
The institutions where the employee has completed their residency |
resource_name |
string |
The resource name of the Local Services Verification |
status |
string |
Employee status, such as DELETED or ENABLED |
type |
string |
Employee type |
university_degrees |
string |
A list of degrees this employee has obtained, and wants to feature |
year_started_practicing |
integer |
The year that this employee started practicing in this field |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_conversion_tracking_setting_google_ads_conversion_customer |
string |
The resource name of the customer where conversions are created and managed. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Customer customer agreement setting accepted lead form terms |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
CREATE VIEW google_ads_api_examples.example_Performance_LocalServicesEmployee AS SELECT * FROM ( CALL google_ads_api.Performance_LocalServicesEmployee ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x;;
Performance_Location
Location view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_criterion_ad_schedule_day_of_week |
string |
Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_end_hour |
integer |
Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_end_minute |
string |
Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_start_hour |
integer |
Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_ad_schedule_start_minute |
string |
Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_age_range_type |
string |
Type of the age range |
campaign_criterion_bid_modifier |
float |
The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type |
campaign_criterion_campaign |
string |
Immutable. The campaign to which the criterion belongs |
campaign_criterion_carrier_carrier_constant |
string |
The Carrier constant resource name |
campaign_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
campaign_criterion_content_label_type |
string |
Content label type, required for CREATE operations |
campaign_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored during mutate |
campaign_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
campaign_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
campaign_criterion_device_type |
string |
Type of the device |
campaign_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
campaign_criterion_gender_type |
string |
Type of the gender |
campaign_criterion_income_range_type |
string |
Type of the income range |
campaign_criterion_ip_block_ip_address |
string |
The IP address of this IP block |
campaign_criterion_keyword_match_type |
string |
The match type of the keyword |
campaign_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
campaign_criterion_keyword_theme_free_form_keyword_theme |
string |
Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis |
campaign_criterion_keyword_theme_keyword_theme_constant |
string |
The resource name of a Smart Campaign keyword theme constant. keywordThemeConstants/keyword_theme_id~sub_keyword_theme_id |
campaign_criterion_language_language_constant |
string |
The language constant resource name |
campaign_criterion_listing_scope_dimensions |
string |
Scope of the campaign criterion |
campaign_criterion_location_geo_target_constant |
string |
The geo target constant resource name |
campaign_criterion_location_group |
string |
Immutable. Location Group |
campaign_criterion_location_group_feed |
string |
Feed specifying locations for targeting. This is required and must be set in CREATE operations |
campaign_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
campaign_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
campaign_criterion_mobile_application_name |
string |
Name of this mobile application |
campaign_criterion_mobile_device_mobile_device_constant |
string |
The mobile device constant resource name |
campaign_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion |
campaign_criterion_operating_system_version_operating_system_version_constant |
string |
The operating system version constant resource name |
campaign_criterion_parental_status_type |
string |
Type of the parental status |
campaign_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
campaign_criterion_proximity_address_city_name |
string |
Name of the city |
campaign_criterion_proximity_address_country_code |
string |
Country code |
campaign_criterion_proximity_address_postal_code |
string |
Postal code |
campaign_criterion_proximity_address_province_code |
string |
Province or state code |
campaign_criterion_proximity_address_province_name |
string |
Province or state name |
campaign_criterion_proximity_address_street_address |
string |
Street address line 1 |
campaign_criterion_proximity_geo_point_latitude_in_micro_degrees |
integer |
Micro degrees for the latitude |
campaign_criterion_proximity_geo_point_longitude_in_micro_degrees |
integer |
Micro degrees for the longitude |
campaign_criterion_proximity_radius |
double |
The radius of the proximity |
campaign_criterion_proximity_radius_units |
string |
The unit of measurement of the radius. Default is KILOMETERS |
campaign_criterion_resource_name |
string |
Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: customers/customer_id/campaignCriteria/campaign_id~criterion_id |
campaign_criterion_status |
string |
The status of the criterion |
campaign_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
campaign_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
campaign_criterion_type |
string |
Output only. The type of the criterion |
campaign_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
campaign_criterion_user_list_user_list |
string |
The User List resource name |
campaign_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
campaign_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
campaign_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
campaign_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
campaign_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
resource_name |
string |
Output only. The resource name of the location view. Location view resource names have the form: customers/customer_id/locationViews/campaign_id~criterion_id |
campaign_criterion_local_service_id_service_id |
string |
The criterion resource name |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Campaign listing type |
campaign_shopping_setting_advertising_partner_ids |
string |
Campaign shopping setting advertising partner ids |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Campaign target_cpm_target frequency goal target count |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Campaign target cpm target frequency goal time unit |
campaign_travel_campaign_settings_travel_account_id |
long |
Campaign travel campaign settings travel account id |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_t... |
CREATE VIEW google_ads_api_examples.example_Performance_Location AS SELECT * FROM ( CALL google_ads_api.Performance_Location ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_ManagedPlacement
Managed placement view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit th... |
CREATE VIEW google_ads_api_examples.example_Performance_ManagedPlacement AS SELECT * FROM ( CALL google_ads_api.Performance_ManagedPlacement ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_PaidOrganicSearchTerm
Paid organic search term view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
keyword_ad_group_criterion |
string |
The AdGroupCriterion resource name |
keyword_info_match_type |
string |
The match type of the keyword |
keyword_info_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
search_engine_results_page_type |
string |
Type of the search engine results page |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
clicks |
long |
The number of clicks |
combined_clicks |
long |
The number of times your ad or your site's listing in the unpaid results was clicked. See the help page at https://support.google.com/google-ads/answer/3097241for details |
combined_clicks_per_query |
double |
The number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries. See the help page at https://support.google.com/google-ads/answer/3097241for details |
combined_queries |
long |
The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See the help page at https://support.google.com/google-ads/answer/3097241for details |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
organic_clicks |
long |
The number of times someone clicked your site's listing in the unpaid results for a particular query. See the help page at https://support.google.com/google-ads/answer/3097241for details |
organic_clicks_per_query |
double |
The number of times someone clicked your site's listing in the unpaid results (organic_clicks) divided by the total number of searches that returned pages from your site (organic_queries). See the help page at https://support.google.com/google-ads/answer/3097241for details |
organic_impressions |
long |
The number of listings for your site in the unpaid search results. See the help page at https://support.google.com/google-ads/answer/3097241for details |
organic_impressions_per_query |
double |
The number of times a page from your site was listed in the unpaid search results (organic_impressions) divided by the number of searches returning your site's listing in the unpaid results (organic_queries). See the help page at https://support.google.com/google-ads/answer/3097241for details |
organic_queries |
long |
The total number of searches that returned your site's listing in the unpaid results. See the help page at https://support.google.com/google-ads/answer/3097241for details |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
resource_name |
string |
Output only. The resource name of the search term view. Search term view resource names have the form: customers/customer_id/paidOrganicSearchTermViews/campaign_id}~ ad_group_id}~URL-base64 search term |
search_term |
string |
Output only. The search term |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_fixed_cpm_micros |
long |
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad |
ad_group_primary_status |
string |
Provides aggregated view into why an ad group is not serving or not serving optimally |
ad_group_primary_status_reasons |
string |
Provides reasons for why an ad group is not serving or not serving optimally |
ad_group_target_cpv_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
ad_group_exclude_demographic_expansion |
boolean |
When this value is true, demographics will be excluded from the types of targeting |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_PaidOrganicSearchTerm AS SELECT * FROM ( CALL google_ads_api.Performance_PaidOrganicSearchTerm ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_ParentalStatus
Parental status view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
accessible_bidding_strategy_id |
long |
Output only. The ID of the bidding strategy |
accessible_bidding_strategy_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
accessible_bidding_strategy_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
accessible_bidding_strategy_name |
string |
Output only. The name of the bidding strategy |
accessible_bidding_strategy_owner_customer_id |
long |
Output only. The ID of the Customer which owns the bidding strategy |
accessible_bidding_strategy_owner_descriptive_name |
string |
Output only. descriptive_name of the Customer which owns the bidding strategy |
accessible_bidding_strategy_resource_name |
string |
Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: customers/customer_id/accessibleBiddingStrategies/bidding_strategy_id |
accessible_bidding_strategy_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
accessible_bidding_strategy_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
accessible_bidding_strategy_target_impression_share_location |
string |
The targeted location on the search results page |
accessible_bidding_strategy_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
accessible_bidding_strategy_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
accessible_bidding_strategy_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
accessible_bidding_strategy_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
accessible_bidding_strategy_type |
string |
Output only. The type of the bidding strategy |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
bidding_strategy_campaign_count |
long |
Output only. The number of campaigns attached to this bidding strategy. This field is read-only |
bidding_strategy_currency_code |
string |
Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy |
bidding_strategy_effective_currency_code |
string |
Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only |
bidding_strategy_enhanced_cpc |
string |
A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely |
bidding_strategy_id |
long |
Output only. The ID of the bidding strategy |
bidding_strategy_maximize_conversion_value_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversion_value_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
bidding_strategy_maximize_conversions_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversions_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only |
bidding_strategy_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
bidding_strategy_name |
string |
The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed) |
bidding_strategy_non_removed_campaign_count |
long |
Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only |
bidding_strategy_resource_name |
string |
Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: customers/customer_id/biddingStrategies/bidding_strategy_id |
bidding_strategy_status |
string |
Output only. The status of the bidding strategy. This field is read-only |
bidding_strategy_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
bidding_strategy_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
bidding_strategy_target_impression_share_location |
string |
The targeted location on the search results page |
bidding_strategy_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
bidding_strategy_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
bidding_strategy_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
bidding_strategy_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
bidding_strategy_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https:... |
CREATE VIEW google_ads_api_examples.example_Performance_ParentalStatus AS SELECT * FROM ( CALL google_ads_api.Performance_ParentalStatus ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_ProductGroup
Product group view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
benchmark_average_max_cpc |
double |
An indication of how other advertisers are bidding on similar products |
benchmark_ctr |
double |
An indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826for details. Any value below 0.1 is reported as 0.0999 |
search_click_share |
double |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-ta... |
CREATE VIEW google_ads_api_examples.example_Performance_ProductGroup AS SELECT * FROM ( CALL google_ads_api.Performance_ProductGroup ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_SearchTerm
Search term view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
keyword_ad_group_criterion |
string |
The AdGroupCriterion resource name |
keyword_info_match_type |
string |
The match type of the keyword |
keyword_info_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_value_per_interaction |
double |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group |
string |
Output only. The ad group the search term served in |
ad_group_ad_action_items |
string |
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines." |
ad_group_ad_ad_added_by_google_ads |
boolean |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing |
ad_group_ad_ad_app_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_ad_html5_media_bundles |
string |
List of media bundle assets that may be used with the ad |
ad_group_ad_ad_app_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_ad_mandatory_ad_text |
string |
Mandatory ad text |
ad_group_ad_ad_app_ad_youtube_videos |
string |
List of YouTube video assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_engagement_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_engagement_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_videos |
string |
List of video assets that may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_images |
string |
List of image asset IDs whose images may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_youtube_videos |
string |
List of YouTube video asset IDs whose videos may be displayed with the ad |
ad_group_ad_ad_call_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_call_ad_call_tracked |
boolean |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions |
ad_group_ad_ad_call_ad_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored |
ad_group_ad_ad_call_ad_conversion_reporting_state |
string |
The call conversion behavior of this call ad. It can use its own call conversion setting, inherit the account level setting, or be disabled |
ad_group_ad_ad_call_ad_country_code |
string |
The country code in the ad |
ad_group_ad_ad_call_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_call_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_call_ad_disable_call_conversion |
boolean |
Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored |
ad_group_ad_ad_call_ad_headline1 |
string |
First headline in the ad |
ad_group_ad_ad_call_ad_headline2 |
string |
Second headline in the ad |
ad_group_ad_ad_call_ad_path1 |
string |
First part of text that can be appended to the URL in the ad. Optional |
ad_group_ad_ad_call_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional |
ad_group_ad_ad_call_ad_phone_number |
string |
The phone number in the ad |
ad_group_ad_ad_call_ad_phone_number_verification_url |
string |
The URL to be used for phone number verification |
ad_group_ad_ad_device_preference |
string |
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types |
ad_group_ad_ad_display_upload_ad_display_upload_product_type |
string |
The product type of this ad. See comments on the enum for details |
ad_group_ad_ad_display_upload_ad_media_bundle |
string |
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898for more information |
ad_group_ad_ad_display_url |
string |
The URL that appears in the ad description for some ad formats |
ad_group_ad_ad_expanded_dynamic_search_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_dynamic_search_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_text_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_headline_part1 |
string |
The first part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part2 |
string |
The second part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part3 |
string |
The third part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_path1 |
string |
The text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_expanded_text_ad_path2 |
string |
Additional text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_final_app_urls |
string |
A list of final app URLs that will be used on mobile if the user has the specific app installed |
ad_group_ad_ad_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_final_url_suffix |
string |
The suffix to use when constructing a final URL |
ad_group_ad_ad_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_group |
string |
Immutable. The ad group to which the ad belongs |
ad_group_ad_ad_hotel_ad |
string |
Details pertaining to a hotel ad |
ad_group_ad_ad_id |
long |
Output only. The ID of the ad |
ad_group_ad_ad_image_ad_image_url |
string |
URL of the full size image |
ad_group_ad_ad_image_ad_mime_type |
string |
The mime type of the image |
ad_group_ad_ad_image_ad_name |
string |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty |
ad_group_ad_ad_image_ad_pixel_height |
long |
Height in pixels of the full size image |
ad_group_ad_ad_image_ad_pixel_width |
long |
Width in pixels of the full size image |
ad_group_ad_ad_image_ad_preview_image_url |
string |
URL of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_height |
long |
Height in pixels of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_width |
long |
Width in pixels of the preview size image |
ad_group_ad_ad_legacy_app_install_ad |
string |
Immutable. Details pertaining to a legacy app install ad |
ad_group_ad_ad_legacy_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_legacy_responsive_display_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad |
ad_group_ad_ad_legacy_responsive_display_ad_description |
string |
The description of the ad |
ad_group_ad_ad_legacy_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_legacy_responsive_display_ad_logo_image |
string |
The MediaFile resource name of the logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_long_headline |
string |
The long version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_marketing_image |
string |
The MediaFile resource name of the marketing image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_legacy_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_legacy_responsive_display_ad_short_headline |
string |
The short version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_square_logo_image |
string |
The MediaFile resource name of the square logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_square_marketing_image |
string |
The MediaFile resource name of the square marketing image used in the ad |
ad_group_ad_ad_local_ad_call_to_actions |
string |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified |
ad_group_ad_ad_local_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified |
ad_group_ad_ad_local_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified |
ad_group_ad_ad_local_ad_logo_images |
string |
List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified |
ad_group_ad_ad_local_ad_marketing_images |
string |
List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified |
ad_group_ad_ad_local_ad_path1 |
string |
First part of optional text that can be appended to the URL in the ad |
ad_group_ad_ad_local_ad_path2 |
string |
Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_local_ad_videos |
string |
List of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified |
ad_group_ad_ad_name |
string |
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd |
ad_group_ad_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad resource names have the form: customers/customer_id/ads/ad_id} |
ad_group_ad_ad_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_responsive_display_ad_business_name |
string |
The advertiser/brand name. Maximum display width is 25 |
ad_group_ad_ad_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad. Maximum display width is 30 |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_asset_enhancements |
boolean |
Whether the advertiser has opted into the asset enhancements feature |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_autogen_video |
boolean |
Whether the advertiser has opted into auto-gen video feature |
ad_group_ad_ad_responsive_display_ad_descriptions |
string |
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_responsive_display_ad_headlines |
string |
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_logo_images |
string |
Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_long_headline |
string |
A required long format headline. The maximum length is 90 characters |
ad_group_ad_ad_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_marketing_images |
string |
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_responsive_display_ad_square_logo_images |
string |
Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_square_marketing_images |
string |
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_youtube_videos |
string |
Optional YouTube videos for the ad. A maximum of 5 videos can be specified |
ad_group_ad_ad_responsive_search_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_responsive_search_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_responsive_search_ad_path1 |
string |
First part of text that can be appended to the URL in the ad |
ad_group_ad_ad_responsive_search_ad_path2 |
string |
Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set |
ad_group_ad_ad_shopping_comparison_listing_ad_headline |
string |
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters |
ad_group_ad_ad_shopping_product_ad |
string |
Details pertaining to a Shopping product ad |
ad_group_ad_ad_shopping_smart_ad |
string |
Details pertaining to a Smart Shopping ad |
ad_group_ad_ad_smart_campaign_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified |
ad_group_ad_ad_smart_campaign_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified |
ad_group_ad_ad_strength |
string |
Output only. Overall ad strength for this ad group ad |
ad_group_ad_ad_system_managed_resource_source |
string |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only |
ad_group_ad_ad_text_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_text_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_text_ad_headline |
string |
The headline of the ad |
ad_group_ad_ad_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_ad_ad_type |
string |
Output only. The type of ad |
ad_group_ad_ad_url_collections |
string |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad |
ad_group_ad_ad_url_custom_parameters |
string |
The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations |
ad_group_ad_ad_video_ad_bumper_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_in_feed_description1 |
string |
First text line for the ad |
ad_group_ad_ad_video_ad_in_feed_description2 |
string |
Second text line for the ad |
ad_group_ad_ad_video_ad_in_feed_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_in_feed_thumbnail |
string |
Video thumbnail image to use |
ad_group_ad_ad_video_ad_in_stream_action_button_label |
string |
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise |
ad_group_ad_ad_video_ad_in_stream_action_headline |
string |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_in_stream_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_non_skippable_action_button_label |
string |
Label on the "Call To Action" button taking the user to the video ad's final URL |
ad_group_ad_ad_video_ad_non_skippable_action_headline |
string |
Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_non_skippable_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_out_stream_description |
string |
The description line |
ad_group_ad_ad_video_ad_out_stream_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_video_asset |
string |
The Asset resource name of this video |
ad_group_ad_ad_video_responsive_ad_call_to_actions |
string |
List of text assets used for the button, e.g. the "Call To Action" button. Currently, only a single value for the button is supported |
ad_group_ad_ad_video_responsive_ad_companion_banners |
string |
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported |
ad_group_ad_ad_video_responsive_ad_descriptions |
string |
List of text assets used for the description. Currently, only a single value for the description is supported |
ad_group_ad_ad_video_responsive_ad_headlines |
string |
List of text assets used for the short headline, e.g. the "Call To Action" banner. Currently, only a single value for the short headline is supported |
ad_group_ad_ad_video_responsive_ad_long_headlines |
string |
List of text assets used for the long headline. Currently, only a single value for the long headline is supported |
ad_group_ad_ad_video_responsive_ad_videos |
string |
List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported |
ad_group_ad_labels |
string |
Output only. The resource names of labels attached to this ad group ad |
ad_group_ad_policy_summary_approval_status |
string |
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries |
ad_group_ad_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this ad |
ad_group_ad_policy_summary_review_status |
string |
Output only. Where in the review process this ad is |
ad_group_ad_resource_name |
string |
Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/customer_id/adGroupAds/ad_group_id}~ad_id} |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_ad_status |
string |
The status of the ad |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a trac... |
CREATE VIEW google_ads_api_examples.example_Performance_SearchTerm AS SELECT * FROM ( CALL google_ads_api.Performance_SearchTerm ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Shopping
Shopping performance view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
product_aggregator_id |
long |
Aggregator ID of the product |
product_brand |
string |
Brand of the product |
product_channel |
string |
Channel of the product |
product_channel_exclusivity |
string |
Channel exclusivity of the product |
product_condition |
string |
Condition of the product |
product_country |
string |
Resource name of the geo target constant for the country of sale of the product |
product_custom_attribute0 |
string |
Custom attribute 0 of the product |
product_custom_attribute1 |
string |
Custom attribute 1 of the product |
product_custom_attribute2 |
string |
Custom attribute 2 of the product |
product_custom_attribute3 |
string |
Custom attribute 3 of the product |
product_custom_attribute4 |
string |
Custom attribute 4 of the product |
product_item_id |
string |
Item ID of the product |
product_language |
string |
Resource name of the language constant for the language of the product |
product_merchant_id |
long |
Merchant ID of the product |
product_type_l1 |
string |
Type (level 1) of the product |
product_type_l2 |
string |
Type (level 2) of the product |
product_type_l3 |
string |
Type (level 3) of the product |
product_type_l4 |
string |
Type (level 4) of the product |
product_type_l5 |
string |
Type (level 5) of the product |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/google-ads/answer/7501826for details. Any value below 0.1 is reported as 0.0999 |
search_click_share |
double |
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
search_impression_share |
double |
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999 |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
resource_name |
string |
Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: customers/customer_id/shoppingPerformanceView |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
average_cart_size |
double |
The average number of products in each order attributed to your ads |
average_order_value_micros |
double |
The average revenue you made per order attributed to your ads |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
cost_of_goods_sold_micros |
long |
The total cost of the products you sold in orders attributed to your ads |
cross_sell_cost_of_goods_sold_micros |
long |
The total cost of products sold as a result of advertising a different product |
cross_sell_gross_profit_micros |
double |
The profit you made from products sold as a result of advertising a different product, minus cost of goods sold |
cross_sell_revenue_micros |
double |
The total amount you made from products sold as a result of advertising a different product |
cross_sell_units_sold |
double |
The total number of products sold as a result of advertising a different product |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
gross_profit_margin |
double |
The percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold |
gross_profit_micros |
double |
The profit you made from orders attributed to your ads minus the cost of goods sold |
lead_cost_of_goods_sold_micros |
long |
The total cost of products sold as a result of advertising the same product |
lead_gross_profit_micros |
long |
The profit you made from products sold as a result of advertising the same product, minus cost of goods sold |
lead_revenue_micros |
long |
The total amount you made from products sold as a result of advertising the same product |
lead_units_sold |
double |
The total number of products sold as a result of advertising the same product |
orders |
double |
The total number of purchase conversions you received attributed to your ads |
product_category_level1 |
string |
Category (level 1) of the product |
product_category_level2 |
string |
Category (level 2) of the product |
product_category_level3 |
string |
Category (level 3) of the product |
product_category_level4 |
string |
Category (level 4) of the product |
product_category_level5 |
string |
Category (level 5) of the product |
revenue_micros |
long |
The total amount you made from orders attributed to your ads |
units_sold |
double |
Units sold is the total number of products sold from orders attributed to your ads |
ad_group_fixed_cpm_micros |
long |
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad |
ad_group_primary_status |
string |
Provides aggregated view into why an ad group is not serving or not serving optimally |
ad_group_primary_status_reasons |
string |
Provides reasons for why an ad group is not serving or not serving optimally |
ad_group_target_cpv_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
campaign_demand_ge... |
CREATE VIEW google_ads_api_examples.example_Performance_Shopping AS SELECT * FROM ( CALL google_ads_api.Performance_Shopping ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_ShoppingProduct
Shopping product
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
report_date |
date |
Report date |
customer_id |
long |
Customer id |
availability |
string |
The availability of the product as provided by the merchant |
brand |
string |
The brand of the product as provided by the merchant |
category_level1 |
string |
The category level 1 of the product |
category_level2 |
string |
The category level 2 of the product |
category_level3 |
string |
The category level 3 of the product |
category_level4 |
string |
The category level 4 of the product |
category_level5 |
string |
The category level 5 of the product |
channel |
string |
The product channel describing the locality of the product |
channel_exclusivity |
string |
The channel exclusivity of the product as provided by the merchant |
condition |
string |
The condition of the product as provided by the merchant |
currency_code |
string |
The currency code as provided by the merchant |
custom_attribute0 |
string |
The custom attribute 0 of the product as provided by the merchant |
custom_attribute1 |
string |
The custom attribute 1 of the product as provided by the merchant |
custom_attribute2 |
string |
The custom attribute 2 of the product as provided by the merchant |
custom_attribute3 |
string |
The custom attribute 3 of the product as provided by the merchant |
custom_attribute4 |
string |
The custom attribute 4 of the product as provided by the merchant |
effective_max_cpc_micros |
long |
The effective maximum cost-per-click (effective max. CPC) of the product |
feed_label |
string |
The product feed label as provided by the merchant |
issues |
string |
The list of issues affecting whether the product can show in ads |
item_id |
string |
The item id of the product as provided by the merchant |
language_code |
string |
The language code as provided by the merchant |
merchant_center_id |
long |
The id of the merchant that owns the product |
multi_client_account_id |
long |
The id of the Multi Client Account of the merchant |
price_micros |
long |
The price of the product in micros as provided by the merchant |
product_type_level1 |
string |
The product type level 1 as provided by the merchant |
product_type_level2 |
string |
The product type level 2 as provided by the merchant |
product_type_level3 |
string |
The product type level 3 as provided by the merchant |
product_type_level4 |
string |
The product type level 4 as provided by the merchant |
product_type_level5 |
string |
The product type level 5 as provided by the merchant |
resource_name |
string |
The resource name of the shopping product |
status |
string |
The status that indicates whether the product can show in ads |
target_countries |
string |
Upper-case two-letter ISO 3166-1 code of the regions where the product is intended to be shown in ads |
title |
string |
The title of the product as provided by the merchant |
all_conversions |
double |
The total number of conversions |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cart_size |
double |
Average cart size is the average number of products in each order attributed to your ads |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_order_value_micros |
long |
Average order value is the average revenue you made per order attributed to your ads |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions |
conversions_from_interactions_value_per_interaction |
double |
The value of conversions from interactions divided by the number of ad interactions |
conversions_value |
double |
The value of conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_of_goods_sold_micros |
long |
Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser |
cross_device_conversions_value_micros |
long |
The sum of the value of cross-device conversions, in micros |
cross_sell_cost_of_goods_sold_micros |
long |
Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product |
cross_sell_gross_profit_micros |
long |
Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS) |
cross_sell_revenue_micros |
long |
Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product |
cross_sell_units_sold |
double |
Cross-sell units sold is the total number of products sold as a result of advertising a different product |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
gross_profit_margin |
double |
Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS) |
gross_profit_micros |
long |
Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
lead_cost_of_goods_sold_micros |
long |
Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product |
lead_gross_profit_micros |
long |
Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS) |
lead_revenue_micros |
long |
Lead revenue is the total amount you made from products sold as a result of advertising the same product |
lead_units_sold |
double |
Lead units sold is the total number of products sold as a result of advertising the same product |
orders |
double |
Orders is the total number of purchase conversions you received attributed to your ads |
revenue_micros |
long |
Revenue is the total amount you made from orders attributed to your ads |
search_absolute_top_impression_share |
double |
The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position |
units_sold |
double |
Units sold is the total number of products sold from orders attributed to your ads. How it works |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions |
CREATE VIEW google_ads_api_examples.example_Performance_ShoppingProduct AS SELECT * FROM ( CALL google_ads_api.Performance_ShoppingProduct ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x;;
Performance_SmartCampaignSearchTerm
Smart campaign search term view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
clicks |
long |
The number of clicks |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
campaign |
string |
Output only. The Smart campaign the search term served in |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
resource_name |
string |
Output only. The resource name of the Smart campaign search term view. Smart campaign search term view resource names have the form: customers/customer_id/smartCampaignSearchTermViews/campaign_id~URL-base64_search_term |
search_term |
string |
Output only. The search term |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Listing type of ads served for this campaign |
campaign_shopping_setting_advertising_partner_ids |
string |
The ads account IDs of advertising partners cooperating within the campaign |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Target Frequency count representing how many times you want to reach a single user |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_travel_campaign_settings_travel_account_id |
long |
The Travel account ID associated with the Travel campaign |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
campaign_brand_guidelines_enabled |
boolean |
Whether Brand Guidelines are enabled for this Campaign |
CREATE VIEW google_ads_api_examples.example_Performance_SmartCampaignSearchTerm AS SELECT * FROM ( CALL google_ads_api.Performance_SmartCampaignSearchTerm ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Topic
Topic view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_from_interactions_value_per_interaction |
double |
The value of all conversions from interactions divided by the total number of interactions |
all_conversions_value |
double |
The value of all conversions |
all_conversions_value_per_cost |
double |
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads) |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
gmail_forwards |
long |
The number of times the ad was forwarded to someone else as a message |
gmail_saves |
long |
The number of times someone has saved your Gmail ad to their inbox as a message |
gmail_secondary_clicks |
long |
The number of clicks to the landing page on the expanded state of Gmail ads |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "<platform>-<platform_native_id>", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/<ad_group_id>~<criterion_id> |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/<ad_group_id> |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/<campaign_id> |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bi... |
CREATE VIEW google_ads_api_examples.example_Performance_Topic AS SELECT * FROM ( CALL google_ads_api.Performance_Topic ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_UserLocation
User location view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
campaign_shopping_setting_use_vehicle_inventory |
boolean |
Immutable. Whether to target Vehicle Listing inventory |
campaign_start_date |
date |
The date when campaign started in serving customer's timezone in YYYY-MM-DD format |
campaign_status |
string |
The status of the campaign. When a new campaign is added, the status defaults to ENABLED |
campaign_target_cpa_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_cpa_target_cpa_micros |
long |
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account |
campaign_target_impression_share_cpc_bid_ceiling_micros |
long |
The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros |
campaign_target_impression_share_location |
string |
The targeted location on the search results page |
campaign_target_impression_share_location_fraction_micros |
long |
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000 |
campaign_target_roas_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_cpc_bid_floor_micros |
long |
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies |
campaign_target_roas_target_roas |
double |
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive |
campaign_target_spend_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy |
campaign_target_spend_target_spend_micros |
long |
The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.htmlfor details |
campaign_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
campaign_tracking_setting_tracking_url |
string |
Output only. The url used for dynamic tracking |
campaign_tracking_url_template |
string |
The URL template for constructing a tracking URL |
campaign_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_url_expansion_opt_out |
boolean |
Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false |
campaign_vanity_pharma_vanity_pharma_display_url_mode |
string |
The display mode for vanity pharma URLs |
campaign_vanity_pharma_vanity_pharma_text |
string |
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs |
campaign_video_brand_safety_suitability |
string |
Output only. 3-Tier Brand Safety setting for the campaign |
country_criterion_id |
long |
Output only. Criterion Id for the country |
customer_auto_tagging_enabled |
boolean |
Whether auto-tagging is enabled for the customer |
customer_call_reporting_setting_call_conversion_action |
string |
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true |
customer_call_reporting_setting_call_conversion_reporting_enabled |
boolean |
Whether to enable call conversion reporting |
customer_call_reporting_setting_call_reporting_enabled |
boolean |
Enable reporting of phone call events by redirecting them via Google System |
customer_conversion_tracking_setting_accepted_customer_data_terms |
boolean |
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 |
customer_conversion_tracking_setting_conversion_tracking_id |
long |
Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only |
customer_conversion_tracking_setting_conversion_tracking_status |
string |
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request |
customer_conversion_tracking_setting_cross_account_conversion_tracking_id |
long |
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only |
customer_conversion_tracking_setting_enhanced_conversions_for_leads_enabled |
boolean |
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only |
customer_currency_code |
string |
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported |
customer_descriptive_name |
string |
Optional, non-unique descriptive name of the customer |
customer_final_url_suffix |
string |
The URL template for appending params to the final URL |
customer_has_partners_badge |
boolean |
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774 |
customer_id |
long |
Output only. The ID of the customer |
customer_manager |
boolean |
Output only. Whether the customer is a manager |
customer_optimization_score |
double |
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
customer_optimization_score_weight |
double |
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only |
customer_pay_per_conversion_eligibility_failure_reasons |
string |
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only |
customer_remarketing_setting_google_global_site_tag |
string |
Output only. The Google tag |
customer_resource_name |
string |
Immutable. The resource name of the customer. Customer resource names have the form: customers/customer_id |
customer_status |
string |
Output only. The status of the customer |
customer_test_account |
boolean |
Output only. Whether the customer is a test account |
customer_time_zone |
string |
Immutable. The local timezone ID of the customer |
customer_tracking_url_template |
string |
The URL template for constructing a tracking URL out of parameters |
resource_name |
string |
Output only. The resource name of the user location view. UserLocation view resource names have the form: customers/customer_id/userLocationViews/country_criterion_id~targeting_location |
targeting_location |
boolean |
Output only. Indicates whether location was targeted or not |
ad_group_optimized_targeting_enabled |
boolean |
True if optimized targeting is enabled |
campaign_hotel_property_asset_set |
string |
The set of hotel properties for Performance Max for travel goals campaigns |
campaign_listing_type |
string |
Campaign listing type |
campaign_shopping_setting_advertising_partner_ids |
string |
Campaign shopping setting advertising partner ids |
campaign_target_cpm_target_frequency_goal_target_count |
long |
Campaign target_cpm_target frequency goal target count |
campaign_target_cpm_target_frequency_goal_time_unit |
string |
Campaign target cpm target frequency goal time unit |
campaign_travel_campaign_settings_travel_account_id |
long |
Campaign travel campaign settings travel account id |
customer_customer_agreement_setting_accepted_lead_form_terms |
boolean |
Whether the customer has accepted lead form term of service |
customer_image_asset_auto_migration_done |
boolean |
True if feed based image has been migrated to asset based image |
customer_image_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based image to asset base image |
customer_location_asset_auto_migration_done |
boolean |
True if feed based location has been migrated to asset based location |
customer_location_asset_auto_migration_done_date_time |
timestamp |
Timestamp of migration from feed based location to asset base location |
campaign_asset_automation_settings |
string |
Contains the opt-in/out status of each AssetAutomationType |
campaign_network_settings_target_google_tv_network |
boolean |
Whether ads will be served on the Google TV network |
campaign_network_settings_target_youtube |
boolean |
Whether ads will be served on YouTube |
customer_local_services_settings_granular_insurance_statuses |
string |
A read-only list of geo vertical level insurance statuses |
customer_local_services_settings_granular_license_statuses |
string |
A read-only list of geo vertical level license statuses |
ad_group_excluded_parent_asset_set_types |
string |
The asset set types that should be excluded from this ad group |
ad_group_fixed_cpm_micros |
long |
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad |
ad_group_primary_status |
string |
Provides aggregated view into why an ad group is not serving or not serving optimally |
ad_group_primary_status_reasons |
string |
Provides reasons for why an ad group is not serving or not serving optimally |
ad_group_target_cpv_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
campaign_bidding_strategy_system_status |
string |
The system status of the campaign's bidding strategy |
campaign_campaign_group |
string |
The campaign group this campaign belongs to |
campaign_demand_gen_campaign_settings_upgraded_targeting |
boolean |
Specifies whether this campaign uses upgraded targeting options |
campaign_excluded_parent_asset_set_types |
string |
The asset set types that should be excluded from this campaign |
campaign_fixed_cpm_goal |
string |
Campaign fixed CPM bidding goal |
campaign_fixed_cpm_target_frequency_info_target_count |
long |
Target frequency count represents the number of times an advertiser wants to show the ad to target a single user |
campaign_fixed_cpm_target_frequency_info_time_unit |
string |
Time window expressing the period over which you want to reach the specified target_count |
campaign_keyword_match_type |
string |
The match type of the keyword |
campaign_local_services_campaign_settings_category_bids |
string |
Categorical level bids associated with MANUAL_CPA bidding strategy |
campaign_manual_cpa |
string |
Standard Manual CPA bidding strategy |
campaign_performance_max_upgrade_performance_max_campaign |
string |
Indicates which Performance Max campaign the campaign is upgraded to |
campaign_performance_max_upgrade_pre_upgrade_campaign |
string |
Indicates legacy campaign upgraded to Performance Max |
campaign_performance_max_upgrade_status |
string |
The upgrade status of a campaign requested to be upgraded to Performance Max |
campaign_primary_status |
string |
The primary status of the campaign |
campaign_primary_status_reasons |
string |
The primary status reasons of the campaign |
campaign_shopping_setting_disable_product_feed |
boolean |
Disable the optional product feed |
campaign_shopping_setting_feed_label |
string |
Feed label of products to include in the campaign |
campaign_target_cpv |
string |
Campaign target CPV (cost per view) bidding strategy |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_feed |
boolean |
Determine if VideoResponsiveAds can be used for in-feed video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_in_stream |
boolean |
Determine if VideoResponsiveAds can be used for in-stream video ads |
campaign_video_campaign_settings_video_ad_inventory_control_allow_shorts |
boolean |
Determine if VideoResponsiveAds can be used as shorts format |
customer_conversion_tracking_setting_google_ads_conversion_customer |
string |
The resource name of the customer where conversions are created and managed |
customer_video_brand_safety_suitability |
string |
Brand Safety setting at the individual campaign level |
geo_target_airport |
string |
Resource name of the geo target constant that represents an airport |
geo_target_canton |
string |
Resource name ... |
CREATE VIEW google_ads_api_examples.example_Performance_UserLocation AS SELECT * FROM ( CALL google_ads_api.Performance_UserLocation ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Video
Video
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
device |
string |
Device to which metrics apply |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your google_ads_api_ds. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_value_per_interaction |
double |
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value_per_cost |
double |
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox google_ads_api_ds. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
video_quartile_p100_rate |
double |
Percentage of impressions where the viewer watched all of your video |
video_quartile_p25_rate |
double |
Percentage of impressions where the viewer watched 25% of your video |
video_quartile_p50_rate |
double |
Percentage of impressions where the viewer watched 50% of your video |
video_quartile_p75_rate |
double |
Percentage of impressions where the viewer watched 75% of your video |
video_view_rate |
double |
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads |
video_views |
long |
The number of times your video ads were viewed |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_action_items |
string |
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines." |
ad_group_ad_ad_added_by_google_ads |
boolean |
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing |
ad_group_ad_ad_app_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_ad_html5_media_bundles |
string |
List of media bundle assets that may be used with the ad |
ad_group_ad_ad_app_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_ad_mandatory_ad_text |
string |
Mandatory ad text |
ad_group_ad_ad_app_ad_youtube_videos |
string |
List of YouTube video assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_engagement_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_engagement_ad_images |
string |
List of image assets that may be displayed with the ad |
ad_group_ad_ad_app_engagement_ad_videos |
string |
List of video assets that may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_app_pre_registration_ad_images |
string |
List of image asset IDs whose images may be displayed with the ad |
ad_group_ad_ad_app_pre_registration_ad_youtube_videos |
string |
List of YouTube video asset IDs whose videos may be displayed with the ad |
ad_group_ad_ad_call_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_call_ad_call_tracked |
boolean |
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions |
ad_group_ad_ad_call_ad_conversion_action |
string |
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored |
ad_group_ad_ad_call_ad_conversion_reporting_state |
string |
The call conversion behavior of this call google_ads_api_ds. It can use its own call conversion setting, inherit the account level setting, or be disabled |
ad_group_ad_ad_call_ad_country_code |
string |
The country code in the ad |
ad_group_ad_ad_call_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_call_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_call_ad_disable_call_conversion |
boolean |
Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored |
ad_group_ad_ad_call_ad_headline1 |
string |
First headline in the ad |
ad_group_ad_ad_call_ad_headline2 |
string |
Second headline in the ad |
ad_group_ad_ad_call_ad_path1 |
string |
First part of text that can be appended to the URL in the google_ads_api_ds. Optional |
ad_group_ad_ad_call_ad_path2 |
string |
Second part of text that can be appended to the URL in the google_ads_api_ds. This field can only be set when path1 is also set. Optional |
ad_group_ad_ad_call_ad_phone_number |
string |
The phone number in the ad |
ad_group_ad_ad_call_ad_phone_number_verification_url |
string |
The URL to be used for phone number verification |
ad_group_ad_ad_device_preference |
string |
The device preference for the google_ads_api_ds. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types |
ad_group_ad_ad_display_upload_ad_display_upload_product_type |
string |
The product type of this google_ads_api_ds. See comments on the enum for details |
ad_group_ad_ad_display_upload_ad_media_bundle |
string |
A media bundle asset to be used in the google_ads_api_ds. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898for more information |
ad_group_ad_ad_display_url |
string |
The URL that appears in the ad description for some ad formats |
ad_group_ad_ad_expanded_dynamic_search_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_dynamic_search_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_description |
string |
The description of the ad |
ad_group_ad_ad_expanded_text_ad_description2 |
string |
The second description of the ad |
ad_group_ad_ad_expanded_text_ad_headline_part1 |
string |
The first part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part2 |
string |
The second part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_headline_part3 |
string |
The third part of the ad's headline |
ad_group_ad_ad_expanded_text_ad_path1 |
string |
The text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_expanded_text_ad_path2 |
string |
Additional text that can appear alongside the ad's displayed URL |
ad_group_ad_ad_final_app_urls |
string |
A list of final app URLs that will be used on mobile if the user has the specific app installed |
ad_group_ad_ad_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_final_url_suffix |
string |
The suffix to use when constructing a final URL |
ad_group_ad_ad_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_ad_ad_group |
string |
Immutable. The ad group to which the ad belongs |
ad_group_ad_ad_hotel_ad |
string |
Details pertaining to a hotel ad |
ad_group_ad_ad_id |
long |
Output only. The ID of the ad |
ad_group_ad_ad_image_ad_image_url |
string |
URL of the full size image |
ad_group_ad_ad_image_ad_mime_type |
string |
The mime type of the image |
ad_group_ad_ad_image_ad_name |
string |
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty |
ad_group_ad_ad_image_ad_pixel_height |
long |
Height in pixels of the full size image |
ad_group_ad_ad_image_ad_pixel_width |
long |
Width in pixels of the full size image |
ad_group_ad_ad_image_ad_preview_image_url |
string |
URL of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_height |
long |
Height in pixels of the preview size image |
ad_group_ad_ad_image_ad_preview_pixel_width |
long |
Width in pixels of the preview size image |
ad_group_ad_ad_legacy_app_install_ad |
string |
Immutable. Details pertaining to a legacy app install ad |
ad_group_ad_ad_legacy_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_legacy_responsive_display_ad_business_name |
string |
The business name in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the ad |
ad_group_ad_ad_legacy_responsive_display_ad_description |
string |
The description of the ad |
ad_group_ad_ad_legacy_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_legacy_responsive_display_ad_logo_image |
string |
The MediaFile resource name of the logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_long_headline |
string |
The long version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_legacy_responsive_display_ad_marketing_image |
string |
The MediaFile resource name of the marketing image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_legacy_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_legacy_responsive_display_ad_short_headline |
string |
The short version of the ad's headline |
ad_group_ad_ad_legacy_responsive_display_ad_square_logo_image |
string |
The MediaFile resource name of the square logo image used in the ad |
ad_group_ad_ad_legacy_responsive_display_ad_square_marketing_image |
string |
The MediaFile resource name of the square marketing image used in the ad |
ad_group_ad_ad_local_ad_call_to_actions |
string |
List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified |
ad_group_ad_ad_local_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified |
ad_group_ad_ad_local_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified |
ad_group_ad_ad_local_ad_logo_images |
string |
List of logo image assets that may be displayed with the google_ads_api_ds. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified |
ad_group_ad_ad_local_ad_marketing_images |
string |
List of marketing image assets that may be displayed with the google_ads_api_ds. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified |
ad_group_ad_ad_local_ad_path1 |
string |
First part of optional text that can be appended to the URL in the ad |
ad_group_ad_ad_local_ad_path2 |
string |
Second part of optional text that can be appended to the URL in the google_ads_api_ds. This field can only be set when path1 is also set |
ad_group_ad_ad_local_ad_videos |
string |
List of YouTube video assets that may be displayed with the google_ads_api_ds. Videos are optional and at most 20 can be specified |
ad_group_ad_ad_name |
string |
Immutable. The name of the google_ads_api_ds. This is only used to be able to identify the google_ads_api_ds. It does not need to be unique and does not affect the served google_ads_api_ds. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd |
ad_group_ad_ad_resource_name |
string |
Immutable. The resource name of the google_ads_api_ds. Ad resource names have the form: customers/customer_id/ads/ad_id} |
ad_group_ad_ad_responsive_display_ad_accent_color |
string |
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_allow_flexible_color |
boolean |
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set |
ad_group_ad_ad_responsive_display_ad_business_name |
string |
The advertiser/brand name. Maximum display width is 25 |
ad_group_ad_ad_responsive_display_ad_call_to_action_text |
string |
The call-to-action text for the google_ads_api_ds. Maximum display width is 30 |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_asset_enhancements |
boolean |
Whether the advertiser has opted into the asset enhancements feature |
ad_group_ad_ad_responsive_display_ad_control_spec_enable_autogen_video |
boolean |
Whether the advertiser has opted into auto-gen video feature |
ad_group_ad_ad_responsive_display_ad_descriptions |
string |
Descriptive texts for the google_ads_api_ds. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_format_setting |
string |
Specifies which format the ad will be served in. Default is ALL_FORMATS |
ad_group_ad_ad_responsive_display_ad_headlines |
string |
Short format headlines for the google_ads_api_ds. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified |
ad_group_ad_ad_responsive_display_ad_logo_images |
string |
Logo images to be used in the google_ads_api_ds. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_long_headline |
string |
A required long format headline. The maximum length is 90 characters |
ad_group_ad_ad_responsive_display_ad_main_color |
string |
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well |
ad_group_ad_ad_responsive_display_ad_marketing_images |
string |
Marketing images to be used in the google_ads_api_ds. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_price_prefix |
string |
Prefix before price. E.g. 'as low as' |
ad_group_ad_ad_responsive_display_ad_promo_text |
string |
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping' |
ad_group_ad_ad_responsive_display_ad_square_logo_images |
string |
Square logo images to be used in the google_ads_api_ds. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5 |
ad_group_ad_ad_responsive_display_ad_square_marketing_images |
string |
Square marketing images to be used in the google_ads_api_ds. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15 |
ad_group_ad_ad_responsive_display_ad_youtube_videos |
string |
Optional YouTube videos for the google_ads_api_ds. A maximum of 5 videos can be specified |
ad_group_ad_ad_responsive_search_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list |
ad_group_ad_ad_responsive_search_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list |
ad_group_ad_ad_responsive_search_ad_path1 |
string |
First part of text that can be appended to the URL in the ad |
ad_group_ad_ad_responsive_search_ad_path2 |
string |
Second part of text that can be appended to the URL in the google_ads_api_ds. This field can only be set when path1 is also set |
ad_group_ad_ad_shopping_comparison_listing_ad_headline |
string |
Headline of the google_ads_api_ds. This field is required. Allowed length is between 25 and 45 characters |
ad_group_ad_ad_shopping_product_ad |
string |
Details pertaining to a Shopping product ad |
ad_group_ad_ad_shopping_smart_ad |
string |
Details pertaining to a Smart Shopping ad |
ad_group_ad_ad_smart_campaign_ad_descriptions |
string |
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified |
ad_group_ad_ad_smart_campaign_ad_headlines |
string |
List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified |
ad_group_ad_ad_strength |
string |
Output only. Overall ad strength for this ad group ad |
ad_group_ad_ad_system_managed_resource_source |
string |
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only |
ad_group_ad_ad_text_ad_description1 |
string |
The first line of the ad's description |
ad_group_ad_ad_text_ad_description2 |
string |
The second line of the ad's description |
ad_group_ad_ad_text_ad_headline |
string |
The headline of the ad |
ad_group_ad_ad_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_ad_ad_type |
string |
Output only. The type of ad |
ad_group_ad_ad_url_collections |
string |
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad |
ad_group_ad_ad_url_custom_parameters |
string |
The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations |
ad_group_ad_ad_video_ad_bumper_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_in_feed_description1 |
string |
First text line for the ad |
ad_group_ad_ad_video_ad_in_feed_description2 |
string |
Second text line for the ad |
ad_group_ad_ad_video_ad_in_feed_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_in_feed_thumbnail |
string |
Video thumbnail image to use |
ad_group_ad_ad_video_ad_in_stream_action_button_label |
string |
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise |
ad_group_ad_ad_video_ad_in_stream_action_headline |
string |
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_in_stream_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_non_skippable_action_button_label |
string |
Label on the "Call To Action" button taking the user to the video ad's final URL |
ad_group_ad_ad_video_ad_non_skippable_action_headline |
string |
Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button |
ad_group_ad_ad_video_ad_non_skippable_companion_banner_asset |
string |
The Asset resource name of this image |
ad_group_ad_ad_video_ad_out_stream_description |
string |
The description line |
ad_group_ad_ad_video_ad_out_stream_headline |
string |
The headline of the ad |
ad_group_ad_ad_video_ad_video_asset |
string |
The Asset resource name of this video |
ad_group_ad_ad_video_responsive_ad_call_to_actions |
string |
List of text assets used for the button, e.g. the "Call To Action" button. Currently, only a single value for the button is supported |
ad_group_ad_ad_video_responsive_ad_companion_banners |
string |
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported |
ad_group_ad_ad_video_responsive_ad_descriptions |
string |
List of text assets used for the description. Currently, only a single value for the description is supported |
ad_group_ad_ad_video_responsive_ad_headlines |
string |
List of text assets used for the short headline, e.g. the "Call To Action" banner. Currently, only a single value for the short headline is supported |
ad_group_ad_ad_video_responsive_ad_long_headlines |
string |
List of text assets used for the long headline. Currently, only a single value for the long headline is supported |
ad_group_ad_ad_video_responsive_ad_videos |
string |
List of YouTube video assets used for the google_ads_api_ds. Currently, only a single value for the YouTube video asset is supported |
ad_group_ad_labels |
string |
Output only. The resource names of labels attached to this ad group ad |
ad_group_ad_policy_summary_approval_status |
string |
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries |
ad_group_ad_policy_summary_policy_topic_entries |
string |
Output only. The list of policy findings for this ad |
ad_group_ad_policy_summary_review_status |
string |
Output only. Where in the review process this ad is |
ad_group_ad_resource_name |
string |
Immutable. The resource name of the google_ads_api_ds. Ad group ad resource names have the form: customers/customer_id/adGroupAds/ad_group_id}~ad_id} |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_ad_status |
string |
The status of the ad |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type... |
CREATE VIEW google_ads_api_examples.example_Performance_Video AS SELECT * FROM ( CALL google_ads_api.Performance_Video ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
Performance_Webpage
Webpage view
Parameter
<customerId> (optional): Customer ID or CSV list of Customer IDs
<startDate> (optional): Start Date
<endDate> (optional): End Date
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration of the step in days
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
Attribute |
Type |
Description |
---|---|---|
ad_network_type |
string |
Ad network type |
date |
date |
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17 |
day_of_week |
string |
Day of the week, e.g., MONDAY |
month |
date |
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd |
quarter |
date |
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd |
week |
date |
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd |
year |
integer |
Year, formatted as yyyy |
absolute_top_impression_percentage |
double |
The percent of your ad impressions that are shown as the very first ad above the organic search results |
active_view_cpm |
double |
Average cost of viewable impressions (active_view_impressions) |
active_view_ctr |
double |
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network |
active_view_impressions |
long |
A measurement of how often your ad has become viewable on a Display Network site |
active_view_measurability |
double |
The ratio of impressions that could be measured by Active View over the number of served impressions |
active_view_measurable_cost_micros |
long |
The cost of the impressions you received that were measurable by Active View |
active_view_measurable_impressions |
long |
The number of times your ads are appearing on placements in positions where they can be seen |
active_view_viewability |
double |
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions) |
all_conversions |
double |
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric |
all_conversions_from_interactions_rate |
double |
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions |
all_conversions_value |
double |
The value of all conversions |
average_cost |
double |
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions |
average_cpc |
double |
The total cost of all clicks divided by the total number of clicks received |
average_cpe |
double |
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements |
average_cpm |
double |
Average cost-per-thousand impressions (CPM) |
average_cpv |
double |
The average amount you pay each time someone views your google_ads_api_ds. The average CPV is defined by the total cost of all ad views divided by the number of views |
clicks |
long |
The number of clicks |
conversions |
double |
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_from_interactions_rate |
double |
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
conversions_value |
double |
The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_micros |
long |
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period |
cost_per_all_conversions |
double |
The cost of ad interactions divided by all conversions |
cost_per_conversion |
double |
The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cost_per_current_model_attributed_conversion |
double |
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
cross_device_conversions |
double |
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions |
ctr |
double |
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions) |
current_model_attributed_conversions |
double |
Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
current_model_attributed_conversions_value |
double |
The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
engagement_rate |
double |
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown |
engagements |
long |
The number of engagements. An engagement occurs when a viewer expands your Lightbox google_ads_api_ds. Also, in the future, other ad types may support engagement metrics |
impressions |
long |
Count of how often your ad has appeared on a search results page or website on the Google Network |
interaction_event_types |
string |
The types of payable and free interactions |
interaction_rate |
double |
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown |
interactions |
long |
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on |
top_impression_percentage |
double |
The percent of your ad impressions that are shown anywhere above the organic search results |
value_per_all_conversions |
double |
The value of all conversions divided by the number of all conversions |
value_per_conversion |
double |
The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
value_per_current_model_attributed_conversion |
double |
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions |
view_through_conversions |
long |
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad |
ad_group_ad_rotation_mode |
string |
The ad rotation mode of the ad group |
ad_group_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
ad_group_base_ad_group |
string |
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only |
ad_group_campaign |
string |
Immutable. The campaign to which the ad group belongs |
ad_group_cpc_bid_micros |
long |
The maximum CPC (cost-per-click) bid |
ad_group_cpm_bid_micros |
long |
The maximum CPM (cost-per-thousand viewable impressions) bid |
ad_group_cpv_bid_micros |
long |
Output only. The CPV (cost-per-view) bid |
ad_group_criterion_ad_group |
string |
Immutable. The ad group to which the criterion belongs |
ad_group_criterion_age_range_type |
string |
Type of the age range |
ad_group_criterion_app_payment_model_type |
string |
Type of the app payment model |
ad_group_criterion_approval_status |
string |
Output only. Approval status of the criterion |
ad_group_criterion_audience_audience |
string |
The Audience resource name |
ad_group_criterion_bid_modifier |
double |
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers |
ad_group_criterion_combined_audience_combined_audience |
string |
The CombinedAudience resource name |
ad_group_criterion_cpc_bid_micros |
long |
The CPC (cost-per-click) bid |
ad_group_criterion_cpm_bid_micros |
long |
The CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_cpv_bid_micros |
long |
The CPV (cost-per-view) bid |
ad_group_criterion_criterion_id |
long |
Output only. The ID of the criterion. This field is ignored for mutates |
ad_group_criterion_custom_affinity_custom_affinity |
string |
The CustomInterest resource name |
ad_group_criterion_custom_audience_custom_audience |
string |
The CustomAudience resource name |
ad_group_criterion_custom_intent_custom_intent |
string |
The CustomInterest resource name |
ad_group_criterion_disapproval_reasons |
string |
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942This field is read-only |
ad_group_criterion_display_name |
string |
Output only. The display name of the criterion. This field is ignored for mutates |
ad_group_criterion_effective_cpc_bid_micros |
long |
Output only. The effective CPC (cost-per-click) bid |
ad_group_criterion_effective_cpc_bid_source |
string |
Output only. Source of the effective CPC bid |
ad_group_criterion_effective_cpm_bid_micros |
long |
Output only. The effective CPM (cost-per-thousand viewable impressions) bid |
ad_group_criterion_effective_cpm_bid_source |
string |
Output only. Source of the effective CPM bid |
ad_group_criterion_effective_cpv_bid_micros |
long |
Output only. The effective CPV (cost-per-view) bid |
ad_group_criterion_effective_cpv_bid_source |
string |
Output only. Source of the effective CPV bid |
ad_group_criterion_effective_percent_cpc_bid_micros |
long |
Output only. The effective Percent CPC bid amount |
ad_group_criterion_effective_percent_cpc_bid_source |
string |
Output only. Source of the effective Percent CPC bid |
ad_group_criterion_final_mobile_urls |
string |
The list of possible final mobile URLs after all cross-domain redirects |
ad_group_criterion_final_url_suffix |
string |
URL template for appending params to final URL |
ad_group_criterion_final_urls |
string |
The list of possible final URLs after all cross-domain redirects for the ad |
ad_group_criterion_gender_type |
string |
Type of the gender |
ad_group_criterion_income_range_type |
string |
Type of the income range |
ad_group_criterion_keyword_match_type |
string |
The match type of the keyword |
ad_group_criterion_keyword_text |
string |
The text of the keyword (at most 80 characters and 10 words) |
ad_group_criterion_labels |
string |
Output only. The resource names of labels attached to this ad group criterion |
ad_group_criterion_listing_group_case_value_hotel_city_city_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_class_value |
long |
Long value of the hotel class |
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_hotel_id_value |
string |
String value of the hotel ID |
ad_group_criterion_listing_group_case_value_hotel_state_state_criterion |
string |
The Geo Target Constant resource name |
ad_group_criterion_listing_group_case_value_product_brand_value |
string |
String value of the product brand |
ad_group_criterion_listing_group_case_value_product_channel_channel |
string |
Value of the locality |
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivity |
string |
Value of the availability |
ad_group_criterion_listing_group_case_value_product_condition_condition |
string |
Value of the condition |
ad_group_criterion_listing_group_case_value_product_custom_attribute_index |
string |
Indicates the index of the custom attribute |
ad_group_criterion_listing_group_case_value_product_custom_attribute_value |
string |
String value of the product custom attribute |
ad_group_criterion_listing_group_case_value_product_item_id_value |
string |
Value of the id |
ad_group_criterion_listing_group_case_value_product_type_level |
string |
Level of the type |
ad_group_criterion_listing_group_case_value_product_type_value |
string |
Value of the type |
ad_group_criterion_listing_group_parent_ad_group_criterion |
string |
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group |
ad_group_criterion_listing_group_type |
string |
Type of the listing group |
ad_group_criterion_mobile_app_category_mobile_app_category_constant |
string |
The mobile app category constant resource name |
ad_group_criterion_mobile_application_app_id |
string |
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "platform-platform_native_id", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations |
ad_group_criterion_mobile_application_name |
string |
Name of this mobile application |
ad_group_criterion_negative |
boolean |
Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it |
ad_group_criterion_parental_status_type |
string |
Type of the parental status |
ad_group_criterion_percent_cpc_bid_micros |
long |
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_criterion_placement_url |
string |
URL of the placement. For example, "http://www.domain.com" |
ad_group_criterion_position_estimates_estimated_add_clicks_at_first_position_cpc |
long |
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_estimated_add_cost_at_first_position_cpc |
long |
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros |
ad_group_criterion_position_estimates_first_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results |
ad_group_criterion_position_estimates_first_position_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results |
ad_group_criterion_position_estimates_top_of_page_cpc_micros |
long |
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results |
ad_group_criterion_quality_info_creative_quality_score |
string |
Output only. The performance of the ad compared to other advertisers |
ad_group_criterion_quality_info_post_click_quality_score |
string |
Output only. The quality score of the landing page |
ad_group_criterion_quality_info_quality_score |
integer |
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value |
ad_group_criterion_quality_info_search_predicted_ctr |
string |
Output only. The click-through rate compared to that of other advertisers |
ad_group_criterion_resource_name |
string |
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: customers/customer_id/adGroupCriteria/ad_group_id}~criterion_id} |
ad_group_criterion_status |
string |
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added |
ad_group_criterion_system_serving_status |
string |
Output only. Serving status of the criterion |
ad_group_criterion_topic_path |
string |
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category |
ad_group_criterion_topic_topic_constant |
string |
The Topic Constant resource name |
ad_group_criterion_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_criterion_type |
string |
Output only. The type of the criterion |
ad_group_criterion_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
ad_group_criterion_user_interest_user_interest_category |
string |
The UserInterest resource name |
ad_group_criterion_user_list_user_list |
string |
The User List resource name |
ad_group_criterion_webpage_conditions |
string |
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_coverage_percentage |
double |
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only |
ad_group_criterion_webpage_criterion_name |
string |
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations |
ad_group_criterion_webpage_sample_sample_urls |
string |
Webpage sample urls |
ad_group_criterion_youtube_channel_channel_id |
string |
The YouTube uploader channel id or the channel code of a YouTube channel |
ad_group_criterion_youtube_video_video_id |
string |
YouTube video id as it appears on the YouTube watch page |
ad_group_display_custom_bid_dimension |
string |
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search |
ad_group_effective_cpc_bid_micros |
long |
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null |
ad_group_effective_target_cpa_micros |
long |
Output only. The effective target CPA (cost-per-acquisition). This field is read-only |
ad_group_effective_target_cpa_source |
string |
Output only. Source of the effective target CPA. This field is read-only |
ad_group_effective_target_roas |
double |
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only |
ad_group_effective_target_roas_source |
string |
Output only. Source of the effective target ROAS. This field is read-only |
ad_group_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels |
ad_group_final_url_suffix |
string |
URL template for appending params to Final URL |
ad_group_id |
long |
Output only. The ID of the ad group |
ad_group_labels |
string |
Output only. The resource names of labels attached to this ad group |
ad_group_name |
string |
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
ad_group_percent_cpc_bid_micros |
long |
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction |
ad_group_resource_name |
string |
Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id} |
ad_group_status |
string |
The status of the ad group |
ad_group_target_cpa_micros |
long |
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_target_cpm_micros |
long |
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown |
ad_group_target_roas |
double |
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored |
ad_group_targeting_setting_target_restrictions |
string |
The per-targeting-dimension setting to restrict the reach of your campaign or ad group |
ad_group_tracking_url_template |
string |
The URL template for constructing a tracking URL |
ad_group_type |
string |
Immutable. The type of the ad group |
ad_group_url_custom_parameters |
string |
The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls |
campaign_accessible_bidding_strategy |
string |
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource |
campaign_ad_serving_optimization_status |
string |
The ad serving optimization status of the campaign |
campaign_advertising_channel_sub_type |
string |
Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed |
campaign_advertising_channel_type |
string |
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed |
campaign_app_campaign_setting_app_id |
string |
Immutable. A string that uniquely identifies a mobile application |
campaign_app_campaign_setting_app_store |
string |
Immutable. The application store that distributes this specific app |
campaign_app_campaign_setting_bidding_strategy_goal_type |
string |
Represents the goal which the bidding strategy of this app campaign should optimize towards |
campaign_audience_setting_use_audience_grouped |
boolean |
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead |
campaign_base_campaign |
string |
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only |
campaign_bidding_strategy |
string |
Portfolio bidding strategy used by campaign |
campaign_bidding_strategy_type |
string |
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only |
campaign_campaign_budget |
string |
The budget of the campaign |
campaign_commission_commission_rate_micros |
long |
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%) |
campaign_dynamic_search_ads_setting_domain_name |
string |
Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com" |
campaign_dynamic_search_ads_setting_feeds |
string |
The list of page feeds associated with the campaign |
campaign_dynamic_search_ads_setting_language_code |
string |
Required. The language code specifying the language of the domain, e.g., "en" |
campaign_dynamic_search_ads_setting_use_supplied_urls_only |
boolean |
Whether the campaign uses advertiser supplied URLs exclusively |
campaign_end_date |
date |
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format |
campaign_excluded_parent_asset_field_types |
string |
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level |
campaign_experiment_type |
string |
Output only. The type of campaign: normal, draft, or experiment |
campaign_final_url_suffix |
string |
Suffix used to append query parameters to landing pages that are served with parallel tracking |
campaign_frequency_caps |
string |
A list that limits how often each user will see this campaign's ads |
campaign_geo_target_type_setting_negative_geo_target_type |
string |
The setting used for negative geotargeting in this particular campaign |
campaign_geo_target_type_setting_positive_geo_target_type |
string |
The setting used for positive geotargeting in this particular campaign |
campaign_hotel_setting_hotel_center_id |
long |
Immutable. The linked Hotel Center account |
campaign_id |
long |
Output only. The ID of the campaign |
campaign_labels |
string |
Output only. The resource names of labels attached to this campaign |
campaign_local_campaign_setting_location_source_type |
string |
The location source type for this local campaign |
campaign_manual_cpc_enhanced_cpc_enabled |
boolean |
Whether bids are to be enhanced based on conversion optimizer data |
campaign_manual_cpm |
string |
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions |
campaign_manual_cpv |
string |
Output only. A bidding strategy that pays a configurable amount per video view |
campaign_maximize_conversion_value_target_roas |
double |
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget |
campaign_maximize_conversions_target_cpa_micros |
long |
The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget |
campaign_name |
string |
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters |
campaign_network_settings_target_content_network |
boolean |
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion |
campaign_network_settings_target_google_search |
boolean |
Whether ads will be served with google.com search results |
campaign_network_settings_target_partner_search_network |
boolean |
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts |
campaign_network_settings_target_search_network |
boolean |
Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true) |
campaign_optimization_goal_setting_optimization_goal_types |
string |
The list of optimization goal types |
campaign_optimization_score |
double |
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only |
campaign_payment_mode |
string |
Payment mode for the campaign |
campaign_percent_cpc_cpc_bid_ceiling_micros |
long |
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined |
campaign_percent_cpc_enhanced_cpc_enabled |
boolean |
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not |
campaign_real_time_bidding_setting_opt_in |
boolean |
Whether the campaign is opted in to real-time bidding |
campaign_resource_name |
string |
Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id |
campaign_selective_optimization_conversion_actions |
string |
The selected set of conversion actions for optimizing this campaign |
campaign_serving_status |
string |
Output only. The ad serving status of the campaign |
campaign_shopping_setting_campaign_priority |
integer |
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set |
campaign_shopping_setting_enable_local |
boolean |
Whether to include local products |
campaign_shopping_setting_merchant_id |
long |
Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns |
...|
CREATE VIEW google_ads_api_examples.example_Performance_Webpage AS SELECT * FROM ( CALL google_ads_api.Performance_Webpage ( startDate => TIMESTAMPADD (SQL_TSI_DAY, -8, CURDATE ()), preview => true ) ) AS x
v3_Products_ThemeBasedBidRecommendation
Bid recommendation themes and associated bid recommendations
Parameter
<profileId> (optional): Return results for one or more profiles mentioned in CSV list of profile Ids
<accountId> (optional): Return results for one or more profiles for the mentioned in CSV list of account Ids
<targetingExpressions> (required): The list of targeting expressions in form of CSV formatted as type1,value1|type2,value2|type3,value3|...
<campaignId> (optional): CSV of the campaign identifiers
<adGroupId> (optional): CSV of the ad group identifiers
<includeAnalysis> (optional): Flag to include new bid analyzer data
<content_type_version> (optional): Version of the content type one of 3, 4, 5
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label
Attribute |
Type |
Description |
---|---|---|
profileId |
long |
ID of the profile |
campaignId |
long |
The identifier of the campaign to which the keyword is associated |
adGroupId |
long |
The identifier of the keyword |
theme |
string |
A list of bid recommendation themes and associated bid recommendations |
part |
string |
Name of the node representing part of the report |
impactMetrics_lower |
integer |
The impact metrics are given in the same order of suggested bids. Describes lower and upper bounds of the range |
impactMetrics_upper |
integer |
The impact metrics are given in the same order of suggested bids. Describes lower and upper bounds of the range |
bidRecom_suggestedBidImpactMetrics_estimatedImpressionUpper |
integer |
Bids recommendations: suggested bid impactMetrics estimated impression upper |
bidRecom_suggestedBidImpactMetrics_estimatedImpressionLower |
integer |
Bids recommendations: suggested bid impactMetrics estimated impression lower |
bidRecom_bidValues_suggestedBid |
bigdecimal |
Bids recommendations: suggested bid value |
bidAnalyses_name |
string |
Bids analyses: name of the node |
bidAnalyses_bid |
bigdecimal |
Bids analyses: bid |
bidAnalyses_type |
string |
Bids analyses: type |
bidAnalyses_impactMetrics_estimatedImpressionAvg |
integer |
Bids analyses: impact metrics, estimated impression average |
bidAnalyses_impactMetrics_estimatedImpressionUpper |
integer |
Bids analyses: impact metrics, estimated impression upper |
bidAnalyses_impactMetrics_estimatedImpressionLower |
integer |
Bids analyses: impact metrics, estimated impression lower |
targetingExpression_type |
string |
A list of bid recommendation themes and associated bid recommendations. The bid recommendations for targeting expressions listed in the request. The targeting expression. The 'type' property specifies the targeting option. Use 'CLOSE_MATCH' to match your auto targeting ads closely to the specified value. Use 'LOOSE_MATCH' to match your auto targeting ads broadly to the specified value. Use 'SUBSTITUTES' to display your auto targeting ads along with substitutable products. Use 'COMPLEMENTS' to display your auto targeting ads along with affiliated products. Use 'KEYWORD_BROAD_MATCH' to broadly match your keyword targeting ads with search queries. Use 'KEYWORD_EXACT_MATCH' to exactly match your keyword targeting ads with search queries. Use 'KEYWORD_PHRASE_MATCH' to match your keyword targeting ads with search phrases (CLOSE_MATCH, LOOSE_MATCH, SUBSTITUTES, COMPLEMENTS, KEYWORD_BROAD_MATCH, KEYWORD_EXACT_MATCH, KEYWORD_PHRASE_MATCH) |
errorMessage |
string |
Error message if any problem happened |
CREATE VIEW amazon_ads_examples.example_v3_Products_ThemeBasedBidRecommendation AS SELECT * FROM ( CALL amazon_ads.v3_Products_ThemeBasedBidRecommendation ( campaignId => '279475520664366', adGroupId => '108904307944971' ) ) AS x;;
v3_Products_ThemeBasedBidRecommendationByAsins
Bid recommendation themes and associated bid recommendations by list of ASINs
Parameter
<profileId> (optional): Return results for one or more profiles mentioned in CSV list of profile Ids
<accountId> (optional): Return results for one or more profiles for the mentioned in CSV list of account Ids
<asins> (required): CSV list of ad ASINs in the ad group
<table_asins> (optional): A table containing asins in the column "asin"
<targetingExpressions> (required): The list of targeting expressions in form of CSV formatted as type1,value1|type2,value2|type3,value3|...
<adjustments_placement_top_percentage> (optional): Placement adjustment configuration for the campaign. Specifies bid adjustments based on the placement location. Use 'PLACEMENT_TOP' for the top of the search page
<adjustments_placement_rest_of_search_percentage> (optional): Placement adjustment configuration for the campaign. Specifies bid adjustments based on the placement location. Use 'PLACEMENT_REST_OF_SEARCH' for the top of the search page
<adjustments_placement_product_page_percentage> (optional): Placement adjustment configuration for the campaign. Specifies bid adjustments based on the placement location. Use 'PLACEMENT_PRODUCT_PAGE' for a product page
<strategy> (optional): The bidding strategy selected for the campaign. Use 'LEGACY_FOR_SALES' to lower your bid in real time when your ad may be less likely to convert to a sale (LEGACY_FOR_SALES, AUTO_FOR_SALES, MANUAL, RULE_BASED)
<includeAnalysis> (optional): Flag to include new bid analyzer data
<content_type_version> (optional): Version of the content type one of 3, 4, 5
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute |
Type |
Description |
---|---|---|
profileId |
long |
ID of the profile |
asins |
string |
CSV list of ad ASINs in the ad group |
strategy |
string |
The bidding strategy selected for the campaign. Use 'LEGACY_FOR_SALES' to lower your bid in real time when your ad may be less likely to convert to a sale (LEGACY_FOR_SALES, AUTO_FOR_SALES, MANUAL, RULE_BASED) |
theme |
string |
A list of bid recommendation themes and associated bid recommendations |
part |
string |
Name of the node representing part of the report |
impactMetrics_lower |
integer |
The impact metrics are given in the same order of suggested bids. Describes lower and upper bounds of the range |
impactMetrics_upper |
integer |
The impact metrics are given in the same order of suggested bids. Describes lower and upper bounds of the range |
bidRecom_suggestedBidImpactMetrics_estimatedImpressionUpper |
integer |
Bids recommendations: suggested bid impactMetrics estimated impression upper |
bidRecom_suggestedBidImpactMetrics_estimatedImpressionLower |
integer |
Bids recommendations: suggested bid impactMetrics estimated impression lower |
bidRecom_bidValues_suggestedBid |
bigdecimal |
Bids recommendations: suggested bid value |
bidAnalyses_name |
string |
Bids analyses: name of the node |
bidAnalyses_bid |
bigdecimal |
Bids analyses: bid |
bidAnalyses_type |
string |
Bids analyses: type |
bidAnalyses_impactMetrics_estimatedImpressionAvg |
integer |
Bids analyses: impact metrics, estimated impression average |
bidAnalyses_impactMetrics_estimatedImpressionUpper |
integer |
Bids analyses: impact metrics, estimated impression upper |
bidAnalyses_impactMetrics_estimatedImpressionLower |
integer |
Bids analyses: impact metrics, estimated impression lower |
targetingExpression_type |
string |
A list of bid recommendation themes and associated bid recommendations. The bid recommendations for targeting expressions listed in the request. The targeting expression. The 'type' property specifies the targeting option. Use 'CLOSE_MATCH' to match your auto targeting ads closely to the specified value. Use 'LOOSE_MATCH' to match your auto targeting ads broadly to the specified value. Use 'SUBSTITUTES' to display your auto targeting ads along with substitutable products. Use 'COMPLEMENTS' to display your auto targeting ads along with affiliated products. Use 'KEYWORD_BROAD_MATCH' to broadly match your keyword targeting ads with search queries. Use 'KEYWORD_EXACT_MATCH' to exactly match your keyword targeting ads with search queries. Use 'KEYWORD_PHRASE_MATCH' to match your keyword targeting ads with search phrases (CLOSE_MATCH, LOOSE_MATCH, SUBSTITUTES, COMPLEMENTS, KEYWORD_BROAD_MATCH, KEYWORD_EXACT_MATCH, KEYWORD_PHRASE_MATCH) |
errorMessage |
string |
Error message if any problem happened |
CREATE VIEW amazon_ads_examples.example_v3_Products_ThemeBasedBidRecommendationByAsins AS SELECT * FROM ( CALL amazon_ads.v3_Products_ThemeBasedBidRecommendationByAsins ( strategy => 'AUTO_FOR_SALES', asins => 'B09ZH7R4CN', adjustments_placement_top_percentage => 100, adjustments_placement_product_page_percentage => 50 ) ) AS x;;