Google Ads

The ID of the customer.

The official name of the customer account.

The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.

The local timezone ID of the customer.

Date to which metrics apply.

The ID of the campaign.

The name of the campaign.

The start date of the campaign, when ads begin running.

The end date of the campaign, after which ads will stop running.

The status of the campaign. When a new campaign is added, the status defaults to ENABLED.

Resource name of the portfolio bidding strategy attached to the campaign, limited to the attributes visible to every account the strategy is shared with. Empty when the campaign does not use a portfolio strategy.

The ad serving optimization status of the campaign.

Refinement of the advertising channel type, for example a sub-type of Search or Display.

The primary serving target for ads within the campaign, for example Search, Display or Video. The targeting options are refined by the campaign network settings.

A string that uniquely identifies a mobile application.

The application store that distributes this specific app.

Represents the goal which the bidding strategy of this app campaign should optimize towards.

Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.

If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.

The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name.

The resource name of the portfolio bidding strategy used by the campaign.

The system status of the campaign's bidding strategy.

The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy.

The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.

The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.

The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.

Whether Brand Guidelines are enabled for the campaign. Only applicable to Performance Max campaigns, and not supported for campaigns with Travel goals. When enabled, business name and logo assets are linked to the campaign rather than to individual asset groups.

The resource name of the campaign group that this campaign belongs to.

The portion of the conversion value that the advertiser is billed. For example, 0.106 represents a commission rate of 10.6%.

Whether the campaign uses upgraded targeting options, which allow location and language targeting at the ad group level instead of the campaign level.

The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".

The language code specifying the language of the domain, for example, "en".

Whether the campaign uses advertiser supplied URLs exclusively.

The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.

The asset set types excluded from this campaign. Asset set links with these types are not inherited from the upper level. The location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC: when LOCATION_SYNC is excluded, no location group asset set applies to the campaign, and Location Extensions and Affiliate Location Extensions are not served. Only LOCATION_SYNC is currently supported.

The type of campaign: normal, draft, or experiment.

Suffix used to append query parameters to landing pages that are served with parallel tracking.

Fixed CPM bidding goal. Determines the exact bidding optimization parameters.

Target frequency count represents the number of times an advertiser wants to show the ad to target a single user.

Time window expressing the period over which you want to reach the specified target_count.

A list that limits how often each user will see this campaign's ads.

The setting used for negative geotargeting in this particular campaign.

The setting used for positive geotargeting in this particular campaign.

The resource name for a set of hotel properties for Performance Max for travel goals campaigns.

The linked Hotel Center account.

Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.

The resource names of labels attached to this campaign.

Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.

The location source type for this local campaign.

Categorical level bids associated with MANUAL_CPA bidding strategy.

The target return on ad spend (ROAS). The bid strategy maximises revenue while averaging this target. A high target ROAS may prevent the strategy from spending the full budget. When empty, the strategy aims for the highest possible ROAS within the budget.

The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost- per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.

Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.

Whether ads will be served with google.com search results.

Whether ads will be served on the Google TV network.

Whether ads are served on the partner network. This network is available only to a few select partner accounts and is distinct from the Google Search Partners Network.

Whether ads will be served on sites in the Google Search Partners Network (requires target_google_search to also be true ).

Whether ads will be served on YouTube.

The list of optimization goal types.

Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. Empty for unscored campaigns.

Payment mode for the campaign.

Maximum bid limit applied by the bid strategy, in the account currency. A zero value means no ceiling is defined.

Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.

The resource name of the Performance Max campaign the campaign is upgraded to.

The resource name of the legacy campaign upgraded to Performance Max.

The upgrade status of a campaign requested to be upgraded to Performance Max.

If true, brand exclusions are ignored for Shopping ads.

The primary status of the campaign. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.

The primary status reasons of the campaign. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus.

Whether the campaign is opted in to real-time bidding.

The selected set of resource names for conversion actions for optimizing this campaign.

