Google Ads

Sample

 

https://connectors.windsor.ai/google_ads?api_key=[your API key]&date_preset=last_7d&fields=source,campaign,spend,date&_renderer=csv

 

Google ads connector is unique in that keywords can be requested in stead of the fields to get search volume estimates.
 

“https://connectors.windsor.ai/google_ads?keywords=sample,words&api_key=[your API key]”


Fields

IDTypeNameDescription
absolute_top_impression_percentageNUMERICAbsolute top impression percentageThe percent of your ad impressions that are shown as the very first ad above the organic search results.
access_reasonTEXTAccess reasonIndicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only.
accessible_bidding_strategyTEXTAccessible bidding strategyResource 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_idNUMERICAccessible bidding strategy idThe ID of the bidding strategy.
accessible_bidding_strategy_maximize_conversion_value_target_roasNUMERICAccessible bidding strategy maximize conversion value target roasThe 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_microsNUMERICAccessible bidding strategy maximize conversions target cpa microsThe 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_nameTEXTAccessible bidding strategy nameThe name of the bidding strategy.
accessible_bidding_strategy_owner_customer_idNUMERICAccessible bidding strategy owner customer idThe ID of the Customer which owns the bidding strategy.
accessible_bidding_strategy_owner_descriptive_nameTEXTAccessible bidding strategy owner descriptive namedescriptive_name of the Customer which owns the bidding strategy.
accessible_bidding_strategy_resource_nameTEXTAccessible bidding strategy resource nameThe 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_microsNUMERICAccessible bidding strategy target cpa target cpa microsAverage 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_microsNUMERICAccessible bidding strategy target impression share cpc bid ceiling microsThe 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_locationTEXTAccessible bidding strategy target impression share locationThe targeted location on the search results page.
accessible_bidding_strategy_target_impression_share_location_fraction_microsNUMERICAccessible bidding strategy target impression share location fraction microsThe chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
accessible_bidding_strategy_target_roas_target_roasNUMERICAccessible bidding strategy target roas target roasRequired. The chosen 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_microsNUMERICAccessible bidding strategy target spend cpc bid ceiling microsMaximum 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_microsNUMERICAccessible bidding strategy target spend target spend microsThe 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.html for details.
accessible_bidding_strategy_typeTEXTAccessible bidding strategy typeThe type of the bidding strategy.
account_currency_codeTEXTAccount currency codeThe currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
account_descriptive_nameTEXTAccount descriptive nameOptional, non-unique descriptive name of the customer.
account_idTEXTAccount IDThe Google Ads account ID.
account_nameTEXTAccount NameOptional, non-unique descriptive name of the customer.
account_time_zoneTEXTAccount time zoneThe local timezone ID of the customer.
account_user_list_statusTEXTAccount user list statusIndicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED.
action_itemsTEXTAction itemsA 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.".
active_view_cpmNUMERICActive view cpmAverage cost of viewable impressions (active_view_impressions).
active_view_ctrNUMERICActive view ctrActive view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.
active_view_impressionsNUMERICActive view impressionsA measurement of how often your ad has become viewable on a Display Network site.
active_view_measurabilityNUMERICActive view measurabilityThe ratio of impressions that could be measured by Active View over the number of served impressions.
active_view_measurable_costNUMERICActive view measurable costThe cost of the impressions you received that were measurable by Active View.
active_view_measurable_cost_microsNUMERICActive view measurable cost microsThe cost of the impressions you received that were measurable by Active View.
active_view_measurable_impressionsNUMERICActive view measurable impressionsThe number of times your ads are appearing on placements in positions where they can be seen.
active_view_viewabilityNUMERICActive view viewabilityThe percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
BOOLEANAd added by google adsIndicates 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_descriptionsTEXTAd app ad descriptionsList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_app_ad_headlinesTEXTAd app ad headlinesList of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_app_ad_html5_media_bundlesTEXTAd app ad html5 media bundlesList of media bundle assets that may be used with the ad.
ad_app_ad_html5_media_bundles_assetTEXTAd app ad html5 media bundles assetThe Asset resource name of this media bundle.
ad_app_ad_imagesTEXTAd app ad imagesList of image assets that may be displayed with the ad.
ad_app_ad_images_assetTEXTAd app ad images assetThe Asset resource name of this image.
ad_app_ad_mandatory_ad_textTEXTAd app ad mandatory ad textMandatory ad text.
ad_app_ad_youtube_videosTEXTAd app ad youtube videosList of YouTube video assets that may be displayed with the ad.
ad_app_ad_youtube_videos_assetTEXTAd app ad youtube videos assetThe Asset resource name of this video.
ad_app_engagement_ad_descriptionsTEXTAd app engagement ad descriptionsList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_app_engagement_ad_headlinesTEXTAd app engagement ad headlinesList of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_app_engagement_ad_imagesTEXTAd app engagement ad imagesList of image assets that may be displayed with the ad.
ad_app_engagement_ad_images_assetTEXTAd app engagement ad images assetThe Asset resource name of this image.
ad_app_engagement_ad_videosTEXTAd app engagement ad videosList of video assets that may be displayed with the ad.
ad_app_engagement_ad_videos_assetTEXTAd app engagement ad videos assetThe Asset resource name of this video.
ad_app_pre_registration_ad_descriptionsTEXTAd app pre registration ad descriptionsList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_app_pre_registration_ad_headlinesTEXTAd app pre registration ad headlinesList of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_app_pre_registration_ad_imagesTEXTAd app pre registration ad imagesList of image asset IDs whose images may be displayed with the ad.
ad_app_pre_registration_ad_images_assetTEXTAd app pre registration ad images assetThe Asset resource name of this image.
ad_app_pre_registration_ad_youtube_videosTEXTAd app pre registration ad youtube videosList of YouTube video asset IDs whose videos may be displayed with the ad.
ad_app_pre_registration_ad_youtube_videos_assetTEXTAd app pre registration ad youtube videos assetThe Asset resource name of this video.
ad_call_ad_business_nameTEXTAd call ad business nameThe business name in the ad.
ad_call_ad_call_trackedBOOLEANAd call ad call trackedWhether to enable call tracking for the creative. Enabling call tracking also enables call conversions.
ad_call_ad_conversion_actionTEXTAd call ad conversion actionThe 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_stateTEXTAd call ad conversion reporting stateThe 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_codeTEXTAd call ad country codeThe country code in the ad.
ad_call_ad_description1TEXTAd call ad description1The first line of the ad's description.
ad_call_ad_description2TEXTAd call ad description2The second line of the ad's description.
ad_call_ad_disable_call_conversionBOOLEANAd call ad disable call conversionWhether 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_headline1TEXTAd call ad headline1First headline in the ad.
ad_call_ad_headline2TEXTAd call ad headline2Second headline in the ad.
ad_call_ad_path1TEXTAd call ad path1First part of text that can be appended to the URL in the ad. Optional.
ad_call_ad_path2TEXTAd call ad path2Second 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_numberTEXTAd call ad phone numberThe phone number in the ad.
ad_call_ad_phone_number_verification_urlTEXTAd call ad phone number verification urlThe URL to be used for phone number verification.
ad_destination_typeTEXTAd destination typeAd Destination type.
ad_device_preferenceTEXTAd device preferenceThe 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, for example, if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types.
TEXTAd discovery carousel ad business nameRequired. The Advertiser/brand name.
TEXTAd discovery carousel ad call to action textCall to action text.
TEXTAd discovery carousel ad carousel cardsRequired. Carousel cards that will display with the ad. Min 2 max 10.
TEXTAd discovery carousel ad carousel cards assetThe Asset resource name of this discovery carousel card.
TEXTAd discovery carousel ad descriptionRequired. The descriptive text of the ad.
TEXTAd discovery carousel ad headlineRequired. Headline of the ad.
TEXTAd discovery carousel ad logo imageRequired. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%).
TEXTAd discovery carousel ad logo image assetThe Asset resource name of this image.
ad_discovery_multi_asset_ad_business_nameTEXTAd discovery multi asset ad business nameThe Advertiser/brand name. Maximum display width is 25. Required.
ad_discovery_multi_asset_ad_call_to_action_textTEXTAd discovery multi asset ad call to action textCall to action text.
ad_discovery_multi_asset_ad_descriptionsTEXTAd discovery multi asset ad descriptionsThe descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.
ad_discovery_multi_asset_ad_headlinesTEXTAd discovery multi asset ad headlinesHeadline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.
ad_discovery_multi_asset_ad_lead_form_onlyBOOLEANAd discovery multi asset ad lead form onlyBoolean option that indicates if this ad must be served with lead form.
ad_discovery_multi_asset_ad_logo_imagesTEXTAd discovery multi asset ad logo imagesLogo image assets 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%). At least 1 and max 5 logo images can be specified.
ad_discovery_multi_asset_ad_logo_images_assetTEXTAd discovery multi asset ad logo images assetThe Asset resource name of this image.
ad_discovery_multi_asset_ad_marketing_imagesTEXTAd discovery multi asset ad marketing imagesMarketing image assets 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%). Required if square_marketing_images is not present. Combined with square_marketing_images and portrait_marketing_images the maximum is 20.
ad_discovery_multi_asset_ad_marketing_images_assetTEXTAd discovery multi asset ad marketing images assetThe Asset resource name of this image.
ad_discovery_multi_asset_ad_portrait_marketing_imagesTEXTAd discovery multi asset ad portrait marketing imagesPortrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must be 4:5 (+-1%). Combined with marketing_images and square_marketing_images the maximum is 20.
ad_discovery_multi_asset_ad_portrait_marketing_images_assetTEXTAd discovery multi asset ad portrait marketing images assetThe Asset resource name of this image.
ad_discovery_multi_asset_ad_square_marketing_imagesTEXTAd discovery multi asset ad square marketing imagesSquare marketing image assets 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%). Required if marketing_images is not present. Combined with marketing_images and portrait_marketing_images the maximum is 20.
ad_discovery_multi_asset_ad_square_marketing_images_assetTEXTAd discovery multi asset ad square marketing images assetThe Asset resource name of this image.
ad_display_upload_ad_display_upload_product_typeTEXTAd display upload ad display upload product typeThe product type of this ad. See comments on the enum for details.
ad_display_upload_ad_media_bundleTEXTAd display upload ad media bundleA 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/1722096 Media 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/7543898 for more information.
ad_display_upload_ad_media_bundle_assetTEXTAd display upload ad media bundle assetThe Asset resource name of this media bundle.
ad_display_urlTEXTAd display urlThe URL that appears in the ad description for some ad formats.
ad_expanded_dynamic_search_ad_descriptionTEXTAd expanded dynamic search ad descriptionThe description of the ad.
ad_expanded_dynamic_search_ad_description2TEXTAd expanded dynamic search ad description2The second description of the ad.
ad_expanded_text_ad_descriptionTEXTAd expanded text ad descriptionThe description of the ad.
ad_expanded_text_ad_description2TEXTAd expanded text ad description2The second description of the ad.
ad_expanded_text_ad_headline_part1TEXTAd expanded text ad headline part1The first part of the ad's headline.
ad_expanded_text_ad_headline_part2TEXTAd expanded text ad headline part2The second part of the ad's headline.
ad_expanded_text_ad_headline_part3TEXTAd expanded text ad headline part3The third part of the ad's headline.
ad_expanded_text_ad_path1TEXTAd expanded text ad path1The text that can appear alongside the ad's displayed URL.
ad_expanded_text_ad_path2TEXTAd expanded text ad path2Additional text that can appear alongside the ad's displayed URL.
ad_final_app_urlsTEXTAd final app urlsA list of final app URLs that will be used on mobile if the user has the specific app installed.
ad_final_mobile_urlsTEXTAd final mobile urlsThe list of possible final mobile URLs after all cross-domain redirects for the ad.
ad_final_url_suffixTEXTAd final url suffixThe suffix to use when constructing a final URL.
ad_final_urlsTEXTAd final urlsThe list of possible final URLs after all cross-domain redirects for the ad.
ad_gmail_ad_header_imageTEXTAd gmail ad header imageThe MediaFile resource name of the header image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must be between 3:1 and 5:1 (+-1%).
ad_gmail_ad_marketing_imageTEXTAd gmail ad marketing imageThe MediaFile resource name of the marketing image. Valid image types are GIF, JPEG and PNG. The image must either be landscape with a minimum size of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)
ad_gmail_ad_marketing_image_descriptionTEXTAd gmail ad marketing image descriptionDescription of the marketing image.
ad_gmail_ad_marketing_image_display_call_to_action_textTEXTAd gmail ad marketing image display call to action textText for the display-call-to-action.
ad_gmail_ad_marketing_image_display_call_to_action_text_colorTEXTAd gmail ad marketing image display call to action text colorText color for the display-call-to-action in hexadecimal, for example, # ffffff for white.
ad_gmail_ad_marketing_image_display_call_to_action_url_collection_idTEXTAd gmail ad marketing image display call to action url collection idIdentifies the URL collection in the ad.url_collections field. If not set, the URL defaults to final_url.
ad_gmail_ad_marketing_image_headlineTEXTAd gmail ad marketing image headlineHeadline of the marketing image.
ad_gmail_ad_product_imagesTEXTAd gmail ad product imagesProduct images. Up to 15 images are supported.
ad_gmail_ad_product_images_product_imageTEXTAd gmail ad product images product imageThe MediaFile resource name of the product image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x300 pixels and the aspect ratio must be 1:1 (+-1%).
ad_gmail_ad_product_videosTEXTAd gmail ad product videosProduct videos. Up to 7 videos are supported. At least one product video or a marketing image must be specified.
ad_gmail_ad_product_videos_product_videoTEXTAd gmail ad product videos product videoThe MediaFile resource name of a video which must be hosted on YouTube.
ad_gmail_ad_teaser_business_nameTEXTAd gmail ad teaser business nameBusiness name of the advertiser.
ad_gmail_ad_teaser_descriptionTEXTAd gmail ad teaser descriptionDescription of the teaser.
ad_gmail_ad_teaser_headlineTEXTAd gmail ad teaser headlineHeadline of the teaser.
ad_gmail_ad_teaser_logo_imageTEXTAd gmail ad teaser logo imageThe MediaFile resource name of the logo image. Valid image types are GIF, JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must be 1:1 (+-1%).
ad_groupTEXTAd groupThe ad group to which the criterion belongs.
ad_group_ad_action_itemsTEXTAd group ad action itemsA 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_adsBOOLEANAd group ad ad added by google adsIndicates 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_descriptionsTEXTAd group ad ad app ad descriptionsList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_group_ad_ad_app_ad_headlinesTEXTAd group ad ad app ad headlinesList 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_bundlesTEXTAd group ad ad app ad html5 media bundlesList of media bundle assets that may be used with the ad.
ad_group_ad_ad_app_ad_html5_media_bundles_assetTEXTAd group ad ad app ad html5 media bundles assetThe Asset resource name of this media bundle.
ad_group_ad_ad_app_ad_imagesTEXTAd group ad ad app ad imagesList of image assets that may be displayed with the ad.
ad_group_ad_ad_app_ad_images_assetTEXTAd group ad ad app ad images assetThe Asset resource name of this image.
ad_group_ad_ad_app_ad_mandatory_ad_textTEXTAd group ad ad app ad mandatory ad textMandatory ad text.
ad_group_ad_ad_app_ad_youtube_videosTEXTAd group ad ad app ad youtube videosList of YouTube video assets that may be displayed with the ad.
ad_group_ad_ad_app_ad_youtube_videos_assetTEXTAd group ad ad app ad youtube videos assetThe Asset resource name of this video.
ad_group_ad_ad_app_engagement_ad_descriptionsTEXTAd group ad ad app engagement ad descriptionsList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_group_ad_ad_app_engagement_ad_headlinesTEXTAd group ad ad app engagement ad headlinesList of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_group_ad_ad_app_engagement_ad_imagesTEXTAd group ad ad app engagement ad imagesList of image assets that may be displayed with the ad.
ad_group_ad_ad_app_engagement_ad_images_assetTEXTAd group ad ad app engagement ad images assetThe Asset resource name of this image.
ad_group_ad_ad_app_engagement_ad_videosTEXTAd group ad ad app engagement ad videosList of video assets that may be displayed with the ad.
ad_group_ad_ad_app_engagement_ad_videos_assetTEXTAd group ad ad app engagement ad videos assetThe Asset resource name of this video.
ad_group_ad_ad_app_pre_registration_ad_descriptionsTEXTAd group ad ad app pre registration ad descriptionsList 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_headlinesTEXTAd group ad ad app pre registration ad headlinesList 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_imagesTEXTAd group ad ad app pre registration ad imagesList of image asset IDs whose images may be displayed with the ad.
ad_group_ad_ad_app_pre_registration_ad_images_assetTEXTAd group ad ad app pre registration ad images assetThe Asset resource name of this image.
ad_group_ad_ad_app_pre_registration_ad_youtube_videosTEXTAd group ad ad app pre registration ad youtube videosList of YouTube video asset IDs whose videos may be displayed with the ad.
ad_group_ad_ad_app_pre_registration_ad_youtube_videos_assetTEXTAd group ad ad app pre registration ad youtube videos assetThe Asset resource name of this video.
ad_group_ad_ad_call_ad_business_nameTEXTAd group ad ad call ad business nameThe business name in the ad.
ad_group_ad_ad_call_ad_call_trackedBOOLEANAd group ad ad call ad call trackedWhether to enable call tracking for the creative. Enabling call tracking also enables call conversions.
ad_group_ad_ad_call_ad_conversion_actionTEXTAd group ad ad call ad conversion actionThe 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_stateTEXTAd group ad ad call ad conversion reporting stateThe 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_codeTEXTAd group ad ad call ad country codeThe country code in the ad.
ad_group_ad_ad_call_ad_description1TEXTAd group ad ad call ad description1The first line of the ad's description.
ad_group_ad_ad_call_ad_description2TEXTAd group ad ad call ad description2The second line of the ad's description.
ad_group_ad_ad_call_ad_disable_call_conversionBOOLEANAd group ad ad call ad disable call conversionWhether 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_headline1TEXTAd group ad ad call ad headline1First headline in the ad.
ad_group_ad_ad_call_ad_headline2TEXTAd group ad ad call ad headline2Second headline in the ad.
ad_group_ad_ad_call_ad_path1TEXTAd group ad ad call ad path1First part of text that can be appended to the URL in the ad. Optional.
ad_group_ad_ad_call_ad_path2TEXTAd group ad ad call ad path2Second 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_numberTEXTAd group ad ad call ad phone numberThe phone number in the ad.
ad_group_ad_ad_call_ad_phone_number_verification_urlTEXTAd group ad ad call ad phone number verification urlThe URL to be used for phone number verification.
ad_group_ad_ad_device_preferenceTEXTAd group ad ad device preferenceThe 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, for example, if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types.
TEXTAd group ad ad discovery carousel ad business nameRequired. The Advertiser/brand name.
TEXTAd group ad ad discovery carousel ad call to action textCall to action text.
TEXTAd group ad ad discovery carousel ad carousel cardsRequired. Carousel cards that will display with the ad. Min 2 max 10.
TEXTAd group ad ad discovery carousel ad carousel cards assetThe Asset resource name of this discovery carousel card.
TEXTAd group ad ad discovery carousel ad descriptionRequired. The descriptive text of the ad.
TEXTAd group ad ad discovery carousel ad headlineRequired. Headline of the ad.
TEXTAd group ad ad discovery carousel ad logo imageRequired. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%).
TEXTAd group ad ad discovery carousel ad logo image assetThe Asset resource name of this image.
ad_group_ad_ad_discovery_multi_asset_ad_business_nameTEXTAd group ad ad discovery multi asset ad business nameThe Advertiser/brand name. Maximum display width is 25. Required.
ad_group_ad_ad_discovery_multi_asset_ad_call_to_action_textTEXTAd group ad ad discovery multi asset ad call to action textCall to action text.
ad_group_ad_ad_discovery_multi_asset_ad_descriptionsTEXTAd group ad ad discovery multi asset ad descriptionsThe descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.
ad_group_ad_ad_discovery_multi_asset_ad_headlinesTEXTAd group ad ad discovery multi asset ad headlinesHeadline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.
ad_group_ad_ad_discovery_multi_asset_ad_lead_form_onlyBOOLEANAd group ad ad discovery multi asset ad lead form onlyBoolean option that indicates if this ad must be served with lead form.
ad_group_ad_ad_discovery_multi_asset_ad_logo_imagesTEXTAd group ad ad discovery multi asset ad logo imagesLogo image assets 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%). At least 1 and max 5 logo images can be specified.
ad_group_ad_ad_discovery_multi_asset_ad_logo_images_assetTEXTAd group ad ad discovery multi asset ad logo images assetThe Asset resource name of this image.
ad_group_ad_ad_discovery_multi_asset_ad_marketing_imagesTEXTAd group ad ad discovery multi asset ad marketing imagesMarketing image assets 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%). Required if square_marketing_images is not present. Combined with square_marketing_images and portrait_marketing_images the maximum is 20.
ad_group_ad_ad_discovery_multi_asset_ad_marketing_images_assetTEXTAd group ad ad discovery multi asset ad marketing images assetThe Asset resource name of this image.
ad_group_ad_ad_discovery_multi_asset_ad_portrait_marketing_imagesTEXTAd group ad ad discovery multi asset ad portrait marketing imagesPortrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must be 4:5 (+-1%). Combined with marketing_images and square_marketing_images the maximum is 20.
ad_group_ad_ad_discovery_multi_asset_ad_portrait_marketing_images_assetTEXTAd group ad ad discovery multi asset ad portrait marketing images assetThe Asset resource name of this image.
ad_group_ad_ad_discovery_multi_asset_ad_square_marketing_imagesTEXTAd group ad ad discovery multi asset ad square marketing imagesSquare marketing image assets 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%). Required if marketing_images is not present. Combined with marketing_images and portrait_marketing_images the maximum is 20.
ad_group_ad_ad_discovery_multi_asset_ad_square_marketing_images_assetTEXTAd group ad ad discovery multi asset ad square marketing images assetThe Asset resource name of this image.
ad_group_ad_ad_display_upload_ad_display_upload_product_typeTEXTAd group ad ad display upload ad display upload product typeThe product type of this ad. See comments on the enum for details.
ad_group_ad_ad_display_upload_ad_media_bundleTEXTAd group ad ad display upload ad media bundleA 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/1722096 Media 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/7543898 for more information.
ad_group_ad_ad_display_upload_ad_media_bundle_assetTEXTAd group ad ad display upload ad media bundle assetThe Asset resource name of this media bundle.
ad_group_ad_ad_display_urlTEXTAd group ad ad display urlThe URL that appears in the ad description for some ad formats.
ad_group_ad_ad_expanded_dynamic_search_ad_descriptionTEXTAd group ad ad expanded dynamic search ad descriptionThe description of the ad.
ad_group_ad_ad_expanded_dynamic_search_ad_description2TEXTAd group ad ad expanded dynamic search ad description2The second description of the ad.
ad_group_ad_ad_expanded_text_ad_descriptionTEXTAd group ad ad expanded text ad descriptionThe description of the ad.
ad_group_ad_ad_expanded_text_ad_description2TEXTAd group ad ad expanded text ad description2The second description of the ad.
ad_group_ad_ad_expanded_text_ad_headline_part1TEXTAd group ad ad expanded text ad headline part1The first part of the ad's headline.
ad_group_ad_ad_expanded_text_ad_headline_part2TEXTAd group ad ad expanded text ad headline part2The second part of the ad's headline.
ad_group_ad_ad_expanded_text_ad_headline_part3TEXTAd group ad ad expanded text ad headline part3The third part of the ad's headline.
ad_group_ad_ad_expanded_text_ad_path1TEXTAd group ad ad expanded text ad path1The text that can appear alongside the ad's displayed URL.
ad_group_ad_ad_expanded_text_ad_path2TEXTAd group ad ad expanded text ad path2Additional text that can appear alongside the ad's displayed URL.
ad_group_ad_ad_final_app_urlsTEXTAd group ad ad final app urlsA 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_urlsTEXTAd group ad ad final mobile urlsThe list of possible final mobile URLs after all cross-domain redirects for the ad.
ad_group_ad_ad_final_url_suffixTEXTAd group ad ad final url suffixThe suffix to use when constructing a final URL.
ad_group_ad_ad_final_urlsTEXTAd group ad ad final urlsThe list of possible final URLs after all cross-domain redirects for the ad.
ad_group_ad_ad_gmail_ad_header_imageTEXTAd group ad ad gmail ad header imageThe MediaFile resource name of the header image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must be between 3:1 and 5:1 (+-1%).
ad_group_ad_ad_gmail_ad_marketing_imageTEXTAd group ad ad gmail ad marketing imageThe MediaFile resource name of the marketing image. Valid image types are GIF, JPEG and PNG. The image must either be landscape with a minimum size of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)
ad_group_ad_ad_gmail_ad_marketing_image_descriptionTEXTAd group ad ad gmail ad marketing image descriptionDescription of the marketing image.
ad_group_ad_ad_gmail_ad_marketing_image_display_call_to_action_textTEXTAd group ad ad gmail ad marketing image display call to action textText for the display-call-to-action.
ad_group_ad_ad_gmail_ad_marketing_image_display_call_to_action_text_colorTEXTAd group ad ad gmail ad marketing image display call to action text colorText color for the display-call-to-action in hexadecimal, for example, # ffffff for white.
ad_group_ad_ad_gmail_ad_marketing_image_display_call_to_action_url_collection_idTEXTAd group ad ad gmail ad marketing image display call to action url collection idIdentifies the URL collection in the ad.url_collections field. If not set, the URL defaults to final_url.
ad_group_ad_ad_gmail_ad_marketing_image_headlineTEXTAd group ad ad gmail ad marketing image headlineHeadline of the marketing image.
ad_group_ad_ad_gmail_ad_product_imagesTEXTAd group ad ad gmail ad product imagesProduct images. Up to 15 images are supported.
ad_group_ad_ad_gmail_ad_product_images_product_imageTEXTAd group ad ad gmail ad product images product imageThe MediaFile resource name of the product image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x300 pixels and the aspect ratio must be 1:1 (+-1%).
ad_group_ad_ad_gmail_ad_product_videosTEXTAd group ad ad gmail ad product videosProduct videos. Up to 7 videos are supported. At least one product video or a marketing image must be specified.
ad_group_ad_ad_gmail_ad_product_videos_product_videoTEXTAd group ad ad gmail ad product videos product videoThe MediaFile resource name of a video which must be hosted on YouTube.
ad_group_ad_ad_gmail_ad_teaser_business_nameTEXTAd group ad ad gmail ad teaser business nameBusiness name of the advertiser.
ad_group_ad_ad_gmail_ad_teaser_descriptionTEXTAd group ad ad gmail ad teaser descriptionDescription of the teaser.
ad_group_ad_ad_gmail_ad_teaser_headlineTEXTAd group ad ad gmail ad teaser headlineHeadline of the teaser.
ad_group_ad_ad_gmail_ad_teaser_logo_imageTEXTAd group ad ad gmail ad teaser logo imageThe MediaFile resource name of the logo image. Valid image types are GIF, JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must be 1:1 (+-1%).
ad_group_ad_ad_groupTEXTAd group ad ad groupThe ad group to which the ad belongs.
ad_group_ad_ad_hotel_adTEXTAd group ad ad hotel adDetails pertaining to a hotel ad.
ad_group_ad_ad_idNUMERICAd group ad ad idThe ID of the ad.
ad_group_ad_ad_image_ad_image_urlTEXTAd group ad ad image ad image urlURL of the full size image.
ad_group_ad_ad_image_ad_media_fileTEXTAd group ad ad image ad media fileThe MediaFile resource to use for the image.
ad_group_ad_ad_image_ad_mime_typeTEXTAd group ad ad image ad mime typeThe mime type of the image.
ad_group_ad_ad_image_ad_nameTEXTAd group ad ad image ad nameThe 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_heightNUMERICAd group ad ad image ad pixel heightHeight in pixels of the full size image.
ad_group_ad_ad_image_ad_pixel_widthNUMERICAd group ad ad image ad pixel widthWidth in pixels of the full size image.
ad_group_ad_ad_image_ad_preview_image_urlTEXTAd group ad ad image ad preview image urlURL of the preview size image.
ad_group_ad_ad_image_ad_preview_pixel_heightNUMERICAd group ad ad image ad preview pixel heightHeight in pixels of the preview size image.
ad_group_ad_ad_image_ad_preview_pixel_widthNUMERICAd group ad ad image ad preview pixel widthWidth in pixels of the preview size image.
ad_group_ad_ad_legacy_app_install_adTEXTAd group ad ad legacy app install adDetails pertaining to a legacy app install ad.
ad_group_ad_ad_legacy_responsive_display_ad_accent_colorTEXTAd group ad ad legacy responsive display ad accent colorThe accent color of the ad in hexadecimal, for example, #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_colorBOOLEANAd group ad ad legacy responsive display ad allow flexible colorAdvertiser'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_nameTEXTAd group ad ad legacy responsive display ad business nameThe business name in the ad.
ad_group_ad_ad_legacy_responsive_display_ad_call_to_action_textTEXTAd group ad ad legacy responsive display ad call to action textThe call-to-action text for the ad.
ad_group_ad_ad_legacy_responsive_display_ad_descriptionTEXTAd group ad ad legacy responsive display ad descriptionThe description of the ad.
ad_group_ad_ad_legacy_responsive_display_ad_format_settingTEXTAd group ad ad legacy responsive display ad format settingSpecifies which format the ad will be served in. Default is ALL_FORMATS.
ad_group_ad_ad_legacy_responsive_display_ad_logo_imageTEXTAd group ad ad legacy responsive display ad logo imageThe MediaFile resource name of the logo image used in the ad.
ad_group_ad_ad_legacy_responsive_display_ad_long_headlineTEXTAd group ad ad legacy responsive display ad long headlineThe long version of the ad's headline.
ad_group_ad_ad_legacy_responsive_display_ad_main_colorTEXTAd group ad ad legacy responsive display ad main colorThe main color of the ad in hexadecimal, for example, #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_imageTEXTAd group ad ad legacy responsive display ad marketing imageThe MediaFile resource name of the marketing image used in the ad.
ad_group_ad_ad_legacy_responsive_display_ad_price_prefixTEXTAd group ad ad legacy responsive display ad price prefixPrefix before price. For example, 'as low as'.
ad_group_ad_ad_legacy_responsive_display_ad_promo_textTEXTAd group ad ad legacy responsive display ad promo textPromotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
ad_group_ad_ad_legacy_responsive_display_ad_short_headlineTEXTAd group ad ad legacy responsive display ad short headlineThe short version of the ad's headline.
ad_group_ad_ad_legacy_responsive_display_ad_square_logo_imageTEXTAd group ad ad legacy responsive display ad square logo imageThe MediaFile resource name of the square logo image used in the ad.
ad_group_ad_ad_legacy_responsive_display_ad_square_marketing_imageTEXTAd group ad ad legacy responsive display ad square marketing imageThe MediaFile resource name of the square marketing image used in the ad.
ad_group_ad_ad_local_ad_call_to_actionsTEXTAd group ad ad local ad call to actionsList 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_descriptionsTEXTAd group ad ad local ad descriptionsList 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_headlinesTEXTAd group ad ad local ad headlinesList 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_imagesTEXTAd group ad ad local ad logo imagesList 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_logo_images_assetTEXTAd group ad ad local ad logo images assetThe Asset resource name of this image.
ad_group_ad_ad_local_ad_marketing_imagesTEXTAd group ad ad local ad marketing imagesList 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_marketing_images_assetTEXTAd group ad ad local ad marketing images assetThe Asset resource name of this image.
ad_group_ad_ad_local_ad_path1TEXTAd group ad ad local ad path1First part of optional text that can be appended to the URL in the ad.
ad_group_ad_ad_local_ad_path2TEXTAd group ad ad local ad path2Second 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_videosTEXTAd group ad ad local ad videosList 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_local_ad_videos_assetTEXTAd group ad ad local ad videos assetThe Asset resource name of this video.
ad_group_ad_ad_nameTEXTAd group ad ad nameThe 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_nameTEXTAd group ad ad resource nameThe 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_colorTEXTAd group ad ad responsive display ad accent colorThe accent color of the ad in hexadecimal, for example, #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_colorBOOLEANAd group ad ad responsive display ad allow flexible colorAdvertiser'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_nameTEXTAd group ad ad responsive display ad business nameThe advertiser/brand name. Maximum display width is 25.
ad_group_ad_ad_responsive_display_ad_call_to_action_textTEXTAd group ad ad responsive display ad call to action textThe call-to-action text for the ad. Maximum display width is 30.
ad_group_ad_ad_responsive_display_ad_control_spec_enable_asset_enhancementsBOOLEANAd group ad ad responsive display ad control spec enable asset enhancementsWhether the advertiser has opted into the asset enhancements feature.
ad_group_ad_ad_responsive_display_ad_control_spec_enable_autogen_videoBOOLEANAd group ad ad responsive display ad control spec enable autogen videoWhether the advertiser has opted into auto-gen video feature.
ad_group_ad_ad_responsive_display_ad_descriptionsTEXTAd group ad ad responsive display ad descriptionsDescriptive 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_settingTEXTAd group ad ad responsive display ad format settingSpecifies which format the ad will be served in. Default is ALL_FORMATS.
ad_group_ad_ad_responsive_display_ad_headlinesTEXTAd group ad ad responsive display ad headlinesShort 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_imagesTEXTAd group ad ad responsive display ad logo imagesLogo 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_logo_images_assetTEXTAd group ad ad responsive display ad logo images assetThe Asset resource name of this image.
ad_group_ad_ad_responsive_display_ad_long_headlineTEXTAd group ad ad responsive display ad long headlineA required long format headline. The maximum length is 90 characters.
ad_group_ad_ad_responsive_display_ad_main_colorTEXTAd group ad ad responsive display ad main colorThe main color of the ad in hexadecimal, for example, #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_imagesTEXTAd group ad ad responsive display ad marketing imagesMarketing 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_marketing_images_assetTEXTAd group ad ad responsive display ad marketing images assetThe Asset resource name of this image.
ad_group_ad_ad_responsive_display_ad_price_prefixTEXTAd group ad ad responsive display ad price prefixPrefix before price. For example, 'as low as'.
ad_group_ad_ad_responsive_display_ad_promo_textTEXTAd group ad ad responsive display ad promo textPromotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
ad_group_ad_ad_responsive_display_ad_square_logo_imagesTEXTAd group ad ad responsive display ad square logo imagesSquare 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_logo_images_assetTEXTAd group ad ad responsive display ad square logo images assetThe Asset resource name of this image.
ad_group_ad_ad_responsive_display_ad_square_marketing_imagesTEXTAd group ad ad responsive display ad square marketing imagesSquare 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_square_marketing_images_assetTEXTAd group ad ad responsive display ad square marketing images assetThe Asset resource name of this image.
ad_group_ad_ad_responsive_display_ad_youtube_videosTEXTAd group ad ad responsive display ad youtube videosOptional YouTube videos for the ad. A maximum of 5 videos can be specified.
ad_group_ad_ad_responsive_display_ad_youtube_videos_assetTEXTAd group ad ad responsive display ad youtube videos assetThe Asset resource name of this video.
ad_group_ad_ad_responsive_search_ad_descriptionsTEXTAd group ad ad responsive search ad descriptionsList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_group_ad_ad_responsive_search_ad_headlinesTEXTAd group ad ad responsive search ad headlinesList of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_group_ad_ad_responsive_search_ad_path1TEXTAd group ad ad responsive search ad path1First part of text that can be appended to the URL in the ad.
ad_group_ad_ad_responsive_search_ad_path2TEXTAd group ad ad responsive search ad path2Second 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_headlineTEXTAd group ad ad shopping comparison listing ad headlineHeadline of the ad. This field is required. Allowed length is between 25 and 45 characters.
ad_group_ad_ad_shopping_product_adTEXTAd group ad ad shopping product adDetails pertaining to a Shopping product ad.
ad_group_ad_ad_shopping_smart_adTEXTAd group ad ad shopping smart adDetails pertaining to a Smart Shopping ad.
ad_group_ad_ad_smart_campaign_ad_descriptionsTEXTAd group ad ad smart campaign ad descriptionsList of text assets, each of which corresponds to a description when the ad serves. This list consists of a minimum of 2 and up to 4 text assets.
ad_group_ad_ad_smart_campaign_ad_headlinesTEXTAd group ad ad smart campaign ad headlinesList of text assets, each of which corresponds to a headline when the ad serves. This list consists of a minimum of 3 and up to 15 text assets.
ad_group_ad_ad_strengthTEXTAd group ad ad strengthOverall ad strength for this ad group ad.
ad_group_ad_ad_system_managed_resource_sourceTEXTAd group ad ad system managed resource sourceIf this ad is system managed, then this field will indicate the source. This field is read-only.
ad_group_ad_ad_text_ad_description1TEXTAd group ad ad text ad description1The first line of the ad's description.
ad_group_ad_ad_text_ad_description2TEXTAd group ad ad text ad description2The second line of the ad's description.
ad_group_ad_ad_text_ad_headlineTEXTAd group ad ad text ad headlineThe headline of the ad.
ad_group_ad_ad_tracking_url_templateTEXTAd group ad ad tracking url templateThe URL template for constructing a tracking URL.
ad_group_ad_ad_typeTEXTAd group ad ad typeThe type of ad.
ad_group_ad_ad_url_collectionsTEXTAd group ad ad url collectionsAdditional 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_parametersTEXTAd group ad ad url custom parametersThe 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, use url custom parameter operations.
ad_group_ad_ad_video_ad_bumper_companion_banner_assetTEXTAd group ad ad video ad bumper companion banner assetThe Asset resource name of this image.
ad_group_ad_ad_video_ad_in_feed_description1TEXTAd group ad ad video ad in feed description1First text line for the ad.
ad_group_ad_ad_video_ad_in_feed_description2TEXTAd group ad ad video ad in feed description2Second text line for the ad.
ad_group_ad_ad_video_ad_in_feed_headlineTEXTAd group ad ad video ad in feed headlineThe headline of the ad.
ad_group_ad_ad_video_ad_in_feed_thumbnailTEXTAd group ad ad video ad in feed thumbnailVideo thumbnail image to use.
ad_group_ad_ad_video_ad_in_stream_action_button_labelTEXTAd group ad ad video ad in stream action button labelLabel 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_headlineTEXTAd group ad ad video ad in stream action headlineAdditional 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_assetTEXTAd group ad ad video ad in stream companion banner assetThe Asset resource name of this image.
ad_group_ad_ad_video_ad_non_skippable_action_button_labelTEXTAd group ad ad video ad non skippable action button labelLabel 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_headlineTEXTAd group ad ad video ad non skippable action headlineAdditional 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_assetTEXTAd group ad ad video ad non skippable companion banner assetThe Asset resource name of this image.
ad_group_ad_ad_video_ad_out_stream_descriptionTEXTAd group ad ad video ad out stream descriptionThe description line.
ad_group_ad_ad_video_ad_out_stream_headlineTEXTAd group ad ad video ad out stream headlineThe headline of the ad.
ad_group_ad_ad_video_ad_video_assetTEXTAd group ad ad video ad video assetThe Asset resource name of this video.
ad_group_ad_ad_video_responsive_ad_breadcrumb1TEXTAd group ad ad video responsive ad breadcrumb1First part of text that appears in the ad with the displayed URL.
ad_group_ad_ad_video_responsive_ad_breadcrumb2TEXTAd group ad ad video responsive ad breadcrumb2Second part of text that appears in the ad with the displayed URL.
ad_group_ad_ad_video_responsive_ad_call_to_actionsTEXTAd group ad ad video responsive ad call to actionsList of text assets used for the button, for example, the "Call To Action" button. Currently, only a single value for the button is supported.
ad_group_ad_ad_video_responsive_ad_companion_bannersTEXTAd group ad ad video responsive ad companion bannersList 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_companion_banners_assetTEXTAd group ad ad video responsive ad companion banners assetThe Asset resource name of this image.
ad_group_ad_ad_video_responsive_ad_descriptionsTEXTAd group ad ad video responsive ad descriptionsList of text assets used for the description. Currently, only a single value for the description is supported.
ad_group_ad_ad_video_responsive_ad_headlinesTEXTAd group ad ad video responsive ad headlinesList of text assets used for the short headline, for example, the "Call To Action" banner. Currently, only a single value for the short headline is supported.
ad_group_ad_ad_video_responsive_ad_long_headlinesTEXTAd group ad ad video responsive ad long headlinesList 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_videosTEXTAd group ad ad video responsive ad videosList of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.
ad_group_ad_ad_video_responsive_ad_videos_assetTEXTAd group ad ad video responsive ad videos assetThe Asset resource name of this video.
ad_group_ad_labelsTEXTAd group ad labelsThe resource names of labels attached to this ad group ad.
ad_group_ad_policy_summary_approval_statusTEXTAd group ad policy summary approval statusThe overall approval status of this ad, calculated based on the status of its individual policy topic entries.
ad_group_ad_policy_summary_policy_topic_entriesTEXTAd group ad policy summary policy topic entriesThe list of policy findings for this ad.
ad_group_ad_policy_summary_review_statusTEXTAd group ad policy summary review statusWhere in the review process this ad is.
ad_group_ad_resource_nameTEXTAd group ad resource nameThe 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_statusTEXTAd group ad statusThe status of the ad.
ad_group_audience_setting_use_audience_groupedBOOLEANAd group audience setting use audience groupedIf true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
ad_group_criterion_ad_groupTEXTAd group criterion ad groupThe ad group to which the criterion belongs.
ad_group_criterion_app_payment_model_typeTEXTAd group criterion app payment model typeType of the app payment model.
ad_group_criterion_audience_audienceTEXTAd group criterion audience audienceThe Audience resource name.
ad_group_criterion_combined_audience_combined_audienceTEXTAd group criterion combined audience combined audienceThe CombinedAudience resource name.
ad_group_criterion_cpc_bid_microsNUMERICAd group criterion cpc bid microsThe CPC (cost-per-click) bid.
ad_group_criterion_cpm_bid_microsNUMERICAd group criterion cpm bid microsThe CPM (cost-per-thousand viewable impressions) bid.
ad_group_criterion_cpv_bid_microsNUMERICAd group criterion cpv bid microsThe CPV (cost-per-view) bid.
ad_group_criterion_custom_affinity_custom_affinityTEXTAd group criterion custom affinity custom affinityThe CustomInterest resource name.
ad_group_criterion_custom_audience_custom_audienceTEXTAd group criterion custom audience custom audienceThe CustomAudience resource name.
ad_group_criterion_custom_intent_custom_intentTEXTAd group criterion custom intent custom intentThe CustomInterest resource name.
ad_group_criterion_disapproval_reasonsTEXTAd group criterion disapproval reasonsList of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942 This field is read-only.
ad_group_criterion_display_nameTEXTAd group criterion display nameThe display name of the criterion. This field is ignored for mutates.
ad_group_criterion_effective_cpv_bid_microsNUMERICAd group criterion effective cpv bid microsThe effective CPV (cost-per-view) bid.
ad_group_criterion_effective_cpv_bid_sourceTEXTAd group criterion effective cpv bid sourceSource of the effective CPV bid.
ad_group_criterion_effective_percent_cpc_bid_microsNUMERICAd group criterion effective percent cpc bid microsThe effective Percent CPC bid amount.
ad_group_criterion_effective_percent_cpc_bid_sourceTEXTAd group criterion effective percent cpc bid sourceSource of the effective Percent CPC bid.
ad_group_criterion_income_range_typeTEXTAd group criterion income range typeType of the income range.
ad_group_criterion_labelsTEXTAd group criterion labelsThe resource names of labels attached to this ad group criterion.
ad_group_criterion_listing_group_case_value_hotel_city_city_criterionTEXTAd group criterion listing group case value hotel city city criterionThe Geo Target Constant resource name.
ad_group_criterion_listing_group_case_value_hotel_class_valueNUMERICAd group criterion listing group case value hotel class valueLong value of the hotel class.
ad_group_criterion_listing_group_case_value_hotel_country_region_country_region_criterionTEXTAd group criterion listing group case value hotel country region country region criterionThe Geo Target Constant resource name.
ad_group_criterion_listing_group_case_value_hotel_id_valueTEXTAd group criterion listing group case value hotel id valueString value of the hotel ID.
ad_group_criterion_listing_group_case_value_hotel_state_state_criterionTEXTAd group criterion listing group case value hotel state state criterionThe Geo Target Constant resource name.
ad_group_criterion_listing_group_case_value_product_bidding_category_country_codeTEXTAd group criterion listing group case value product bidding category country codeTwo-letter upper-case country code of the product bidding category. It must match the campaign.shopping_setting.sales_country field.
ad_group_criterion_listing_group_case_value_product_bidding_category_idNUMERICAd group criterion listing group case value product bidding category idID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
ad_group_criterion_listing_group_case_value_product_bidding_category_levelTEXTAd group criterion listing group case value product bidding category levelLevel of the product bidding category.
ad_group_criterion_listing_group_case_value_product_brand_valueTEXTAd group criterion listing group case value product brand valueString value of the product brand.
ad_group_criterion_listing_group_case_value_product_channel_channelTEXTAd group criterion listing group case value product channel channelValue of the locality.
ad_group_criterion_listing_group_case_value_product_channel_exclusivity_channel_exclusivityTEXTAd group criterion listing group case value product channel exclusivity channel exclusivityValue of the availability.
ad_group_criterion_listing_group_case_value_product_condition_conditionTEXTAd group criterion listing group case value product condition conditionValue of the condition.
ad_group_criterion_listing_group_case_value_product_custom_attribute_indexTEXTAd group criterion listing group case value product custom attribute indexIndicates the index of the custom attribute.
ad_group_criterion_listing_group_case_value_product_custom_attribute_valueTEXTAd group criterion listing group case value product custom attribute valueString value of the product custom attribute.
ad_group_criterion_listing_group_case_value_product_item_id_valueTEXTAd group criterion listing group case value product item id valueValue of the id.
ad_group_criterion_listing_group_case_value_product_type_levelTEXTAd group criterion listing group case value product type levelLevel of the type.
ad_group_criterion_listing_group_case_value_product_type_valueTEXTAd group criterion listing group case value product type valueValue of the type.
ad_group_criterion_listing_group_parent_ad_group_criterionTEXTAd group criterion listing group parent ad group criterionResource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
ad_group_criterion_listing_group_typeTEXTAd group criterion listing group typeType of the listing group.
ad_group_criterion_mobile_app_category_mobile_app_category_constantTEXTAd group criterion mobile app category mobile app category constantThe mobile app category constant resource name.
ad_group_criterion_mobile_application_app_idTEXTAd group criterion mobile application app idA 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 (for example, "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 (for example, "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_nameTEXTAd group criterion mobile application nameName of this mobile application.
ad_group_criterion_parental_status_typeTEXTAd group criterion parental status typeType of the parental status.
ad_group_criterion_percent_cpc_bid_microsNUMERICAd group criterion percent cpc bid microsThe 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_urlTEXTAd group criterion placement urlURL of the placement. For example, "http://www.domain.com".
ad_group_criterion_resource_nameTEXTAd group criterion resource nameThe 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_topic_pathTEXTAd group criterion topic pathThe 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_typeTEXTAd group criterion typeThe type of the criterion.
ad_group_criterion_user_interest_user_interest_categoryTEXTAd group criterion user interest user interest categoryThe UserInterest resource name.
ad_group_criterion_user_list_user_listTEXTAd group criterion user list user listThe User List resource name.
ad_group_criterion_webpage_conditionsTEXTAd group criterion webpage conditionsConditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
ad_group_criterion_webpage_coverage_percentageNUMERICAd group criterion webpage coverage percentageWebsite 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_nameTEXTAd group criterion webpage criterion nameThe 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_urlsTEXTAd group criterion webpage sample sample urlsWebpage sample urls
ad_group_criterion_youtube_channel_channel_idTEXTAd group criterion youtube channel channel idThe YouTube uploader channel id or the channel code of a YouTube channel.
ad_group_criterion_youtube_video_video_idTEXTAd group criterion youtube video video idYouTube video id as it appears on the YouTube watch page.
ad_group_effective_cpc_bid_microsNUMERICAd group effective cpc bid microsValue 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_excluded_parent_asset_field_typesTEXTAd group excluded parent asset field typesThe 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_explorer_auto_optimizer_setting_opt_inBOOLEANAd group explorer auto optimizer setting opt inIndicates whether the optimizer is turned on.
ad_group_idNUMERICAd group idThe ID of the ad group.
ad_group_labelsTEXTAd group labelsThe resource names of labels attached to this ad group.
ad_group_nameTEXTAd group nameThe 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_microsNUMERICAd group percent cpc bid microsThe 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_nameTEXTAd group resource nameThe resource name of the ad group. Ad group resource names have the form: customers/{customer_id}/adGroups/{ad_group_id}
ad_group_statusTEXTAd group statusThe status of the ad group.
ad_group_target_cpa_microsNUMERICAd group target cpa microsThe 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_microsNUMERICAd group target cpm microsAverage amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
ad_group_target_roasNUMERICAd group target roasThe 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_typeTEXTAd group typeThe type of the ad group.
ad_hotel_adTEXTAd hotel adDetails pertaining to a hotel ad.
ad_idTEXTAd idThe ID of the ad.
ad_image_ad_image_urlTEXTAd image ad image urlURL of the full size image.
ad_image_ad_media_fileTEXTAd image ad media fileThe MediaFile resource to use for the image.
ad_image_ad_mime_typeTEXTAd image ad mime typeThe mime type of the image.
ad_image_ad_nameTEXTAd image ad nameThe 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_heightNUMERICAd image ad pixel heightHeight in pixels of the full size image.
ad_image_ad_pixel_widthNUMERICAd image ad pixel widthWidth in pixels of the full size image.
ad_image_ad_preview_image_urlTEXTAd image ad preview image urlURL of the preview size image.
ad_image_ad_preview_pixel_heightNUMERICAd image ad preview pixel heightHeight in pixels of the preview size image.
ad_image_ad_preview_pixel_widthNUMERICAd image ad preview pixel widthWidth in pixels of the preview size image.
ad_legacy_app_install_adTEXTAd legacy app install adDetails pertaining to a legacy app install ad.
ad_legacy_responsive_display_ad_accent_colorTEXTAd legacy responsive display ad accent colorThe accent color of the ad in hexadecimal, for example, #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_colorBOOLEANAd legacy responsive display ad allow flexible colorAdvertiser'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_nameTEXTAd legacy responsive display ad business nameThe business name in the ad.
ad_legacy_responsive_display_ad_call_to_action_textTEXTAd legacy responsive display ad call to action textThe call-to-action text for the ad.
ad_legacy_responsive_display_ad_descriptionTEXTAd legacy responsive display ad descriptionThe description of the ad.
ad_legacy_responsive_display_ad_format_settingTEXTAd legacy responsive display ad format settingSpecifies which format the ad will be served in. Default is ALL_FORMATS.
ad_legacy_responsive_display_ad_logo_imageTEXTAd legacy responsive display ad logo imageThe MediaFile resource name of the logo image used in the ad.
ad_legacy_responsive_display_ad_long_headlineTEXTAd legacy responsive display ad long headlineThe long version of the ad's headline.
ad_legacy_responsive_display_ad_main_colorTEXTAd legacy responsive display ad main colorThe main color of the ad in hexadecimal, for example, #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_imageTEXTAd legacy responsive display ad marketing imageThe MediaFile resource name of the marketing image used in the ad.
ad_legacy_responsive_display_ad_price_prefixTEXTAd legacy responsive display ad price prefixPrefix before price. For example, 'as low as'.
ad_legacy_responsive_display_ad_promo_textTEXTAd legacy responsive display ad promo textPromotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
ad_legacy_responsive_display_ad_short_headlineTEXTAd legacy responsive display ad short headlineThe short version of the ad's headline.
ad_legacy_responsive_display_ad_square_logo_imageTEXTAd legacy responsive display ad square logo imageThe MediaFile resource name of the square logo image used in the ad.
ad_legacy_responsive_display_ad_square_marketing_imageTEXTAd legacy responsive display ad square marketing imageThe MediaFile resource name of the square marketing image used in the ad.
ad_local_ad_call_to_actionsTEXTAd local ad call to actionsList 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_descriptionsTEXTAd local ad descriptionsList 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_headlinesTEXTAd local ad headlinesList 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_imagesTEXTAd local ad logo imagesList 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_logo_images_assetTEXTAd local ad logo images assetThe Asset resource name of this image.
ad_local_ad_marketing_imagesTEXTAd local ad marketing imagesList 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_marketing_images_assetTEXTAd local ad marketing images assetThe Asset resource name of this image.
ad_local_ad_path1TEXTAd local ad path1First part of optional text that can be appended to the URL in the ad.
ad_local_ad_path2TEXTAd local ad path2Second 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_videosTEXTAd local ad videosList of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified.
ad_local_ad_videos_assetTEXTAd local ad videos assetThe Asset resource name of this video.
ad_nameTEXTAd nameThe 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_network_typeTEXTAd network typeAd network type.
ad_network_type1TEXTAd network type1Ad network type.
ad_network_type2TEXTAd network type2Ad network type.
ad_resource_nameTEXTAd resource nameThe resource name of the ad. Ad resource names have the form: customers/{customer_id}/ads/{ad_id}
ad_responsive_display_ad_accent_colorTEXTAd responsive display ad accent colorThe accent color of the ad in hexadecimal, for example, #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_colorBOOLEANAd responsive display ad allow flexible colorAdvertiser'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_nameTEXTAd responsive display ad business nameThe advertiser/brand name. Maximum display width is 25.
ad_responsive_display_ad_call_to_action_textTEXTAd responsive display ad call to action textThe call-to-action text for the ad. Maximum display width is 30.
ad_responsive_display_ad_control_spec_enable_asset_enhancementsBOOLEANAd responsive display ad control spec enable asset enhancementsWhether the advertiser has opted into the asset enhancements feature.
ad_responsive_display_ad_control_spec_enable_autogen_videoBOOLEANAd responsive display ad control spec enable autogen videoWhether the advertiser has opted into auto-gen video feature.
ad_responsive_display_ad_descriptionsTEXTAd responsive display ad descriptionsDescriptive 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_settingTEXTAd responsive display ad format settingSpecifies which format the ad will be served in. Default is ALL_FORMATS.
ad_responsive_display_ad_headlinesTEXTAd responsive display ad headlinesShort 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_imagesTEXTAd responsive display ad logo imagesLogo 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_logo_images_assetTEXTAd responsive display ad logo images assetThe Asset resource name of this image.
ad_responsive_display_ad_long_headlineTEXTAd responsive display ad long headlineA required long format headline. The maximum length is 90 characters.
ad_responsive_display_ad_main_colorTEXTAd responsive display ad main colorThe main color of the ad in hexadecimal, for example, #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
ad_responsive_display_ad_marketing_imagesTEXTAd responsive display ad marketing imagesMarketing 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_marketing_images_assetTEXTAd responsive display ad marketing images assetThe Asset resource name of this image.
ad_responsive_display_ad_price_prefixTEXTAd responsive display ad price prefixPrefix before price. For example, 'as low as'.
ad_responsive_display_ad_promo_textTEXTAd responsive display ad promo textPromotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
ad_responsive_display_ad_square_logo_imagesTEXTAd responsive display ad square logo imagesSquare 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_logo_images_assetTEXTAd responsive display ad square logo images assetThe Asset resource name of this image.
ad_responsive_display_ad_square_marketing_imagesTEXTAd responsive display ad square marketing imagesSquare 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_square_marketing_images_assetTEXTAd responsive display ad square marketing images assetThe Asset resource name of this image.
ad_responsive_display_ad_youtube_videosTEXTAd responsive display ad youtube videosOptional YouTube videos for the ad. A maximum of 5 videos can be specified.
ad_responsive_display_ad_youtube_videos_assetTEXTAd responsive display ad youtube videos assetThe Asset resource name of this video.
ad_responsive_search_ad_descriptionsTEXTAd responsive search ad descriptionsList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
ad_responsive_search_ad_headlinesTEXTAd responsive search ad headlinesList of text assets for headlines. When the ad serves the headlines will be selected from this list.
ad_responsive_search_ad_path1TEXTAd responsive search ad path1First part of text that can be appended to the URL in the ad.
ad_responsive_search_ad_path2TEXTAd responsive search ad path2Second 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_rotation_modeTEXTAd rotation modeThe ad rotation mode of the ad group.
ad_schedule_day_of_weekTEXTAd schedule day of weekDay of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
ad_schedule_end_hourNUMERICAd schedule end hourEnding 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.
ad_schedule_end_minuteTEXTAd schedule end minuteMinutes 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.
ad_schedule_start_hourNUMERICAd schedule start hourStarting 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.
ad_schedule_start_minuteTEXTAd schedule start minuteMinutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
ad_serving_optimization_statusTEXTAd serving optimization statusThe ad serving optimization status of the campaign.
ad_shopping_comparison_listing_ad_headlineTEXTAd shopping comparison listing ad headlineHeadline of the ad. This field is required. Allowed length is between 25 and 45 characters.
ad_shopping_product_adTEXTAd shopping product adDetails pertaining to a Shopping product ad.
ad_shopping_smart_adTEXTAd shopping smart adDetails pertaining to a Smart Shopping ad.
ad_smart_campaign_ad_descriptionsTEXTAd smart campaign ad descriptionsList of text assets, each of which corresponds to a description when the ad serves. This list consists of a minimum of 2 and up to 4 text assets.
ad_smart_campaign_ad_headlinesTEXTAd smart campaign ad headlinesList of text assets, each of which corresponds to a headline when the ad serves. This list consists of a minimum of 3 and up to 15 text assets.
ad_strengthTEXTAd strengthOverall ad strength for this ad group ad.
ad_system_managed_resource_sourceTEXTAd system managed resource sourceIf this ad is system managed, then this field will indicate the source. This field is read-only.
ad_text_ad_description1TEXTAd text ad description1The first line of the ad's description.
ad_text_ad_description2TEXTAd text ad description2The second line of the ad's description.
ad_text_ad_headlineTEXTAd text ad headlineThe headline of the ad.
ad_tracking_url_templateTEXTAd tracking url templateThe URL template for constructing a tracking URL.
ad_typeTEXTAd typeThe type of ad.
ad_url_collectionsTEXTAd url collectionsAdditional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
ad_url_custom_parametersTEXTAd url custom parametersThe 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, use url custom parameter operations.
ad_video_ad_bumper_companion_banner_assetTEXTAd video ad bumper companion banner assetThe Asset resource name of this image.
ad_video_ad_in_feed_description1TEXTAd video ad in feed description1First text line for the ad.
ad_video_ad_in_feed_description2TEXTAd video ad in feed description2Second text line for the ad.
ad_video_ad_in_feed_headlineTEXTAd video ad in feed headlineThe headline of the ad.
ad_video_ad_in_feed_thumbnailTEXTAd video ad in feed thumbnailVideo thumbnail image to use.
ad_video_ad_in_stream_action_button_labelTEXTAd video ad in stream action button labelLabel 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_headlineTEXTAd video ad in stream action headlineAdditional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
ad_video_ad_in_stream_companion_banner_assetTEXTAd video ad in stream companion banner assetThe Asset resource name of this image.
ad_video_ad_non_skippable_action_button_labelTEXTAd video ad non skippable action button labelLabel on the "Call To Action" button taking the user to the video ad's final URL.
ad_video_ad_non_skippable_action_headlineTEXTAd video ad non skippable action headlineAdditional text displayed with the "Call To Action" button to give context and encourage clicking on the button.
ad_video_ad_non_skippable_companion_banner_assetTEXTAd video ad non skippable companion banner assetThe Asset resource name of this image.
ad_video_ad_out_stream_descriptionTEXTAd video ad out stream descriptionThe description line.
ad_video_ad_out_stream_headlineTEXTAd video ad out stream headlineThe headline of the ad.
ad_video_ad_video_assetTEXTAd video ad video assetThe Asset resource name of this video.
ad_video_responsive_ad_breadcrumb1TEXTAd video responsive ad breadcrumb1First part of text that appears in the ad with the displayed URL.
ad_video_responsive_ad_breadcrumb2TEXTAd video responsive ad breadcrumb2Second part of text that appears in the ad with the displayed URL.
ad_video_responsive_ad_call_to_actionsTEXTAd video responsive ad call to actionsList of text assets used for the button, for example, the "Call To Action" button. Currently, only a single value for the button is supported.
ad_video_responsive_ad_companion_bannersTEXTAd video responsive ad companion bannersList of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
ad_video_responsive_ad_companion_banners_assetTEXTAd video responsive ad companion banners assetThe Asset resource name of this image.
ad_video_responsive_ad_descriptionsTEXTAd video responsive ad descriptionsList of text assets used for the description. Currently, only a single value for the description is supported.
ad_video_responsive_ad_headlinesTEXTAd video responsive ad headlinesList of text assets used for the short headline, for example, the "Call To Action" banner. Currently, only a single value for the short headline is supported.
ad_video_responsive_ad_long_headlinesTEXTAd video responsive ad long headlinesList of text assets used for the long headline. Currently, only a single value for the long headline is supported.
ad_video_responsive_ad_videosTEXTAd video responsive ad videosList of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.
ad_video_responsive_ad_videos_assetTEXTAd video responsive ad videos assetThe Asset resource name of this video.
adnetwork_conversionsNUMERICAdnetwork conversionsThe total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
adnetwork_revenueNUMERICAdnetwork revenueThe value of all conversions.
advertising_channel_sub_typeTEXTAdvertising channel sub typeOptional 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_typeTEXTAdvertising channel typeThe 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.
age_range_typeTEXTAge range typeType of the age range.
age_range_view_resource_nameTEXTAge range view resource nameThe resource name of the age range view. Age range view resource names have the form: customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}
aggregator_idNUMERICAggregator idAggregator ID of the product.
all_conversion_rateNUMERICAll conversion rateAll conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
all_conversion_valueNUMERICAll conversion valueThe value of all conversions.
all_conversionsNUMERICAll conversionsThe total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
all_conversions_by_conversion_dateNUMERICAll conversions by conversion dateThe 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_click_to_callNUMERICAll conversions from click to callThe number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
all_conversions_from_directionsNUMERICAll conversions from directionsThe number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.
all_conversions_from_interactions_rateNUMERICAll conversions from interactions rateAll conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
all_conversions_from_interactions_value_per_interactionNUMERICAll conversions from interactions value per interactionThe value of all conversions from interactions divided by the total number of interactions.
all_conversions_from_menuNUMERICAll conversions from menuThe number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
all_conversions_from_orderNUMERICAll conversions from orderThe number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
all_conversions_from_other_engagementNUMERICAll conversions from other engagementThe number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
all_conversions_from_store_visitNUMERICAll conversions from store visitEstimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
all_conversions_from_store_websiteNUMERICAll conversions from store websiteThe number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
all_conversions_valueNUMERICAll conversions valueThe value of all conversions.
all_conversions_value_by_conversion_dateNUMERICAll conversions value by conversion dateThe 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_costNUMERICAll conversions value per costThe value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
amountNUMERICAmountThe 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.
amount_microsNUMERICAmount microsThe 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.
app_campaign_setting_app_idTEXTApp campaign setting app idA string that uniquely identifies a mobile application.
app_campaign_setting_app_storeTEXTApp campaign setting app storeThe application store that distributes this specific app.
app_campaign_setting_bidding_strategy_goal_typeTEXTApp campaign setting bidding strategy goal typeRepresents the goal which the bidding strategy of this app campaign should optimize towards.
app_payment_model_typeTEXTApp payment model typeType of the app payment model.
approval_statusTEXTApproval statusApproval status of the criterion.
asset_interaction_target_assetTEXTAsset interaction target assetThe asset resource name.
asset_interaction_target_interaction_on_this_assetBOOLEANAsset interaction target interaction on this assetOnly used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
auction_insight_domainTEXTAuction insight domainDomain (visible URL) of a participant in the Auction Insights report.
auction_insight_search_absolute_top_impression_percentageNUMERICAuction insight search absolute top impression percentageThis metric is part of the Auction Insights report, and tells how often the ads of another participant showed as the very first ad above the organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.
auction_insight_search_impression_shareNUMERICAuction insight search impression shareThis metric is part of the Auction Insights report, and tells the percentage of impressions that another participant obtained, over the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.
auction_insight_search_outranking_shareNUMERICAuction insight search outranking shareThis metric is part of the Auction Insights report, and tells the percentage of impressions that your ads outranked (showed above) another participant in the auction, compared to the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.
auction_insight_search_overlap_rateNUMERICAuction insight search overlap rateThis metric is part of the Auction Insights report, and tells how often another participant's ad received an impression when your ad also received an impression. This metric is not publicly available.
auction_insight_search_position_above_rateNUMERICAuction insight search position above rateThis metric is part of the Auction Insights report, and tells how often another participant's ad was shown in a higher position than yours, when both of your ads were shown at the same page. This metric is not publicly available.
auction_insight_search_top_impression_percentageNUMERICAuction insight search top impression percentageThis metric is part of the Auction Insights report, and tells how often the ads of another participant showed above the organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.
audience_audienceTEXTAudience audienceThe Audience resource name.
audience_descriptionTEXTAudience descriptionDescription of this audience.
audience_dimensionsTEXTAudience dimensionsPositive dimensions specifying the audience composition.
audience_dimensions_audience_segments_segments_custom_audience_custom_audienceTEXTAudience dimensions audience segments segments custom audience custom audienceThe custom audience resource.
audience_dimensions_audience_segments_segments_detailed_demographic_detailed_demographicTEXTAudience dimensions audience segments segments detailed demographic detailed demographicThe detailed demographic resource.
audience_dimensions_audience_segments_segments_life_event_life_eventTEXTAudience dimensions audience segments segments life event life eventThe life event resource.
audience_dimensions_audience_segments_segments_user_interest_user_interest_categoryTEXTAudience dimensions audience segments segments user interest user interest categoryThe user interest resource.
audience_dimensions_audience_segments_segments_user_list_user_listTEXTAudience dimensions audience segments segments user list user listThe user list resource.
audience_exclusion_dimensionTEXTAudience exclusion dimensionNegative dimension specifying the audience composition.
audience_exclusion_dimension_exclusions_user_list_user_listTEXTAudience exclusion dimension exclusions user list user listThe user list resource.
audience_idNUMERICAudience idID of the audience.
audience_nameTEXTAudience nameRequired. Name of the audience. It should be unique across all audiences. It must have a minimum length of 1 and maximum length of 255.
audience_resource_nameTEXTAudience resource nameThe resource name of the audience. Audience names have the form: customers/{customer_id}/audiences/{audience_id}
audience_setting_use_audience_groupedBOOLEANAudience setting use audience groupedIf true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
audience_statusTEXTAudience statusStatus of this audience. Indicates whether the audience is enabled or removed.
auto_tagging_enabledBOOLEANAuto tagging enabledWhether auto-tagging is enabled for the customer.
availabilitiesTEXTAvailabilitiesAvailability information of the user interest.
average_costNUMERICAverage costThe average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
average_cpcNUMERICAverage cpcThe total cost of all clicks divided by the total number of clicks received.
average_cpeNUMERICAverage cpeThe 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_cpmNUMERICAverage cpmAverage cost-per-thousand impressions (CPM).
average_cpvNUMERICAverage cpvThe 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_viewsNUMERICAverage page viewsAverage number of pages viewed per session.
average_pageviewsNUMERICAverage pageviewsAverage number of pages viewed per session.
average_time_on_siteNUMERICAverage time on siteTotal duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
base_ad_groupTEXTBase ad groupFor 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.
base_ad_group_idTEXTBase ad group idFor 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.
base_campaignTEXTBase campaignThe 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.
base_campaign_idTEXTBase campaign idThe 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.
basic_user_list_actionsTEXTBasic user list actionsActions associated with this user list.
benchmark_average_max_cpcNUMERICBenchmark average max cpcAn indication of how other advertisers are bidding on similar products.
bid_modifierNUMERICBid modifierThe 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.
biddable_app_install_conversionsNUMERICBiddable app install conversionsNumber of app installs.
biddable_app_post_install_conversionsNUMERICBiddable app post install conversionsNumber of in-app actions.
bidding_strategyTEXTBidding strategyPortfolio bidding strategy used by campaign.
bidding_strategy_campaign_countNUMERICBidding strategy campaign countThe number of campaigns attached to this bidding strategy. This field is read-only.
bidding_strategy_currency_codeTEXTBidding strategy currency codeThe 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_codeTEXTBidding strategy effective currency codeThe 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_cpcTEXTBidding strategy enhanced cpcA 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_idTEXTBidding strategy idPortfolio bidding strategy used by campaign.
bidding_strategy_maximize_conversion_value_cpc_bid_ceiling_microsNUMERICBidding strategy maximize conversion value cpc bid ceiling microsMaximum 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_microsNUMERICBidding strategy maximize conversion value cpc bid floor microsMinimum 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_roasNUMERICBidding strategy maximize conversion value target roasThe 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_microsNUMERICBidding strategy maximize conversions cpc bid ceiling microsMaximum 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_microsNUMERICBidding strategy maximize conversions cpc bid floor microsMinimum 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_microsNUMERICBidding strategy maximize conversions target cpa microsThe 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_nameTEXTBidding strategy nameThe 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_countNUMERICBidding strategy non removed campaign countThe number of non-removed campaigns attached to this bidding strategy. This field is read-only.
bidding_strategy_resource_nameTEXTBidding strategy resource nameThe resource name of the bidding strategy. Bidding strategy resource names have the form: customers/{customer_id}/biddingStrategies/{bidding_strategy_id}
bidding_strategy_sourceTEXTBidding strategy sourceThe 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_statusTEXTBidding strategy statusThe status of the bidding strategy. This field is read-only.
bidding_strategy_system_statusTEXTBidding strategy system statusThe system status of the campaign's bidding strategy.
bidding_strategy_target_cpa_cpc_bid_ceiling_microsNUMERICBidding strategy target cpa cpc bid ceiling microsMaximum 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_microsNUMERICBidding strategy target cpa cpc bid floor microsMinimum 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_microsNUMERICBidding strategy target cpa target cpa microsAverage 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_microsNUMERICBidding strategy target impression share cpc bid ceiling microsThe 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_locationTEXTBidding strategy target impression share locationThe targeted location on the search results page.
bidding_strategy_target_impression_share_location_fraction_microsNUMERICBidding strategy target impression share location fraction microsThe chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
bidding_strategy_target_roas_cpc_bid_ceiling_microsNUMERICBidding strategy target roas cpc bid ceiling microsMaximum 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_microsNUMERICBidding strategy target roas cpc bid floor microsMinimum 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_roasNUMERICBidding strategy target roas target roasRequired. The chosen 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_microsNUMERICBidding strategy target spend cpc bid ceiling microsMaximum 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_microsNUMERICBidding strategy target spend target spend microsThe 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.html for details.
bidding_strategy_typeTEXTBidding strategy typeThe 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.
bounce_rateNUMERICBounce ratePercentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
brandTEXTBrandBrand of the product.
budget_campaign_association_status_campaignTEXTBudget campaign association status campaignThe campaign resource name.
budget_campaign_association_status_statusTEXTBudget campaign association status statusBudget campaign association status.
budget_idTEXTBudget idThe budget of the campaign.
call_reporting_setting_call_conversion_actionTEXTCall reporting setting call conversion actionCustomer-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_enabledBOOLEANCall reporting setting call conversion reporting enabledWhether to enable call conversion reporting.
call_reporting_setting_call_reporting_enabledBOOLEANCall reporting setting call reporting enabledEnable reporting of phone call events by redirecting them through Google System.
campaignTEXTCampaignThe 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_accessible_bidding_strategyTEXTCampaign accessible bidding strategyResource 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_statusTEXTCampaign ad serving optimization statusThe ad serving optimization status of the campaign.
campaign_app_campaign_setting_app_idTEXTCampaign app campaign setting app idA string that uniquely identifies a mobile application.
campaign_app_campaign_setting_app_storeTEXTCampaign app campaign setting app storeThe application store that distributes this specific app.
campaign_app_campaign_setting_bidding_strategy_goal_typeTEXTCampaign app campaign setting bidding strategy goal typeRepresents the goal which the bidding strategy of this app campaign should optimize towards.
campaign_audience_setting_use_audience_groupedBOOLEANCampaign audience setting use audience groupedIf true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
campaign_audience_view_resource_nameTEXTCampaign audience view resource nameThe resource name of the campaign audience view. Campaign audience view resource names have the form: customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}
campaign_bidding_strategy_system_statusTEXTCampaign bidding strategy system statusThe system status of the campaign's bidding strategy.
campaign_budgetTEXTCampaign budgetThe budget of the campaign.
campaign_budget_delivery_methodTEXTCampaign budget delivery methodThe delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
campaign_budget_idTEXTCampaign budget idThe 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_nameTEXTCampaign budget nameThe 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).
NUMERICCampaign budget recommended budget estimated change weekly clicksThe estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
NUMERICCampaign budget recommended budget estimated change weekly cost microsThe 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.
NUMERICCampaign budget recommended budget estimated change weekly interactionsThe estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
NUMERICCampaign budget recommended budget estimated change weekly viewsThe estimated change in weekly views if the recommended budget is applied. This field is read-only.
campaign_budget_reference_countNUMERICCampaign budget reference countThe number of campaigns actively using the budget. This field is read-only.
campaign_budget_resource_nameTEXTCampaign budget resource nameThe resource name of the campaign budget. Campaign budget resource names have the form: customers/{customer_id}/campaignBudgets/{campaign_budget_id}
campaign_budget_statusTEXTCampaign budget statusThe status of this campaign budget. This field is read-only.
campaign_budget_typeTEXTCampaign budget typeThe type of the campaign budget.
campaign_campaign_groupTEXTCampaign campaign groupThe campaign group this campaign belongs to.
campaign_commission_commission_rate_microsNUMERICCampaign commission commission rate microsCommission 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_countNUMERICCampaign countThe number of campaigns attached to this bidding strategy. This field is read-only.
campaign_criterion_ad_schedule_day_of_weekTEXTCampaign criterion ad schedule day of weekDay 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_hourNUMERICCampaign criterion ad schedule end hourEnding 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_minuteTEXTCampaign criterion ad schedule end minuteMinutes 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_hourNUMERICCampaign criterion ad schedule start hourStarting 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_minuteTEXTCampaign criterion ad schedule start minuteMinutes 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_typeTEXTCampaign criterion age range typeType of the age range.
campaign_criterion_bid_modifierNUMERICCampaign criterion bid modifierThe 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_campaignTEXTCampaign criterion campaignThe campaign to which the criterion belongs.
campaign_criterion_carrier_carrier_constantTEXTCampaign criterion carrier carrier constantThe Carrier constant resource name.
campaign_criterion_combined_audience_combined_audienceTEXTCampaign criterion combined audience combined audienceThe CombinedAudience resource name.
campaign_criterion_content_label_typeTEXTCampaign criterion content label typeContent label type, required for CREATE operations.
campaign_criterion_custom_affinity_custom_affinityTEXTCampaign criterion custom affinity custom affinityThe CustomInterest resource name.
campaign_criterion_custom_audience_custom_audienceTEXTCampaign criterion custom audience custom audienceThe CustomAudience resource name.
campaign_criterion_device_typeTEXTCampaign criterion device typeType of the device.
campaign_criterion_display_nameTEXTCampaign criterion display nameThe display name of the criterion. This field is ignored for mutates.
campaign_criterion_gender_typeTEXTCampaign criterion gender typeType of the gender.
campaign_criterion_income_range_typeTEXTCampaign criterion income range typeType of the income range.
campaign_criterion_ip_block_ip_addressTEXTCampaign criterion ip block ip addressThe IP address of this IP block.
campaign_criterion_keyword_match_typeTEXTCampaign criterion keyword match typeThe match type of the keyword.
campaign_criterion_keyword_theme_free_form_keyword_themeTEXTCampaign criterion keyword theme free form keyword themeFree-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
campaign_criterion_keyword_theme_keyword_theme_constantTEXTCampaign criterion keyword theme keyword theme constantThe resource name of a Smart Campaign keyword theme constant. keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}
campaign_criterion_language_language_constantTEXTCampaign criterion language language constantThe language constant resource name.
campaign_criterion_listing_scope_dimensionsTEXTCampaign criterion listing scope dimensionsScope of the campaign criterion.
campaign_criterion_listing_scope_dimensions_hotel_city_city_criterionTEXTCampaign criterion listing scope dimensions hotel city city criterionThe Geo Target Constant resource name.
campaign_criterion_listing_scope_dimensions_hotel_country_region_country_region_criterionTEXTCampaign criterion listing scope dimensions hotel country region country region criterionThe Geo Target Constant resource name.
campaign_criterion_listing_scope_dimensions_hotel_state_state_criterionTEXTCampaign criterion listing scope dimensions hotel state state criterionThe Geo Target Constant resource name.
campaign_criterion_location_geo_target_constantTEXTCampaign criterion location geo target constantThe geo target constant resource name.
campaign_criterion_location_groupTEXTCampaign criterion location groupLocation Group
campaign_criterion_location_group_feedTEXTCampaign criterion location group feedFeed specifying locations for targeting. This is required and must be set in CREATE operations.
campaign_criterion_location_group_geo_target_constantsTEXTCampaign criterion location group geo target constantsGeo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
campaign_criterion_mobile_app_category_mobile_app_category_constantTEXTCampaign criterion mobile app category mobile app category constantThe mobile app category constant resource name.
campaign_criterion_mobile_application_app_idTEXTCampaign criterion mobile application app idA 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 (for example, "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 (for example, "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_nameTEXTCampaign criterion mobile application nameName of this mobile application.
campaign_criterion_mobile_device_mobile_device_constantTEXTCampaign criterion mobile device mobile device constantThe mobile device constant resource name.
campaign_criterion_operating_system_version_operating_system_version_constantTEXTCampaign criterion operating system version operating system version constantThe operating system version constant resource name.
campaign_criterion_parental_status_typeTEXTCampaign criterion parental status typeType of the parental status.
campaign_criterion_placement_urlTEXTCampaign criterion placement urlURL of the placement. For example, "http://www.domain.com".
campaign_criterion_proximity_address_city_nameTEXTCampaign criterion proximity address city nameName of the city.
campaign_criterion_proximity_address_country_codeTEXTCampaign criterion proximity address country codeCountry code.
campaign_criterion_proximity_address_postal_codeTEXTCampaign criterion proximity address postal codePostal code.
campaign_criterion_proximity_address_province_codeTEXTCampaign criterion proximity address province codeProvince or state code.
campaign_criterion_proximity_address_province_nameTEXTCampaign criterion proximity address province nameProvince or state name.
campaign_criterion_proximity_address_street_addressTEXTCampaign criterion proximity address street addressStreet address line 1.
campaign_criterion_proximity_geo_point_latitude_in_micro_degreesNUMERICCampaign criterion proximity geo point latitude in micro degreesMicro degrees for the latitude.
campaign_criterion_proximity_geo_point_longitude_in_micro_degreesNUMERICCampaign criterion proximity geo point longitude in micro degreesMicro degrees for the longitude.
campaign_criterion_proximity_radiusNUMERICCampaign criterion proximity radiusThe radius of the proximity.
campaign_criterion_proximity_radius_unitsTEXTCampaign criterion proximity radius unitsThe unit of measurement of the radius. Default is KILOMETERS.
campaign_criterion_resource_nameTEXTCampaign criterion resource nameThe resource name of the campaign criterion. Campaign criterion resource names have the form: customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}
campaign_criterion_statusTEXTCampaign criterion statusThe status of the criterion.
campaign_criterion_topic_pathTEXTCampaign criterion topic pathThe 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_constantTEXTCampaign criterion topic topic constantThe Topic Constant resource name.
campaign_criterion_user_interest_user_interest_categoryTEXTCampaign criterion user interest user interest categoryThe UserInterest resource name.
campaign_criterion_user_list_user_listTEXTCampaign criterion user list user listThe User List resource name.
campaign_criterion_webpage_conditionsTEXTCampaign criterion webpage conditionsConditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
campaign_criterion_webpage_coverage_percentageNUMERICCampaign criterion webpage coverage percentageWebsite 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_nameTEXTCampaign criterion webpage criterion nameThe 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_urlsTEXTCampaign criterion webpage sample sample urlsWebpage sample urls
campaign_criterion_youtube_channel_channel_idTEXTCampaign criterion youtube channel channel idThe YouTube uploader channel id or the channel code of a YouTube channel.
campaign_criterion_youtube_video_video_idTEXTCampaign criterion youtube video video idYouTube video id as it appears on the YouTube watch page.
campaign_dynamic_search_ads_setting_domain_nameTEXTCampaign dynamic search ads setting domain nameRequired. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
campaign_dynamic_search_ads_setting_feedsTEXTCampaign dynamic search ads setting feedsThe list of page feeds associated with the campaign.
campaign_dynamic_search_ads_setting_language_codeTEXTCampaign dynamic search ads setting language codeRequired. The language code specifying the language of the domain, for example, "en".
campaign_dynamic_search_ads_setting_use_supplied_urls_onlyBOOLEANCampaign dynamic search ads setting use supplied urls onlyWhether the campaign uses advertiser supplied URLs exclusively.
campaign_excluded_parent_asset_field_typesTEXTCampaign excluded parent asset field typesThe 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_frequency_capsTEXTCampaign frequency capsA list that limits how often each user will see this campaign's ads.
campaign_geo_target_type_setting_negative_geo_target_typeTEXTCampaign geo target type setting negative geo target typeThe setting used for negative geotargeting in this particular campaign.
campaign_geo_target_type_setting_positive_geo_target_typeTEXTCampaign geo target type setting positive geo target typeThe setting used for positive geotargeting in this particular campaign.
campaign_groupTEXTCampaign groupThe campaign group this campaign belongs to.
campaign_hotel_setting_hotel_center_idNUMERICCampaign hotel setting hotel center idThe linked Hotel Center account.
campaign_idTEXTCampaign idThe ID of the campaign.
campaign_labelsTEXTCampaign labelsThe resource names of labels attached to this campaign.
campaign_local_campaign_setting_location_source_typeTEXTCampaign local campaign setting location source typeThe location source type for this local campaign.
campaign_local_services_campaign_settings_category_bidsTEXTCampaign local services campaign settings category bidsCategorical level bids associated with MANUAL_CPA bidding strategy.
campaign_manual_cpaTEXTCampaign manual cpaStandard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
campaign_manual_cpc_enhanced_cpc_enabledBOOLEANCampaign manual cpc enhanced cpc enabledWhether bids are to be enhanced based on conversion optimizer data.
campaign_manual_cpmTEXTCampaign manual cpmStandard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
campaign_manual_cpvTEXTCampaign manual cpvA bidding strategy that pays a configurable amount per video view.
campaign_maximize_conversions_target_cpa_microsNUMERICCampaign maximize conversions target cpa microsThe 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_nameTEXTCampaign nameThe 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_networkBOOLEANCampaign network settings target content networkWhether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
BOOLEANCampaign network settings target google searchWhether ads will be served with google.com search results.
campaign_network_settings_target_partner_search_networkBOOLEANCampaign network settings target partner search networkWhether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
campaign_network_settings_target_search_networkBOOLEANCampaign network settings target search networkWhether 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_typesTEXTCampaign optimization goal setting optimization goal typesThe list of optimization goal types.
campaign_optimization_scoreNUMERICCampaign optimization scoreOptimization 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_modeTEXTCampaign payment modePayment mode for the campaign.
campaign_percent_cpc_cpc_bid_ceiling_microsNUMERICCampaign percent cpc cpc bid ceiling microsMaximum 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_enabledBOOLEANCampaign percent cpc enhanced cpc enabledAdjusts 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_performance_max_upgrade_performance_max_campaignTEXTCampaign performance max upgrade performance max campaignIndicates which Performance Max campaign the campaign is upgraded to.
campaign_performance_max_upgrade_pre_upgrade_campaignTEXTCampaign performance max upgrade pre upgrade campaignIndicates legacy campaign upgraded to Performance Max.
campaign_performance_max_upgrade_statusTEXTCampaign performance max upgrade statusThe upgrade status of a campaign requested to be upgraded to Performance Max.
campaign_real_time_bidding_setting_opt_inBOOLEANCampaign real time bidding setting opt inWhether the campaign is opted in to real-time bidding.
campaign_resource_nameTEXTCampaign resource nameThe resource name of the campaign. Campaign resource names have the form: customers/{customer_id}/campaigns/{campaign_id}
campaign_selective_optimization_conversion_actionsTEXTCampaign selective optimization conversion actionsThe selected set of conversion actions for optimizing this campaign.
campaign_shopping_setting_campaign_priorityNUMERICCampaign shopping setting campaign priorityPriority 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_localBOOLEANCampaign shopping setting enable localWhether to include local products.
campaign_shopping_setting_feed_labelTEXTCampaign shopping setting feed labelFeed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.
campaign_shopping_setting_merchant_idNUMERICCampaign shopping setting merchant idID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
campaign_shopping_setting_sales_countryTEXTCampaign shopping setting sales countrySales country of products to include in the campaign. Only one of feed_label or sales_country can be set. Field is immutable except for clearing. Once this field is cleared, you must use feed_label if you want to set the sales country.
campaign_shopping_setting_use_vehicle_inventoryBOOLEANCampaign shopping setting use vehicle inventoryWhether to target Vehicle Listing inventory.
campaign_statusTEXTCampaign statusThe status of the campaign. When a new campaign is added, the status defaults to ENABLED.
campaign_target_cpa_cpc_bid_ceiling_microsNUMERICCampaign target cpa cpc bid ceiling microsMaximum 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_microsNUMERICCampaign target cpa cpc bid floor microsMinimum 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_microsNUMERICCampaign target cpa target cpa microsAverage CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
campaign_target_cpmTEXTCampaign target cpmA bidding strategy that automatically optimizes cost per thousand impressions.
campaign_target_impression_share_cpc_bid_ceiling_microsNUMERICCampaign target impression share cpc bid ceiling microsThe 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_locationTEXTCampaign target impression share locationThe targeted location on the search results page.
campaign_target_impression_share_location_fraction_microsNUMERICCampaign target impression share location fraction microsThe chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
campaign_target_roas_cpc_bid_ceiling_microsNUMERICCampaign target roas cpc bid ceiling microsMaximum 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_microsNUMERICCampaign target roas cpc bid floor microsMinimum 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_roasNUMERICCampaign target roas target roasRequired. The chosen 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_microsNUMERICCampaign target spend cpc bid ceiling microsMaximum 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_microsNUMERICCampaign target spend target spend microsThe 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.html for details.
campaign_targeting_setting_target_restrictionsTEXTCampaign targeting setting target restrictionsThe per-targeting-dimension setting to restrict the reach of your campaign or ad group.
campaign_tracking_setting_tracking_urlTEXTCampaign tracking setting tracking urlThe url used for dynamic tracking.
campaign_trial_typeTEXTCampaign trial typeThe type of campaign: normal, draft, or experiment.
campaign_url_expansion_opt_outBOOLEANCampaign url expansion opt outRepresents 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_modeTEXTCampaign vanity pharma vanity pharma display url modeThe display mode for vanity pharma URLs.
campaign_vanity_pharma_vanity_pharma_textTEXTCampaign vanity pharma vanity pharma textThe 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_suitabilityTEXTCampaign video brand safety suitability3-Tier Brand Safety setting for the campaign.
carrier_carrier_constantTEXTCarrier carrier constantThe Carrier constant resource name.
category_l1TEXTCategory l1Bidding category (level 1) of the product.
category_l2TEXTCategory l2Bidding category (level 2) of the product.
category_l3TEXTCategory l3Bidding category (level 3) of the product.
category_l4TEXTCategory l4Bidding category (level 4) of the product.
category_l5TEXTCategory l5Bidding category (level 5) of the product.
channelTEXTChannelChannel of the product.
channel_exclusivityTEXTChannel exclusivityChannel exclusivity of the product.
cityTEXTGeo target cityGeo target city name.
click_typeTEXTClick typeClick type.
clicksNUMERICClicksThe number of clicks.
closing_reasonTEXTClosing reasonIndicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open.
combined_audience_combined_audienceTEXTCombined audience combined audienceThe CombinedAudience resource name.
commission_commission_rate_microsNUMERICCommission commission rate microsCommission 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%).
content_bid_criterion_type_groupTEXTContent bid criterion type groupAllows 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.
content_budget_lost_impression_shareNUMERICContent budget lost impression shareThe 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_shareNUMERICContent impression shareThe 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_label_typeTEXTContent label typeContent label type, required for CREATE operations.
content_rank_lost_impression_shareNUMERICContent rank lost impression shareThe 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.
conversion_actionTEXTConversion actionResource name of the conversion action.
conversion_action_categoryTEXTConversion action categoryConversion action category.
conversion_action_nameTEXTConversion action nameConversion action name.
conversion_adjustmentBOOLEANConversion adjustmentThis segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
conversion_adjustment_lag_bucketTEXTConversion adjustment lag bucketAn enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
conversion_attribution_event_typeTEXTConversion attribution event typeConversion attribution event type.
conversion_category_nameTEXTConversion category nameConversion action category.
conversion_lag_bucketTEXTConversion lag bucketAn enum value representing the number of days between the impression and the conversion.
conversion_last_conversion_dateDATEConversion last conversion dateThe date of the most recent conversion for this conversion action. The date is in the customer's time zone.
conversion_last_received_request_date_timeDATEConversion last received request date timeThe last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (for example, because the tag was fired from a browser that did not previously click an ad from an appropriate advertiser). The date/time is in the customer's time zone.
conversion_or_adjustment_lag_bucketTEXTConversion or adjustment lag bucketAn enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
conversion_rateNUMERICConversion rateConversions 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.
conversion_tracker_idTEXTConversion tracker idResource name of the conversion action.
conversion_tracking_setting_accepted_customer_data_termsBOOLEANConversion tracking setting accepted customer data termsWhether 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_idNUMERICConversion tracking setting conversion tracking idThe conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
conversion_tracking_setting_conversion_tracking_statusTEXTConversion tracking setting conversion tracking statusConversion 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_idNUMERICConversion tracking setting cross account conversion tracking idThe 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_enabledBOOLEANConversion tracking setting enhanced conversions for leads enabledWhether 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.
conversion_tracking_setting_google_ads_conversion_customerTEXTConversion tracking setting google ads conversion customerThe resource name of the customer where conversions are created and managed. This field is read-only.
conversion_type_nameTEXTConversion type nameConversion action name.
conversion_valueNUMERICConversion valueThe 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.
conversion_value_rule_primary_dimensionTEXTConversion value rule primary dimensionPrimary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value rules were applied.
conversionsNUMERICConversionsThe 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_dateNUMERICConversions by conversion dateThe 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_rateNUMERICConversions from interactions rateConversions 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_interactionNUMERICConversions from interactions value per interactionThe 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_valueNUMERICConversions valueThe 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_dateNUMERICConversions value by conversion dateThe 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_costNUMERICConversions value per costThe 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.
costNUMERICCostThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
cost_microsNUMERICCost microsThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
cost_per_all_conversionNUMERICCost per all conversionThe cost of ad interactions divided by all conversions.
cost_per_all_conversionsNUMERICCost per all conversionsThe cost of ad interactions divided by all conversions.
cost_per_conversionNUMERICCost per conversionThe 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_conversionNUMERICCost per current model attributed conversionThe 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.
countryTEXTGeo target country codeGeo target country code.
country_criteria_idTEXTCountry criteria idResource name of the geo target constant for the country of sale of the product.
country_criterion_idNUMERICCountry criterion idCriterion Id for the country.
cpc_bidNUMERICCpc bidThe maximum CPC (cost-per-click) bid.
cpc_bid_microsNUMERICCpc bid microsThe maximum CPC (cost-per-click) bid.
cpc_bid_sourceTEXTCpc bid sourceSource of the effective CPC bid.
cpm_bidNUMERICCpm bidThe maximum CPM (cost-per-thousand viewable impressions) bid.
cpm_bid_microsNUMERICCpm bid microsThe maximum CPM (cost-per-thousand viewable impressions) bid.
cpm_bid_sourceTEXTCpm bid sourceSource of the effective CPM bid.
cpv_bidNUMERICCpv bidThe CPV (cost-per-view) bid.
cpv_bid_microsNUMERICCpv bid microsThe CPV (cost-per-view) bid.
creative_quality_scoreTEXTCreative quality scoreThe performance of the ad compared to other advertisers.
criteriaTEXTCriteriaType of the age range.
criteria_typeTEXTCriteria typeThe type of the criterion.
criterion_idNUMERICCriterion idThe ID of the criterion. This field is ignored for mutates.
crm_based_user_list_app_idTEXTCrm based user list app idA string that uniquely identifies a mobile application from which the data was collected. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.
crm_based_user_list_data_source_typeTEXTCrm based user list data source typeData source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
crm_based_user_list_upload_key_typeTEXTCrm based user list upload key typeMatching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
cross_device_conversionsNUMERICCross device conversionsConversions 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.
ctrPERCENTCtrThe number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
currencyTEXTCurrencyThe currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
currency_codeTEXTCurrency codeThe currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
current_model_attributed_conversion_valueNUMERICCurrent model attributed conversion valueThe 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_conversionsNUMERICCurrent model attributed conversionsShows 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_rateNUMERICCurrent model attributed conversions from interactions rateCurrent 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_interactionNUMERICCurrent model attributed conversions from interactions value per interactionThe 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_valueNUMERICCurrent model attributed conversions valueThe 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_costNUMERICCurrent model attributed conversions value per costThe 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.
custom_affinity_custom_affinityTEXTCustom affinity custom affinityThe CustomInterest resource name.
custom_attribute0TEXTCustom attribute0Custom attribute 0 of the product.
custom_attribute1TEXTCustom attribute1Custom attribute 1 of the product.
custom_attribute2TEXTCustom attribute2Custom attribute 2 of the product.
custom_attribute3TEXTCustom attribute3Custom attribute 3 of the product.
custom_attribute4TEXTCustom attribute4Custom attribute 4 of the product.
custom_audience_custom_audienceTEXTCustom audience custom audienceThe CustomAudience resource name.
custom_intent_custom_intentTEXTCustom intent custom intentThe CustomInterest resource name.
customer_auto_tagging_enabledBOOLEANCustomer auto tagging enabledWhether auto-tagging is enabled for the customer.
customer_call_reporting_setting_call_conversion_actionTEXTCustomer call reporting setting call conversion actionCustomer-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_enabledBOOLEANCustomer call reporting setting call conversion reporting enabledWhether to enable call conversion reporting.
customer_call_reporting_setting_call_reporting_enabledBOOLEANCustomer call reporting setting call reporting enabledEnable reporting of phone call events by redirecting them through Google System.
customer_conversion_tracking_setting_accepted_customer_data_termsBOOLEANCustomer conversion tracking setting accepted customer data termsWhether 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_idNUMERICCustomer conversion tracking setting conversion tracking idThe conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
customer_conversion_tracking_setting_conversion_tracking_statusTEXTCustomer conversion tracking setting conversion tracking statusConversion 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_idNUMERICCustomer conversion tracking setting cross account conversion tracking idThe 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_enabledBOOLEANCustomer conversion tracking setting enhanced conversions for leads enabledWhether 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_customerTEXTCustomer conversion tracking setting google ads conversion customerThe resource name of the customer where conversions are created and managed. This field is read-only.
customer_descriptive_nameTEXTCustomer descriptive nameOptional, non-unique descriptive name of the customer.
customer_final_url_suffixTEXTCustomer final url suffixThe URL template for appending params to the final URL
customer_has_partners_badgeBOOLEANCustomer has partners badgeWhether 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_managerBOOLEANCustomer managerWhether the customer is a manager.
customer_optimization_scoreNUMERICCustomer optimization scoreOptimization 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_weightNUMERICCustomer optimization score weightOptimization 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_reasonsTEXTCustomer pay per conversion eligibility failure reasonsReasons 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_tagTEXTCustomer remarketing setting google global site tagThe Google tag.
customer_resource_nameTEXTCustomer resource nameThe resource name of the customer. Customer resource names have the form: customers/{customer_id}
customer_statusTEXTCustomer statusThe status of the customer.
customer_test_accountBOOLEANCustomer test accountWhether the customer is a test account.
customer_tracking_url_templateTEXTCustomer tracking url templateThe URL template for constructing a tracking URL out of parameters.
dateDATEDateDate to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
day_of_weekTEXTDay of weekDay of the week, for example, MONDAY.
delivery_methodTEXTDelivery methodThe delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
descriptionTEXTDescriptionDescription of this user list.
descriptive_nameTEXTDescriptive nameOptional, non-unique descriptive name of the customer.
deviceTEXTDeviceDevice to which metrics apply.
device_typeTEXTDevice typeType of the device.
dimensionsTEXTDimensionsPositive dimensions specifying the audience composition.
dimensions_audience_segments_segments_custom_audience_custom_audienceTEXTDimensions audience segments segments custom audience custom audienceThe custom audience resource.
dimensions_audience_segments_segments_detailed_demographic_detailed_demographicTEXTDimensions audience segments segments detailed demographic detailed demographicThe detailed demographic resource.
dimensions_audience_segments_segments_life_event_life_eventTEXTDimensions audience segments segments life event life eventThe life event resource.
dimensions_audience_segments_segments_user_interest_user_interest_categoryTEXTDimensions audience segments segments user interest user interest categoryThe user interest resource.
dimensions_audience_segments_segments_user_list_user_listTEXTDimensions audience segments segments user list user listThe user list resource.
disapproval_reasonsTEXTDisapproval reasonsList of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942 This field is read-only.
display_custom_bid_dimensionTEXTDisplay custom bid dimensionAllows 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.
display_nameTEXTDisplay nameThe display name of the criterion. This field is ignored for mutates.
dynamic_search_ads_setting_domain_nameTEXTDynamic search ads setting domain nameRequired. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
dynamic_search_ads_setting_feedsTEXTDynamic search ads setting feedsThe list of page feeds associated with the campaign.
dynamic_search_ads_setting_language_codeTEXTDynamic search ads setting language codeRequired. The language code specifying the language of the domain, for example, "en".
dynamic_search_ads_setting_use_supplied_urls_onlyBOOLEANDynamic search ads setting use supplied urls onlyWhether the campaign uses advertiser supplied URLs exclusively.
effective_cpc_bid_microsNUMERICEffective cpc bid microsValue 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.
effective_cpc_bid_sourceTEXTEffective cpc bid sourceSource of the effective CPC bid.
effective_cpm_bid_microsNUMERICEffective cpm bid microsThe effective CPM (cost-per-thousand viewable impressions) bid.
effective_cpm_bid_sourceTEXTEffective cpm bid sourceSource of the effective CPM bid.
effective_cpv_bid_microsNUMERICEffective cpv bid microsThe effective CPV (cost-per-view) bid.
effective_cpv_bid_sourceTEXTEffective cpv bid sourceSource of the effective CPV bid.
effective_currency_codeTEXTEffective currency codeThe 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.
effective_percent_cpc_bid_microsNUMERICEffective percent cpc bid microsThe effective Percent CPC bid amount.
effective_percent_cpc_bid_sourceTEXTEffective percent cpc bid sourceSource of the effective Percent CPC bid.
effective_target_cpa_microsNUMERICEffective target cpa microsThe effective target CPA (cost-per-acquisition). This field is read-only.
effective_target_cpa_sourceTEXTEffective target cpa sourceSource of the effective target CPA. This field is read-only.
effective_target_roasNUMERICEffective target roasThe effective target ROAS (return-on-ad-spend). This field is read-only.
effective_target_roas_sourceTEXTEffective target roas sourceSource of the effective target ROAS. This field is read-only.
eligible_for_displayBOOLEANEligible for displayIndicates this user list is eligible for Google Display Network. This field is read-only.
BOOLEANEligible for searchIndicates if this user list is eligible for Google Search Network.
end_dateDATEEnd dateThe last day of the campaign in serving customer's timezone in YYYY-MM-DD format.
engagement_rateNUMERICEngagement rateHow 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.
engagementsNUMERICEngagementsThe number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
enhanced_cpcTEXTEnhanced cpcA 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.
estimated_add_clicks_at_first_position_cpcNUMERICEstimated add clicks at first position cpcEstimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
estimated_add_cost_at_first_position_cpcNUMERICEstimated add cost at first position cpcEstimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
excluded_parent_asset_field_typesTEXTExcluded parent asset field typesThe 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.
exclusion_dimensionTEXTExclusion dimensionNegative dimension specifying the audience composition.
exclusion_dimension_exclusions_user_list_user_listTEXTExclusion dimension exclusions user list user listThe user list resource.
experiment_typeTEXTExperiment typeThe type of campaign: normal, draft, or experiment.
explicitly_sharedBOOLEANExplicitly sharedSpecifies 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.
explorer_auto_optimizer_setting_opt_inBOOLEANExplorer auto optimizer setting opt inIndicates whether the optimizer is turned on.
external_conversion_sourceTEXTExternal conversion sourceExternal conversion source.
external_customer_idNUMERICExternal customer idThe ID of the customer.
final_mobile_urlsTEXTFinal mobile urlsThe list of possible final mobile URLs after all cross-domain redirects.
final_urlTEXTFinal urlThe advertiser-specified final URL.
final_url_suffixTEXTFinal url suffixSuffix used to append query parameters to landing pages that are served with parallel tracking.
final_urlsTEXTFinal urlsThe list of possible final URLs after all cross-domain redirects for the ad.
first_page_cpcNUMERICFirst page cpcThe estimate of the CPC bid required for ad to be shown on first page of search results.
first_position_cpcNUMERICFirst position cpcThe estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.
frequency_capsTEXTFrequency capsA list that limits how often each user will see this campaign's ads.
gender_typeTEXTGender typeType of the gender.
gender_view_resource_nameTEXTGender view resource nameThe resource name of the gender view. Gender view resource names have the form: customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}
geo_target_airportTEXTGeo target airportResource name of the geo target constant that represents an airport.
geo_target_cantonTEXTGeo target cantonResource name of the geo target constant that represents a canton.
geo_target_cityTEXTGeo target cityResource name of the geo target constant that represents a city.
geo_target_countryTEXTGeo target countryResource name of the geo target constant that represents a country.
geo_target_countyTEXTGeo target countyResource name of the geo target constant that represents a county.
geo_target_districtTEXTGeo target districtResource name of the geo target constant that represents a district.
geo_target_metroTEXTGeo target metroResource name of the geo target constant that represents a metro.
geo_target_most_specific_locationTEXTGeo target most specific locationResource name of the geo target constant that represents the most specific location.
geo_target_postal_codeTEXTGeo target postal codeResource name of the geo target constant that represents a postal code.
geo_target_provinceTEXTGeo target provinceResource name of the geo target constant that represents a province.
geo_target_regionTEXTGeo target regionResource name of the geo target constant that represents a region.
geo_target_stateTEXTGeo target stateResource name of the geo target constant that represents a state.
geo_target_type_setting_negative_geo_target_typeTEXTGeo target type setting negative geo target typeThe setting used for negative geotargeting in this particular campaign.
geo_target_type_setting_positive_geo_target_typeTEXTGeo target type setting positive geo target typeThe setting used for positive geotargeting in this particular campaign.
geographic_view_country_criterion_idNUMERICGeographic view country criterion idCriterion Id for the country.
geographic_view_location_typeTEXTGeographic view location typeType of the geo targeting of the campaign.
geographic_view_resource_nameTEXTGeographic view resource nameThe resource name of the geographic view. Geographic view resource names have the form: customers/{customer_id}/geographicViews/{country_criterion_id}~{location_type}
gmail_forwardsNUMERICGmail forwardsThe number of times the ad was forwarded to someone else as a message.
gmail_savesNUMERICGmail savesThe number of times someone has saved your Gmail ad to their inbox as a message.
gmail_secondary_clicksNUMERICGmail secondary clicksThe number of clicks to the landing page on the expanded state of Gmail ads.
has_partners_badgeBOOLEANHas partners badgeWhether 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.
BOOLEANHas recommended budgetIndicates whether there is a recommended budget for this campaign budget. This field is read-only.
historical_creative_quality_scoreTEXTHistorical creative quality scoreThe creative historical quality score.
historical_landing_page_quality_scoreTEXTHistorical landing page quality scoreThe quality of historical landing page experience.
historical_quality_scoreNUMERICHistorical quality scoreThe historical quality score.
historical_search_predicted_ctrTEXTHistorical search predicted ctrThe historical search predicted click through rate (CTR).
hotel_average_lead_value_microsNUMERICHotel average lead value microsAverage lead value based on clicks.
hotel_booking_window_daysNUMERICHotel booking window daysHotel booking window in days.
hotel_center_idNUMERICHotel center idHotel center ID.
hotel_check_in_dateDATEHotel check in dateHotel check-in date. Formatted as yyyy-MM-dd.
hotel_check_in_day_of_weekTEXTHotel check in day of weekHotel check-in day of week.
hotel_cityTEXTHotel cityHotel city.
hotel_classNUMERICHotel classHotel class.
hotel_countryTEXTHotel countryHotel country.
hotel_date_selection_typeTEXTHotel date selection typeHotel date selection type.
hotel_eligible_impressionsNUMERICHotel eligible impressionsThe number of impressions that hotel partners could have had given their feed performance.
hotel_length_of_stayNUMERICHotel length of stayHotel length of stay.
hotel_price_bucketTEXTHotel price bucketHotel price bucket.
hotel_price_difference_percentageNUMERICHotel price difference percentageThe average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
hotel_rate_rule_idTEXTHotel rate rule idHotel rate rule ID.
hotel_rate_typeTEXTHotel rate typeHotel rate type.
hotel_setting_hotel_center_idNUMERICHotel setting hotel center idThe linked Hotel Center account.
hotel_stateTEXTHotel stateHotel state.
hourTEXTHourHour of day as a number between 0 and 23, inclusive.
hour_of_dayNUMERICHour of dayHour of day as a number between 0 and 23, inclusive.
idTEXTIdThe ID of the campaign.
impressionsNUMERICImpressionsCount of how often your ad has appeared on a search results page or website on the Google Network.
income_range_typeTEXTIncome range typeType of the income range.
integration_codeTEXTIntegration codeAn ID from external system. It is used by user list sellers to correlate IDs on their systems.
interaction_event_typesTEXTInteraction event typesThe types of payable and free interactions.
interaction_on_this_extensionBOOLEANInteraction on this extensionOnly used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
interaction_rateNUMERICInteraction rateHow 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.
interaction_typesTEXTInteraction typesThe types of payable and free interactions.
interactionsNUMERICInteractionsThe 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_rateNUMERICInvalid click rateThe percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
invalid_clicksNUMERICInvalid clicksNumber of clicks Google considers illegitimate and doesn't charge you for.
ip_block_ip_addressTEXTIp block ip addressThe IP address of this IP block.
is_budget_explicitly_sharedBOOLEANIs budget explicitly sharedSpecifies 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.
is_negativeBOOLEANIs negativeWhether 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.
is_restrictTEXTIs restrictThe per-targeting-dimension setting to restrict the reach of your campaign or ad group.
keyword_ad_group_criterionTEXTKeyword ad group criterionThe AdGroupCriterion resource name.
keyword_criterion_idTEXTKeyword Criterion IDThe Criterion ID for a keyword
keyword_info_match_typeTEXTKeyword info match typeThe match type of the keyword.
keyword_info_textTEXTKeyword info textThe text of the keyword (at most 80 characters and 10 words).
keyword_match_typeTEXTKeyword match typeThe match type of the keyword.
keyword_textTEXTKeyword textThe text of the keyword (at most 80 characters and 10 words).
keyword_theme_free_form_keyword_themeTEXTKeyword theme free form keyword themeFree-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
keyword_theme_keyword_theme_constantTEXTKeyword theme keyword theme constantThe resource name of a Smart Campaign keyword theme constant. keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}
keyword_view_resource_nameTEXTKeyword view resource nameThe resource name of the keyword view. Keyword view resource names have the form: customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}
label_idNUMERICLabel idID of the label. Read only.
label_nameTEXTLabel nameThe name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
label_resource_nameTEXTLabel resource nameName of the resource. Label resource names have the form: customers/{customer_id}/labels/{label_id}
label_statusTEXTLabel statusStatus of the label. Read only.
label_text_label_background_colorTEXTLabel text label background colorBackground color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
label_text_label_descriptionTEXTLabel text label descriptionA short description of the label. The length must be no more than 200 characters.
labelsTEXTLabelsThe resource names of labels attached to this campaign.
landing_page_view_resource_nameTEXTLanding page view resource nameThe resource name of the landing page view. Landing page view resource names have the form: customers/{customer_id}/landingPageViews/{unexpanded_final_url_fingerprint}
language_criteria_idTEXTLanguage criteria idResource name of the language constant for the language of the product.
language_language_constantTEXTLanguage language constantThe language constant resource name.
launched_to_allBOOLEANLaunched to allTrue if the user interest is launched to all channels and locales.
listing_group_case_value_hotel_city_city_criterionTEXTListing group case value hotel city city criterionThe Geo Target Constant resource name.
listing_group_case_value_hotel_class_valueNUMERICListing group case value hotel class valueLong value of the hotel class.
listing_group_case_value_hotel_country_region_country_region_criterionTEXTListing group case value hotel country region country region criterionThe Geo Target Constant resource name.
listing_group_case_value_hotel_id_valueTEXTListing group case value hotel id valueString value of the hotel ID.
listing_group_case_value_hotel_state_state_criterionTEXTListing group case value hotel state state criterionThe Geo Target Constant resource name.
listing_group_case_value_product_bidding_category_country_codeTEXTListing group case value product bidding category country codeTwo-letter upper-case country code of the product bidding category. It must match the campaign.shopping_setting.sales_country field.
listing_group_case_value_product_bidding_category_idNUMERICListing group case value product bidding category idID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
listing_group_case_value_product_bidding_category_levelTEXTListing group case value product bidding category levelLevel of the product bidding category.
listing_group_case_value_product_brand_valueTEXTListing group case value product brand valueString value of the product brand.
listing_group_case_value_product_channel_channelTEXTListing group case value product channel channelValue of the locality.
listing_group_case_value_product_channel_exclusivity_channel_exclusivityTEXTListing group case value product channel exclusivity channel exclusivityValue of the availability.
listing_group_case_value_product_condition_conditionTEXTListing group case value product condition conditionValue of the condition.
listing_group_case_value_product_custom_attribute_indexTEXTListing group case value product custom attribute indexIndicates the index of the custom attribute.
listing_group_case_value_product_custom_attribute_valueTEXTListing group case value product custom attribute valueString value of the product custom attribute.
listing_group_case_value_product_item_id_valueTEXTListing group case value product item id valueValue of the id.
listing_group_case_value_product_type_levelTEXTListing group case value product type levelLevel of the type.
listing_group_case_value_product_type_valueTEXTListing group case value product type valueValue of the type.
listing_group_parent_ad_group_criterionTEXTListing group parent ad group criterionResource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
listing_group_typeTEXTListing group typeType of the listing group.
listing_scope_dimensionsTEXTListing scope dimensionsScope of the campaign criterion.
listing_scope_dimensions_hotel_city_city_criterionTEXTListing scope dimensions hotel city city criterionThe Geo Target Constant resource name.
listing_scope_dimensions_hotel_country_region_country_region_criterionTEXTListing scope dimensions hotel country region country region criterionThe Geo Target Constant resource name.
listing_scope_dimensions_hotel_state_state_criterionTEXTListing scope dimensions hotel state state criterionThe Geo Target Constant resource name.
local_campaign_setting_location_source_typeTEXTLocal campaign setting location source typeThe location source type for this local campaign.
local_services_campaign_settings_category_bidsTEXTLocal services campaign settings category bidsCategorical level bids associated with MANUAL_CPA bidding strategy.
location_geo_target_constantTEXTLocation geo target constantThe geo target constant resource name.
location_groupTEXTLocation groupLocation Group
location_group_feedTEXTLocation group feedFeed specifying locations for targeting. This is required and must be set in CREATE operations.
location_group_geo_target_constantsTEXTLocation group geo target constantsGeo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
location_typeTEXTLocation typeType of the geo targeting of the campaign.
logical_user_list_rulesTEXTLogical user list rulesLogical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated. Required for creating a logical user list.
managerBOOLEANManagerWhether the customer is a manager.
manual_cpaTEXTManual cpaStandard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
manual_cpc_enhanced_cpc_enabledBOOLEANManual cpc enhanced cpc enabledWhether bids are to be enhanced based on conversion optimizer data.
manual_cpmTEXTManual cpmStandard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
manual_cpvTEXTManual cpvA bidding strategy that pays a configurable amount per video view.
match_rate_percentageNUMERICMatch rate percentageIndicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. This field is read-only.
maximize_conversion_value_cpc_bid_ceiling_microsNUMERICMaximize conversion value cpc bid ceiling microsMaximum 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_microsNUMERICMaximize conversion value cpc bid floor microsMinimum 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_roasNUMERICMaximize conversion value target roasThe 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_microsNUMERICMaximize conversions cpc bid ceiling microsMaximum 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_microsNUMERICMaximize conversions cpc bid floor microsMinimum 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_microsNUMERICMaximize conversions target cpa microsThe 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.
membership_life_spanNUMERICMembership life spanNumber of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based userlists, this field can be set to 10000 which means no expiration. It'll be ignored for logical_user_list.
membership_statusTEXTMembership statusMembership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to.
merchant_idNUMERICMerchant idMerchant ID of the product.
message_chat_rateNUMERICMessage chat rateNumber of message chats initiated (message_chats) divided by the number of message impressions (message_impressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate can be more than 1.0 for a given message impression.
message_chatsNUMERICMessage chatsNumber of message chats initiated for Click To Message impressions that were message tracking eligible.
message_impressionsNUMERICMessage impressionsNumber of Click To Message impressions that were message tracking eligible.
metroTEXTGeo target metro areaGeo target metro area.
mobile_app_category_mobile_app_category_constantTEXTMobile app category mobile app category constantThe mobile app category constant resource name.
mobile_application_app_idTEXTMobile application app idA 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 (for example, "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 (for example, "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.
mobile_application_nameTEXTMobile application nameName of this mobile application.
mobile_device_mobile_device_constantTEXTMobile device mobile device constantThe mobile device constant resource name.
mobile_friendly_clicks_percentageNUMERICMobile friendly clicks percentageThe percentage of mobile clicks that go to a mobile-friendly page.
monthTEXTMonthMonth as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
month_of_yearTEXTMonth of yearMonth of the year, for example, January.
nameTEXTNameThe 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.
negativeBOOLEANNegativeWhether 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.
network_settings_target_content_networkBOOLEANNetwork settings target content networkWhether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
BOOLEANNetwork settings target google searchWhether ads will be served with google.com search results.
network_settings_target_partner_search_networkBOOLEANNetwork settings target partner search networkWhether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
network_settings_target_search_networkBOOLEANNetwork settings target search networkWhether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true).
non_removed_campaign_countNUMERICNon removed campaign countThe number of non-removed campaigns attached to this bidding strategy. This field is read-only.
num_offline_impressionsNUMERICNum offline impressionsNumber of offline phone impressions.
num_offline_interactionsNUMERICNum offline interactionsNumber of offline phone calls.
offer_idTEXTOffer idItem ID of the product.
offline_interaction_rateNUMERICOffline interaction rateNumber of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
operating_system_version_operating_system_version_constantTEXTOperating system version operating system version constantThe operating system version constant resource name.
optimization_goal_setting_optimization_goal_typesTEXTOptimization goal setting optimization goal typesThe list of optimization goal types.
optimization_scoreNUMERICOptimization scoreOptimization 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.
optimization_score_upliftNUMERICOptimization score upliftTotal optimization score uplift of all recommendations.
optimization_score_urlTEXTOptimization score urlURL for the optimization score page in the Google Ads web interface. This metric can be selected from customer or campaign, and can be segmented by segments.recommendation_type. For example, SELECT metrics.optimization_score_url, segments.recommendation_type FROM customer will return a URL for each unique (customer, recommendation_type) combination.
optimization_score_weightNUMERICOptimization score weightOptimization 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.
owner_customer_idNUMERICOwner customer idThe ID of the Customer which owns the bidding strategy.
owner_descriptive_nameTEXTOwner descriptive namedescriptive_name of the Customer which owns the bidding strategy.
parental_status_typeTEXTParental status typeType of the parental status.
partner_hotel_idTEXTPartner hotel idPartner hotel ID.
pay_per_conversion_eligibility_failure_reasonsTEXTPay per conversion eligibility failure reasonsReasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
payment_modeTEXTPayment modePayment mode for the campaign.
percent_cpc_bid_microsNUMERICPercent cpc bid microsThe 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].
percent_cpc_cpc_bid_ceiling_microsNUMERICPercent cpc cpc bid ceiling microsMaximum 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.
percent_cpc_enhanced_cpc_enabledBOOLEANPercent cpc enhanced cpc enabledAdjusts 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.
percent_new_visitorsNUMERICPercent new visitorsPercentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
performance_max_upgrade_performance_max_campaignTEXTPerformance max upgrade performance max campaignIndicates which Performance Max campaign the campaign is upgraded to.
performance_max_upgrade_pre_upgrade_campaignTEXTPerformance max upgrade pre upgrade campaignIndicates legacy campaign upgraded to Performance Max.
performance_max_upgrade_statusTEXTPerformance max upgrade statusThe upgrade status of a campaign requested to be upgraded to Performance Max.
periodTEXTPeriodPeriod over which to spend the budget. Defaults to DAILY if not specified.
phone_callsNUMERICPhone callsNumber of offline phone calls.
phone_impressionsNUMERICPhone impressionsNumber of offline phone impressions.
phone_through_rateNUMERICPhone through rateNumber of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
placeholder_typeTEXTPlaceholder typePlaceholder type. This is only used with feed item metrics.
placement_urlTEXTPlacement urlURL of the placement. For example, "http://www.domain.com".
policy_summary_approval_statusTEXTPolicy summary approval statusThe overall approval status of this ad, calculated based on the status of its individual policy topic entries.
policy_summary_policy_topic_entriesTEXTPolicy summary policy topic entriesThe list of policy findings for this ad.
policy_summary_review_statusTEXTPolicy summary review statusWhere in the review process this ad is.
position_estimates_estimated_add_clicks_at_first_position_cpcNUMERICPosition estimates estimated add clicks at first position cpcEstimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
position_estimates_estimated_add_cost_at_first_position_cpcNUMERICPosition estimates estimated add cost at first position cpcEstimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
position_estimates_first_page_cpc_microsNUMERICPosition estimates first page cpc microsThe estimate of the CPC bid required for ad to be shown on first page of search results.
position_estimates_first_position_cpc_microsNUMERICPosition estimates first position cpc microsThe estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.
position_estimates_top_of_page_cpc_microsNUMERICPosition estimates top of page cpc microsThe estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
post_click_quality_scoreTEXTPost click quality scoreThe quality score of the landing page.
postal_codeTEXTGeo target postal code numbersGeo target postal code.
product_aggregator_idNUMERICProduct aggregator idAggregator ID of the product.
product_bidding_category_level1TEXTProduct bidding category level1Bidding category (level 1) of the product.
product_bidding_category_level2TEXTProduct bidding category level2Bidding category (level 2) of the product.
product_bidding_category_level3TEXTProduct bidding category level3Bidding category (level 3) of the product.
product_bidding_category_level4TEXTProduct bidding category level4Bidding category (level 4) of the product.
product_bidding_category_level5TEXTProduct bidding category level5Bidding category (level 5) of the product.
product_brandTEXTProduct brandBrand of the product.
product_channelTEXTProduct channelChannel of the product.
product_channel_exclusivityTEXTProduct channel exclusivityChannel exclusivity of the product.
product_conditionTEXTProduct conditionCondition of the product.
product_countryTEXTProduct countryResource name of the geo target constant for the country of sale of the product.
product_custom_attribute0TEXTProduct custom attribute0Custom attribute 0 of the product.
product_custom_attribute1TEXTProduct custom attribute1Custom attribute 1 of the product.
product_custom_attribute2TEXTProduct custom attribute2Custom attribute 2 of the product.
product_custom_attribute3TEXTProduct custom attribute3Custom attribute 3 of the product.
product_custom_attribute4TEXTProduct custom attribute4Custom attribute 4 of the product.
product_item_idTEXTProduct item idItem ID of the product.
product_languageTEXTProduct languageResource name of the language constant for the language of the product.
product_merchant_idNUMERICProduct merchant idMerchant ID of the product.
product_store_idTEXTProduct store idStore ID of the product.
product_titleTEXTProduct titleTitle of the product.
product_type_l1TEXTProduct type l1Type (level 1) of the product.
product_type_l2TEXTProduct type l2Type (level 2) of the product.
product_type_l3TEXTProduct type l3Type (level 3) of the product.
product_type_l4TEXTProduct type l4Type (level 4) of the product.
product_type_l5TEXTProduct type l5Type (level 5) of the product.
proximity_address_city_nameTEXTProximity address city nameName of the city.
proximity_address_country_codeTEXTProximity address country codeCountry code.
proximity_address_postal_codeTEXTProximity address postal codePostal code.
proximity_address_province_codeTEXTProximity address province codeProvince or state code.
proximity_address_province_nameTEXTProximity address province nameProvince or state name.
proximity_address_street_addressTEXTProximity address street addressStreet address line 1.
proximity_geo_point_latitude_in_micro_degreesNUMERICProximity geo point latitude in micro degreesMicro degrees for the latitude.
proximity_geo_point_longitude_in_micro_degreesNUMERICProximity geo point longitude in micro degreesMicro degrees for the longitude.
proximity_radiusNUMERICProximity radiusThe radius of the proximity.
proximity_radius_unitsTEXTProximity radius unitsThe unit of measurement of the radius. Default is KILOMETERS.
quality_info_creative_quality_scoreTEXTQuality info creative quality scoreThe performance of the ad compared to other advertisers.
quality_info_post_click_quality_scoreTEXTQuality info post click quality scoreThe quality score of the landing page.
quality_info_quality_scoreNUMERICQuality info quality scoreThe quality score. This field may not be populated if Google does not have enough information to determine a value.
quality_info_search_predicted_ctrTEXTQuality info search predicted ctrThe click-through rate compared to that of other advertisers.
quality_scoreNUMERICQuality scoreThe quality score. This field may not be populated if Google does not have enough information to determine a value.
quarterTEXTQuarterQuarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
read_onlyBOOLEANRead onlyAn option that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is read-only.
real_time_bidding_setting_opt_inBOOLEANReal time bidding setting opt inWhether the campaign is opted in to real-time bidding.
recommendation_typeTEXTRecommendation typeRecommendation type.
NUMERICRecommended budget amountThe 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.
NUMERICRecommended budget amount microsThe 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.
NUMERICRecommended budget estimated change weekly clicksThe estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
NUMERICRecommended budget estimated change weekly cost microsThe 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.
NUMERICRecommended budget estimated change weekly interactionsThe estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
NUMERICRecommended budget estimated change weekly viewsThe estimated change in weekly views if the recommended budget is applied. This field is read-only.
reference_countNUMERICReference countThe number of campaigns actively using the budget. This field is read-only.
regionTEXTGeo target regionGeo target region name.
relative_ctrNUMERICRelative ctrYour 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.
remarketing_setting_google_global_site_tagTEXTRemarketing setting google global site tagThe Google tag.
resource_nameTEXTResource nameThe resource name of the campaign. Campaign resource names have the form: customers/{customer_id}/campaigns/{campaign_id}
rule_based_user_list_combined_rule_user_list_left_operand_rule_item_groupsTEXTRule based user list combined rule user list left operand rule item groupsList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
rule_based_user_list_combined_rule_user_list_left_operand_rule_typeTEXTRule based user list combined rule user list left operand rule typeRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
rule_based_user_list_combined_rule_user_list_right_operand_rule_item_groupsTEXTRule based user list combined rule user list right operand rule item groupsList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
rule_based_user_list_combined_rule_user_list_right_operand_rule_typeTEXTRule based user list combined rule user list right operand rule typeRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
rule_based_user_list_combined_rule_user_list_rule_operatorTEXTRule based user list combined rule user list rule operatorOperator to connect the two operands. Required for creating a combined rule user list.
rule_based_user_list_expression_rule_user_list_rule_rule_item_groupsTEXTRule based user list expression rule user list rule rule item groupsList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
rule_based_user_list_expression_rule_user_list_rule_rule_typeTEXTRule based user list expression rule user list rule rule typeRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
rule_based_user_list_flexible_rule_user_list_exclusive_operandsTEXTRule based user list flexible rule user list exclusive operandsActions that are located on the exclusive side. These are joined together with OR.
rule_based_user_list_flexible_rule_user_list_inclusive_operandsTEXTRule based user list flexible rule user list inclusive operandsActions that are located on the inclusive side. These are joined together by either AND/OR as specified by the inclusive_rule_operator.
rule_based_user_list_flexible_rule_user_list_inclusive_rule_operatorTEXTRule based user list flexible rule user list inclusive rule operatorOperator that defines how the inclusive operands are combined.
rule_based_user_list_prepopulation_statusTEXTRule based user list prepopulation statusThe status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.
search_absolute_top_impression_shareNUMERICSearch absolute top impression shareThe 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/7501826 for details. Any value below 0.1 is reported as 0.0999.
search_budget_lost_absolute_top_impression_shareNUMERICSearch budget lost absolute top impression shareThe 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_shareNUMERICSearch budget lost impression shareThe 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_shareNUMERICSearch budget lost top impression shareThe 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_shareNUMERICSearch click shareThe 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_engine_results_page_typeTEXTSearch engine results page typeType of the search engine results page.
search_exact_match_impression_shareNUMERICSearch exact match impression shareThe 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_shareNUMERICSearch impression shareThe 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_predicted_ctrTEXTSearch predicted ctrThe click-through rate compared to that of other advertisers.
search_rank_lost_absolute_top_impression_shareNUMERICSearch rank lost absolute top impression shareThe 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_shareNUMERICSearch rank lost impression shareThe 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_shareNUMERICSearch rank lost top impression shareThe 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_termTEXTSearch termThe search term.
search_term_match_typeTEXTSearch term match typeMatch type of the keyword that triggered the ad, including variants.
search_term_view_ad_groupTEXTSearch term view ad groupThe ad group the search term served in.
search_term_view_ad_group_idTEXTSearch Term View Ad Group IDThe Ad Group ID for a search term
search_term_view_campaign_idTEXTSearch Term View Campaign IDThe Campaign ID for a search term
search_term_view_keyword_idTEXTSearch Term View Keyword IDThe Keyword ID for a search term
search_term_view_resource_nameTEXTSearch term view resource nameThe resource name of the search term view. Search term view resource names have the form: customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}
search_term_view_search_termTEXTSearch term view search termThe search term.
search_term_view_statusTEXTSearch term view statusIndicates whether the search term is currently one of your targeted or excluded keywords.
search_top_impression_shareNUMERICSearch top impression shareThe 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.
selective_optimization_conversion_actionsTEXTSelective optimization conversion actionsThe selected set of conversion actions for optimizing this campaign.
serving_statusTEXTServing statusThe ad serving status of the campaign.
shopping_performance_view_resource_nameTEXTShopping performance view resource nameThe resource name of the Shopping performance view. Shopping performance view resource names have the form: customers/{customer_id}/shoppingPerformanceView
shopping_setting_campaign_priorityNUMERICShopping setting campaign priorityPriority 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.
shopping_setting_enable_localBOOLEANShopping setting enable localWhether to include local products.
shopping_setting_feed_labelTEXTShopping setting feed labelFeed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.
shopping_setting_merchant_idNUMERICShopping setting merchant idID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
shopping_setting_sales_countryTEXTShopping setting sales countrySales country of products to include in the campaign. Only one of feed_label or sales_country can be set. Field is immutable except for clearing. Once this field is cleared, you must use feed_label if you want to set the sales country.
shopping_setting_use_vehicle_inventoryBOOLEANShopping setting use vehicle inventoryWhether to target Vehicle Listing inventory.
similar_user_list_seed_user_listTEXTSimilar user list seed user listSeed UserList from which this list is derived.
size_for_displayNUMERICSize for displayEstimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
NUMERICSize for searchEstimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only.
size_range_for_displayTEXTSize range for displaySize range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
TEXTSize range for searchSize range in terms of number of users of the UserList, for Search ads. This field is read-only.
sk_ad_network_ad_event_typeTEXTSk ad network ad event typeiOS Store Kit Ad Network ad event type.
sk_ad_network_attribution_creditTEXTSk ad network attribution creditiOS Store Kit Ad Network attribution credit
sk_ad_network_conversion_valueNUMERICSk ad network conversion valueiOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign.
sk_ad_network_conversionsNUMERICSk ad network conversionsThe number of iOS Store Kit Ad Network conversions.
sk_ad_network_source_app_sk_ad_network_source_app_idTEXTSk ad network source app sk ad network source app idApp id where the ad that drove the iOS Store Kit Ad Network install was shown.
sk_ad_network_user_typeTEXTSk ad network user typeiOS Store Kit Ad Network user type.
slotTEXTSlotPosition of the ad.
sourceTEXTSourceThe name of the connector ("google_ads")
speed_scoreNUMERICSpeed scoreA 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.
spendNUMERICSpendThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
start_dateDATEStart dateThe date when campaign started in serving customer's timezone in YYYY-MM-DD format.
stateTEXTGeo target state name.Geo target state name.
statusTEXTStatusThe status of the campaign. When a new campaign is added, the status defaults to ENABLED.
store_idTEXTStore idStore ID of the product.
system_serving_statusTEXTSystem serving statusServing status of the criterion.
target_cpaNUMERICTarget cpaThe effective target CPA (cost-per-acquisition). This field is read-only.
target_cpa_bid_sourceTEXTTarget cpa bid sourceSource of the effective target CPA. This field is read-only.
target_cpa_cpc_bid_ceiling_microsNUMERICTarget cpa cpc bid ceiling microsMaximum 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_microsNUMERICTarget cpa cpc bid floor microsMinimum 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_microsNUMERICTarget cpa microsThe 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.
target_cpa_target_cpa_microsNUMERICTarget cpa target cpa microsAverage CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
target_cpmTEXTTarget cpmA bidding strategy that automatically optimizes cost per thousand impressions.
target_cpm_microsNUMERICTarget cpm microsAverage amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
target_impression_share_cpc_bid_ceiling_microsNUMERICTarget impression share cpc bid ceiling microsThe 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_locationTEXTTarget impression share locationThe targeted location on the search results page.
target_impression_share_location_fraction_microsNUMERICTarget impression share location fraction microsThe chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
target_roasNUMERICTarget roasThe 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.
target_roas_cpc_bid_ceiling_microsNUMERICTarget roas cpc bid ceiling microsMaximum 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_microsNUMERICTarget roas cpc bid floor microsMinimum 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_roasNUMERICTarget roas target roasRequired. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
target_spend_cpc_bid_ceiling_microsNUMERICTarget spend cpc bid ceiling microsMaximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
target_spend_target_spend_microsNUMERICTarget spend target spend microsThe 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.html for details.
targeting_setting_target_restrictionsTEXTTargeting setting target restrictionsThe per-targeting-dimension setting to restrict the reach of your campaign or ad group.
taxonomy_typeTEXTTaxonomy typeTaxonomy type of the user interest.
test_accountBOOLEANTest accountWhether the customer is a test account.
text_label_background_colorTEXTText label background colorBackground color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
text_label_descriptionTEXTText label descriptionA short description of the label. The length must be no more than 200 characters.
time_zoneTEXTTime zoneThe local timezone ID of the customer.
top_impression_percentageNUMERICTop impression percentageThe percent of your ad impressions that are shown anywhere above the organic search results.
top_of_page_cpcNUMERICTop of page cpcThe estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
topic_pathTEXTTopic pathThe 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.
topic_topic_constantTEXTTopic topic constantThe Topic Constant resource name.
total_amountNUMERICTotal amountThe 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.
total_amount_microsNUMERICTotal amount microsThe 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.
totalcostNUMERICTotal CostThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
tracking_setting_tracking_urlTEXTTracking setting tracking urlThe url used for dynamic tracking.
tracking_url_templateTEXTTracking url templateThe URL template for constructing a tracking URL.
transactionrevenueNUMERICTransactionrevenueThe value of all conversions.
transactionsNUMERICTransactionsThe total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
typeTEXTTypeThe type of the ad group.
url_custom_parametersTEXTUrl custom parametersThe list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.
url_expansion_opt_outBOOLEANUrl expansion opt outRepresents 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.
user_interest_availabilitiesTEXTUser interest availabilitiesAvailability information of the user interest.
user_interest_idNUMERICUser interest idThe ID of the user interest.
user_interest_launched_to_allBOOLEANUser interest launched to allTrue if the user interest is launched to all channels and locales.
user_interest_nameTEXTUser interest nameThe name of the user interest.
user_interest_parentTEXTUser interest parentThe parent of the user interest.
user_interest_resource_nameTEXTUser interest resource nameThe resource name of the user interest. User interest resource names have the form: customers/{customer_id}/userInterests/{user_interest_id}
user_interest_taxonomy_typeTEXTUser interest taxonomy typeTaxonomy type of the user interest.
user_interest_user_interest_categoryTEXTUser interest user interest categoryThe UserInterest resource name.
user_interest_user_interest_idNUMERICUser interest user interest idThe ID of the user interest.
user_interest_user_interest_parentTEXTUser interest user interest parentThe parent of the user interest.
user_list_access_reasonTEXTUser list access reasonIndicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only.
user_list_account_user_list_statusTEXTUser list account user list statusIndicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED.
user_list_basic_user_list_actionsTEXTUser list basic user list actionsActions associated with this user list.
user_list_closing_reasonTEXTUser list closing reasonIndicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open.
user_list_crm_based_user_list_app_idTEXTUser list crm based user list app idA string that uniquely identifies a mobile application from which the data was collected. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.
user_list_crm_based_user_list_data_source_typeTEXTUser list crm based user list data source typeData source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
user_list_crm_based_user_list_upload_key_typeTEXTUser list crm based user list upload key typeMatching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
user_list_descriptionTEXTUser list descriptionDescription of this user list.
user_list_eligible_for_displayBOOLEANUser list eligible for displayIndicates this user list is eligible for Google Display Network. This field is read-only.
BOOLEANUser list eligible for searchIndicates if this user list is eligible for Google Search Network.
user_list_idNUMERICUser list idId of the user list.
user_list_integration_codeTEXTUser list integration codeAn ID from external system. It is used by user list sellers to correlate IDs on their systems.
user_list_logical_user_list_rulesTEXTUser list logical user list rulesLogical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated. Required for creating a logical user list.
user_list_match_rate_percentageNUMERICUser list match rate percentageIndicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. This field is read-only.
user_list_membership_life_spanNUMERICUser list membership life spanNumber of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based userlists, this field can be set to 10000 which means no expiration. It'll be ignored for logical_user_list.
user_list_membership_statusTEXTUser list membership statusMembership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to.
user_list_nameTEXTUser list nameName of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)
user_list_read_onlyBOOLEANUser list read onlyAn option that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is read-only.
user_list_resource_nameTEXTUser list resource nameThe resource name of the user list. User list resource names have the form: customers/{customer_id}/userLists/{user_list_id}
user_list_rule_based_user_list_combined_rule_user_list_left_operand_rule_item_groupsTEXTUser list rule based user list combined rule user list left operand rule item groupsList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
user_list_rule_based_user_list_combined_rule_user_list_left_operand_rule_typeTEXTUser list rule based user list combined rule user list left operand rule typeRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
user_list_rule_based_user_list_combined_rule_user_list_right_operand_rule_item_groupsTEXTUser list rule based user list combined rule user list right operand rule item groupsList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
user_list_rule_based_user_list_combined_rule_user_list_right_operand_rule_typeTEXTUser list rule based user list combined rule user list right operand rule typeRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
user_list_rule_based_user_list_combined_rule_user_list_rule_operatorTEXTUser list rule based user list combined rule user list rule operatorOperator to connect the two operands. Required for creating a combined rule user list.
user_list_rule_based_user_list_expression_rule_user_list_rule_rule_item_groupsTEXTUser list rule based user list expression rule user list rule rule item groupsList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
user_list_rule_based_user_list_expression_rule_user_list_rule_rule_typeTEXTUser list rule based user list expression rule user list rule rule typeRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
user_list_rule_based_user_list_flexible_rule_user_list_exclusive_operandsTEXTUser list rule based user list flexible rule user list exclusive operandsActions that are located on the exclusive side. These are joined together with OR.
user_list_rule_based_user_list_flexible_rule_user_list_inclusive_operandsTEXTUser list rule based user list flexible rule user list inclusive operandsActions that are located on the inclusive side. These are joined together by either AND/OR as specified by the inclusive_rule_operator.
user_list_rule_based_user_list_flexible_rule_user_list_inclusive_rule_operatorTEXTUser list rule based user list flexible rule user list inclusive rule operatorOperator that defines how the inclusive operands are combined.
user_list_rule_based_user_list_prepopulation_statusTEXTUser list rule based user list prepopulation statusThe status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.
user_list_similar_user_list_seed_user_listTEXTUser list similar user list seed user listSeed UserList from which this list is derived.
user_list_size_for_displayNUMERICUser list size for displayEstimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
NUMERICUser list size for searchEstimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only.
user_list_size_range_for_displayTEXTUser list size range for displaySize range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
TEXTUser list size range for searchSize range in terms of number of users of the UserList, for Search ads. This field is read-only.
user_list_typeTEXTUser list typeType of this list. This field is read-only.
user_list_user_listTEXTUser list user listThe User List resource name.
valid_accelerated_mobile_pages_clicks_percentageNUMERICValid accelerated mobile pages clicks percentageThe percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
value_per_all_conversionNUMERICValue per all conversionThe value of all conversions divided by the number of all conversions.
value_per_all_conversionsNUMERICValue per all conversionsThe value of all conversions divided by the number of all conversions.
value_per_all_conversions_by_conversion_dateNUMERICValue per all conversions by conversion dateThe 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_conversionNUMERICValue per conversionThe 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_dateNUMERICValue per conversions by conversion dateThe 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_conversionNUMERICValue per current model attributed conversionThe 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.
vanity_pharma_vanity_pharma_display_url_modeTEXTVanity pharma vanity pharma display url modeThe display mode for vanity pharma URLs.
vanity_pharma_vanity_pharma_textTEXTVanity pharma vanity pharma textThe text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.
vertical_idTEXTVertical idThe Topic Constant resource name.
video_brand_safety_suitabilityTEXTVideo brand safety suitability3-Tier Brand Safety setting for the campaign.
video_quartile100_rateNUMERICVideo quartile100 ratePercentage of impressions where the viewer watched all of your video.
video_quartile25_rateNUMERICVideo quartile25 ratePercentage of impressions where the viewer watched 25% of your video.
video_quartile50_rateNUMERICVideo quartile50 ratePercentage of impressions where the viewer watched 50% of your video.
video_quartile75_rateNUMERICVideo quartile75 ratePercentage of impressions where the viewer watched 75% of your video.
video_quartile_p100_rateNUMERICVideo quartile p100 ratePercentage of impressions where the viewer watched all of your video.
video_quartile_p25_rateNUMERICVideo quartile p25 ratePercentage of impressions where the viewer watched 25% of your video.
video_quartile_p50_rateNUMERICVideo quartile p50 ratePercentage of impressions where the viewer watched 50% of your video.
video_quartile_p75_rateNUMERICVideo quartile p75 ratePercentage of impressions where the viewer watched 75% of your video.
video_view_rateNUMERICVideo view rateThe number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
video_viewsNUMERICVideo viewsThe number of times your video ads were viewed.
view_through_conversionsNUMERICView through conversionsThe 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 (for example, clicking on) another ad.
webpage_conditionsTEXTWebpage conditionsConditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
webpage_coverage_percentageNUMERICWebpage coverage percentageWebsite 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.
webpage_criterion_nameTEXTWebpage criterion nameThe 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.
webpage_sample_sample_urlsTEXTWebpage sample sample urlsWebpage sample urls
weekTEXTWeekWeek as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
yearTEXTYearYear, formatted as yyyy.
youtube_channel_channel_idTEXTYoutube channel channel idThe YouTube uploader channel id or the channel code of a YouTube channel.
youtube_video_video_idTEXTYoutube video video idYouTube video id as it appears on the YouTube watch page.