The ad serving status of the campaign.

The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link, and only for Performance Max, Shopping, Search and Demand Gen campaign types.

Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. Ranges from 0 to 2 for Shopping campaigns, and equals 3 for Smart Shopping campaigns.

Whether the optional product feed is disabled. Only applicable to Demand Gen campaigns.

Whether to include local products.

Feed label of products to include in the campaign. Valid feed labels may contain a maximum of 20 characters including uppercase letters, numbers, hyphens, and underscores. If you previously used the deprecated sales_country in the two-letter country code ( XX ) format, the feed_label field should be used instead. For more information see the feed label support article.

ID of the Merchant Center account linked to the campaign.

Whether the campaign targets Vehicle Listing inventory. Only applicable to Smart Shopping campaigns; Performance Max campaigns report this through the listing type.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.

Target Frequency count representing how many times you want to reach a single user.

Time window expressing the period over which you want to reach the specified target_count.

An automated bidding strategy that sets bids to optimize performance given the target CPV you set.

The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

The targeted location on the search results page.

The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Deprecated. The spend target under which to maximise clicks. The strategy spends the smaller of this value and the natural throttling spend amount. When empty, the budget is used as the spend target.

The per-targeting-dimension setting to restrict the reach of your campaign or ad group.

The url used for dynamic tracking.

The URL template for constructing a tracking URL.

The Travel account ID associated with the Travel campaign.

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

Deprecated, always NULL: final URL expansion is now reported through the campaign asset automation settings. Kept for schema stability. Indicates whether URL expansion is opted out for the campaign, affecting how landing pages are generated.

The display mode for vanity pharma URLs.

The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.

Deprecated, always NULL: brand safety suitability is now set at the customer level, not per campaign. Kept for schema stability. Brand Safety setting at the individual campaign level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand.

Determine if video responsive ads can be used for in-feed video ads.

Determine if video responsive ads can be used for in-stream video ads.

Determine if video responsive ads can be used as shorts format.

The ID of the ad group.

The name of the ad group.

The status of the ad group.

The type of the ad group.

The resource names of labels attached to this ad group.

If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.

For a draft or experiment ad group, the resource name of the ad group it was created from. Empty when there is none, and equal to its own resource name for a base ad group.

The maximum CPC (cost-per-click) bid. Applies when the ad group's effective bidding strategy is Manual CPC, and is ignored when the campaign uses a portfolio bidding strategy.

The maximum CPM (cost-per-thousand viewable impressions) bid.

The CPV (cost-per-view) bid.

Channel configuration of the ad group.

High level channel strategy.

Whether to enable ads on the Discover channel.

Whether to enable ads on the Display channel.

Whether to enable ads on the Gmail channel.

Whether to enable ads on the YouTube In-Feed channel.

Whether to enable ads on the YouTube In-Stream channel.

Whether to enable ads on the YouTube Shorts channel.

Lets advertisers 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.

Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.

The effective target CPA (cost-per-acquisition).

Source of the effective target CPA.

The effective target ROAS (return-on-ad-spend).

Source of the effective target ROAS.

Whether demographics are excluded from the targeting expanded by optimized targeting. Ignored when optimized targeting is disabled. Defaults to false.

The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.

The asset set types excluded from this ad group. Asset set links with these types are not inherited from the upper level. The location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC: when LOCATION_SYNC is excluded, no location group asset set applies to the ad group, and Location Extensions and Affiliate Location Extensions are not served. Only LOCATION_SYNC is currently supported.

URL template for appending params to Final URL.

The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.

True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.

The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction.

Provides aggregated view into why an ad group is not serving or not serving optimally.

Provides reasons for why an ad group is not serving or not serving optimally.

The target CPA (cost-per-acquisition) for the ad group. Overrides the target CPA of the campaign's bidding strategy when that strategy is Target CPA, or Maximize Conversions with a target CPA. Otherwise ignored.

Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.

Average amount in micros that the advertiser is willing to pay for every ad view.

The target ROAS (return-on-ad-spend) for the ad group. Overrides the target ROAS of the campaign's bidding strategy when that strategy is a standard Target ROAS strategy, or a standard Maximize Conversion Value strategy with a target ROAS. Otherwise ignored. The effective target ROAS and its source report the value actually applied.

The per-targeting-dimension setting to restrict the reach of your campaign or ad group.

The URL template for constructing a tracking URL.

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

The ID of the ad.

The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, LegacyAppInstallAd, ShoppingComparisonListingAd, VideoAd, VideoResponsiveAd and DemandGen ads.

The type of ad.

The status of the customer.

Settings that control the types of asset automation. See the AssetAutomationTypeEnum documentation for the default opt in/out behavior of each type.

Overall ad strength for this ad group ad.

A list of recommendations to improve the ad strength. For example, a recommendation could be "Try adding a few more unique headlines or unpinning some assets.".

Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.

An app deep link asset that may be used with the ad.

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

List of media bundle assets that may be used with the ad.

List of image assets that may be displayed with the ad.

Mandatory ad text.

List of YouTube video assets that may be displayed with the ad.

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

List of image assets that may be displayed with the ad.

List of video assets that may be displayed with the ad.

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

List of image asset IDs whose images may be displayed with the ad.

List of YouTube video asset IDs whose videos may be displayed with the ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The business name displayed in a call-only ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. Indicates whether calls made from this call-only ad are tracked as conversions.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The resource name of the conversion action that tracks calls from this call-only ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The reporting state for call conversions from this call-only ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The country code associated with the phone number in a Call ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The first line of descriptive text for a Call Ad, providing additional details about the advertised business or offering.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The second line of descriptive text for a Call Ad, offering further information to potential customers.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. Indicates whether call conversions are disabled for this specific Call Ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The first headline for a call-only ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The second headline for a Call Ad, used to provide more information or encourage engagement.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The first optional display URL path for a call-only ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The second optional display URL path for a call-only ad.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The phone number displayed in the Call Ad, which users can directly dial.

Deprecated, always NULL: call-only ads (CallAd) are no longer exposed by the Google Ads API. Kept for schema stability. The URL used for verifying the phone number in a Call ad, required if final URLs are empty.

The Advertiser/brand name.

Call to action text.

Carousel cards that will display with the ad. Min 2 max 10.

The descriptive text of the ad.

Headline of the ad.

Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).

The Advertiser/brand name. Maximum display width is 25.

Call to action text.

The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.

Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.

Deprecated, always NULL: the field was removed from the Google Ads API with no replacement. Kept for schema stability. Indicates whether the Demand Gen multi-asset ad is configured as a lead form only ad.

Logo 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.

Marketing 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, portrait_marketing_images, and tall_portrait_marketing_images the maximum is 20.

Portrait 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, square_marketing_images, and tall_portrait_marketing_images the maximum is 20.

Square 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, portrait_marketing_images, and tall_portrait_marketing_images the maximum is 20.

Tall portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x1067 and the aspect ratio must be 9:16 (+-1%). Combined with marketing_images, square_marketing_images, and portrait_marketing_images, the maximum is 20.

First part of text that appears in the ad with the displayed URL.

Second part of text that appears in the ad with the displayed URL.

The advertiser/brand name.

Asset of type CallToActionAsset used for the "Call To Action" button.

Text asset used for the description.

Text asset used for the short headline.

Logo image 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%).

First part of text that appears in the ad with the displayed URL.

Second part of text that appears in the ad with the displayed URL.

The advertiser/brand name.

Assets of type CallToActionAsset used for the "Call To Action" button.

List of text assets used for the description.

List of text assets used for the short headline.

Logo image 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%).

List of text assets used for the long headline.

List of YouTube video assets used for the ad.

The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, 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.

The product type of this ad. See comments on the enum for details.

A media bundle asset to be used in the ad. Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer.

The URL that appears in the ad description for some ad formats.

The description of the ad.

The second description of the ad.

The description of the ad.

The second description of the ad.

The first part of the ad's headline.

The second part of the ad's headline.

The third part of the ad's headline.

The text that can appear alongside the ad's displayed URL.

Additional text that can appear alongside the ad's displayed URL.

A list of final app URLs that will be used on mobile if the user has the specific app installed.

The list of possible final mobile URLs after all cross-domain redirects for the ad.

The suffix to use when constructing a final URL.

The list of possible final URLs after all cross-domain redirects for the ad.

Details pertaining to a hotel ad.

The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty.

The Asset resource name of this image.

URL of the full size image.

The mime type of the image.

Height in pixels of the full size image.

Width in pixels of the full size image.

URL of the preview size image.

Height in pixels of the preview size image.

Width in pixels of the preview size image.

Details pertaining to a legacy app install ad.

The accent color of the ad in hexadecimal, for example #ffffff for white.

Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set.

The business name in the ad.

The call-to-action text for the ad.

The description of the ad.

Specifies which format the ad will be served in. Default is ALL_FORMATS.

The MediaFile resource name of the logo image used in the ad.

The long version of the ad's headline.

The main color of the ad in hexadecimal, for example #ffffff for white.

The MediaFile resource name of the marketing image used in the ad.

Prefix before price. For example, 'as low as'.

Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.

The short version of the ad's headline.

The MediaFile resource name of the square logo image used in the ad.

The MediaFile resource name of the square marketing image used in the ad.

List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. At least 1 and at most 5 call-to-actions must be specified.

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified.

List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified.

List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified.

List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified.

First part of optional text that can be appended to the URL in the ad.

Second part of the optional text appended to the URL displayed in the ad.

List of YouTube video assets that may be displayed with the ad. At least 1 and at most 20 video assets must be specified.

The accent color of the ad in hexadecimal, for example #ffffff for white.

Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set.

The advertiser/brand name. Maximum display width is 25.

The call-to-action text for the ad. Maximum display width is 30.

Whether the advertiser has opted into the asset enhancements feature.

Whether the advertiser has opted into auto-gen video feature.

Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.

Specifies which format the ad will be served in. Default is ALL_FORMATS.

Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.

Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5.

A required long format headline. The maximum length is 90 characters.

The main color of the ad in hexadecimal, for example #ffffff for white.

Marketing images used in the ad. Valid image types are GIF, JPEG and PNG, with a minimum size of 600x314 and an aspect ratio of 1.91:1.

Prefix before price. For example, 'as low as'.

Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.

Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with logo_images, the maximum is 5.

Square marketing images used in the ad. Valid image types are GIF, JPEG and PNG, with a minimum size of 300x300 and an aspect ratio of 1:1.

Optional YouTube videos for the ad. A maximum of 5 videos can be specified.

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

First part of text that can be appended to the URL in the ad.

Second part of the text appended to the URL displayed in the ad.

Headline of the ad, between 25 and 45 characters.

Details pertaining to a Shopping product ad.

Details pertaining to a Smart Shopping ad.

List 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.

List 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.

Source of the ad when it is managed automatically by Google Ads.

The first line of the ad's description.

The second line of the ad's description.

The headline of the ad.

The URL template for constructing a tracking URL.

Details pertaining to a travel ad.

Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.

The list of mappings used to substitute custom parameter tags in the tracking URL template, the final URLs or the mobile final URLs.

YouTube Audio ad format.

Label on the "Call To Action" button taking the user to the video ad's final URL.

Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.

The Asset resource name of this image.

First text line for the ad.

Second text line for the ad.

The headline of the ad.

Video thumbnail image to use.

Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise.

Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.

The Asset resource name of this image.

Label on the "Call To Action" button taking the user to the video ad's final URL.

Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button.

The Asset resource name of this image.

The description line.

The headline of the ad.

The Asset resource name of this video.

First part of text that appears in the ad with the displayed URL.

Second part of text that appears in the ad with the displayed URL.

List of text assets used for the button, for example, the "Call To Action" button. Currently, only a single value for the button is supported.

List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.

List of text assets used for the description. Currently, only a single value for the description is supported.

List of text assets used for the short headline. Currently, only a single value for the short headline is supported.

List of text assets used for the long headline. Currently, only a single value for the long headline is supported.

List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.

The names of the labels attached to this ad.

The overall approval status of this ad, calculated based on the status of its individual policy topic entries.

The list of policy findings for this ad.

Where in the review process this ad is.

The primary status of the ad. Provides insight into why the ad is not serving or not serving optimally.

The reasons behind the primary status of the ad. Provides insight into why the ad is not serving or not serving optimally.

The ad rotation mode of the ad group.

The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.

A measurement of how often your ad has become viewable on a Display Network site.

The ratio of impressions that could be measured by Active View over the number of served impressions.

The cost of the impressions you received that were measurable by Active View.

The number of times your ads are appearing on placements in positions where they can be seen.

The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns.

The value of all conversions.

The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns.

All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in all_conversions_value. See About customer lifecycle goals for more details.

Average number of pages viewed per session.

Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.

Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.

The number of clicks.

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.

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 Understand conversions by time with new columns.

The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns.

Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.

Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.

The sum of the value of cross-device conversions.

Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data.

Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data.

Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data.

Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.

Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.

The number of times the ad was forwarded to someone else as a message.

The number of times someone has saved your Gmail ad to their inbox as a message.

The number of clicks to the landing page on the expanded state of Gmail ads.

Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data.

Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.

Count of how often your ad has appeared on a search results page or website on the Google Network.

The types of payable and free interactions.

The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.

Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data.

Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data.

Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data.

Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.

New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in "conversions_value" for optimization. See About customer lifecycle goals for more details.

Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.

Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.

Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data.

Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data.

Number of times the video was played to 25% of its length.

Number of times the video was played to 50% of its length.

Number of times the video was played to 75% of its length.

Number of times the video was played to 100% of its length.

The number of times your video ads were viewed, counted as TrueView views.

The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.

The percent of your ad impressions that are shown adjacent to the top organic search results.

The ID of the customer.

The official name of the customer account.

The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.

The local timezone ID of the customer.

Date to which metrics apply.

The ID of the campaign.

The name of the campaign.

The start date of the campaign, when ads begin running.

The end date of the campaign, after which ads will stop running.

The status of the campaign. When a new campaign is added, the status defaults to ENABLED.

Resource name of the portfolio bidding strategy attached to the campaign, limited to the attributes visible to every account the strategy is shared with. Empty when the campaign does not use a portfolio strategy.

The ad serving optimization status of the campaign.

Refinement of the advertising channel type, for example a sub-type of Search or Display.

The primary serving target for ads within the campaign, for example Search, Display or Video. The targeting options are refined by the campaign network settings.

A string that uniquely identifies a mobile application.

The application store that distributes this specific app.

Represents the goal which the bidding strategy of this app campaign should optimize towards.

Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.

If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.

The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name.

The resource name of the portfolio bidding strategy used by the campaign.

The system status of the campaign's bidding strategy.

The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy.

The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.

The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.

The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.

Whether Brand Guidelines are enabled for the campaign. Only applicable to Performance Max campaigns, and not supported for campaigns with Travel goals. When enabled, business name and logo assets are linked to the campaign rather than to individual asset groups.

The resource name of the campaign group that this campaign belongs to.

The portion of the conversion value that the advertiser is billed. For example, 0.106 represents a commission rate of 10.6%.

Whether the campaign uses upgraded targeting options, which allow location and language targeting at the ad group level instead of the campaign level.

The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".

The language code specifying the language of the domain, for example, "en".

Whether the campaign uses advertiser supplied URLs exclusively.

The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.

The asset set types excluded from this campaign. Asset set links with these types are not inherited from the upper level. The location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC: when LOCATION_SYNC is excluded, no location group asset set applies to the campaign, and Location Extensions and Affiliate Location Extensions are not served. Only LOCATION_SYNC is currently supported.

The type of campaign: normal, draft, or experiment.

Suffix used to append query parameters to landing pages that are served with parallel tracking.

Fixed CPM bidding goal. Determines the exact bidding optimization parameters.

Target frequency count represents the number of times an advertiser wants to show the ad to target a single user.

Time window expressing the period over which you want to reach the specified target_count.

A list that limits how often each user will see this campaign's ads.

The setting used for negative geotargeting in this particular campaign.

The setting used for positive geotargeting in this particular campaign.

The resource name for a set of hotel properties for Performance Max for travel goals campaigns.

The linked Hotel Center account.

Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.

The resource names of labels attached to this campaign.

Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.

The location source type for this local campaign.

Categorical level bids associated with MANUAL_CPA bidding strategy.

The target return on ad spend (ROAS). The bid strategy maximises revenue while averaging this target. A high target ROAS may prevent the strategy from spending the full budget. When empty, the strategy aims for the highest possible ROAS within the budget.

The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost- per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.

Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.

Whether ads will be served with google.com search results.

Whether ads will be served on the Google TV network.

Whether ads are served on the partner network. This network is available only to a few select partner accounts and is distinct from the Google Search Partners Network.

Whether ads will be served on sites in the Google Search Partners Network (requires target_google_search to also be true ).

Whether ads will be served on YouTube.

The list of optimization goal types.

Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. Empty for unscored campaigns.

Payment mode for the campaign.

Maximum bid limit applied by the bid strategy, in the account currency. A zero value means no ceiling is defined.

Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.

The resource name of the Performance Max campaign the campaign is upgraded to.

The resource name of the legacy campaign upgraded to Performance Max.

The upgrade status of a campaign requested to be upgraded to Performance Max.

If true, brand exclusions are ignored for Shopping ads.

The primary status of the campaign. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.

The primary status reasons of the campaign. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus.

Whether the campaign is opted in to real-time bidding.

The selected set of resource names for conversion actions for optimizing this campaign.

The ad serving status of the campaign.

The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link, and only for Performance Max, Shopping, Search and Demand Gen campaign types.

Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. Ranges from 0 to 2 for Shopping campaigns, and equals 3 for Smart Shopping campaigns.

Whether the optional product feed is disabled. Only applicable to Demand Gen campaigns.

Whether to include local products.

Feed label of products to include in the campaign. Valid feed labels may contain a maximum of 20 characters including uppercase letters, numbers, hyphens, and underscores. If you previously used the deprecated sales_country in the two-letter country code ( XX ) format, the feed_label field should be used instead. For more information see the feed label support article.

ID of the Merchant Center account linked to the campaign.

Whether the campaign targets Vehicle Listing inventory. Only applicable to Smart Shopping campaigns; Performance Max campaigns report this through the listing type.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.

Target Frequency count representing how many times you want to reach a single user.

Time window expressing the period over which you want to reach the specified target_count.

An automated bidding strategy that sets bids to optimize performance given the target CPV you set.

The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

The targeted location on the search results page.

The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Deprecated. The spend target under which to maximise clicks. The strategy spends the smaller of this value and the natural throttling spend amount. When empty, the budget is used as the spend target.

The per-targeting-dimension setting to restrict the reach of your campaign or ad group.

The url used for dynamic tracking.

The URL template for constructing a tracking URL.

The Travel account ID associated with the Travel campaign.

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

Deprecated, always NULL: final URL expansion is now reported through the campaign asset automation settings. Kept for schema stability. Indicates whether URL expansion is opted out for the campaign, affecting how landing pages are generated.

The display mode for vanity pharma URLs.

The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.

Deprecated, always NULL: brand safety suitability is now set at the customer level, not per campaign. Kept for schema stability. Brand Safety setting at the individual campaign level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand.

Determine if video responsive ads can be used for in-feed video ads.

Determine if video responsive ads can be used for in-stream video ads.

Determine if video responsive ads can be used as shorts format.

The ID of the ad group.

The name of the ad group.

The status of the ad group.

The type of the ad group.

The resource names of labels attached to this ad group.

If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.

For a draft or experiment ad group, the resource name of the ad group it was created from. Empty when there is none, and equal to its own resource name for a base ad group.

The maximum CPC (cost-per-click) bid. Applies when the ad group's effective bidding strategy is Manual CPC, and is ignored when the campaign uses a portfolio bidding strategy.

The maximum CPM (cost-per-thousand viewable impressions) bid.

The CPV (cost-per-view) bid.

Channel configuration of the ad group.

High level channel strategy.

Whether to enable ads on the Discover channel.

Whether to enable ads on the Display channel.

Whether to enable ads on the Gmail channel.

Whether to enable ads on the YouTube In-Feed channel.

Whether to enable ads on the YouTube In-Stream channel.

Whether to enable ads on the YouTube Shorts channel.

Lets advertisers 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.

Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.

The effective target CPA (cost-per-acquisition).

Source of the effective target CPA.

The effective target ROAS (return-on-ad-spend).

Source of the effective target ROAS.

Whether demographics are excluded from the targeting expanded by optimized targeting. Ignored when optimized targeting is disabled. Defaults to false.

The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.

The asset set types excluded from this ad group. Asset set links with these types are not inherited from the upper level. The location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC: when LOCATION_SYNC is excluded, no location group asset set applies to the ad group, and Location Extensions and Affiliate Location Extensions are not served. Only LOCATION_SYNC is currently supported.

URL template for appending params to Final URL.

The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.

True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.

The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction.

Provides aggregated view into why an ad group is not serving or not serving optimally.

Provides reasons for why an ad group is not serving or not serving optimally.

The target CPA (cost-per-acquisition) for the ad group. Overrides the target CPA of the campaign's bidding strategy when that strategy is Target CPA, or Maximize Conversions with a target CPA. Otherwise ignored.

Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.

Average amount in micros that the advertiser is willing to pay for every ad view.

The target ROAS (return-on-ad-spend) for the ad group. Overrides the target ROAS of the campaign's bidding strategy when that strategy is a standard Target ROAS strategy, or a standard Maximize Conversion Value strategy with a target ROAS. Otherwise ignored. The effective target ROAS and its source report the value actually applied.

The per-targeting-dimension setting to restrict the reach of your campaign or ad group.

The URL template for constructing a tracking URL.

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

The ID of the criterion.

The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.

The match type of the keyword, which determines how closely a search query must match the keyword for the ad to be eligible.

The text of the keyword (at most 80 characters and 10 words).

The display name of the criterion.

Approval status of the criterion.

Whether the criterion is excluded (true) or targeted (false).

The CPC (cost-per-click) bid.

The CPM (cost-per-thousand viewable impressions) bid.

The CPV (cost-per-view) bid.

The effective CPC (cost-per-click) bid.

Source of the effective CPC bid.

The effective CPM (cost-per-thousand viewable impressions) bid.

Source of the effective CPM bid.

The effective CPV (cost-per-view) bid.

Source of the effective CPV bid.

The effective Percent CPC bid amount.

Type of the parental status.

The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * fraction.

URL of the placement. For example, "http://www.domain.com".

The estimate of the CPC bid required for ad to be shown on first page of search results.

The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.

The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.

Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.

Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.

The quality score. Empty when Google does not have enough information to determine a value.

The performance of the ad compared to other advertisers.

The quality score of the landing page.

The click-through rate compared to that of other advertisers.

The ID of the bidding strategy.

The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).

The status of the bidding strategy.

The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy.

The currency used by the bidding strategy (ISO 4217 three-letter code). For strategies held in a manager account, the currency chosen by the advertiser; for strategies held in a serving account, the account's own currency.

The currency the bidding strategy actually operates in (ISO 4217 three-letter code). Bidding strategy metrics are reported in this currency.

ID of the campaign budget that this portfolio bidding strategy is aligned with. When a portfolio and a campaign budget are aligned, that means that they are attached to the same set of campaigns. After a bidding strategy is aligned with a campaign budget, campaigns that are added to the bidding strategy must also use the aligned campaign budget.

The number of campaigns attached to this bidding strategy.

The number of non-removed campaigns attached to this bidding strategy.

A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.

The target return on ad spend (ROAS). The bid strategy maximises revenue while averaging this target. A high target ROAS may prevent the strategy from spending the full budget. When empty, the strategy aims for the highest possible ROAS within the budget.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost- per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.

The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

The targeted location on the search results page.

The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Minimum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.

Maximum bid limit applied by the bid strategy, in the account currency. The limit applies to all keywords managed by the strategy.

Deprecated. The spend target under which to maximise clicks. The strategy spends the smaller of this value and the natural throttling spend amount. When empty, the budget is used as the spend target.

The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.

A measurement of how often your ad has become viewable on a Display Network site.

The ratio of impressions that could be measured by Active View over the number of served impressions.

The cost of the impressions you received that were measurable by Active View.

The number of times your ads are appearing on placements in positions where they can be seen.

The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns.

The value of all conversions.

The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns.

Average number of pages viewed per session.

Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.

Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.

The number of clicks.

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.

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 Understand conversions by time with new columns.

The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns.

Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.

Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.

The sum of the value of cross-device conversions.

Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data.

Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data.

Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data.

Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.

Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.

The number of times the ad was forwarded to someone else as a message.

The number of times someone has saved your Gmail ad to their inbox as a message.

The number of clicks to the landing page on the expanded state of Gmail ads.

Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data.

Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.

Count of how often your ad has appeared on a search results page or website on the Google Network.

The types of payable and free interactions.

The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.

Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data.

Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data.

Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data.

Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.

Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.

Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.

Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data.

Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data.

Number of times the video was played to 25% of its length.

Number of times the video was played to 50% of its length.

Number of times the video was played to 75% of its length.

Number of times the video was played to 100% of its length.

The number of times your video ads were viewed, counted as TrueView views.

The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.

The percent of your ad impressions that are shown adjacent to the top organic search results.

The ID of the customer.

The official name of the customer account.

The ID of the campaign.

The name of the campaign.

The status of the campaign. When a new campaign is added, the status defaults to ENABLED.

The ID of the ad group.

The name of the ad group.

Date to which metrics apply.

The search term.

Indicates whether the search term is currently one of your targeted or excluded keywords.

The AdGroupCriterion resource name.

The text of the keyword (at most 80 characters and 10 words).

The match type of the keyword.

Count of how often your ad has appeared on a search results page or website on the Google Network.

The number of clicks.

The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.

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.

The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.

The ID of the customer.

The official name of the customer account.

The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.

The local timezone ID of the customer.

Date to which metrics apply.

Type of the geo targeting of the campaign.

Criterion Id for the country.

The name of the country the ad was served in, or that the user showed interest in.

ISO country code of the geographic location the row is reported for.

The ID of the campaign.

The name of the campaign.

The status of the campaign. When a new campaign is added, the status defaults to ENABLED.

The primary serving target for ads within the campaign, for example Search, Display or Video. The targeting options are refined by the campaign network settings.

Refinement of the advertising channel type, for example a sub-type of Search or Display.

Resource name of the conversion action.

Conversion action name.

Conversion action category.

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.

The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.

The value of all conversions.