Provider operations that accept a property; absence means not classified.
Accepted during create and update operations.
Accepted during create and rejected during update.
Returned by the provider and rejected during create and update.
Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
Output only. descriptive_name of the Customer which owns the bidding strategy.
Output only. The ID of the Customer which owns the bidding strategy.
Output only. The name of the bidding strategy.
Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
Output only. The type of the bidding strategy.
Output only. A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
Output only. A bid strategy that sets your bids to help get as many clicks as possible within your budget.
Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: `customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}`
Output only. A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
Output only. The ID of the bidding strategy.
Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
Output only. The chosen revenue (based on conversion data) per unit of spend.
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
Output only. The targeted location on the search results page.
Output only. 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.
Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
Output only. The approved start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. For example, if a new budget is approved after the proposed start time, the approved start time is the time of approval.
Output only. The adjusted spending limit in micros. One million is equivalent to one unit. If the approved spending limit is finite, the adjusted spending limit may vary depending on the types of adjustments applied to this budget, if applicable. The different kinds of adjustments are described here: https://support.google.com/google-ads/answer/1704323 For example, a debit adjustment reduces how much the account is allowed to spend.
Output only. The adjusted spending limit as a well-defined type, for example, INFINITE. This will only be populated if the adjusted spending limit is INFINITE, which is guaranteed to be true if the approved spending limit is INFINITE.
Output only. The ID of the account-level budget.
Output only. The status of this account-level budget.
Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
Output only. The value of Ads that have been served, in micros. This includes overdelivery costs, in which case a credit might be automatically applied to the budget (see total_adjustments_micros).
Output only. The pending proposal to modify this budget, if applicable.
Output only. The proposed spending limit in micros. One million is equivalent to one unit.
Output only. The proposed start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. If a start time type of NOW was proposed, this is the time of request.
Output only. The name of the account-level budget.
Output only. The proposed spending limit as a well-defined type, for example, INFINITE.
Output only. The resource name of the account-level budget. AccountBudget resource names have the form: `customers/{customer_id}/accountBudgets/{account_budget_id}`
Output only. Notes associated with the budget.
Output only. The approved end time as a well-defined type, for example, FOREVER.
Output only. The total adjustments amount. An example of an adjustment is courtesy credits.
Output only. The approved spending limit in micros. One million is equivalent to one unit. This will only be populated if the proposed spending limit is finite, and will always be greater than or equal to the proposed spending limit.
Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`
Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
Output only. The approved spending limit as a well-defined type, for example, INFINITE. This will only be populated if the approved spending limit is INFINITE.
Output only. The proposed end time as a well-defined type, for example, FOREVER.
Output only. The spending limit as a well-defined type, for example, INFINITE.
Output only. The type of this proposal, for example, END to end the budget associated with this proposal.
Output only. The time when this account-level budget proposal was created. Formatted as yyyy-MM-dd HH:mm:ss.
Output only. The name to assign to the account-level budget.
Output only. The start time in yyyy-MM-dd HH:mm:ss format.
Output only. Notes associated with this budget.
Output only. The end time in yyyy-MM-dd HH:mm:ss format.
Output only. The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
Output only. The end time as a well-defined type, for example, FOREVER.
Output only. The spending limit in micros. One million is equivalent to one unit.
Immutable. The name to assign to the account-level budget.
Immutable. The proposed end date time as a well-defined type, for example, FOREVER.
Immutable. The proposed start date time as a well-defined type, for example, NOW.
Immutable. The resource name of the billing setup associated with this proposal.
Output only. The approved spending limit as a well-defined type, for example, INFINITE.
Immutable. The resource name of the account-level budget associated with this proposal.
Output only. The approved spending limit in micros. One million is equivalent to one unit.
Immutable. Notes associated with this budget.
Immutable. The proposed spending limit as a well-defined type, for example, INFINITE.
Immutable. The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
Output only. The approved end date time as a well-defined type, for example, FOREVER.
Immutable. The type of this proposal, for example, END to end the budget associated with this proposal.
Immutable. A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices.
Output only. The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable.
Immutable. The proposed spending limit in micros. One million is equivalent to one unit.
Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format.
Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format.
Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format.
Output only. The status of this proposal. When a new proposal is created, the status defaults to PENDING.
Output only. The date time when this account-level budget was approved, if applicable.
Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format.
Immutable. A third party app analytics link.
Output only. The ID of the link. This field is read only.
Output only. The type of the linked account.
Immutable. Resource name of the account link. AccountLink resource names have the form: `customers/{customer_id}/accountLinks/{account_link_id}`
Immutable. The ID of the app analytics provider. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
Immutable. A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "422689480" for "Gmail" whose App Store link is https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For Android, the ID string is the application's package name (for example, "com.google.android.gm" for "Gmail" given Google Play link https://play.google.com/store/apps/details?id=com.google.android.gm) This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
Immutable. The vendor of the app. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
String value of the activity city. The Geo Target Constant resource name.
String value of the activity country. The Geo Target Constant resource name.
String value of the activity state. The Geo Target Constant resource name.
Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.
Details pertaining to a Demand Gen video responsive ad.
Details pertaining to a display upload ad.
The list of mappings that can be used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`. For mutates, use url custom parameter operations.
The URL that appears in the ad description for some ad formats.
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.
Immutable. Details pertaining to an Image ad.
Output only. If this ad is system managed, then this field will indicate the source. This field is read-only.
Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
Details pertaining to a Demand Gen carousel ad.
Details pertaining to a Smart Shopping ad.
Details pertaining to a Shopping Comparison Listing ad.
Details pertaining to a Smart campaign ad.
Details pertaining to an app engagement ad.
Details pertaining to a Demand Gen multi asset ad.
Immutable. Details pertaining to a legacy app install ad.
Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, LegacyAppInstallAd, ShoppingComparisonListingAd, VideoAd, VideoResponsiveAd and DemandGen ads.
Details pertaining to a responsive search ad.
Details pertaining to a Demand Gen product ad.
Details pertaining to a Video responsive ad.
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
Details pertaining to an app pre-registration ad.
The URL template for constructing a tracking URL.
Details pertaining to a legacy responsive display ad.
Immutable. Details pertaining to an Expanded Dynamic Search Ad. This type of ad has its headline, final URLs, and display URL auto-generated at serving time according to domain name specific information provided by `dynamic_search_ads_setting` linked at the campaign level.
A list of final app URLs that will be used on mobile if the user has the specific app installed.
The suffix to use when constructing a final URL.
Immutable. Details pertaining to a text ad.
The list of possible final URLs after all cross-domain redirects for the ad.
Details pertaining to an expanded text ad. Expanded text ads are deprecated. Use `ResponsiveSearchAd` instead.
The list of possible final mobile URLs after all cross-domain redirects for the ad.
Details pertaining to a Shopping product ad.
Details pertaining to a responsive display ad.
List of text assets used for the short headline.
Required. List of YouTube video assets used for the ad.
List of text assets used for the long headline.
List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.
Second part of text that appears in the ad with the displayed URL.
List of text assets used for the description.
Assets of type CallToActionAsset used for the "Call To Action" button.
First part of text that appears in the ad with the displayed URL.
Required. 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%).
The pinned field of the asset. This restricts the asset to only serve within this field. Multiple assets can be pinned to the same field. An asset that is unpinned or pinned to a different field will not serve in a field where some other asset has been pinned.
The performance label of this text asset.
The list of policy findings for this asset.
The overall approval status of this asset, which is calculated based on the status of its individual policy topic entries.
Describes the negative or positive effect this policy will have on serving.
Policy topic this finding refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time.
Additional information that explains policy finding (for example, the brand name for a trademark finding).
Indicates how serving of this resource may be affected (for example, not serving in a country).
List of websites linked with this resource.
List of evidence found in the text of a resource.
Mismatch between the destinations of a resource's URLs.
Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
The language the resource was detected to be written in. This is an IETF language tag such as "en-US".
The text in the destination of the resource that is causing a policy finding.
Websites that caused the policy finding.
The fragments of text from the resource that caused the policy finding.
The set of URLs that did not match each other.
The time the URL was last checked. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
The type of device that failed to load the URL.
List of text found in the resource's destination page.
Countries where the resource cannot serve.
Countries where a certificate is required for serving.
certificate domain mismatch in country list
Countries where the resource's domain is not covered by the certificates associated with it.
Total number of countries targeted by the resource.
Countries in which serving is restricted.
Geo target constant resource name of the country in which serving is constrained.
Contains info fields for this AdVideoAsset.
Defines feature controls for this AdVideoAsset during serving time. For example, whether YouTube comments should be enabled for Partnership Ads served on YouTube Shorts.
List of inventory preferences for this AdVideoAsset. This field can only be set for DiscoveryVideoResponsiveAd. The video assets with an inventory asset preference set will be preferred over other videos from the same ad during serving time. For example, consider this ad being served for a specific inventory. The server will first try to match an eligible video with a matching preference for that inventory. Videos with no preferences are chosen only when a video with matching preference and eligible for a given ad slot can be found.
Defines if YouTube comments should be enabled for the creative using this YouTube video asset served on YouTube Shorts.
When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve In Stream.
When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve In Feed.
When true, YouTube Video Asset with this inventory preference will be preferred when choosing a video to serve on YouTube Shorts.
The Asset resource name of this call to action asset.
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898 for more information.
The product type of this ad. See comments on the enum for details.
The Asset resource name of this media bundle.
The key matching the parameter tag name.
Height in pixels of the full size image.
Height in pixels of the preview size image.
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.
Width in pixels of the preview size image.
Required. Carousel cards that will display with the ad. Min 2 max 10.
Required. The descriptive text of the ad.
Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).
The Asset resource name of this discovery carousel card.
Video non-skippable in-stream ad format.
The YouTube video assets used for the ad.
The image assets of the companion banner used with the ad.
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.
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 "Call To Action" button to give context and encourage clicking on the button.
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters.
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.
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 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.
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.
The Advertiser/brand name. Maximum display width is 25. Required.
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.
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.
The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.
Classic display image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. At most 20 classic display images can be specified per ad.
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.
Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.
The app store the mobile app is available in.
First part of text that can be appended to the URL in the ad.
Second part of text that can be appended to the URL in the ad. This field can only be set when `path1` is also set.
Asset of type CallToActionAsset used for the "Call To Action" button.
Required. Text asset used for the short headline.
Required. Text asset used for the description.
Output only. Information about synthetic content generated by Google's systems.
Indicates whether the content is considered synthetic by this source.
The source of the synthetic content attestation.
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.
Required. List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.
List of text assets used for the long headline. Currently, only a single value for the long headline is supported.
Required. Advertiser/brand name. Maximum display width is 25 characters.
Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1(+-1%).
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.
Unique identifier for this UrlCollection instance.
URL template for constructing a tracking URL.
List of YouTube video asset IDs whose videos may be displayed with the ad.
List of image asset IDs whose images may be displayed with the ad.
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.
Specifies which format the ad will be served in. Default is ALL_FORMATS.
The main color of the ad in hexadecimal, for example, #ffffff for white. If one of `main_color` and `accent_color` is set, the other is required as well.
The accent color of the ad in hexadecimal, for example, #ffffff for white. If one of `main_color` and `accent_color` is set, the other is required as well.
Prefix before price. For example, 'as low as'.
The MediaFile resource name of the logo image used in the ad.
Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.
The MediaFile resource name of the marketing image used in the ad.
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.
List of YouTube video assets that may be displayed with the ad.
List of media bundle assets that may be used with the ad.
An app deep link asset that may be used with the ad.
The Asset resource name of this app deep link asset.
The operating system targeted by this URL. Required.
The app deep link URL. Deep links specify a location in an app that corresponds to the content you'd like to show, and should be of the form {scheme}://{host_path} The scheme identifies which app to open. For your app, you can use a custom scheme that starts with the app's name. The host and path specify the unique location in the app where your content exists. Example: "exampleapp://productid_1234". Required.
The second line of the ad's description.
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 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 YouTube video assets that may be displayed with the ad. At least 1 and at most 20 video assets must be specified.
Second part of optional text that can be appended to the URL in the ad. This field can only be set when `path1` is also set.
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 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.
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.
First part of optional text that can be appended to the URL in the ad.
Additional text that can appear alongside the ad's displayed URL.
The text that can appear alongside the ad's displayed URL.
The advertiser/brand name. Maximum display width is 25.
A required long format headline. The maximum length is 90 characters.
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.
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one `marketing_image` is required. Combined with `square_marketing_images`, the maximum is 15.
Specification for various creative controls.
The call-to-action text for the ad. Maximum display width is 30.
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.
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square `marketing_image` is required. Combined with `marketing_images`, the maximum is 15.
Optional YouTube videos for the ad. A maximum of 5 videos can be specified.
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.
Whether the advertiser has opted into auto-gen video feature.
Whether the advertiser has opted into the asset enhancements feature.
Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
URL template for appending params to Final URL.
Settings for AI Max feature in standard search adgroups.
Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
Output only. Source of the effective target ROAS. This field is read-only.
When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.
True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
Output only. The resource names of labels attached to this ad group.
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.
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.
Average amount in micros that the advertiser is willing to pay for every ad click. Overrides the target CPC configured at the campaign level.
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
Output only. Source of the effective target CPA. This field is read-only.
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
The target ROAS (return-on-ad-spend) for this ad group. This field lets you override the target ROAS specified in the campaign's bidding strategy, but only if the campaign is using a standard (not portfolio) `TargetRoas` strategy or a standard `MaximizeConversionValue` strategy with its `target_roas` field set. If the campaign is using a portfolio bidding strategy, this field cannot be set and attempting to do so will result in an error. For any other bidding strategies, this value is ignored. To see the actual target ROAS being used by the ad group, considering potential overrides, query the `effective_target_roas` and `effective_target_roas_source` fields.
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.
The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
Average amount in micros that the advertiser is willing to pay for every ad view.
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.
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
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].
The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy.
The maximum CPM (cost-per-thousand viewable impressions) bid.
Immutable. Setting for audience related features.
Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
Output only. Source of the effective target CPC. This field is read-only.
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
Immutable. The campaign to which the ad group belongs.
Output only. The effective target CPC (cost-per-click). This field is read-only.
Vertical ads setting feature to enable/disable ad group format controls in search campaigns. This setting requires AiMaxAdGroupSetting to be enabled and a travel feed to be attached to the campaign.
Disable search term matching for this adgroup when AI Max is enabled. Search term matching uses broad match, asset-based, and landing page-based technology to improve reach.
The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
The list of operations changing the target restrictions. Adding a target restriction with a targeting dimension that already exists causes the existing target restriction to be replaced with the new value.
The targeting dimension that these settings apply to.
Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
The target restriction being added to or removed from the list.
The video ads sequence step settings containing step ID.
The ID of this sequence step from an existing `campaign.video_campaign_settings.video_ad_sequence` definition. Only one Ad Group can point to a given `step_id`.
Immutable. If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.
Channel controls for Demand Gen ad groups.
Explicitly selected channels. This field should be set with at least one true value when present.
Output only. Channel configuration reflecting which field in the oneof is populated.
Whether to enable ads on the YouTube In-Stream 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 Shorts channel.
Whether to enable ads on the Discover channel.
Whether to enable ads on the Maps channel.
Whether to enable ads on the Display channel.
If true, vertical promotion ads will be enabled for this ad group.
If true, text ads will be disabled for this ad group.
If true, booking links will be enabled for this ad group.
Output only. Provides aggregated view into why an ad group ad is not serving or not serving optimally.
Immutable. The ad group to which the ad belongs.
Output only. Overall ad strength for this ad group ad.
Immutable. The resource name of the ad. Ad group ad resource names have the form: `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
Output only. The resource names of labels attached to this ad group ad.
The date and time when ad group ad starts serving. This is added on top of the campaign's start date and time, if present, to further restrict the duration of an ad group ad. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Only supported for some ad types.
Output only. Policy information for the ad.
Output only. Provides reasons for why an ad group ad is not serving or not serving optimally.
The last day and time when ad group ad serves. This is added on top of the campaign's end date and time, if present, to further restrict the duration of an ad group ad. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Only supported for some ad types.
Settings that control the types of asset automation. See the AssetAutomationTypeEnum documentation for the default opt in/out behavior of each type.
Output only. 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.".
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries.
Output only. The list of policy findings for this ad.
Output only. Where in the review process this ad is.
The asset automation type that this setting configures.
The opt-in/out status for the specified asset automation type.
Output only. The status between the asset combination and the latest version of the ad. If true, the asset combination is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.
Output only. The resource name of the ad group ad asset combination view. The combination ID is 128 bits long, where the upper 64 bits are stored in asset_combination_id_high, and the lower 64 bits are stored in asset_combination_id_low. AdGroupAd Asset Combination view resource names have the form: `customers/{customer_id}/adGroupAdAssetCombinationViews/{AdGroupAd.ad_group_id}~{AdGroupAd.ad.ad_id}~{AssetCombination.asset_combination_id_low}~{AssetCombination.asset_combination_id_high}`
Output only. The overall approval status of this ad group ad asset, calculated based on the status of its individual policy topic entries.
Output only. The list of policy findings for the ad group ad asset.
Output only. Where in the review process this ad group ad asset is.
Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4): `customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}` Ad group ad asset view resource names have the form (Beginning from V4): `customers/{customer_id}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}`
Output only. Role that the asset takes in the ad.
Output only. The status between the asset and the latest version of the ad. If true, the asset is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.
Output only. The asset which is linked to the ad group ad.
Output only. Performance of an asset linkage.
Output only. Source of the ad group ad asset.
Output only. The ad group ad to which the asset is linked.
Output only. Policy information for the ad group ad asset.
Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`
Immutable. The ad group ad to which the label is attached.
Immutable. The label assigned to the ad group ad.
Required. Immutable. The asset which is linked to the ad group.
Output only. Source of the adgroup asset link.
Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
Output only. Provides the details of the primary status and its associated reasons.
Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
Required. Immutable. The ad group to which the asset is linked.
Immutable. The resource name of the ad group asset. AdGroupAsset resource names have the form: `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
Required. Immutable. Role that the asset takes under the linked ad group.
Provides the details for AssetLinkPrimaryStatusReason.ASSET_DISAPPROVED
Provides the PrimaryStatus of this status detail.
Provides the reason of this PrimaryStatus.
Provides the quality evaluation disapproval reason of an asset.
Immutable. The ad group to which this asset set is linked.
Immutable. The resource name of the ad group asset set. Ad group asset set resource names have the form: `customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}`
Immutable. The asset set which is linked to the ad group.
Output only. The status of the ad group asset set. Read-only.
Output only. The resource name of the ad group audience view. Ad group audience view resource names have the form: `customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}`
Immutable. Criterion for length of hotel stay in nights.
Immutable. Criterion for number of days prior to the stay the booking is being made.
Immutable. Criterion for day of the week the booking is for.
Immutable. Criterion for hotel date selection (default dates versus user selected).
Immutable. Criterion for a hotel check-in date range.
Immutable. The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Use 0 to opt out of a Device type.
Immutable. The ad group to which this criterion belongs.
Output only. The base ad group from which this draft/trial adgroup bid modifier was created. If ad_group is a base ad group then this field will be equal to ad_group. If the ad group was created in the draft or trial and has no corresponding base ad group, then this field will be null. This field is readonly.
Low end of the number of nights in the stay.
High end of the number of nights in the stay.
Low end of the number of days prior to the stay.
High end of the number of days prior to the stay.
Output only. The display name of the criterion. This field is ignored for mutates.
Immutable. The ad group to which the criterion belongs.
Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
The CPM (cost-per-thousand viewable impressions) bid.
Output only. Information regarding the quality of the criterion.
Immutable. Extended demographic criterion.
Output only. Source of the effective CPV bid.
Output only. Source of the effective Percent CPC bid.
Output only. The resource names of labels attached to this ad group criterion.
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942 This field is read-only.
The list of possible final mobile URLs after all cross-domain redirects.
Output only. Source of the effective CPC bid.
Output only. The primary status reasons for the ad group 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.
Output only. Source of the effective CPM bid.
Output only. The effective CPV (cost-per-view) bid.
Output only. The ID of the criterion. This field is ignored for mutates.
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].
Output only. Serving status of the criterion.
Output only. Approval status of the criterion.
Immutable. Whether to target (`false`) or exclude (`true`) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
Immutable. Life event campaign criterion.
Output only. The primary status for the ad group criterion.
Output only. Estimates for criterion bids at various positions.
Output only. The effective Percent CPC bid amount.
Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
Immutable. Vertical ads item group rule list criterion.
Output only. The effective CPC (cost-per-click) bid.
Shared set resource name of the brand list.
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category.
The mobile app category constant resource name.
Output only. The performance of the ad compared to other advertisers.
Output only. The click-through rate compared to that of other advertisers.
Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
Output only. The quality score of the landing page.
The text of the keyword (at most 80 characters and 10 words).
Taxonomy id of the extended demographic group.
Dimension value with which this listing group is refining its parent. Undefined for the root group.
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
The path of dimensions defining this listing group.
Unknown dimension. Set when no other listing dimension is set.
The country where the travel activity is available.
Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
Labels of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
Class of the hotel as a number of stars 1 to 5.
The state where the travel activity is available.
The city where the travel activity is available.
Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
Country or Region the hotel is located in.
Rating of the activity as a number 1 to 5, where 5 is the best.
Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
String value of the product legacy condition.
String value of the product custom attribute.
Indicates the index of the custom attribute.
The complete path of dimensions through the listing group hierarchy, from the root (excluding the root itself) to this listing group.
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android, this native identifier is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link "https://play.google.com/store/apps/details?id=com.labpixies.colordrips"). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations.
The YouTube uploader channel id or the channel code of a YouTube channel.
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
List of sample urls that match the website target. This field is read-only.
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
Operator of webpage targeting condition.
Argument of webpage targeting condition.
YouTube video id as it appears on the YouTube watch page.
URL of the placement. For example, "http://www.domain.com".
The resource name of the shared set that contains the retail filter. This field is required.
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
estimated add cost at first position cpc
Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.
estimated add clicks at first position cpc
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
The shared set resource name of the vertical ads item group rule list.
ID for a Video lineup. Contact your Google business development representative for details.
Immutable. The resource name of the ad group criterion customizer. Ad group criterion customizer resource names have the form: `customers/{customer_id}/adGroupCriterionCustomizers/{ad_group_id}~{criterion_id}~{customizer_attribute_id}`
Required. Immutable. The customizer attribute which is linked to the ad group criterion.
Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
Output only. The status of the ad group criterion customizer.
Immutable. The ad group criterion to which the customizer attribute is linked. It must be a keyword criterion.
Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type.
Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.
Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`
Immutable. The label assigned to the ad group criterion.
Immutable. The ad group criterion to which the label is attached.
Output only. First day on which the simulation is based, in YYYY-MM-DD format.
Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
Output only. Simulation points if the simulation type is CPC_BID.
Output only. How the simulation modifies the field.
Output only. The field that the simulation modifies.
Output only. The resource name of the ad group criterion simulation. Ad group criterion simulation resource names have the form: `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
Output only. Criterion ID of the simulation.
Output only. Last day on which the simulation is based, in YYYY-MM-DD format.
Output only. AdGroup ID of the simulation.
Projected metrics for a series of percent CPC bid amounts.
Projected number of biddable conversions.
Projected number of top slot impressions.
Projected total value of biddable conversions in local currency.
The simulated percent CPC upon which projected metrics are based. Percent CPC expressed as fraction of the advertised price for some good or service. The value stored here is 1,000,000 * [fraction].
Projected metrics for a series of CPC bid amounts.
Projected number of top slot impressions. Only search advertising channel type supports this field.
The simulated CPC bid upon which projected metrics are based.
Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.
Projected total value of biddable conversions.
The simulated scaling modifier upon which projected metrics are based. All CPC bids relevant to the simulated entity are scaled by this modifier.
Required. Immutable. The customizer attribute which is linked to the ad group.
Immutable. The ad group to which the customizer attribute is linked.
Immutable. The resource name of the ad group customizer. Ad group customizer resource names have the form: `customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}`
Output only. The status of the ad group customizer.
Immutable. The label assigned to the ad group.
Immutable. The ad group to which the label is attached.
Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
Output only. Ad group id of the simulation.
Output only. Simulation points if the simulation type is TARGET_CPA.
Output only. Simulation points if the simulation type is CPV_BID.
Output only. The resource name of the ad group simulation. Ad group simulation resource names have the form: `customers/{customer_id}/adGroupSimulations/{ad_group_id}~{type}~{modification_method}~{start_date}~{end_date}`
Output only. Simulation points if the simulation type is TARGET_ROAS.
Projected metrics for a series of target CPA amounts.
Projected number of interactions. Only discovery advertising channel type supports this field.
The simulated target CPA upon which projected metrics are based.
The simulated scaling modifier upon which projected metrics are based. All CPA targets relevant to the simulated entity are scaled by this modifier.
Projected metrics for a series of CPV bid amounts.
The simulated CPV bid upon which projected metrics are based.
Projected metrics for a series of target ROAS amounts.
The simulated target ROAS upon which projected metrics are based.
Immutable. The ad group criterion that this ad parameter belongs to.
Numeric value to insert into the ad text. The following restrictions apply: - Can use comma or period as a separator, with an optional period or comma (respectively) for fractional values. For example, 1,000,000.00 and 2.000.000,10 are valid. - Can be prepended or appended with a currency symbol. For example, $99.99 is valid. - Can be prepended or appended with a currency code. For example, 99.99USD and EUR200 are valid. - Can use '%'. For example, 1.0% and 1,0% are valid. - Can use plus or minus. For example, -10.99 and 25+ are valid. - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are valid.
Immutable. The unique index of this ad parameter. Must be either 1 or 2.
Immutable. The resource name of the ad parameter. Ad parameter resource names have the form: `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: `customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}`
Output only. The action item details for action item type ADD_ASSET.
Output only. The asset field type of the asset(s) to add.
Output only. The number of assets to add.
Output only. For video field types, the required aspect ratio of the video. When unset and asset_field_type is YOUTUBE_VIDEO, the system recommends the advertiser upload any YouTube video, regardless of aspect ratio.
Output only. The resource name of the advertising partner Google Ads account. This field is required and should not be empty when creating a new Advertising Partner link. It is unable to be modified after the creation of the link.
Immutable. The resource name of the advertising partner Google Ads account. This field is read only.
Immutable. The allowed domain for the Advertising Partner link invitation. The advertising partner will only be able to advertise on this domain. The field is immutable after the creation of the link invitation.
Output only. The allowed domain for the Advertising Partner link. The advertising partner will only be able to advertise on this domain. The field is immutable.
Include users whose age is not determined.
Contiguous age range to be included in the dimension.
Minimum age to include. A minimum age must be specified and must be at least 18. Allowed values are 18, 25, 35, 45, 55, and 65.
Maximum age to include. A maximum age need not be specified. If specified, max_age must be greater than min_age, and allowed values are 24, 34, 44, 54, and 64.
Output only. The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}`
Output only. Ad group where the search term served.
Output only. The destination URL, which was dynamically generated. This field is read-only.
Output only. The resource name of the AI Max Search Term Ad Combination view AI Max Search Term Ad Combination view resource names have the form: `customers/{customer_id}/aiMaxSearchTermAdCombinationViews/{ad_group_id}~{URL-base64_search_term}~{URL-base64_landing_page}~{URL-base64_headline}`
Output only. The search term that triggered the ad. This field is read-only.
Output only. The concatenated string containing headline assets for the ad. Up to three headline assets are concatenated, separated by " | ". This field is read-only.
Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleAdGroups/{campaign_id}~{ad_group_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
Output only. The network type enum used in the share key encoding.
Output only. The ad group ID used in the share key encoding.
Output only. The campaign ID used in the share key encoding.
Output only. 128 bit hex string of the encoded shared ad group key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
Output only. The interaction type enum used in the share key encoding.
Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleCampaigns/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
Output only. 128 bit hex string of the encoded shared campaign key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
Output only. 128 bit hex string of the encoded shared network type key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleNetworkTypes/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
The uri for the app deep link, The uri can be either a custom scheme uri (e.g. mystore://shoes) or universal uri (e.g. http://www.mystore.com/shoes).
Output only. The currency code for all monetary amounts (for example, "USD").
Output only. The time when the granted reward expires in "YYYY-MM-DD HH:MM:SS" format in UTC. This field is not set if the reward has not been granted.
Output only. The time by which the incentive's fulfillment requirements must be met, in "YYYY-MM-DD HH:MM:SS" format in UTC.
Output only. The coupon code of the incentive.
Output only. The minimum amount that must be spent to fulfill the coupon requirements, in micros.
Output only. The amount of the reward granted in micros. This field is not set if the reward has not been granted.
Output only. The current state of the incentive.
Output only. The redemption time of the incentive in "YYYY-MM-DD HH:MM:SS" format in UTC.
Output only. The maximum potential reward amount in micros for the incentive.
Output only. The time when the reward was granted in "YYYY-MM-DD HH:MM:SS" format in UTC. This field is not set if the reward has not been granted.
Output only. The resource name of the incentive. Incentive resource names have the form: `customers/{customer_id}/appliedIncentives/{coupon_code}`
Output only. The remaining balance of the granted reward in micros. This field is not set if the reward has not been granted.
current spend towards fulfillment micros
Output only. The current amount spent towards the fulfillment requirements, in micros.
Output only. The resource name of the app top combination view. App Top Combination view resource names have the form: `customers/{customer_id}/appTopCombinationViews/{ad_group_id}~{ad_id}~{asset_combination_category}`
Output only. The top combinations of assets that served together.
A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls.
Immutable. The resource name of the asset. Asset resource names have the form: `customers/{customer_id}/assets/{asset_id}`
Output only. Policy information for the asset for each FieldType.
Output only. Policy information for the asset.
Output only. Orientation of the asset. This is only supported for image and video assets.
A list of possible final mobile URLs after all cross domain redirects.
A list of possible final URLs after all cross domain redirects.
Immutable. A Demand Gen carousel card asset.
URL template for appending params to landing page URLs served with parallel tracking.
Required. URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
iOS deep link, for example, exampleApp://content/page.
Location ID which can be any sequence of letters and digits. The ID sequence (job ID + location ID) must be unique.
Image URL, for example, http://www.example.com/image.png. The image will not be uploaded as image asset.
Android deep link, for example, android-app://com.example.android/http/example.com/gizmos?1234.
Required. Job ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
Address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
Required. Job title, for example, Software engineer. Required.
Contextual keywords, for example, Software engineering job.
Description, for example, Apply your technical skills.
iOS app store ID. This is used to check if the user has the app installed on their device before deep linking. If this field is set, then the ios_app_link field must also be present.
Required. The name of the business being advertised.
Required. Link to a page describing the policy on how the collected data is handled by the advertiser/business.
Custom disclosure shown along with Google disclaimer on the lead form. Accessible to allowed customers only.
Headline of text shown after form submission that describes how the advertiser will follow up with the user.
Ordered list of input fields. This field can be updated by reordering questions, but not by adding or removing questions.
Ordered list of custom question fields. This field is subject to a limit of 5 qualifying questions per form.
Detailed description shown after form submission that describes how the advertiser will follow up with the user.
Configured methods for collected lead data to be delivered to advertiser. Only one method typed as WebhookDelivery can be configured.
Chosen intent for the lead form, for example, more volume or more qualified.
Pre-defined display text that encourages user action after the form is submitted.
Asset resource name of the background image. The image dimensions must be exactly 1200x628.
Required. Pre-defined display text that encourages user to expand the form.
Required. Headline of the expanded form to describe what the form is asking for or facilitating.
Required. Text giving a clear value proposition of what users expect once they expand the form.
Required. Detailed description of the expanded form to describe what the form is asking for or facilitating.
Describes the input type, which may be a predefined type such as "full name" or a pre-vetted question like "What kind of vehicle do you have?".
Answer configuration for a single choice question. Can be set only for pre-vetted question fields. Minimum of 2 answers required and maximum of 12 allowed.
Answer configuration for location question. If true, campaign/account level location data (state, city, business name etc) will be rendered on the Lead Form. Starting V13.1, has_location_answer can only be set for "What is your preferred dealership?" question, for advertisers with Location Assets setup at campaign/account level.
List of choices for a single question field. The order of entries defines UI order. Minimum of 2 answers required and maximum of 12 allowed.
Answer configuration for a single choice question. Minimum of 2 answers and maximum of 12 allowed.
The exact custom question field text (for example, "What kind of vehicle do you have?").
Anti-spoofing secret set by the advertiser as part of the webhook payload.
Webhook url specified by advertiser to send the lead.
The schema version that this delivery instance will use.
Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $100.00.
Required. Title, for example, Book your train ticket. Required.
Origin ID which can be any sequence of letters and digits. The ID sequence (destination ID + origin ID) must be unique.
Similar destination IDs, for example, NYC.
Sale price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $80.00.
Required. Destination ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
Contextual keywords, for example, Paris trains.
Destination address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
Price which can be a number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
Required. A welcome message to prompt the user to initiate a conversation.
Required. Message provider of the business message asset.
A call to action for the business message asset.
Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
Required. Whatsapp phone number of the business. Examples: '1234567890', '(123)456-7890'.
Zalo Official Account ID of the advertiser.
Custom name generated by the advertiser for their Zalo Account. These names will usually be registered brands or trademarks.
Required. Pre-defined call to action text.
Required. Text providing a clear value proposition of what users expect once they take the action. Examples: 'Message us for a quote', 'Ask our expert team'.
Required. Facebook page name used for starting a chat on Facebook Messenger.
Barcode info used to generate promotion barcode for user to be eligible for the promotion.
The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion.
A code the user should use in order to be eligible for the promotion.
Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
Money amount off for discount in the promotion. Either this or percent_off is required.
A modifier for qualification of the discount.
QR code info used to generate promotion QR code for user to be eligible for the promotion.
The amount the total order needs to be for the user to be eligible for the promotion.
Required. A freeform description of what the promotion is targeting.
The language of the promotion. Represented as BCP 47 language tag.
Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required.
URI to the terms and conditions of the promotion.
Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.
Barcode type used to generate barcode with the correct format.
Promotion message to be encoded in the barcode.
Amount in micros. One million is equivalent to one unit.
Promotion message to be encoded in the QR code.
The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.
Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
Business Profile store code of this location. This is synced from the Business Profile account.
Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.
Listing ID of this Business Profile location. This is synced from the linked Business Profile account.
List of videos. Each is a reference to a YouTube video asset. Minimum of 2 videos required and maximum of 5 allowed.
YouTube video id. This is the 11 character string value used in the YouTube video URL.
Required. Listing name, for example, Boulevard Bungalow. Required.
City name, for example, Mountain View, California.
Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 200,000.00 USD.
Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $200,000.00.
Contextual keywords, for example, For sale; Houses for sale.
Required. Listing ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
Description, for example, 3 beds, 2 baths, 1568 sq. ft.
Media bundle (ZIP file) asset data. The format of the uploaded ZIP file depends on the ad field where it will be used. For more information on the format, see the documentation of the ad field where you plan on using the MediaBundleAsset. This field is mutate only.
Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
Required. Deal name, for example, 50% off at Mountain View Grocers. Required.
Contextual keywords, for example, Save groceries coupons.
Description, for example, Save on your weekly bill.
Required. Deal ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
Required. The webpage that advertisers want to target.
Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.
Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
Star rating. Must be a number between 1 to 5, inclusive.
Destination name, for example, Downtown Mountain View.
Required. Property name, for example, Mountain View Hotel. Required.
Required. Property ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
Contextual keywords, for example, Mountain View "Hotels", South Bay hotels.
Description, for example, Close to SJC Airport.
ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'price' field.
Flight sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD. Must be less than the 'flight_price' field.
Similar destination IDs, for example, PAR,LON.
Required. Flight description, for example, Book your ticket. Required.
Flight price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
A custom field which can be multiple key to values mapping separated by delimiters (",", "|" and ":"), in the forms of ": , , ... , | : , ... , | ... | : , ... ," for example, wifi: most | aircraft: 320, 77W | flights: 42 | legroom: 32".
Place IDs uniquely identify a place in the Google Places database and on Google Maps. See https://developers.google.com/places/web-service/place-id to learn more.
Price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 20,000.00 USD.
Item subtitle, for example, At your Mountain View dealership.
Required. Item title, for example, Mid-size sedan. Required.
Contextual keywords, for example, Sedans, 4 door sedans.
Item description, for example, Best selling mid-size car.
Required. ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag, for example, sedan. Required.
Sale price which can be number followed by the alphabetic currency code, ISO 4217 standard. Use '.' as the decimal mark, for example, 15,000.00 USD. Must be less than the 'price' field.
Formatted sale price which can be any characters. If set, this attribute will be used instead of 'sale price', for example, On sale for $15,000.00.
Item address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
ID2 which can be any sequence of letters and digits, for example, red. ID sequence (ID + ID2) must be unique.
Formatted price which can be any characters. If set, this attribute will be used instead of 'price', for example, Starting at $20,000.00.
Required. The text of the hotel callout asset. The length of this string should be between 1 and 25, inclusive.
Required. The language of the hotel callout. Represented as BCP 47 language tag.
Output only. The list of policy findings for this asset.
Output only. Where in the review process this asset is.
Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries.
Required. The language of the price asset. Represented as BCP 47 language tag.
The price offerings of the price asset. The size of this collection should be between 3 and 8, inclusive.
Required. The header of the price offering. The length of this string should be between 1 and 25, inclusive.
The final mobile URL after all cross domain redirects.
Required. The description of the price offering. The length of this string should be between 1 and 25, inclusive.
Required. The price value of the price offering.
Required. The final URL after all cross domain redirects.
The raw bytes data of an image. This field is mutate only.
Metadata for this image at its original size.
A URL that returns the image with this height and width.
School address which can be specified in one of the following formats. (1) City, state, code, country, for example, Mountain View, CA, USA. (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043. (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
School name, for example, Mountain View School of Nursing.
Location ID which can be any sequence of letters and digits and must be unique.
Required. Program ID which can be any sequence of letters and digits, and must be unique and match the values of remarketing tag. Required.
Required. Program name, for example, Nursing. Required.
Thumbnail image url, for example, http://www.example.com/thumbnail.png. The thumbnail image will not be uploaded as image asset.
Contextual keywords, for example, Nursing certification, Health, Mountain View.
Program description, for example, Nursing Certification.
Required. The header of the snippet. This string should be one of the predefined values at https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers
Required. The values in the snippet. The size of this collection should be between 3 and 10, inclusive. The length of each value should be between 1 and 25 characters, inclusive.
Required. The visible text displayed when the link is rendered in an ad. The length of this string should be between 1 and 25, inclusive.
Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.
Required. The application store that distributes this specific app.
Asset resource name of the associated square marketing image. This and/or a marketing image asset is required.
Asset resource name of the associated 4:5 portrait marketing image.
Asset resource name of the associated 1.91:1 marketing image. This and/or square marketing image asset is required.
Required. Headline of the carousel card.
Required. The callout text. The length of this string should be between 1 and 25, inclusive.
Output only. A list of action items to improve the ad strength of an asset group.
Output only. The resource name of the asset field type view. Asset field type view resource names have the form: `customers/{customer_id}/assetFieldTypeViews/{field_type}`
Output only. The asset field type of the asset field type view.
Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`
A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
Output only. Overall ad strength of this asset group.
A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.
Output only. The asset coverage of this asset group.
Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.
First part of text that may appear appended to the url displayed in the ad.
Immutable. The local services category associated with this asset group. That is, XCAT format - xcat:service_area_business_plumber. See https://developers.google.com/google-ads/api/data/codes-formats#local-services-category-ids This field cannot be modified after the AssetGroup has been created.
Callouts selected by the advertiser to show.
Immutable. The asset which this asset group asset is linking.
Output only. Source of the asset group asset.
Output only. The policy information for this asset group asset.
Immutable. The asset group which this asset group asset is linking.
Immutable. The resource name of the asset group asset. Asset group asset resource name have the form: `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`
The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc
The status of the link between an asset and asset group.
The overall approval status, which is calculated based on the status of its individual policy topic entries.
Where in the review process the resource is.
Output only. The ID of the ListingGroupFilter.
Output only. The path of dimensions defining this listing group filter.
Immutable. The source of listings filtered by this listing group filter.
Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
Immutable. Type of a listing group filter node.
Immutable. The asset group which this asset group listing group filter is part of.
Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
Filters for URLs in a page feed and URLs from the advertiser web domain.
Indicates the level of the category in the taxonomy.
The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
The RetailFilterBundle shared set resource name.
Output only. The resource name of the asset group listing group filter.
Output only. The asset group associated with the listing group filter.
Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form: `customers/{customer_id}/assetGroupProductGroupViews/{asset_group_id}~{listing_group_filter_id}`
Immutable. The local services signal to be used by the performance max campaign.
Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`
Immutable. The asset group which this asset group signal belongs to.
Immutable. The audience signal to be used by the performance max campaign.
Immutable. The list of vertical ads item group rules used to select items from the attached vertical feed. This field links to a SharedSet of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST. The rules within the linked SharedSet define which items from the TRAVEL_FEED AssetSet are eligible to be served. Items that do not match the rules will be excluded. This behavior is different from other signal types, which provide guidance to the optimization engine rather than determining item eligibility.
Immutable. The search_theme signal to be used by the performance max campaign. Mutate errors of search_theme criterion includes AssetGroupSignalError.UNSPECIFIED AssetGroupSignalError.UNKNOWN AssetGroupSignalError.TOO_MANY_WORDS AssetGroupSignalError.SEARCH_THEME_POLICY_VIOLATION FieldError.REQUIRED StringFormatError.ILLEGAL_CHARS StringLengthError.TOO_LONG ResourceCountLimitExceededError.RESOURCE_LIMIT
Output only. Approval status is the output value for search theme signal after Google ads policy review. When using Audience signal, this field is not used and will be absent.
Output only. Computed for SearchTheme signals. When using Audience signal, this field is not used and will be absent.
Each Search Theme has a value of a simple string, like keywords. There are limits on overall length, allowed characters, and number of words.
Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"`
Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
Required. Immutable. The type of the asset set. Required.
Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`
Output only. Travel Feed data. Read-only
Location asset set data. This will be used for sync level location set. This can only be set if AssetSet's type is LOCATION_SYNC.
Merchant ID and Feed Label from Google Merchant Center.
Output only. The status of the asset set. Read-only.
Represents information about a Chain dynamic location group. Only applicable if the sync level AssetSet's type is LOCATION_SYNC and sync source is chain.
Immutable. Parent asset set ID for the asset set where the elements of this asset set come from. For example: the sync level location AssetSet id where the elements in LocationGroup AssetSet come from. This field is required and only applicable for Location Group typed AssetSet.
Output only. For Performance Max for travel goals campaigns with a Hotel Center account link. Read-only.
Business Profile location group asset set data.
Required. Name of the asset set. Required. It must have a minimum length of 1 and maximum length of 128.
Output only. The Partner Center ID used for a travel vertical feed, except for Hotel, Vacation Rental, and Things to Do feeds.
Output only. Indicates the vertical type of the travel feed.
Output only. The Hotel Center account ID used for a Hotel or Vacation Rental feed.
Output only. The Merchant Center account ID used for a Things to Do feed.
Output only. Id representing a subset of the travel feed.
Data used to configure a location on chain set populated with the specified chains.
Only set if locations are synced based on selected maps locations
Required. Immutable. Location Ownership Type (owned location or affiliate location).
Data used to configure a location set populated from Google Business Profile locations.
Required. Immutable. Relationship type the specified chains have with this advertiser.
Required. A list of chain level filters, all filters are OR'ed together.
Required. Used to filter chain locations by chain id. Only chain locations that belong to the specified chain will be in the asset set.
Used to filter chain locations by location attributes. Only chain locations that belong to all of the specified attribute(s) will be in the asset set. If this field is empty, it means no filtering on this field.
Required. A list of maps location info that user manually synced in.
Used to filter Google Business Profile listings by labels. If entries exist in labelFilters, only listings that have any of the labels set are candidates to be synchronized into Assets. If no entries exist in labelFilters, then all listings are candidates for syncing. Label filters are OR'ed together.
Required. Immutable. The HTTP authorization token used to obtain authorization.
Required. Immutable. Email address of a Google Business Profile account or email address of a manager of the Google Business Profile account.
Used to filter Google Business Profile listings by listing id. If entries exist in listingIdFilters, only listings specified by the filters are candidates to be synchronized into Assets. If no entries exist in listingIdFilters, then all listings are candidates for syncing. Listing ID filters are OR'ed together.
Used to filter Google Business Profile listings by business name. If businessNameFilter is set, only listings with a matching business name are candidates to be sync'd into Assets.
Immutable. The account ID of the managed business whose locations are to be used. If this field is not set, then all businesses accessible by the user (specified by the emailAddress) are used.
Required. Merchant ID from Google Merchant Center
Optional. Feed Label from Google Merchant Center.
Used to filter chain locations by chain ids. Only Locations that belong to the specified chain(s) will be in the asset set.
Output only. The hotel center ID of the partner.
dynamic business profile location group filter
Filter for dynamic Business Profile location sets.
Used to filter Business Profile locations by label. Only locations that have any of the listed labels will be in the asset set. Label filters are OR'ed together.
Used to filter Business Profile locations by business name.
Used to filter Business Profile locations by listing ids.
Business name string to use for filtering.
The type of string matching to use when filtering with business_name.
Immutable. The asset which this asset set asset is linking to.
Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
Immutable. The asset set which this asset set asset is linking to.
Output only. The status of the asset set asset. Read-only.
Output only. The asset set type of the asset set type view.
Output only. The resource name of the asset set type view. Asset set type view resource names have the form: `customers/{customer_id}/assetSetTypeViews/{asset_set_type}`
Immutable. The resource name of the audience. Audience names have the form: `customers/{customer_id}/audiences/{audience_id}`
Immutable. The asset group that this audience is scoped under. Must be set if and only if scope is ASSET_GROUP. Immutable after creation. If an audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field will automatically be cleared.
Output only. Status of this audience. Indicates whether the audience is enabled or removed.
Positive dimensions specifying the audience composition.
Negative dimension specifying the audience composition.
Name of the audience. It should be unique across all audiences within the account. It must have a minimum length of 1 and maximum length of 255. Required when scope is not set or is set to CUSTOMER. Cannot be set or updated when scope is ASSET_GROUP.
Defines the scope this audience can be used in. By default, the scope is CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for exclusive use by a single asset_group. Scope may change from ASSET_GROUP to CUSTOMER but not from CUSTOMER to ASSET_GROUP.
Dimension specifying users by their household income.
Dimension specifying users by their age.
Dimension specifying users by their membership in other audience segments.
Dimension specifying users by their gender.
Dimension specifying users by their parental status.
Included household income demographic segments.
Include users whose household income is not determined.
Included audience segments. Users are included if they belong to at least one segment.
Include users whose gender is not determined.
Included parental status demographic segments.
Include users whose parental status is undetermined.
Output only. URL to access background case.
Output only. The timestamp when this background check case result was adjudicated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
A conversion action that's not generated from remarketing.
Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.
Output only. Contains additional information about this batch job.
Immutable. The resource name of the batch job. Batch job resource names have the form: `customers/{customer_id}/batchJobs/{batch_job_id}`
Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.
Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed. This is empty if the job hasn't started running yet.
Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.
Output only. The time when this batch job was completed. Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
Output only. The number of mutate operations in the batch job.
Output only. The time when this batch job was created. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
Immutable. The approximate upper bound for how long a batch job can be executed, in seconds. If the job runs more than the given upper bound, the job will be canceled.
Output only. The time when this batch job started running. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
Output only. The ID of the data exclusion.
Output only. The status of the data exclusion.
If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion.
The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
The description of the data exclusion. The description can be at most 2048 characters.
Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm:ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future.
The name of the data exclusion. The name can be at most 255 characters.
The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. A seasonality adjustment is forward looking and should be used for events that start and end in the future.
The scope of the seasonality adjustment.
The name of the seasonality adjustment. The name can be at most 255 characters.
Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.
The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
Output only. The ID of the seasonality adjustment.
Output only. The status of the seasonality adjustment.
The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form: `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
The description of the seasonality adjustment. The description can be at most 2048 characters.
If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.
Output only. The status of the bidding strategy. This field is read-only.
Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
A bid strategy that sets your bids to help get as many clicks as possible within your budget.
A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
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).
Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.
Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
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.
Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.
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.
An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS. This field is only mutable for portfolio bidding strategies.
Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS.
The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
The targeted location on the search results page.
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 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.
Output only. The resource name of the bidding strategy simulation. Bidding strategy simulation resource names have the form: `customers/{customer_id}/biddingStrategySimulations/{bidding_strategy_id}~{type}~{modification_method}~{start_date}~{end_date}`
Output only. Bidding strategy shared set id of the simulation.
Immutable. The start date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format. Only a future time is allowed.
Output only. The ID of the billing setup.
Output only. The status of the billing setup.
Immutable. The resource name of the payments account associated with this billing setup. Payments resource names have the form: `customers/{customer_id}/paymentsAccounts/{payments_account_id}` When setting up billing, this is used to signup with an existing payments account (and then payments_account_info should not be set). When getting a billing setup, this and payments_account_info will be populated.
Immutable. The start time as a type. Only NOW is allowed.
Immutable. The resource name of the billing setup. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`
Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format.
Output only. The end time as a type. The only possible value is FOREVER.
Immutable. The payments account information associated with this billing setup. When setting up billing, this is used to signup with a new payments account (and then payments_account should not be set). When getting a billing setup, this and payments_account will be populated.
Output only. A secondary payments profile id present in uncommon situations, for example, when a sequential liability agreement has been arranged.
Immutable. A 12 digit id used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, for example, "1234-5678-9012".
Output only. A 16 digit id used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, "1234-5678-9012-3456".
Output only. The name of the payments profile associated with the billing setup.
Immutable. The name of the payments account associated with the billing setup. This enables the user to specify a meaningful name for a payments account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices.
Output only. A text representation of a brand.
Output only. The primary url of a brand.
Output only. The rejection reason when a brand status is REJECTED.
The simulated budget upon which projected metrics are based.
Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency. Only campaigns with the Target Spend bidding strategy support this field.
Projected metrics for a series of budget amounts.
Output only. Message storing government issued number for the business.
Output only. Registration document rejection reason.
Output only. The type of business registration check (number, document).
Output only. The id of the check, such as vat_tax_id, representing "VAT Tax ID" requirement.
Output only. Message storing document info for the business.
Output only. Government-issued number for the business.
Output only. The readonly field containing the information for an uploaded business registration document.
URL to access an already uploaded Local Services document.
Enable reporting of phone call events by redirecting them through Google System.
Whether to enable call conversion reporting.
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
Output only. The call tracking display location.
Output only. Country code of the caller.
Output only. The advertiser-provided call duration in seconds.
Output only. The advertiser-provided call start date time.
Output only. The advertiser-provided call end date time.
Output only. The resource name of the call view. Call view resource names have the form: `customers/{customer_id}/callViews/{call_detail_id}`
Output only. Area code of the caller. Null if the call duration is shorter than 15 seconds.
Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
The last day and time of the campaign in serving customer's timezone in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily granularity, time granularity is only supported for some campaign types. On create, defaults to running indefinitely. To set an existing campaign to run indefinitely, clear this field.
A bidding strategy that automatically optimizes cost per thousand impressions.
A manual bidding strategy with a fixed CPM.
view through conversion optimization enabled
Whether VTC (View-through Conversion) optimization is enabled for this campaign. Only allowed for certain Demand Gen and App Campaigns.
An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set.
Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
The date and time when campaign started in serving. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 00:00:00 for daily granularity, time granularity is only supported for some campaign types.
Output only. The system status of the campaign's bidding strategy.
Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
An automated bidding strategy that sets bids to optimize performance given the target CPV you set.
Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to `resource_name`. This field is read-only.
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
Immutable. Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
Output only. 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.
Output only. The type of campaign: normal, draft, or experiment.
Optimization goal setting for this campaign, which includes a set of optimization goal types.
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
The Local Services Campaign related settings.
Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
Immutable. Whether Brand Guidelines are enabled for this Campaign. Only applicable to Performance Max campaigns. If enabled, business name and logo assets must be linked as CampaignAssets instead of AssetGroupAssets. Writable only at campaign creation. Set to true to enable Brand Guidelines when creating a new Performance Max campaign. Immutable after creation. This field cannot be modified using standard update operations after the campaign has been created. For existing campaigns: To enable Brand Guidelines on a campaign after it has been created, use the CampaignService.EnablePMaxBrandGuidelines method, which is a separate operation. It is not possible to disable Brand Guidelines for an existing campaign. Incompatible with Travel Goals: This feature is not supported for Performance Max campaigns with Travel Goals. Attempting to set this field to true for a Travel Goals campaign will result in an error.
Output only. The resource names of labels attached to this campaign.
Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.
Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
The resource name of the campaign budget of the campaign.
Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
The resource name of the portfolio bidding strategy used by the campaign.
Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
Settings for AI Max in Search and Shopping campaigns.
Output only. Campaign-level settings for tracking information.
Describes how unbranded pharma ads will be displayed.
Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
Output only. Types of feeds that are attached directly to this campaign.
These settings control how your brand appears in automatically generated assets and formats within this campaign. Note: These settings can only be used for Performance Max campaigns that have Brand Guidelines enabled.
A bidding strategy that pays a configurable amount per video view.
missing eu political advertising declaration
Output only. Indicates whether this campaign is missing a declaration about whether it contains political advertising targeted towards the EU and is ineligible for any exemptions. If this field is true, use the contains_eu_political_advertising field to add the required declaration. This field is read-only.
The advertiser should self-declare whether this campaign contains political advertising content targeted towards the European Union.
The asset set types that should be excluded from this campaign. Asset set links with these types will not be inherited by this campaign from the upper level. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this campaign, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this campaign. Only LOCATION_SYNC is currently supported.
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
A list that limits how often each user will see this campaign's ads.
Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
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 setting for controlling Shopping campaigns.
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
Settings to control automatically generated text assets. Only available in Performance Max and Search campaigns (Brand Guidelines does not need to be enabled).
The resource name of the campaign group that this campaign belongs to.
The setting for controlling Dynamic Search Ads (DSA).
Output only. The ad serving status of the campaign.
The ad serving optimization status of the campaign.
Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
Output only. Information about campaigns being upgraded to Performance Max.
Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
Suffix used to append query parameters to landing pages that are served with parallel tracking.
Output only. 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.
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.
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.
Average CPC target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
Overrides of brand targeting for various ad types.
Output only. Indicates whether the Performance Max campaign is a Local Services campaign.
The Local Services Campaign related settings. Only updates are available for existing Local Services Pmax campaigns.
If true, brand exclusions are ignored for Shopping ads.
Whether to use navigational query filter.
Immutable. Country code of the Local Services Ad. Set once during Ad Creation and used to determine verification requirements and validate location criterion selection; upper-case, two-letter codes as defined by ISO-3166.
List of phone numbers associated with the provider.
Upper-case, two-letter codes as defined by ISO-3166.
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
Immutable. Specifies whether this campaign uses upgraded targeting options. When this field is set to `true`, you can use location and language targeting at the ad group level as opposed to the standard campaign-level targeting. This field defaults to `true`, and can only be set when creating a campaign.
Disable the optional hotel setting. This field is currently supported only for Demand Gen campaigns.
The selected set of resource names for conversion actions for optimizing this campaign.
Categorical level bids associated with MANUAL_CPA bidding strategy.
Category for which the bid will be associated with. For example, xcat:service_area_business_plumber.
Target CPA bid for the category. Value is in micros and in the advertiser's currency.
Manual CPA bid for the category. Bid must be greater than the reserve price associated for that category. Value is in micros and in the advertiser's currency.
The asset automation type advertiser would like to opt-in/out.
The opt-in/out status of asset automation type.
Whether bids are to be enhanced based on conversion optimizer data.
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.
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
Immutable. The Travel account ID associated with the Travel campaign.
Third party integration partners for YouTube viewability verification for this Campaign.
Third party integration partners for Brand Lift verification for this Campaign.
Third party integration partners for reach verification for this Campaign.
Third party integration partners for brand safety verification for this Campaign.
Third party partner data for YouTube viewability verification. This is optional metadata for partners to join or attach data to Ads campaigns.
If true, then cost data will be shared with this vendor.
Allowed third party integration partners for YouTube viewability verification.
The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
Third party partner data for YouTube Brand Lift verification. This is optional metadata for partners to join or attach data to Ads campaigns.
Allowed third party integration partners for Brand Lift verification.
Allowed third party integration partners for reach verification.
Third party partner data for YouTube Reach verification. This is optional metadata for partners to join or attach data to Ads campaigns.
Allowed third party integration partners for brand safety verification.
Third party partner data for YouTube brand safety verification. This is optional metadata for partners to join or attach data to Ads campaigns.
Controls whether or not AI Max features are served for this campaign. Individual AI Max features are enabled or disabled by their respective settings. But if enable_ai_max is set to false or cleared, then no AI Max features will serve for this campaign, regardless of the other settings. Supported in Search and Shopping campaigns. For Search campaigns, Search Term Matching is enabled by default when AI Max is enabled, and can be disabled at the ad group level. For Shopping campaigns, Text customization is always enabled when AI Max is enabled.
Output only. Search campaigns only. Indicates whether a campaign has adopted AI Max before, and is required to have AI Max enabled to adopt campaign-level text asset automation and brand list targeting in all API versions.
Whether ads will be served with google.com search results.
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 the Google TV network.
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 on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead.
Output only. The url used for dynamic tracking.
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.
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 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.
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 key of a particular frequency cap. There can be no more than one frequency cap with the same key.
Maximum number of events allowed during the time range by this cap.
The level on which the cap is to be applied (for example, ad group ad, ad group). The cap is applied to all the entities of this level.
The type of event that the cap applies to (for example, impression).
Unit of time the cap is defined at (for example, day, week).
Format-restricting control enabling usage of video responsive ads in format defined Video campaigns (for example, non-skippable).
Container for video ads sequencing definition.
Output only. Booking information for campaigns with the FIXED_CPM or FIXED_SHARE_OF_VOICE bidding strategies.
Ad category self-disclosure for campaigns with the FIXED_CPM or FIXED_SHARE_OF_VOICE bidding strategies.
Inventory control for video responsive ads in reach campaigns.
All contained responsive ads are expected to respect this restriction.
The minimum allowed duration for non-skippable ads.
The maximum allowed duration for non-skippable ads.
Users are eligible to repeat sequence after this period. Defaults to WEEK if not specified.
The list of sequence steps and data associated with them.
Type of interaction *on the previous step* required in order for the user to advance to this step. As with the previous step ID, it's required for every step except for the first one.
The ad group type for this step (denoting the video format).
The ID of the previous step. This field is required for all steps except the first one. It must point to a step that appears in the step definition list before this step.
The ID of the Asset for this step. The asset must be type YOUTUBE_VIDEO.
Output only. Time until which booked inventory will be held or has been held for this campaign. Available for status HELD and HOLD_EXPIRED. Format is "yyyy-MM-dd HH:mm:ss" in the customer's time zone.
Output only. Time when the booked inventory of this campaign will be cancelled or has been cancelled. Available for primary status NOT_ELIGIBLE if the campaign will be cancelled and for primary status reason BOOKING_CANCELLED. Format is "yyyy-MM-dd HH:mm:ss" in the customer's time zone.
The campaign is expected to contain alcohol-related ads.
The campaign is expected to contain politics-related ads.
The campaign is expected to contain gambling-related ads.
Determine if video responsive ads can be used for non-skippable in-stream ads. This is only available for campaigns that allow mixing of non-skippable with other formats (Video reach campaign with Target Frequency bidding strategy goal).
Determine if video responsive ads can be used for in-stream video ads.
Determine if video responsive ads can be used for in-feed video ads.
Determine if video responsive ads can be used as shorts format.
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.
Disable the optional product feed. This field is currently supported only for Demand Gen campaigns. See https://support.google.com/google-ads/answer/13721750 to learn more about this feature.
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. Once set, the field is immutable. This feature is currently supported only for Performance Max, Shopping, Search and Demand Gen campaign types.
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.google.com/merchants/answer/12453549) support article.
If true, brand exclusions are ignored for Shopping ads. Only supported for Shopping campaigns.
ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
Immutable. Whether to target Vehicle Listing inventory. This field is supported only in Smart Shopping Campaigns. For setting Vehicle Listing inventory in Performance Max campaigns, use `listing_type` instead.
Exact words or phrases that will be excluded from generated text assets. At most 25 exclusions may be provided. Valid exclusions may contain a maximum of 30 characters.
Freeform instructions that will be used to guide text asset generation using LLM inference. At most 40 restrictions may be provided.
Freeform instructions to guide text asset generation using LLM inference. Valid instructions may contain a maximum of 300 characters.
Determines how the guideline is applied. Only `RESTRICTION_BASED_EXCLUSION` is currently supported.
Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
Required. The language code specifying the language of the domain, for example, "en".
Whether the campaign uses advertiser supplied URLs exclusively.
Represents the goal which the bidding strategy of this app campaign should optimize towards.
Immutable. A string that uniquely identifies a mobile application.
Immutable. The application store that distributes this specific app.
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%).
The setting used for positive geotargeting in this particular campaign.
The setting used for negative geotargeting in this particular campaign.
The location source type for this local campaign.
Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.
Output only. The resource name of the legacy campaign upgraded to Performance Max.
Whether the campaign is opted in to real-time bidding.
Output only. The resource name of the campaign aggregate asset view. Campaign aggregate asset view resource names have the form: `customers/{customer_id}/campaignAggregateAssetViews/{Campaign.campaign_id}~{Asset.asset_id}~{AssetLinkSource.asset_link_source}~{AssetFieldType.field_type}`
Output only. Campaign in which the asset served.
Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form: `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
Immutable. Role that the asset takes under the linked campaign. Required.
Immutable. The campaign to which the asset is linked.
Immutable. The asset which is linked to the campaign.
Output only. Source of the campaign asset link.
Immutable. The campaign to which this asset set is linked.
Immutable. The resource name of the campaign asset set. Asset set asset resource names have the form: `customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}`
Immutable. The asset set which is linked to the campaign.
Output only. The status of the campaign asset set asset. Read-only.
Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: `customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}`
Immutable. The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: `customers/{customer_id}/campaignBidModifiers/{campaign_id}~{criterion_id}`
The modifier for the bid when the criterion matches.
Immutable. Criterion for interaction type. Only supported for search campaigns.
Output only. The campaign to which this criterion belongs.
Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{campaign_budget_id}`
Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared.
recommended budget estimated change weekly clicks
Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
The total amount to be spent by the campaign over its entire duration. This field is used *only* when the CampaignBudget `period` is set to `CUSTOM_PERIOD`. It represents the budget cap for the campaign's lifetime, rather than a daily limit. The amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. This field is mutually exclusive with 'amount_micros'. Only one of 'total_amount_micros' or 'amount_micros' should be set.
ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campaigns that are added to the campaign budget must also use the aligned bidding strategy.
Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.
recommended budget estimated change weekly cost micros
Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only.
The average daily amount to be spent by the campaign. This field is used when the CampaignBudget `period` is set to `DAILY`, which is the default. Amount is specified in micros in the account's local currency. One million micros is equivalent to one currency unit. The effective monthly spend is capped at 30.4 times this daily amount. This field is mutually exclusive with 'total_amount_micros'. Only one of 'amount_micros' or 'total_amount_micros' should be set.
Output only. The number of campaigns actively using the budget. This field is read-only.
Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
recommended budget estimated change weekly views
Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.
Immutable. The type of the campaign budget.
Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results.
Output only. The status of this campaign budget. This field is read-only.
recommended budget estimated change weekly interactions
Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only.
Immutable. The campaign with which this campaign conversion goal is associated.
The biddability of the campaign conversion goal. If left unspecified during campaign creation or update operations, this value will inherit the account-level default biddability for the corresponding conversion category and origin. Note: The account-level default may be set to `true` for newly created conversion goals. To explicitly prevent a campaign from bidding on this goal, you must explicitly set `biddable` to `false` and include "biddable" in your mutate operation's `update_mask`.
The conversion category of this campaign conversion goal.
Immutable. The resource name of the campaign conversion goal. Campaign conversion goal resource names have the form: `customers/{customer_id}/campaignConversionGoals/{campaign_id}~{category}~{origin}`
The conversion origin of this campaign conversion goal.
Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
Output only. The ID of the criterion. This field is ignored during mutate.
Immutable. Brand list campaign criterion.
Immutable. The campaign to which the criterion belongs.
The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.
Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
Immutable. Smart Campaign Keyword Theme.
Immutable. Webpage list. This criterion is not publicly available.
Immutable. GLS service campaign criterion.
Immutable. IpBlock. You can exclude up to 500 IP addresses per campaign.
The operating system version constant resource name.
Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed. Cannot be set with AssetSet fields.
AssetSets whose Assets are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with feed, geo target constants or feed item sets. When using asset sets, either this field or enable_customer_level_location_asset_set should be specified. Both cannot be used at the same time. This can only be set in CREATE operations.
FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geo_target_constants. This is optional and can only be set in CREATE operations. Cannot be set with AssetSet fields.
Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
enable customer level location asset set
Denotes that the latest customer level asset set is used for targeting. Used with radius and radius_units. Cannot be used with feed, geo target constants or feed item sets. When using asset sets, either this field or location_group_asset_sets should be specified. Both cannot be used at the same time. This can only be set in CREATE operations.
Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets and asset sets. This is required and must be set in CREATE operations.
Content label type, required for CREATE operations.
Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
Shared set resource name of the webpage list.
The IP address or the CIDR block to be excluded.
The unit of measurement of the radius. Default is KILOMETERS.
The mobile device constant resource name.
Immutable. The campaign to which the customizer attribute is linked.
Output only. The status of the campaign customizer.
Immutable. The resource name of the campaign customizer. Campaign customizer resource names have the form: `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
Required. Immutable. The customizer attribute which is linked to the campaign.
Immutable. The base campaign to which the draft belongs.
Immutable. The resource name of the campaign draft. Campaign draft resource names have the form: `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
Output only. Whether there is an experiment based on this draft currently serving.
The name of the campaign draft. This field is required and should not be empty when creating new campaign drafts. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
Output only. The status of the campaign draft. This field is read-only. When a new campaign draft is added, the status defaults to PROPOSED.
Output only. The ID of the draft. This field is read-only.
Output only. Resource name of the Campaign that results from overlaying the draft changes onto the base campaign. This field is read-only.
Output only. The resource name of the long-running operation that can be used to poll for completion of draft promotion. This is only set if the draft promotion is in progress or finished.
Immutable. The resource name of the campaign goal config. campaign goal config resource names have the form: `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
Immutable. The resource name of the goal this link is attached to.
Immutable. The resource name of the campaign for this link.
Output only. The goal type this link is attached to.
Retention goal campaign specific value settings.
Retention goal optimization mode for this campaign. Defaults to TARGET_ALL. Only customers on the allowlist can set target_option.
Value of the lifecycle goal. For example, for retention goals, value is the incremental conversion value for lapsed customers who are not of high value.
High lifetime value of the lifecycle goal. For example, for customer acquisition goals, high lifetime value is the incremental conversion value for lapsed customers who are of high value. High lifetime value should be greater than value, if set.
Immutable. The resource name of the campaign group. Campaign group resource names have the form: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
Output only. The ID of the campaign group.
The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED.
Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
Immutable. The campaign to which the label is attached.
Immutable. The label assigned to the campaign.
Immutable. The resource name of the customer lifecycle goal of a campaign. `customers/{customer_id}/campaignLifecycleGoals/{campaign_id}`
Output only. The campaign where the goal is attached.
Output only. The customer acquisition goal settings for the campaign. The customer acquisition goal is described in this article: https://support.google.com/google-ads/answer/12080169
Output only. Customer acquisition optimization mode of this campaign.
Output only. Campaign specific values for the customer acquisition goal.
Value of the lifecycle goal. For example, for customer acquisition goal, value is the incremental conversion value for new customers who are not of high value.
High lifetime value of the lifecycle goal. For example, for customer acquisition goal, high lifetime value is the incremental conversion value for new customers who are of high value. High lifetime value should be greater than value, if set.
Output only. The resource name of the campaign level search term insight. Campaign level search term insight resource names have the form: `customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{category_id}`
Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.
Output only. The resource name of the campaign search term view. Campaign search term view resource names have the form: `customers/{customer_id}/campaignSearchTermViews/{campaign_id}~{URL-base64_search_term}`
Output only. The campaign the search term served in.
Immutable. The resource name of the campaign shared set. Campaign shared set resource names have the form: `customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}`
Output only. The status of this campaign shared set. Read only.
Immutable. The campaign to which the campaign shared set belongs.
Immutable. The shared set associated with the campaign. This may be a negative keyword shared set of another customer. This customer should be a manager of the other customer, otherwise the campaign shared set will exist but have no serving effect. Only negative keyword shared sets can be associated with Shopping campaigns. Only negative placement shared sets can be associated with Display mobile app campaigns.
Output only. Simulation points if the simulation type is TARGET_IMPRESSION_SHARE.
Output only. Campaign id of the simulation.
Output only. The resource name of the campaign simulation. Campaign simulation resource names have the form: `customers/{customer_id}/campaignSimulations/{campaign_id}~{type}~{modification_method}~{start_date}~{end_date}`
Output only. Simulation points if the simulation type is BUDGET.
Projected metrics for a specific target impression share value.
Projected number of absolute top impressions. Only search advertising channel type supports this field.
The simulated target impression share value (in micros) upon which projected metrics are based. For example, 10% impression share, which is equal to 0.1, is stored as 100_000. This value is validated and will not exceed 1M (100%).
Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency.
Output only. The resource name of the carrier criterion. Carrier criterion resource names have the form: `carrierConstants/{criterion_id}`
Output only. The ID of the carrier criterion.
Output only. The full name of the carrier in English.
Output only. The country code of the country where the carrier is located, for example, "AR", "FR", etc.
Output only. The resource name of the Cart data sales view. Cart data sales view resource names have the form: `customers/{customer_id}/cartDataSalesView`
Output only. The new resource after the change. Only changed fields will be populated.
Output only. The Campaign affected by this change.
Output only. Time at which the change was committed on this resource.
Output only. The operation on the changed resource.
Output only. The Simply resource this change occurred on.
Output only. The Asset affected by this change.
Output only. The old resource before the change. Only changed fields will be populated.
Output only. The email of the user who made this change.
Output only. The resource name of the change event. Change event resource names have the form: `customers/{customer_id}/changeEvents/{timestamp_micros}~{command_index}~{mutate_index}`
Output only. Where the change was made through.
Output only. The AdGroup affected by this change.
Output only. The type of the changed resource. This dictates what resource will be set in old_resource and new_resource.
Output only. A list of fields that are changed in the returned resource.
Output only. Set if change_resource_type == CAMPAIGN_BUDGET.
Output only. Set if change_resource_type == AD_GROUP_CRITERION.
Output only. Set if change_resource_type == CAMPAIGN_ASSET.
Output only. Set if change_resource_type == CAMPAIGN.
Output only. Set if change_resource_type == ASSET.
Output only. Set if change_resource_type == ASSET_SET_ASSET.
Output only. Set if change_resource_type == AD_GROUP_BID_MODIFIER.
Output only. Set if change_resource_type == CAMPAIGN_ASSET_SET.
Output only. Set if change_resource_type == AD_GROUP.
Output only. Set if change_resource_type == CAMPAIGN_CRITERION.
Output only. Set if change_resource_type == CUSTOMER_ASSET.
Output only. Set if change_resource_type == AD.
Output only. Set if change_resource_type == AD_GROUP_ASSET.
Output only. Set if change_resource_type == AD_GROUP_AD.
Output only. Set if change_resource_type == ASSET_SET.
Immutable. The resource name of the customer asset. CustomerAsset resource names have the form: `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
Required. Immutable. Role that the asset takes for the customer link.
Required. Immutable. The asset which is linked to the customer.
Output only. Source of the customer asset link.
Output only. The CampaignCriterion affected by this change.
Output only. The CustomerAsset affected by this change.
Output only. The resource name of the change status. Change status resource names have the form: `customers/{customer_id}/changeStatus/{change_status_id}`
Output only. The CampaignAssetSet affected by this change.
Output only. The AdGroupBidModifier affected by this change.
Output only. The AssetGroup affected by this change.
Output only. Represents the status of the changed resource.
Output only. Time at which the most recent change has occurred on this resource.
Output only. Represents the type of the changed resource. This dictates what fields will be set. For example, for AD_GROUP, campaign and ad_group fields will be set.
Output only. The AdGroupAd affected by this change.
Output only. The AssetSet affected by this change.
Output only. The AdGroupAsset affected by this change.
Output only. The CombinedAudience affected by this change.
Output only. The CampaignBudget affected by this change.
Output only. The CampaignSharedSet affected by this change.
Output only. The AdGroupCriterion affected by this change.
Output only. The CampaignAsset affected by this change.
Output only. The SharedSet affected by this change.
Output only. The resource name of the channel aggregate asset view. Channel aggregate asset view resource names have the form: `customers/{customer_id}/channelAggregateAssetViews/{ChannelAssetV2.advertising_channel_type}~{ChannelAssetV2.asset_id}~{ChannelAssetV2.asset_source}~{ChannelAssetV2.field_type}"`
Output only. Channel in which the asset served.
The metro location criterion associated with the impression.
The region location criterion associated with the impression.
The most specific location criterion associated with the impression.
The city location criterion associated with the impression.
The country location criterion associated with the impression.
Output only. The location criteria matching the location of presence associated with the impression.
Output only. The location criteria matching the area of interest associated with the impression.
Output only. The associated user list, if one exists.
Output only. The resource name of the click view. Click view resource names have the form: `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}`
Output only. The associated campaign location target, if one exists.
Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel.
Output only. Basic information about the associated keyword, if it exists.
Output only. Page number in search results where the ad was shown.
Immutable. The resource name of the combined audience. Combined audience names have the form: `customers/{customer_id}/combinedAudience/{combined_audience_id}`
Output only. Description of this combined audience.
Output only. ID of the combined audience.
Output only. Status of this combined audience. Indicates whether the combined audience is enabled or removed.
Output only. Name of the combined audience. It should be unique across all combined audiences.
auction insight search absolute top impression percentage
This metric is part of the Auction Insights report, and tells how often the ads of another participant showed in the most prominent position on the search results page. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.
all conversions from location asset order
Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
The value of all conversions divided by the number of all conversions.
The p-value for the null hypothesis that the experiment has no effect on conversion value. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversion value, is 3%.
conversions absolute change margin of error
The margin of error when estimating the experiment's effect on conversions absolute change. Together with `conversions_absolute_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment - control). This field specifies the radius of the confidence interval, which is centered at `conversions_absolute_change_point_estimate`.
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.
Unique query intent cluster count for conversions.
All units sold is the total number of products sold from orders attributed to your ads. Includes the amount from the units_sold metric, plus units sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
The estimated percent of times that your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
The number of impressions that were audible at the second quartile of the ad playback, divided by the total number of impressions measurable for audibility.
The point estimate when estimating the experiment's effect on cost change. Together with `cost_micros_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(cost_micros_change_point_estimate - cost_micros_margin_of_error, cost_micros_change_point_estimate + cost_micros_margin_of_error)`.
An indication of how other advertisers are bidding on similar products.
This metric counts the unique individuals who were shown your video ad three or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
Number of phone calls received (`phone_calls`) divided by the number of times your phone number is shown (`phone_impressions`).
Percentage of impressions where the viewer watched 75% of your video.
The number of platform comparable conversions. This only includes conversion actions for 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 times a business's location-based ad was shown. This metric applies to feed items only.
The total cost of all clicks divided by the total number of clicks received.
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
This metric counts the unique individuals who were shown your video ad four or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).
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](https://support.google.com/google-ads/answer/9549009).
The p-value for the null hypothesis that the experiment has no effect on conversions absolute change. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversions absolute change, is 3%.
All cross-sell units sold is the total number of products sold as a result of advertising a different product. Includes the amount shown in the cross_sell_units_sold metric, plus cross-sell units sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
conversions absolute change point estimate
The point estimate when estimating the experiment's effect on conversions absolute change. Together with `conversions_absolute_change_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment - control). This field specifies the point estimate, which is the center of the confidence interval: `(conversions_absolute_change_point_estimate - conversions_absolute_change_margin_of_error, conversions_absolute_change_point_estimate + conversions_absolute_change_margin_of_error)`.
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](https://support.google.com/google-ads/answer/9549009).
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
The sum of the value of cross-device conversions, in micros.
view through conversions from location asset order
Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
The number of times someone clicked your site's listing in the unpaid results for a particular query. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
value per conversions by conversion date
The value of conversions divided by the number of conversions. This only includes conversion actions for which the `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](https://support.google.com/google-ads/answer/9549009).
The p-value for the null hypothesis that the experiment has no effect on cost. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on cost, is 3%.
Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity
All average order value is the average revenue you made per order attributed to your ads. Includes the amount from the average_order_value metric, plus avg. order value from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
The types of payable and free interactions.
The number of impressions that hotel partners could have had given their feed performance.
Average number of pages viewed per session.
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
active view audible two seconds impressions rate
The number of impressions that were audible for at least 2 seconds (cumulative), divided by the total number of impressions measurable for audibility.
The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
Number of linked resources in which the asset is used. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`.
cost per current model attributed conversion
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity
all conversions from interactions value per interaction
The value of all conversions from interactions divided by the total number of interactions.
All co-viewed impressions represent the total number of people who saw your ad. This includes people who are signed into their Google Account, as well as other people who are watching the same ad on a connected TV. This metric is only available for the Campaign resource with adjusted_age_range and adjusted_gender segments. These segmentations are mandatory to get the all coviewed impressions.
Number of Click To Message impressions that were message tracking eligible.
The point estimate when estimating the experiment's effect on clicks. Together with `clicks_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(clicks_point_estimate - clicks_margin_of_error, clicks_point_estimate + clicks_margin_of_error)`.
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.
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
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.
The number of clicks on the control arm of an experiment. The treatment clicks value can be selected by using `clicks`.
The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for Shorts ads.
The value of platform comparable 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 average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of TrueView views.
This feature is available to allowlisted accounts only.
The conversion value metric on the control arm of the experiment. The treatment conversion value can be selected by using `conversions_value`.
Primary impression is counted each time your ad is served. This metric is only available for the Campaign resource with adjusted_age_range and adjusted_gender segments. These segmentations are mandatory to get the primary impressions.
Number of message chats initiated for Click To Message impressions that were message tracking eligible.
conversions from interactions value per interaction
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
The number of impressions that were audible at the first quartile of the ad playback, divided by the total number of impressions measurable for audibility.
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.
All 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). This value is between 0.0 and 1.0, where 1.0 means 100%. Includes the amount from the gross_profit_margin metric, plus gross profit margin across all conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
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.
The margin of error when estimating the experiment's effect on clicks. Together with `clicks_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `clicks_point_estimate`.
active view audibility invalid measurable impressions rate
The number of impressions for which Active View could measure audibility, but that were filtered out by traffic quality filters, divided by the total number of impressions measurable for audibility.
URL for the optimization score page in the Google Ads web interface. This metric can be selected from `customer` or `campaign`, and can be segmented by `segments.recommendation_type`. For example, `SELECT metrics.optimization_score_url, segments.recommendation_type FROM customer` will return a URL for each unique (customer, recommendation_type) combination.
This metric is part of the Auction Insights report, and tells the percentage of impressions that your ads outranked (showed above) another participant in the auction, compared to the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.
The value of conversions divided by the number of conversions. This only includes conversion actions for which the `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
auction insight search top impression percentage
This metric is part of the Auction Insights report, and tells how often the ads of another participant showed adjacent to the top organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.
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 percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See [About top and absolute top metrics](https://support.google.com/google-ads/answer/7501826) for details. Any value below 0.1 is reported as 0.0999.
search budget lost absolute top impression share
The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
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.
platform comparable conversions by conversion date
The number of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
active view audibility invalid givt measurable impressions rate
The number of impressions for which Active View could measure audibility, but that were filtered out by traffic quality filters, divided by the total number of impressions measurable for audibility. Only includes GIVT (general invalid traffic) impressions.
asset pinned as headline position one count
Number of entities in which the asset is pinned to headline 1. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241) for details.
cost converted currency per platform comparable conversion
The cost of the platform comparable conversion in the currency of the authorized customer.
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
All average cart size is the average number of products in each order attributed to your ads. Includes the amount from the average_cart_size metric, plus avg. cart size from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
This metric is part of the Auction Insights report, and tells the percentage of impressions that another participant obtained, over the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.
value per all conversions by conversion date
The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the `by_conversion_date` columns are available at [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009).
The impressions metric on the control arm of the experiment. The treatment impressions value can be selected by using `impressions`.
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](https://support.google.com/google-ads/answer/9549009).
The number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.
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 cost metric on the control arm of the experiment. The treatment cost value can be selected by using `cost_micros`.
The number of times someone has saved your Gmail ad to their inbox as a message.
The margin of error when estimating the experiment's effect on conversion value. Together with `conversion_value_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `conversion_value_change_point_estimate`.
The number of impressions that were audible at the fourth quartile of the ad playback, divided by the total number of impressions measurable for audibility.
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency.
The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
All cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. Includes the amount from the cross_sell_revenue_micros metric, plus cross-sell revenue from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
Number of clicks Google considers illegitimate and doesn't charge you for.
All 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). Includes the amount from the lead_gross_profit_micros metric, plus lead gross profit from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
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.
conversion value per cost margin of error
The margin of error when estimating the experiment's effect on conversion value per cost. Together with `conversion_value_per_cost_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `conversion_value_per_cost_change_point_estimate`.
value per current model attributed conversion
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions for which the `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
average video watch time duration millis
Average video watch time duration in milliseconds for video impressions that started playing.
current model attributed conversions value per cost
The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
The point estimate when estimating the experiment's effect on conversion value change. Together with `conversion_value_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(conversion_value_change_point_estimate - conversion_value_margin_of_error, conversion_value_change_point_estimate + conversion_value_margin_of_error)`.
auction insight search position above rate
This metric is part of the Auction Insights report, and tells how often another participant's ad was shown in a higher position than yours, when both of your ads were shown at the same page. This metric is not publicly available.
The number of times your ad or your site's listing in the unpaid results was clicked. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
The margin of error when estimating the experiment's effect on cost. Together with `cost_micros_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `cost_micros_change_point_estimate`.
An indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it.
Estimated number of times people visited a business after clicking an ad. This metric applies to feed items only.
This metric is part of the Auction Insights report, and tells how often another participant's ad received an impression when your ad also received an impression. This metric is not publicly available.
The number of times people clicked the "Call" button to call a business during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
This metric counts the unique individuals who were shown your video ad two or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
The percentage of mobile clicks that go to a mobile-friendly page.
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.
all conversions from location asset menu
Number of menu link clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
view through conversions from location asset directions
Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
All orders is total number of purchase conversions attributed to your ads. Includes the amount from the orders metric, plus orders from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
all conversions from location asset store visits
Estimated number of visits to the business after a chargeable ad event (click or impression). This measure is coming from Asset based location.
Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
The purchase conversion stats for the unified goals results.
active view audible two seconds impressions
The number of impressions that were audible for at least 2 seconds (cumulative).
The number of times people clicked a link to view a business's menu after clicking an ad. This metric applies to feed items only.
The conversion value rule adjustment from biddable conversions in all conversion categories.
All gross profit is the total profit made from orders attributed to your ads minus the cost of goods sold (COGS). Includes the amount from the gross_profit_micros metric, plus gross profit from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
Percentage of impressions where the viewer watched 25% of your video.
active view audibility measurable impressions
The number of impressions for which Active View could measure if the ad was audible.
Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
The cost of ad interactions divided by conversions. This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
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.
The cost per conversion metric on the control arm of the experiment. The treatment cost per conversion value can be selected by using `cost_per_conversion`.
The quality of historical landing page experience.
current model attributed conversions from interactions rate
Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Average cost-per-thousand impressions (CPM).
The number of impressions that were audible (volume > 0%) at any point during the ad playback, divided by the total number of impressions measurable for audibility.
The margin of error when estimating the experiment's effect on cost per conversion. Together with `cost_per_conversion_change_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `cost_per_conversion_change_point_estimate`.
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
The total number of iOS Store Kit Ad Network conversions.
Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
The p-value for the null hypothesis that the experiment has no effect on conversion value per cost. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on conversion value per cost, is 3%.
platform comparable conversions value per cost
The value of conversions divided by the cost of ad interactions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
The p-value for the null hypothesis that the experiment has no effect on impressions. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on impressions, is 3%.
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](https://support.google.com/google-ads/answer/12080169) for more details.
Number of total usages in which the asset is pinned. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
active view audibility measurable impressions rate
The number of impressions for which Active View could measure if the ad was audible, divided by the total number of impressions with Active View audio enabled.
asset pinned as headline position three count
Number of entities in which the asset is pinned to headline 3. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
view through conversions from location asset menu
Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
The cost of the impressions you received that were measurable by Active View.
biddable cohort app post install conversions
Participated in-app actions. The number of in app actions that come directly or indirectly from the campaign.
The number of times someone clicked your site's listing in the unpaid results (organic_clicks) divided by the total number of searches that returned pages from your site (organic_queries). See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
Clicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic"
The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
The number of listings for your site in the unpaid search results. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
current model attributed conversions from interactions value per interaction
The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Average cost of viewable impressions (`active_view_impressions`).
The ratio of impressions that could be measured by Active View over the number of served impressions.
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](https://support.google.com/google-ads/answer/12080169) for more details.
All lead cost of goods sold is the total cost of products sold as a result of advertising the same product. Includes the amount shown in the lead_cost_of_goods_sold_micros metric, plus lead cost of goods sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
view through conversions from location asset website
Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
biddable indirect install first in app conversion micros
The number of biddable first in app conversions where the app install was driven by interaction with a web campaign.
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.
all conversions from location asset directions
Number of driving directions clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
This metric counts the unique individuals who were shown your video ad five or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
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`.
current model attributed conversions value
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.
All cost of goods sold is the total cost of the products you sold in orders attributed to your ads. Includes the amount from the cost_of_goods_sold_micros metric, plus cost of goods sold from all conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
cost per conversion change point estimate
The point estimate when estimating the experiment's effect on cost per conversion change. Together with `cost_per_conversion_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(cost_per_conversion_change_point_estimate - cost_per_conversion_margin_of_error, cost_per_conversion_change_point_estimate + cost_per_conversion_margin_of_error)`.
The number of times the ad was forwarded to someone else as a message.
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
The number of other conversions (for example, posting a review or saving a location for a business) that occurred after people clicked an ad. This metric applies to feed items only.
eligible impressions from location asset store reach
Number of impressions in which the business location was shown or the location was used for targeting. This measure is coming from Asset based location.
All lead revenue is the total amount you made from products sold as a result of advertising the same product. Includes the amount shown in the lead_revenue_micros metric, plus lead revenue from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
All lead units sold is the total number of products sold as a result of advertising the same product. Includes the amount shown in the lead_units_sold metric, plus lead units sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
The margin of error when estimating the experiment's effect on impressions. Together with `impressions_point_estimate`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the radius of the confidence interval, which is centered at `impressions_point_estimate`.
value per platform comparable conversions by conversion date
The value of platform comparable conversions divided by the number of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
active view audible thirty seconds impressions rate
The number of impressions that were audible for at least 30 seconds (cumulative), divided by the total number of impressions measurable for audibility.
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.
asset pinned as description position two count
Number of entities in which the asset is pinned to description 2. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.
Percentage of impressions where the viewer watched all of your video.
The number of times a page from your site was listed in the unpaid search results (`organic_impressions`) divided by the number of searches returning your site's listing in the unpaid results (`organic_queries`). See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241).
Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites.
The number of TrueView views your video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
view through conversions from location asset other engagement
Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
platform comparable conversions from interactions rate
Platform comparable conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
This metric counts the unique individuals who were shown your video ad ten or more times within the selected date range. This metric cannot be aggregated, and can only be requested for date ranges of 31 days or less.
The total number of searches that returned your site's listing in the unpaid results. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241) for details.
asset pinned as description position one count
Number of entities in which the asset is pinned to description 1. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
The p-value for the null hypothesis that the experiment has no effect on clicks. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on clicks, is 3%.
value per platform comparable conversion
The value of platform comparable conversions divided by the number of platform comparable conversions. This only includes conversion actions for 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 impressions that were audible at the third quartile of the ad playback, divided by the total number of impressions measurable for audibility.
A measurement of how often your ad has become viewable on a Display Network site.
Count of how often your ad has appeared on a search results page or website on the Google Network.
Unique query intent cluster count for clicks.
all conversions value by conversion date
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](https://support.google.com/google-ads/answer/9549009).
Total watch time duration in milliseconds for video impressions that started playing. For a small percentage of impressions, we may not be able to measure the watch time accurately. In such cases, we adjust the total time to account for any unmeasured time by applying the average watch time of impressions that were measured.
The point estimate when estimating the experiment's effect on impressions. Together with `impressions_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(impressions_point_estimate - impressions_margin_of_error, impressions_point_estimate + impressions_margin_of_error)`.
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.
The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for in-feed formats.
The number of times that people were taken to a business's URL after clicking an ad. This metric applies to feed items only.
The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
conversion last received request date time
The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (for example, because the tag was fired from a browser that did not previously click an ad from an appropriate advertiser). The date/time is in the customer's time zone.
The conversion value rule adjustment from all conversions in all conversion categories.
A list of up to 20 sample linked resources in which the asset is used. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`.
Number of message chats initiated (message_chats) divided by the number of message impressions (message_impressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate can be more than 1.0 for a given message impression.
The number of impressions that were audible (volume > 0%) at any point during the ad playback.
The number of iOS Store Kit Ad Network conversions.
Search volume range for a search term insight category.
A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest.
The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999. Top ads are generally above the top organic results, although they may show below the top organic results on certain queries.
all conversions from location asset other engagement
Number of other types of local action clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
Commission bid rate in micros. A 20% commission is represented as 200,000.
The number of TrueView views your video ads received.
The number of times your ads are appearing on placements in positions where they can be seen.
The number of times people clicked a "Get directions" button to navigate to a business after clicking an ad. This metric applies to feed items only.
The number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries. See [About measuring paid and organic search results](https://support.google.com/google-ads/answer/3097241) for details.
Unique query intent cluster count for impressions.
The cost of ad interactions divided by all conversions.
conversion value per cost change point estimate
The point estimate when estimating the experiment's effect on conversion value per cost change. Together with `conversion_value_per_cost_margin_of_error`, they describe a confidence interval with a prescribed confidence level for the difference being estimated. The quantity being estimated is (treatment / control - 1). This field specifies the point estimate, which is the center of the confidence interval: `(conversion_value_per_cost_change_point_estimate - conversion_value_per_cost_margin_of_error, conversion_value_per_cost_change_point_estimate + conversion_value_per_cost_margin_of_error)`.
The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
cross device conversions value by conversion date
The sum of cross-device conversions value by conversion date. Details for the `by_conversion_date` columns are available at [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009)
all cross sell cost of goods sold micros
All cross-sell cost of goods sold is the total cost of products sold as a result of advertising a different product. Includes the amount from the cross_sell_cost_of_goods_sold_micros metric, plus cross-sell cost of goods sold from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
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.
The cost of ad interactions divided by the number of platform comparable conversions. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
all conversions from location asset click to call
Number of call button clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
The number of clicks to the landing page on the expanded state of Gmail ads.
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
All 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). Includes the amount from the cross_sell_gross_profit_micros metric, plus cross-sell gross profit from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
asset pinned as headline position two count
Number of entities in which the asset is pinned to headline 2. This metric can only be selected with `ChannelAggregateAssetView` and `CampaignAggregateAssetView`. This metric is only supported in Search channel.
active view audible thirty seconds impressions
The number of impressions that were audible for at least 30 seconds (cumulative).
all conversions from location asset website
Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
The historical search predicted click through rate (CTR).
The sum of the value of cross-device conversions.
Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
platform comparable conversions value by conversion date
The value of platform comparable conversions. When this metric is segmented by date, the values in the date segment represent the conversion date. This only includes conversion actions for which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
All revenue is the total you made from orders attributed to your ads. Includes the amount from the revenue_micros metric, plus revenue from all your conversion actions, even if your campaigns are not actively optimizing towards them. It's calculated using product info from cart data to give more detail than conversion value alone.
platform comparable conversions from interactions value per interaction
The value of platform comparable conversions from interactions divided by the number of ad interactions. This only includes conversion actions for 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 estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
Total optimization score uplift of all recommendations.
search rank lost absolute top impression share
The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
The conversion value per cost metric on the control arm of the experiment. The treatment conversion value per cost value can be selected by using `conversions_value_per_cost`.
The number of times people placed an order at a business after clicking an ad. This metric applies to feed items only.
The p-value for the null hypothesis that the experiment has no effect on cost per conversion. Ranges from 0 to 1. Say if the p-value is 0.03, that means the probability of observing the data, if the experiment has no effect on cost per conversion, is 3%.
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.
The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
view through conversions from location asset click to call
Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
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.
store visits last click model attributed conversions
The amount of business visits attributed by the last click model.
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which `include_in_conversions_metric` attribute is set to `true`. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
The percent of your ad impressions that are shown adjacent to the top organic search results.
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.
The conversions metric on the control arm of the experiment. The treatment conversions value can be selected by using `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.
cross device conversions by conversion date
The number of cross-device conversions by conversion date. Details for the `by_conversion_date` columns are available at [Understand conversions by time with new columns](https://support.google.com/google-ads/answer/9549009)
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.
Percentage of impressions where the viewer watched 50% of your video.
valid accelerated mobile pages clicks percentage
The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
view through conversions from location asset store visits
Estimated number of visits to the business after an impression. This measure is coming from Asset based location.
The number of TrueView views divided by number of impressions that can potentially lead to TrueView views for in-stream formats.
Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See [Filtering invalid traffic to ensure quality](https://support.google.com/campaignmanager/answer/6076504).
This represents consent for ad user data.
This represents consent for ad personalization. This can only be set for OfflineUserDataJobService and UserDataService.
Output only. Phone number of the consumer for the lead. This can be a real phone number or a tracking number. The phone number is returned in E164 format. See https://support.google.com/google-ads/answer/16355235?hl=en to learn more. Example: +16504519489.
Output only. Consumer name if consumer provided name from Message or Booking form on google.com
Output only. The resource name of the content criterion view. Content criterion view resource names have the form: `customers/{customer_id}/contentCriterionViews/{ad_group_id}~{criterion_id}`
How to count conversion events for the conversion action.
Immutable. The resource name of the conversion action. Conversion action resource names have the form: `customers/{customer_id}/conversionActions/{conversion_action_id}`
Settings related to the value for conversion events associated with this conversion action.
Output only. Firebase settings for Firebase conversion types.
The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.
Output only. Google Analytics 4 settings for Google Analytics 4 conversion types.
Output only. Mobile app vendor for an app conversion action.
If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.
The category of conversions reported for this conversion action.
Immutable. The type of this conversion action.
Whether this conversion action should be included in the "conversions" metric.
Settings related to this conversion action's attribution model.
Output only. The ID of the conversion action.
The status of this conversion action for conversion event accrual.
Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
Output only. The snippets used for tracking conversions.
The phone call duration in seconds after which a conversion should be reported for this conversion action. The value must be between 0 and 10000, inclusive.
Output only. The conversion origin of this conversion action.
The name of the conversion action. This field is required and should not be empty when creating new conversion actions.
The maximum number of days which may elapse between an impression and a conversion without an interaction.
Output only. Third Party App Analytics settings for third party conversion types.
Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.
The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.
The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.
Output only. The event name of a Firebase conversion.
Output only. The Firebase project ID of the conversion.
Output only. The GA property ID of the conversion.
Output only. The GA property name of the conversion.
Output only. The ID of the GA 4 property.
Output only. The name of the GA 4 event.
Output only. The name of the GA 4 property.
The attribution model type of this conversion action.
Output only. The status of the data-driven attribution model for the conversion action.
The site tag that adds visitors to your basic remarketing lists and sets new cookies on your domain.
The event snippet that works with the site tag to track actions that should be counted as conversions.
The type of the generated tag snippets for tracking conversions.
The format of the web page where the tracking tag and snippet will be installed, for example, HTML.
Output only. The event name of a third-party app analytics conversion.
Output only. Name of the third-party app analytics provider.
Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet and sent to Google Ads along with conversion pings. For conversion uploads in Google Ads API, the resource name of the conversion custom variable is used. Tag should be unique. The maximum size of tag is 100 bytes. There should not be any extra spaces before and after. Currently only lowercase letters, numbers and underscores are allowed in the tag.
Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
Output only. The ID of the conversion custom variable.
Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
The status of the conversion custom variable for conversion event accrual.
Output only. The resource name of the customer that owns the conversion custom variable.
The level of goal config the campaign is using.
Immutable. The campaign with which this conversion goal campaign config is associated.
Immutable. The resource name of the conversion goal campaign config. Conversion goal campaign config resource names have the form: `customers/{customer_id}/conversionGoalCampaignConfigs/{campaign_id}`
The custom conversion goal the campaign is using for optimization.
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
The resource name of the customer where conversions are created and managed. This field is read-only.
Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
Condition for audience that must be satisfied for the value rule to apply.
Condition for itinerary that must be satisfied for the value rule to apply.
Condition for device type that must be satisfied for the value rule to apply.
Immutable. The resource name of the conversion value rule. Conversion value rule resource names have the form: `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
Output only. The ID of the conversion value rule.
Condition for Geo location that must be satisfied for the value rule to apply.
Output only. The resource name of the conversion value rule's owner customer. When the value rule is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
The status of the conversion value rule.
Action applied when the rule is triggered.
Range for the number of days between the date of the booking and the start of the itinerary.
Range for the itinerary length in number of nights.
The days of the week on which this itinerary's travel can start.
Minimum number of days between the date of the booking the start date.
Maximum number of days between the date of the booking the start date.
Minimum number of nights between the start date and the end date.
Maximum number of days between the start date and the end date.
Geo locations that advertisers want to exclude.
Geo locations that advertisers want to include.
Immutable. Defines the scope where the conversion value rule set is attached.
Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form: `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
Output only. The ID of the conversion value rule set.
Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply.
Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
Output only. The status of the conversion value rule set. ** Read-only **
Immutable. The conversion action categories of the conversion value rule set.
The resource name of the campaign when the conversion value rule set is attached to a campaign.
Resource names of rules within the rule set.
Output only. The date time when the credit state of the lead was last updated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Locales that are available to the category for the channel.
Channel types and subtypes that are available to the category.
ISO 639-1 code of the language associated with the category.
Format of the locale availability. Can be LAUNCHED_TO_ALL (both country and language will be empty), COUNTRY (only country will be set), LANGUAGE (only language wil be set), COUNTRY_AND_LANGUAGE (both country and language will be set).
The ISO-3166-1 alpha-2 country code associated with the category.
Format of the channel availability. Can be ALL_CHANNELS (the rest of the fields will not be set), CHANNEL_TYPE (only advertising_channel_type type will be set, the category is available to all sub types under it) or CHANNEL_TYPE_AND_SUBTYPES (advertising_channel_type, advertising_channel_sub_type, and include_default_channel_sub_type will all be set).
Channel type the category is available to.
Channel subtypes under the channel type the category is available to.
Whether default channel sub type is included. For example, advertising_channel_type being DISPLAY and include_default_channel_sub_type being false means that the default display campaign where channel sub type is not set is not included in this availability configuration.
A string that uniquely identifies a mobile application from which the data was collected. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.
Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
Output only. ISO 4217 three-letter currency code, for example, "USD"
Output only. Full English name of the currency.
Output only. Standard symbol for describing this currency, for example, '$' for US Dollars.
Output only. The billable unit for this currency. Billed amounts should be multiples of this value.
Output only. The resource name of the currency constant. Currency constant resource names have the form: `currencyConstants/{code}`
Immutable. The resource name of the custom audience. Custom audience resource names have the form: `customers/{customer_id}/customAudiences/{custom_audience_id}`
Type of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences)
Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed.
Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.
List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
An HTTP URL, protocol-included — at most 2048 characters, which includes contents users have interests in.
The type of custom audience member, KEYWORD, URL, PLACE_CATEGORY or APP.
A keyword or keyword phrase — at most 10 words and 80 characters. Languages with double-width characters such as Chinese, Japanese, or Korean, are allowed 40 characters, which describes the user's interests or actions.
A package name of Android apps which users installed such as com.google.example.
A place type described by a place category users visit.
Conversion actions that the custom conversion goal makes biddable.
Immutable. The ID for this custom conversion goal.
The name for this custom conversion goal.
The status of the custom conversion goal.
Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
Brand Safety setting at the account level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
Output only. Whether the customer is a manager.
pay per conversion eligibility failure reasons
Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
Output only. True if feed based location has been migrated to asset based location.
Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
Output only. Customer Agreement Setting for a customer.
Conversion tracking setting for a customer.
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
Whether auto-tagging is enabled for the customer. Only mutable in an `update` operation.
Output only. True if feed based image has been migrated to asset based image.
Immutable. The local timezone ID of the customer.
Output only. Settings for Local Services customer.
Output only. The status of the customer.
Output only. Returns the advertiser self-declaration status of whether this customer contains political advertising content targeted towards the European Union. You can use the Google Ads UI to update this account-level declaration, or use the API to update the self-declaration status of individual campaigns.
Output only. Whether the customer is a test account.
Optional, non-unique descriptive name of the customer.
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
Call reporting setting for a customer. Only mutable in an `update` operation.
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of `Customer.optimization_score * Customer.optimization_score_weight`. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.
Video specific information about a Customer.
image asset auto migration done date time
Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH:mm:ss format.
The URL template for appending params to the final URL. Only mutable in an `update` operation.
Output only. Remarketing setting for a customer.
location asset auto migration done date time
Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH:mm:ss format.
The URL template for constructing a tracking URL out of parameters. Only mutable in an `update` operation.
Output only. Whether the customer has accepted lead form term of service.
Output only. A read-only list of geo vertical level license statuses.
Output only. A read-only list of geo vertical level insurance statuses.
Output only. Granular license status, per geo + vertical.
Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
Output only. Granular insurance status, per geo + vertical.
If true, cost data can be shared with this vendor.
Immutable. The resource name of the customer asset set. Asset set asset resource names have the form: `customers/{customer_id}/customerAssetSets/{asset_set_id}`
Immutable. The asset set which is linked to the customer.
Immutable. The customer to which this asset set is linked.
Output only. The status of the customer asset set asset. Read-only.
Output only. The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
Output only. The resource name of the customer client. CustomerClient resource names have the form: `customers/{customer_id}/customerClients/{client_customer_id}`
Output only. The resource name of the client-customer which is linked to the given customer. Read only.
Output only. Specifies whether this is a [hidden account](https://support.google.com/google-ads/answer/7519830). Read only.
Output only. Identifies if the client is a manager. Read only.
Output only. The ID of the client customer. Read only.
Output only. The status of the client customer. Read only.
Output only. Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.
Output only. Descriptive name for the client. Read only.
Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
Output only. Distance between given customer and client. For self link, the level value will be 0. Read only.
Output only. Identifies if the client is a test account. Read only.
Immutable. Name of the resource. CustomerClientLink resource names have the form: `customers/{customer_id}/customerClientLinks/{client_customer_id}~{manager_link_id}`
Immutable. The client customer linked to this customer.
The visibility of the link. Users can choose whether or not to see hidden links in the Google Ads UI. Default value is false
This is the status of the link between client and manager.
Output only. This is uniquely identifies a customer client link. Read only.
The biddability of the customer conversion goal.
Immutable. The resource name of the customer conversion goal. Customer conversion goal resource names have the form: `customers/{customer_id}/customerConversionGoals/{category}~{origin}`
The conversion category of this customer conversion goal. Only conversion actions that have this category will be included in this goal.
The conversion origin of this customer conversion goal. Only conversion actions that have this conversion origin will be included in this goal.
Immutable. The resource name of the customer customizer. Customer customizer resource names have the form: `customers/{customer_id}/customerCustomizers/{customizer_attribute_id}`
Output only. The status of the customer customizer attribute.
Required. Immutable. The customizer attribute which is linked to the customer.
Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}`
Output only. The resource name of the customer to which the label is attached. This field should not be set when creating a new `CustomerLabel`.
Output only. The resource name of the label assigned to the customer. This field should not be set when creating a new `CustomerLabel`. Note: the Customer ID portion of the label resource name is not validated when creating a new `CustomerLabel`.
customer acquisition goal value settings
Output only. Customer acquisition goal customer level value settings.
Immutable. The resource name of the customer lifecycle goal. Customer lifecycle resource names have the form: `customers/{customer_id}/customerLifecycleGoal`
Output only. The resource name of the customer which owns the lifecycle goal.
Output only. The manager customer linked to the customer.
Output only. ID of the customer-manager link. This field is read only.
Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
Status of the link between the customer and the manager.
The consent setting for all the users in this job.
The resource name of remarketing list to update data. Required for job of CUSTOMER_MATCH_USER_LIST type.
Immutable. The resource name of the customer negative criterion. Customer negative criterion resource names have the form: `customers/{customer_id}/customerNegativeCriteria/{criterion_id}`
Immutable. IpBlock. You can exclude up to 500 IP addresses per account.
The NegativeKeywordListInfo shared set resource name.
The PlacementListInfo shared set resource name.
Output only. The resource name of the customer level search term insight. Customer level search term insight resource names have the form: `customers/{customer_id}/customerSearchTermInsights/{category_id}`
Output only. Email address of the user. Read only field
Output only. The resource name of the pending Multi-Party Authorization review. Read only field
Output only. The customer user access creation time. Read only field The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. User id of the user with the customer access. Read only field
Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccesses/{user_id}`
Output only. The email address of the inviter user. Read only field
Output only. Whether the user has passkey enabled. Read only field
Output only. The ID of the invitation. This field is read-only.
Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`
Output only. Time invitation was created. This field is read-only. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Immutable. Email address the invitation was sent to. This can differ from the email address of the account that accepts the invite.
Output only. Invitation status of the user.
Output only. The new CustomerUserAccessInvitation details. Only fields that need to be reviewed are populated.
Output only. The resource name of the CustomerUserAccess being changed.
Output only. The new CustomerUserAccess details. Only fields that need to be reviewed are populated.
Status of this custom interest. Indicates whether the custom interest is enabled or removed.
Name of the custom interest. It should be unique across the same custom affinity audience. This field is required for create operations.
List of custom interest members that this custom interest is composed of. Members can be added during CustomInterest creation. If members are presented in UPDATE operation, existing members will be overridden.
Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT. By default the type is set to CUSTOM_AFFINITY.
Immutable. The resource name of the custom interest. Custom interest resource names have the form: `customers/{customer_id}/customInterests/{custom_interest_id}`
Description of this custom interest audience.
Keyword text when member_type is KEYWORD or URL string when member_type is URL.
The type of custom interest member, KEYWORD or URL.
Immutable. The resource name of the customizer attribute. Customizer Attribute resource names have the form: `customers/{customer_id}/customizerAttributes/{customizer_attribute_id}`
Immutable. The type of the customizer attribute.
Output only. The ID of the customizer attribute.
Required. Immutable. Name of the customizer attribute. Required. It must have a minimum length of 1 and maximum length of 40. Name of an enabled customizer attribute must be unique (case insensitive).
Output only. The status of the customizer attribute.
Output only. Field value for custom question response, maximum number of characters is 70.
Output only. Question text for custom question, maximum number of characters is 300.
Output only. The ID of the data link. This field is read only.
Immutable. Resource name of the product data link. DataLink resource names have the form: `customers/{customer_id}/datalinks/{product_link_id}~{data_link_id}`
Immutable. A data link to YouTube video.
Output only. The status of the data link.
Immutable. The ID of a YouTube brand channel to help creators understand your brand. The channel must be linked to this account. This is a string value with “UC” prefix. For example, "UCK8sQmJBp8GCxrOtXWBpyEA".
Immutable. The ID of the hosting channel of the video. This is a string value with “UC” prefix. For example, "UCK8sQmJBp8GCxrOtXWBpyEA".
Immutable. The ID of the video associated with the video link. This is the 11 character string value used in the YouTube video URL. For example, video ID is jV1vkHv4zq8 from the YouTube video URL "https://www.youtube.com/watch?v=jV1vkHv4zq8&t=2s".
Immutable. The customer ID of the Data partner account. This field is required and should not be empty when creating a new data partner link. It is unable to be modified after the creation of the link.
The start date, in yyyy-mm-dd format. This date is inclusive.
The end date, in yyyy-mm-dd format. This date is inclusive.
Output only. Represents the type of the placement, for example, Website, YouTubeVideo and MobileApplication.
Output only. The display name is URL for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
Output only. The automatic placement string at detail level, for example. website url, mobile application id, or a YouTube video id.
Output only. The resource name of the detail content suitability placement view. Detail content suitability placement view resource names have the form: `customers/{customer_id}/detailContentSuitabilityPlacementViews/{placement_fingerprint}`
Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
Output only. The resource name of the detailed demographic. Detailed demographic resource names have the form: `customers/{customer_id}/detailedDemographics/{detailed_demographic_id}`
Output only. Availability information of the detailed demographic.
Output only. The parent of the detailed_demographic.
Output only. True if the detailed demographic is launched to all channels and locales.
Output only. The ID of the detailed demographic.
Output only. The name of the detailed demographic. For example,"Highest Level of Educational Attainment"
Output only. Type of the placement, for example, Website, YouTube Video, and Mobile Application.
Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL.
Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID.
Output only. The resource name of the detail placement view. Detail placement view resource names have the form: `customers/{customer_id}/detailPlacementViews/{ad_group_id}~{base64_placement}`
Output only. The resource name of the display keyword view. Display Keyword view resource names have the form: `customers/{customer_id}/displayKeywordViews/{ad_group_id}~{criterion_id}`
Output only. Grouping of user distance from location extensions.
Output only. True if the DistanceBucket is using the metric system, false otherwise.
Output only. The resource name of the distance view. Distance view resource names have the form: `customers/{customer_id}/distanceViews/1~{distance_bucket}`
Output only. The resource name of the domain category. Domain category resource names have the form: `customers/{customer_id}/domainCategories/{campaign_id}~{category_base64}~{language_code}`
Output only. The language code specifying the language of the website, for example, "en" for English. The language can be specified in the DynamicSearchAdsSetting required for dynamic search ads. This is the language of the pages from your website that you want Google Ads to find, create ads for, and match searches with.
Output only. The campaign this category is recommended for.
Output only. Indicates whether this category has sub-categories.
Output only. Fraction of pages on your site that this category matches.
Output only. The position of this category in the set of categories. Lower numbers indicate a better match for the domain. null indicates not recommended.
Output only. Recommended category for the website domain, for example, if you have a website about electronics, the categories could be "cameras", "televisions", etc.
Output only. The domain for the website. The domain can be specified in the DynamicSearchAdsSetting required for dynamic search ads.
Output only. The recommended cost per click for the category.
Output only. The dynamically selected landing page URL of the impression. This field is read-only.
Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: `customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}`
Output only. Search term This field is read-only.
Output only. The dynamically generated headline of the Dynamic Search Ad. This field is read-only.
Output only. The URL of page feed item served for the impression. This field is read-only.
Output only. True if query is added to targeted keywords. This field is read-only.
Output only. True if query matches a negative url. This field is read-only.
Output only. True if query matches a negative keyword. This field is read-only.
Output only. The resource name of the expanded landing page view. Expanded landing page view resource names have the form: `customers/{customer_id}/expandedLandingPageViews/{expanded_final_url_fingerprint}`
Output only. The final URL that clicks are directed to.
Output only. The resource name of the long-running operation that can be used to poll for completion of experiment schedule or promote. The most recent long running operation is returned.
Required. The name of the experiment. It must have a minimum length of 1 and maximum length of 1024. It must be unique under a customer.
Date when the experiment ends. By default, the experiment ends on the campaign's end date. If this field is set, then the experiment ends at the end of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-04-18
Output only. The status of the experiment promotion process.
Immutable. Set to true if changes to base campaigns should be synced to the trial campaigns. Any changes made directly to trial campaigns will be preserved. This field can only be set when the experiment is being created.
The Advertiser-chosen status of this experiment.
Output only. The ID of the experiment. Read only.
Date when the experiment starts. By default, the experiment starts now or on the campaign's start date, whichever is later. If this field is set, then the experiment starts at the beginning of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-03-14
Required. The product/feature that uses this experiment.
The description of the experiment. It must have a minimum length of 1 and maximum length of 2048.
For system managed experiments, the advertiser must provide a suffix during construction, in the setup stage before moving to initiated. The suffix will be appended to the in-design and experiment campaign names so that the name is base campaign name + suffix.
Immutable. Details of the optimize assets experiment. Applies for experiment types: OPTIMIZE_ASSETS.
Immutable. The resource name of the experiment. Experiment resource names have the form: `customers/{customer_id}/experiments/{experiment_id}`
Immutable. Details of the video experiment. Applies for experiment types: YOUTUBE_CUSTOM.
The metric of the goal. For example, clicks, impressions, cost, conversions, etc.
The metric direction of the goal. For example, increase, decrease, no change.
The subtype of the Optimize Assets experiment.
List of campaigns in the trial arm. The max length is one.
Output only. The in design campaigns in the treatment experiment arm.
Immutable. The resource name of the experiment arm. Experiment arm resource names have the form: `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
Whether this arm is a control arm. A control arm is the arm against which the other arms are compared.
Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms.
List of asset groups in the experiment arm. The max length is one. In the Optimize Assets experiment construction, the control arm and treatment arm should both contain the same asset group ID.
Immutable. Information specific to the control or treatment campaign of a Performance Max experiment. This field is specific to experiments of type PMAX_REPLACEMENT_SHOPPING. For example, the treatment experiment arm contains the information of treatment Performance Max campaign settings for PMAX_REPLACEMENT_SHOPPING experiments.
Immutable. The experiment to which the ExperimentArm belongs.
Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment.
Details of assets associated for each experimental copy of the ad.
Details for each asset that is being modified from the base ad.
The asset that is being modified for the experiment.
Enum to specify whether the asset is removed or added from the base ad.
List of asset group assets under the asset group.
Asset resource name of the asset group asset.
experimental performance max campaign settings
Immutable. Performance Max campaign settings to be applied on the Google-created experimental campaign in a Performance Max experiment. The experimental campaign is automatically created by Google upon experiment creation.
Immutable. The amount of budget of the Performance Max experiment campaign.
Immutable. Target ROAS of the Performance Max experiment campaign.
Immutable. Target CPA of the Performance Max experiment campaign.
Immutable. Bidding strategy type of the Performance Max experiment campaign.
Output only. Name of the instutition at which the fellowship was completed.
Output only. Status of the FinalUrlExpansionAsset.
Output only. Final URL of the FinalUrlExpansionAsset.
Output only. Asset Group in which FinalUrlExpansionAsset served.
Output only. Ad Group in which FinalUrlExpansionAsset served.
Output only. The resource name of the FinalUrlExpansionAsset.
Output only. The field type of the asset.
Lookback window for this rule in days. From now until X days ago.
List of rule item groups that defines this rule. Rule item groups are grouped together.
List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
Rule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. OR of ANDs is the only supported type for FlexibleRuleUserList.
Rule items that will be grouped together based on rule_type.
Rule variable name. It should match the corresponding key name fired by the pixel. A name must begin with US-ascii letters or underscore or UTF8 code that is greater than 127 and consist of US-ascii letters or digits or underscore or UTF8 code that is greater than 127. For websites, there are two built-in variable URL (name = 'url__') and referrer URL (name = 'ref_url__'). This field must be populated when creating a new rule item.
An atomic rule item composed of a number operation.
An atomic rule item composed of a date operation.
An atomic rule item composed of a string operation.
Number comparison operator. This field is required and must be populated when creating a new number rule item.
Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.
String representing date value to be compared with the rule variable. Supported date format is YYYY-MM-DD. Times are reported in the customer's time zone.
The relative date value of the right hand side denoted by number of days offset from now. The value field will override this field when both are present.
Date comparison operator. This field is required and must be populated when creating new date rule item.
String comparison operator. This field is required and must be populated when creating a new string rule item.
The right hand side of the string rule item. For URLs or referrer URLs, the value can not contain illegal URL chars such as newlines, quotes, tabs, or parentheses. This field is required and must be populated when creating a new string rule item.
Operator that defines how the inclusive operands are combined.
Rules representing users that should be included in the user list. These are located on the left side of the AND_NOT operator, and joined together by either AND/OR as specified by the inclusive_rule_operator.
Rules representing users that should be excluded from the user list. These are located on the right side of the AND_NOT operator, and joined together by OR.
Output only. The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}`
Output only. The resource name of the geographic view. Geographic view resource names have the form: `customers/{customer_id}/geographicViews/{country_criterion_id}~{location_type}`
Output only. Type of the geo targeting of the campaign.
Output only. Criterion Id for the country.
Output only. Geo target constant target type.
Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.
Output only. The ID of the geo target constant.
Output only. Geo target constant English name.
Output only. Geo target constant status.
Output only. The resource name of the goal owner customer.
Immutable. The resource name of the goal. Goal resource names have the form: `customers/{customer_id}/goals/{goal_id}`
Output only. Indicates if this goal is eligible for campaign optimization.
Immutable. The resource name of the Google Ads account. This field is required and should not be empty when creating a new Google Ads link. It is unable to be modified after the creation of the link.
The keyword plan referenced in the query.
The language constant referenced in the query.
The group placement view referenced in the query.
The Smart campaign setting referenced in the query.
The user list customer type in the query.
The customer lifecycle goal referenced in the query.
The bidding strategy simulation referenced in the query.
The ad group asset referenced in the query.
The ad group customizer referenced in the query.
android privacy shared key google network type
The android privacy shared key google network type referenced in the query.
The ad schedule view referenced in the query.
The ad group ad asset view in the query.
The ChangeEvent referenced in the query.
The keyword plan campaign referenced in the query.
group content suitability placement view
The group content suitability placement view referenced in the query.
The shopping product referenced in the query.
The Smart campaign search term view referenced in the query.
The channel aggregate asset view referenced in the query.
The CustomerConversionGoal referenced in the query.
offline conversion upload conversion action summary
Offline conversion upload summary at conversion type level.
The product group view referenced in the query.
The AccountLink referenced in the query.
The domain category referenced in the query.
The campaign customizer referenced in the query.
The location interest view referenced in the query.
The lead form user submission referenced in the query.
The keyword plan campaign keyword referenced in the query.
The asset group top combination view referenced in the query.
The customer negative criterion referenced in the query.
The ad group ad asset combination view in the query.
The user interest referenced in the query.
The YouTube video upload referenced in the query.
The product category referenced in the query.
The recommendation subscription referenced in the query.
The asset set asset referenced in the query.
The CampaignConversionGoal referenced in the query.
The campaign audience view referenced in the query.
The display keyword view referenced in the query.
The content criterion view referenced in the query.
The operating system version constant referenced in the query.
The campaign bid modifier referenced in the query.
The conversion custom variable referenced in the query.
The managed placement view referenced in the query.
The campaign goal config referenced in the query.
The multi party auth review referenced in the query.
The webpage view referenced in the query.
The keyword plan ad group referenced in the query.
The topic constant referenced in the query.
The campaign criterion referenced in the query.
offline conversion upload client summary
Offline conversion upload summary at customer level.
The currency constant referenced in the query.
The asset set type view referenced in the query.
The CustomAudience referenced in the query.
The CustomerClient referenced in the query.
The customizer attribute referenced in the query.
The customer customizer referenced in the query.
The keyword theme constant referenced in the query.
The local services lead referenced in the query.
The CustomInterest referenced in the query.
The product link invitation in the query.
The keyword view referenced in the query.
The expanded landing page view referenced in the query.
The ad group asset set referenced in the query.
The conversion value rule set referenced in the query.
The gender view referenced in the query.
The hotel performance view referenced in the query.
The asset group signal referenced in the query.
The dynamic search ads search term view referenced in the query.
The local services employee referenced in the query.
The conversion value rule referenced in the query.
android privacy shared key google ad group
The android privacy shared key google ad group referenced in the query.
The hotel group view referenced in the query.
Campaign Shared Set referenced in AWQL query.
The AI Max search term ad combination view referenced in the query.
The video enhancement referenced in the query.
The ad group simulation referenced in the query.
The bidding strategy referenced in the query.
The campaign budget referenced in the query.
The CustomerClientLink referenced in the query.
The landing page view referenced in the query.
The asset group listing group filter referenced in the query.
The local services lead conversationreferenced in the query.
The CombinedAudience referenced in the query.
The asset field type view referenced in the query.
The travel activity group view referenced in the query.
The user location view referenced in the query.
The CustomConversionGoal referenced in the query.
The ad parameter referenced in the query.
The campaign simulation referenced in the query.
The CustomerUserAccess referenced in the query.
The ad group criterion customizer referenced in the query.
The final url expansion asset view referenced in the query.
The parental status view referenced in the query.
The geographic view referenced in the query.
android privacy shared key google campaign
The android privacy shared key google campaign referenced in the query.
The hotel reconciliation referenced in the query.
The campaign draft referenced in the query.
The bidding seasonality adjustment referenced in the query.
The CustomerManagerLink referenced in the query.
The cart data sales view referenced in the query.
The detail placement view referenced in the query.
The asset group asset referenced in the query.
The CustomerUserAccessInvitation referenced in the query.
The detailed demographic referenced in the query.
The remarketing action referenced in the query.
The offline user data job referenced in the query.
The search term view referenced in the query.
The customer search term insight referenced in the query.
The bid modifier referenced in the query.
The asset group referenced in the query.
The campaign label referenced in the query.
The ad group criterion simulation referenced in the query.
The account budget proposal referenced in the query.
Campaign Group referenced in AWQL query.
The customer asset referenced in the query.
The carrier constant referenced in the query.
The performance max placement view referenced in the query.
The bidding data exclusion referenced in the query.
The campaign asset referenced in the query.
The campaign-level search term view referenced in the query.
The ad group audience view referenced in the query.
The matched location interest view referenced in the query.
The distance view referenced in the query.
The ad group label referenced in the query.
The ConversionGoalCampaignConfig referenced in the query.
The geo target constant referenced in the query.
The income range view referenced in the query.
The travel activity performance view referenced in the query.
The conversion action referenced in the query.
The applied incentive referenced in the query.
The customer label referenced in the query.
The age range view referenced in the query.
The paid organic search term view referenced in the query.
The qualifying question referenced in the query.
The ad group criterion label referenced in the query.
detail content suitability placement view
The detail content suitability placement view referenced in the query.
The local services verification artifact referenced in the query.
The product link referenced in the query.
The mobile app category constant referenced in the query.
The campaign aggregate asset view referenced in the query.
The recommendation referenced in the query.
The ad group ad label referenced in the query.
The per store view referenced in the query.
The campaign lifecycle goal referenced in the query.
The billing setup referenced in the query.
The Targeting expansion view referenced in the query.
The experiment arm referenced in the query.
The mobile device constant referenced in the query.
The ChangeStatus referenced in the query.
The shopping performance view referenced in the query.
The customer asset set referenced in the query.
The campaign search term insight referenced in the query.
The asset group product group view referenced in the query.
The campaign asset set referenced in the query.
The app top combination view in the query.
The accessible bidding strategy referenced in the query.
The location view referenced in the query.
Immutable. The resource name of the Keyword Planner plan. KeywordPlan resource names have the form: `customers/{customer_id}/keywordPlans/{kp_plan_id}`
Output only. The ID of the keyword plan.
The name of the keyword plan. This field is required and should not be empty when creating new keyword plans.
The date period used for forecasting the plan.
The custom date range used for forecasting. It cannot be greater than a year. The start and end dates must be in the future. Otherwise, an error will be returned when the forecasting action is performed. The start and end dates are inclusive.
A future date range relative to the current date used for forecasting.
Output only. The owner channel id of the video.
Output only. The resource name of the video. Video resource names have the form: `customers/{customer_id}/videos/{video_id}`
Output only. The duration of the video in milliseconds.
Output only. The ID of the language constant.
Output only. The language code, for example, "en_US", "en_AU", "es", "fr", etc.
Output only. The full name of the language in English, for example, "English (US)", "Spanish", etc.
Output only. Whether the language is targetable.
Output only. The resource name of the language constant. Language constant resource names have the form: `languageConstants/{criterion_id}`
Output only. Domain name for websites and YouTube channel name for YouTube channels.
Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID.
Output only. The resource name of the group placement view. Group placement view resource names have the form: `customers/{customer_id}/groupPlacementViews/{ad_group_id}~{base64_placement}`
Output only. Type of the placement, for example, Website, YouTube Channel, Mobile Application.
Immutable. The resource name of the Smart campaign setting. Smart campaign setting resource names have the form: `customers/{customer_id}/smartCampaignSettings/{campaign_id}`
The user-provided landing page URL for this Campaign.
Settings for configuring a business profile optimized for ads as this campaign's landing page. This campaign must be linked to a business profile to use this option. For more information on this feature, consult https://support.google.com/google-ads/answer/9827068.
Output only. The campaign to which these settings apply.
The language code to advertise in from the set of [supported language codes] (https://developers.google.com/google-ads/api/reference/data/codes-formats#languages).
The resource name of a Business Profile location. Business Profile location resource names can be fetched through the Business Profile API and adhere to the following format: `locations/{locationId}`. See the [Business Profile API] (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) for additional details.
Upper-case, two-letter country code as defined by ISO-3166.
Enabling a lead form on your business profile enables prospective customers to contact your business by filling out a simple form, and you'll receive their information through email.
Immutable. The resource name of the user list customer type User list customer type resource names have the form: `customers/{customer_id}/userListCustomerTypes/{user_list_id}~{customer_type_category}`
Immutable. The resource name for the user list this user list customer type is associated with
Immutable. The user list customer type category
The region the user is searching for at query time.
The version of the SKAdNetwork API used.
Primary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DEVICE, AUDIENCE, ITINERARY show the net adjustment after value rules were applied.
Resource name of the geo target constant that represents a postal code.
Domain (visible URL) of a participant in the Auction Insights report.
An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal.
Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
Hotel check-in date. Formatted as yyyy-MM-dd.
iOS Store Kit Ad Network postback sequence index.
Specifies the source for how the search term was matched, which reveals the type of ad campaign responsible. Use this to distinguish between automated campaigns (like AI Max, Dynamic Search Ads) and keyword-based campaigns (Standard).
The source type where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or neither source domain nor source app were present in any postbacks sent by Apple.
Resource name of the geo target constant that represents a province.
Adjusted gender. This is the gender of the user after applying modeling to get more accurate age and gender information. Currently, both adjusted_age_range and adjusted_gender need to be selected together to get valid reach stats. These segmentations are only available for allowlisted customers.
Resource name of the geo target constant that represents a county.
Resource name of the geo target constant that represents a city.
The city where the vertical ads listing is located.
Resource name of the geo target constant for the country of sale of the product.
A specific partner account within a Partner Center (for example, Hotel Center) that supplies inventory feed data for Vertical Ads.
The source of a landing page in the landing page report.
Match type of the keyword that triggered the ad. This segment is for use with keyword_view. For other resources, use match_type. While match_type is filtered to Broad, Exact, Phrase and Ai Max, search_term_match_type includes variants like Near Exact and Near Phrase.
Resource name of the geo target constant that represents a canton.
The name of the venue for the vertical ads listing, for example, the venue for a concert event.
Type of vertical ad, such as Vacation Rentals, Car Rentals, or Events, used to categorize and segment data in the context of Vertical Ads.
Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interaction_on_this_asset is true, it means the interactions are on this specific asset and when interaction_on_this_asset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with.
The brand associated with a specific listing within a Vertical Ads context, for example, the brand of a car rental, a vacation home, or an event.
Resource name of the geo target constant that represents a region.
Resource name of the geo target constant that represents a country.
Ad sub network type. Currently only available for ads running as part of DemandGen campaigns on YouTube and has to always be selected together with ad_network_type.
The city the user is searching for at query time.
vertical ads event participant display names
The display names of participants in an event listing, like performers, speakers, or teams.
Website where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.
The country where the vertical ads listing is located.
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
Resource name of the geo target constant that represents the most specific location.
Hour of day as a number between 0 and 23, inclusive.
Resource name of the geo target constant that represents a district.
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
This segments your conversion columns by the original conversion and conversion value versus the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
Resource name of the ad group criterion that represents webpage criterion.
App where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.
Indicates whether an ad is using product data from a Google Merchant Center feed. This segment is only available for PMax campaigns and will not return data when any other campaign type is selected.
Indicates whether an ad is using a video asset. This segment is only available for PMax campaigns and will not return data when any other campaign type is selected.
Resource name of the geo target constant that represents a state.
The region where the vertical ads listing is located.
Adjusted age range. This is the age range of the user after applying modeling to get more accurate age and gender information. Currently, both adjusted_age_range and adjusted_gender need to be selected together to get valid reach stats. These segmentations are only available for allowlisted customers.
The class of the hotel. Generally in the range of 1 to 5 stars, but fully customizable in the hotel feed.
A search term subcategory. An empty string denotes the catch-all subcategory for search terms that didn't fit into another subcategory.
Resource name of the language constant for the language of the product.
Month of the year, for example, January.
Indicates whether the search term is currently one of your targeted or excluded keywords.
iOS Store Kit Ad Network coarse conversion value.
iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, for example, non-iOS campaign.
The match type of the keyword that triggered the ad. This segment is for use with keyword_view. For other resources, use search_term_match_type. While match_type is filtered to Broad, Exact, Phrase and Ai Max, search_term_match_type includes variants like Near Exact, Near Phrase.
Resource name of the geo target constant that represents an airport.
An enum value representing the number of days between the impression and the conversion.
Mobile device platform to which metrics apply.
The country the user is searching for at query time.
Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
iOS Store Kit Ad Network attribution credit
Resource name of the geo target constant that represents a metro.
sk ad network redistributed fine conversion value
iOS Store Kit Ad Network redistributed fine conversion value. Google uses modeling on observed conversion values(obtained from Apple) to calculate conversions from SKAN postbacks where NULLs are returned. This column represents the sum of the modeled conversion values and the observed conversion values. See https://support.google.com/google-ads/answer/14892597 to lean more.
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
The listing associated with a listing impression, click or conversion.
Integer value specifying the user rating of the vertical ads listing as a number from 1 to 5, where 5 is the best. The value will always be within this range.
App id where the ad that drove the iOS Store Kit Ad Network install was shown.
The keyword plan this campaign belongs to.
Targeting network. This field is required and should not be empty when creating Keyword Plan campaigns.
Output only. The ID of the Keyword Plan campaign.
The name of the Keyword Plan campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
A default max cpc bid in micros, and in the account currency, for all ad groups under the campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
The geo targets. Max number allowed: 20.
Immutable. The resource name of the Keyword Plan campaign. KeywordPlanCampaign resource names have the form: `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
The languages targeted for the Keyword Plan campaign. Max allowed: 1.
Required. The resource name of the geo target.
Output only. The automatic placement string at group level, for example. website url, mobile application id, or a YouTube video id.
Output only. The resource name of the group content suitability placement view. Group content suitability placement view resource names have the form: `customers/{customer_id}/groupContentSuitabilityPlacementViews/{placement_fingerprint}`
Output only. The product type level 3 as provided by the merchant.
Output only. The custom attribute 3 of the product as provided by the merchant.
Output only. The category level 2 of the product.
Output only. The channel exclusivity of the product as provided by the merchant.
Output only. The custom attribute 0 of the product as provided by the merchant.
Output only. The custom attribute 4 of the product as provided by the merchant.
Output only. The brand of the product as provided by the merchant.
Output only. The product feed label as provided by the merchant.
Output only. The category level 4 of the product.
Output only. The product type level 4 as provided by the merchant.
Output only. The list of issues affecting whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update. This field is not supported for App campaigns.
Output only. The status that indicates whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update. This field is not supported for App campaigns.
Output only. The id of the Multi Client Account of the merchant, if present.
Output only. The product type level 5 as provided by the merchant.
Output only. The currency code as provided by the merchant, in ISO 4217 format.
Output only. The id of the merchant that owns the product.
Output only. The language code as provided by the merchant, in BCP 47 format.
Output only. The category level 1 of the product.
Output only. An ad group of a campaign that includes the product. This field is selectable only in the ad group scope, which requires an equality filter on `campaign` and `ad_group`.
Output only. The resource name of the shopping product. Shopping product resource names have the form: `customers/{customer_id}/shoppingProducts/{merchant_center_id}~{channel}~{language_code}~{feed_label}~{item_id}`
Output only. The product type level 1 as provided by the merchant.
Output only. The effective maximum cost-per-click (effective max. CPC) of the product. This field is available only if the query specifies the campaign or ad group scope, and if the campaign uses manual bidding. The value is the highest bid set for the product in product groups across all enabled ad groups. It represents the most you're willing to pay for a click on the product. This field can take up to 24 hours to update.
Output only. The product channel describing the locality of the product.
Output only. The URI of the product image as provided by the merchant.
Output only. The product type level 2 as provided by the merchant.
Output only. The category level 5 of the product.
Output only. The item id of the product as provided by the merchant.
Output only. The custom attribute 1 of the product as provided by the merchant.
Output only. The category level 3 of the product.
Output only. The condition of the product as provided by the merchant.
Output only. The custom attribute 2 of the product as provided by the merchant.
Output only. A campaign that includes the product. This field is selectable only in the campaign scope, which requires an equality filter on `campaign`.
Output only. The availability of the product as provided by the merchant.
Output only. The title of the product as provided by the merchant.
Output only. The price of the product in micros as provided by the merchant, in the currency specified in `currency_code` (e.g. $2.97 is reported as 2970000).
Output only. Upper-case two-letter ISO 3166-1 code of the regions where the product is intended to be shown in ads.
Output only. List of upper-case two-letter ISO 3166-1 codes of the regions affected by the issue. If empty, all regions are affected.
Output only. The error code that identifies the issue.
Output only. The name of the product's attribute, if any, that triggered the issue.
Output only. The short description of the issue in English.
Output only. The URL of the Help Center article for the issue.
Output only. The detailed description of the issue in English.
Output only. The severity of the issue in Google Ads.
Output only. The Smart campaign the search term served in.
Output only. The resource name of the Smart campaign search term view. Smart campaign search term view resource names have the form: `customers/{customer_id}/smartCampaignSearchTermViews/{campaign_id}~{URL-base64_search_term}`
Output only. Summary of history stats by last N jobs.
Output only. Total count of successful uploaded events.
Output only. Details for each error code. Alerts are generated from most recent calendar day with upload stats.
Output only. Date for the latest upload batch. The format is "yyyy-mm-dd hh:mm:ss", and it's in the time zone of the Google Ads account.
Output only. Client type of the upload event.
Output only. Total count of pending uploaded events.
Output only. Overall status for offline conversion upload conversion action summary. Status is generated from most recent calendar day with upload stats.
Output only. Summary of history stats by last N days.
Output only. The name of the conversion action.
Output only. Total count of uploaded events.
Output only. The resource name of the offline conversion upload summary at conversion action level. Offline conversion upload conversion action summary resource names have the form: `customers/{customer_id}/offlineConversionUploadConversionActionSummaries/{conversion_action_id}~{client}`
Output only. Total count of failed event.
Output only. Total count of successful event.
Output only. Total count of pending uploaded event.
Output only. Dimension key for last N jobs.
Output only. Dimension key for last N days.
Output only. Error for offline conversion client alert.
Output only. Percentage of the error, the range of this field should be [0, 1.0].
Output only. Conversion adjustment upload error.
Output only. The resource name of the product group view. Product group view resource names have the form: `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}`
Immutable. The resource name of the third party app analytics link. Third party app analytics link resource names have the form: `customers/{customer_id}/thirdPartyAppAnalyticsLinks/{account_link_id}`
Output only. The shareable link ID that should be provided to the third party when setting up app analytics. This is able to be regenerated using regenerate method in the ThirdPartyAppAnalyticsLinkService.
Output only. The resource name of the location interest view. Location interest view resource names have the form: `customers/{customer_id}/locationInterestViews/{campaign_id}~{ad_group_id}~{criterion_id}`
Output only. Asset associated with the submitted lead form.
Output only. AdGroupAd associated with the submitted lead form.
Output only. Submission data associated with a custom lead form.
Output only. AdGroup associated with the submitted lead form.
Output only. The date and time at which the lead form was submitted. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
Output only. The resource name of the lead form submission data. Lead form submission data resource names have the form: `customers/{customer_id}/leadFormSubmissionData/{lead_form_submission_data_id}`
Output only. Submission data associated with a lead form.
Output only. Google Click Id associated with the submissed lead form.
Output only. Campaign associated with the submitted lead form.
Output only. ID of this lead form submission.
Output only. Field type for lead form fields.
Output only. Field value for lead form fields.
Output only. The resource name of the life event. Life event resource names have the form: `customers/{customer_id}/lifeEvents/{life_event_id}`
Output only. Availability information of the life event.
Output only. The name of the life event, for example,"Recently Moved"
Output only. The parent of the life_event.
Output only. True if the life event is launched to all channels and locales.
The Keyword Plan campaign to which this negative keyword belongs.
Immutable. If true, the keyword is negative. Must be set to true. Only negative campaign keywords are supported.
Immutable. The resource name of the Keyword Plan Campaign keyword. KeywordPlanCampaignKeyword resource names have the form: `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
Output only. The ID of the Keyword Plan negative keyword.
Output only. Taxonomy type of the user interest.
Output only. The ID of the user interest.
Output only. The parent of the user interest.
Output only. Availability information of the user interest.
Output only. The resource name of the user interest. User interest resource names have the form: `customers/{customer_id}/userInterests/{user_interest_id}`
Output only. True if the user interest is launched to all channels and locales.
Output only. The name of the user interest.
Output only. The current state of the YouTube video upload.
The privacy state of the video. Only mutable for videos uploaded to the advertiser owned (brand) YouTube channel. For videos uploaded to the Google-managed channels only UNLISTED privacy is allowed. Defaults to UNLISTED privacy if not specified.
Input only. Immutable. The title of the video. Only mutable on YouTube video upload creation. Immutable after creation.
Immutable. Resource name of the YouTube video upload.
Input only. Immutable. The description of the video. Only mutable on YouTube video upload creation. Immutable after creation.
Output only. The YouTube video ID of the uploaded video.
Output only. The unique ID of the YouTube video upload.
Immutable. The destination YouTube channel ID for the video upload. Only mutable on YouTube video upload creation. If omitted, the video will be uploaded to the Google-managed YouTube channel associated with the Ads account.
Output only. Resource name of the parent product category.
Output only. Level of the product category.
Output only. The ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.
Output only. List of all available localizations of the product category.
Output only. The resource name of the product category. Product category resource names have the form: `productCategoryConstants/{level}~{category_id}`
Output only. State of the product category.
Output only. Upper-case two-letter ISO 3166-1 country code of the localized category.
Output only. Two-letter ISO 639-1 language code of the localized category.
Output only. The name of the category in the specified locale.
Required. Status of the subscription, either enabled or paused.
Output only. Contains the time in microseconds, when the Recommendation Subscription was last updated. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
Immutable. The resource name of the recommendation subscription. `customers/{customer_id}/recommendationSubscriptions/{recommendation_type}`
Required. Immutable. The type of recommendation subscribed to.
Output only. Time in seconds when the subscription was first created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
Output only. The mime type of the media file.
Immutable. The resource name of the media file. Media file resource names have the form: `customers/{customer_id}/mediaFiles/{media_file_id}`
Immutable. A ZIP archive media the content of which contains HTML5 assets.
Immutable. The name of the media file. The name can be used by clients to help identify previously uploaded media.
Output only. The size of the media file in bytes.
Immutable. The URL of where the original media file was downloaded from (or a file name). Only used for media of type AUDIO and IMAGE.
Output only. The url to the full size version of the image.
Output only. The url to the preview size version of the image.
Output only. The url to access the uploaded zipped data. For example, https://tpc.googlesyndication.com/simgad/123 This field is read-only.
Output only. The duration of the Audio in milliseconds.
Output only. The Advertising Digital Identification code for this video, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
Immutable. The YouTube video ID (as seen in YouTube URLs). Adding prefix "https://www.youtube.com/watch?v=" to this ID will get the YouTube streaming URL for this video.
Output only. The Industry Standard Commercial Identifier code for this video, used mainly for television commercials.
Output only. The OS Minor Version number.
Output only. The ID of the operating system version.
Output only. Name of the operating system.
Output only. The OS Major Version number.
Output only. The resource name of the operating system version constant. Operating system version constant resource names have the form: `operatingSystemVersionConstants/{criterion_id}`
Output only. Determines whether this constant represents a single version or a range of versions.
Output only. The resource name of the Managed Placement view. Managed placement view resource names have the form: `customers/{customer_id}/managedPlacementViews/{ad_group_id}~{criterion_id}`
Immutable. The resource name of the Multi-Party Authentication review. Resource names have the form: `customers/{customer_id}/multiPartyAuthReviews/{multi_party_auth_review_id}`
Output only. The operation type of the Multi-Party Authorization review.
Output only. The CustomerUserAccess details.
Output only. The approval date and time of the Multi-Party Authorization review.
Output only. The status of the Multi-Party Authorization review.
Output only. The CustomerUserAccessInvitation details.
Output only. The target resource for which Multi-Party Authorization is requested.
Output only. The ID of the Multi-Party Authorization review.
Output only. The email of the user who requested the Multi-Party Authorization review
Output only. The creation date and time of the Multi-Party Authorization review.
Output only. The justification for the Multi-Party Authorization review request given by the requester.
Output only. The resource name of the webpage view. Webpage view resource names have the form: `customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}`
Output only. The ID of the keyword plan ad group.
The name of the keyword plan ad group. This field is required and should not be empty when creating keyword plan ad group.
A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group. If not set, will inherit from parent campaign.
The keyword plan campaign to which this ad group belongs.
Immutable. The resource name of the Keyword Planner ad group. KeywordPlanAdGroup resource names have the form: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
Output only. The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/google-ads/api/reference/data/verticals
Output only. The resource name of the topic constant. topic constant resource names have the form: `topicConstants/{topic_id}`
Output only. Resource name of parent of the topic constant.
Output only. The resource name of the offline conversion upload summary at customer level. Offline conversion upload client summary resource names have the form: `customers/{customer_id}/offlineConversionUploadClientSummaries/{client}`
Output only. Overall status for offline conversion client summary. Status is generated from most recent calendar day with upload stats.
Output only. The ratio of total pending events to total events.
Output only. The resource name of the keyword theme constant. Keyword theme constant resource names have the form: `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
Output only. The ISO-3166 Alpha-2 country code of the constant, eg. "US". To display and query matching purpose, the keyword theme needs to be localized.
Output only. The ISO-639-1 language code with 2 letters of the constant, eg. "en". To display and query matching purpose, the keyword theme needs to be localized.
Output only. The display name of the keyword theme or sub keyword theme.
Output only. Service category of the lead. For example: `xcat:service_area_business_hvac`, `xcat:service_area_business_real_estate_agent`, etc. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
Output only. Type of Local Services lead: phone, message, booking, etc.
Output only. Note added by advertiser for the lead.
Output only. The date time at which lead was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. Language used by the Local Services provider linked to lead. See https://developers.google.com/google-ads/api/data/codes-formats#locales
Output only. True if the advertiser submitted feedback for the lead.
Output only. Credit details of the lead.
Immutable. The resource name of the local services lead data. Local Services Lead resource name have the form `customers/{customer_id}/localServicesLead/{local_services_lead_id}`
Output only. True if the advertiser was charged for the lead.
Output only. Service for the category. For example: `buyer_agent`, `seller_agent` for the category of `xcat:service_area_business_real_estate_agent`.
Output only. The date time when lead note was edited. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. The status of the product link invitation. This field is read only.
Output only. Merchant Center link invitation.
Output only. The ID of the product link invitation. This field is read only.
Output only. Advertising Partner link invitation properties. These properties are only applicable when the link is for an Advertising Partner.
Output only. The type of the invited account. This field is read only and can be used for filtering invitations with {
Output only. Advertising Partner link invitation.
Immutable. The resource name of a product link invitation. Product link invitation resource names have the form: `customers/{customer_id}/productLinkInvitations/{product_link_invitation_id}`
Output only. The Merchant Center id of the Merchant account. This field is read only
Output only. The hotel center id of the hotel account. This field is read only
Output only. The resource name of the keyword view. Keyword view resource names have the form: `customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}`
Output only. The resource name of the hotel performance view. Hotel performance view resource names have the form: `customers/{customer_id}/hotelPerformanceView`
Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form: `customers/{customer_id}/localServicesEmployees/{gls_employee_id}`
Output only. The institutions where the employee has completed their fellowship.
Output only. The institutions where the employee has completed their residency.
Output only. Languages that the employee speaks, represented as language tags from https://developers.google.com/admin-sdk/directory/v1/languages
Output only. Middle name of the employee.
Output only. The year that this employee started practicing in this field.
Output only. Employee status, such as DELETED or ENABLED.
Output only. First name of the employee.
Output only. A list of degrees this employee has obtained, and wants to feature.
Output only. Job title for this employee, such as "Senior partner" in legal verticals.
Output only. Email address of the employee.
Output only. Timestamp of employee creation. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. NPI id associated with the employee.
Output only. Category of the employee. A list of Local Services category IDs can be found at https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids.
Output only. Name of the institution at which the residency was completed.
Output only. Name of the degree obtained.
Output only. Name of the university at which the degree was obtained.
Output only. The resource name of the hotel group view. Hotel Group view resource names have the form: `customers/{customer_id}/hotelGroupViews/{ad_group_id}~{criterion_id}`
Output only. Duration of this video, in milliseconds.
Output only. The source of the video (e.g. advertiser or enhanced by Google Ads).
Output only. The resource name of the video enhancement. Video enhancement resource names have the form: `customers/{customer_id}/videoEnhancements/{video_id}`
Output only. The resource name of the landing page view. Landing page view resource names have the form: `customers/{customer_id}/landingPageViews/{unexpanded_final_url_fingerprint}`
Output only. The advertiser-specified final URL.
Output only. The date time at which lead conversation was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. The resource name of the local services lead conversation data. Local Services Lead Conversation resource name have the form `customers/{customer_id}/localServicesLeadConversation/{local_services_lead_conversation_id}`
Output only. Type of GLS lead conversation, EMAIL, MESSAGE, PHONE_CALL, SMS, etc.
Output only. Type of participant in the lead conversation, ADVERTISER or CONSUMER.
Output only. Details of phone call conversation in case of PHONE_CALL.
Output only. Details of message conversation in case of EMAIL, MESSAGE or SMS.
Output only. ID of this Lead Conversation.
Output only. Resource name of Lead associated to the Lead Conversation.
Output only. The duration (in milliseconds) of the phone call (end to end).
Output only. URL to the call recording audio file.
Output only. Textual content of the message.
Output only. URL to the SMS or email attachments. These URLs can be used to download the contents of the attachment by using the developer token.
Output only. The resource name of the travel activity group view. Travel Activity Group view resource names have the form: `customers/{customer_id}/travelActivityGroupViews/{ad_group_id}~{criterion_id}`
Output only. The resource name of the user location view. UserLocation view resource names have the form: `customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}`
Output only. Indicates whether location was targeted or not.
Output only. The resource name of the parental status view. Parental Status view resource names have the form: `customers/{customer_id}/parentalStatusViews/{ad_group_id}~{criterion_id}`
Output only. The order ID is the identifier for this booking as provided in the 'transaction_id' parameter of the conversion tracking tag.
Output only. The resource name for the Campaign associated with the conversion.
Required. Output only. Current status of a booking with regards to reconciliation and billing. Bookings should be reconciled within 45 days after the check-out date. Any booking not reconciled within 45 days will be billed at its original value.
Required. Output only. Reconciled value is the final value of a booking as paid by the guest. If original booking value changes for any reason, such as itinerary changes or room upsells, the reconciled value should be the full final amount collected. If a booking is canceled, the reconciled value should include the value of any cancellation fees or non-refundable nights charged. Value is in millionths of the base unit currency. For example, $12.35 would be represented as 12350000. Currency unit is in the default customer currency.
Immutable. The resource name of the hotel reconciliation. Hotel reconciliation resource names have the form: `customers/{customer_id}/hotelReconciliations/{commission_id}`
Required. Output only. The commission ID is Google's ID for this booking. Every booking event is assigned a Commission ID to help you match it to a guest stay.
Output only. Check-in date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.
Output only. Unique identifier for the booked property, as provided in the Hotel Center feed. The hotel ID comes from the 'ID' parameter of the conversion tracking tag.
Output only. Check-out date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.
Output only. Identifier for the Hotel Center account which provides the rates for the Hotel campaign.
Output only. Whether a given booking has been billed. Once billed, a booking can't be modified.
Immutable. The resource name of the shared criterion. Shared set resource names have the form: `customers/{customer_id}/sharedCriteria/{shared_set_id}~{criterion_id}`
Immutable. The shared set to which the shared criterion belongs.
Immutable. Vertical ads item group rule.
Immutable. If true, the criterion is excluded. If false, the criterion is targeted.
An expression node. At this time, this can only be an OR node.
The name of the expression. This name is used for grouping Retail Tags into one logical expression with OR operator. The name can contain at most 20 characters. Only lowercase latin letters, underscores, and numbers are allowed. This field is required and must be unique within the shared set.
The name of the expression this tag belongs to. If empty, the tag is a top-level condition.
The value of the tag. It can contain at most 50 characters. All Unicode characters except comma and newline are allowed. This field is required.
The resource name of the Geo Target Constant for the city.
The id specifying a particular Vertical Ad listing.
The resource name of the Geo Target Constant for the region.
A name for a specific location, like the venue for a concert event.
Integer value specifying the user rating for a Vertical Ad listing. Ranges from 1 to 5, where 5 is the best.
Integer value specifying the class rating for a hotel. Ranges from 1 to 5 stars.
The name of an associated participant for a given event. For example, headliner for a concert event.
The resource name of the Geo Target Constant for the country.
The Keyword Plan ad group to which this keyword belongs.
Immutable. The resource name of the Keyword Plan ad group keyword. KeywordPlanAdGroupKeyword resource names have the form: `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}`
Immutable. If true, the keyword is negative.
Output only. The ID of the Keyword Plan keyword.
A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency is the same as the account currency code. This will override any CPC bid set at the keyword plan ad group level. Not applicable for negative keywords. (negative = true) This field is Optional.
Output only. The snippets used for tracking remarketing actions.
Immutable. The resource name of the remarketing action. Remarketing action resource names have the form: `customers/{customer_id}/remarketingActions/{remarketing_action_id}`
Output only. Id of the remarketing action.
The name of the remarketing action. This field is required and should not be empty when creating new remarketing actions.
Output only. ID of this offline user data job.
Output only. Metadata of offline user data job depicting match rate range.
Immutable. The resource name of the offline user data job. Offline user data job resource names have the form: `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
Immutable. Metadata for data updates to a CRM-based user list.
Immutable. Metadata for store sales data update.
Output only. Reason for the processing failure, if status is FAILED.
Output only. Match rate of the Customer Match user list upload. Describes the estimated match rate when the status of the job is "RUNNING" and final match rate when the final match rate is available after the status of the job is "SUCCESS/FAILED".
This is the ratio of sales being uploaded compared to the overall sales that can be associated with a customer. Required. The fraction needs to be between 0 and 1 (excluding 0). For example, if you upload half the sales that you are able to associate with a customer, this would be 0.5.
Name of the store sales custom variable key. A predefined key that can be applied to the transaction and then later used for custom segmentation in reporting. Accessible only to customers on the allow-list.
This is the fraction of all transactions that are identifiable (for example, associated with any form of customer information). Required. The fraction needs to be between 0 and 1 (excluding 0).
Metadata for a third party Store Sales upload.
The fraction of valid transactions that are matched to a third party assigned user ID on the partner side. Required. The fraction needs to be between 0 and 1 (excluding 0).
The fraction of valid transactions that are uploaded by the partner to Google. Required. The fraction needs to be between 0 and 1 (excluding 0).
Version of partner IDs to be used for uploads. Required.
ID of the third party partner updating the transaction feed.
The fraction of transactions that are valid. Invalid transactions may include invalid formats or values. Required. The fraction needs to be between 0 and 1 (excluding 0).
Time the advertiser uploaded the data to the partner. Required. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. The ad group the search term served in.
Output only. The resource name of the search term view. Search term view resource names have the form: `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.
Output only. Type of the placement. Possible values for Performance Max placements are WEBSITE, MOBILE_APPLICATION, or YOUTUBE_VIDEO.
Output only. The resource name of the Performance Max placement view. Performance Max placement view resource names have the form: `customers/{customer_id}/performanceMaxPlacementViews/{base_64_placement}`
Output only. The default placement string, such as the website URL, mobile application ID, or a YouTube video ID.
Output only. The name displayed to represent the placement, such as the URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
Output only. The resource name of the matched location interest view. Matched location interest view resource names have the form: `customers/{customer_id}/matchedLocationInterestViews/{country_criterion_id}`
Output only. The resource name of the topic view. Topic view resource names have the form: `customers/{customer_id}/topicViews/{ad_group_id}~{criterion_id}`
Output only. The resource name of the income range view. Income range view resource names have the form: `customers/{customer_id}/incomeRangeViews/{ad_group_id}~{criterion_id}`
Output only. The resource name of the travel activity performance view. Travel Activity performance view resource names have the form: `customers/{customer_id}/travelActivityPerformanceView`
Output only. The resource name of the search term view. Search term view resource names have the form: `customers/{customer_id}/paidOrganicSearchTermViews/{campaign_id}~ {ad_group_id}~{URL-base64 search term}`
Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
Output only. ID of the label. Read only.
The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
Output only. Status of the label. Read only.
A type of label displaying text on a colored background.
A short description of the label. The length must be no more than 200 characters.
Background color of the label in HEX format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
Output only. The resource name of the qualifying question. 'qualifyingQuestions/{qualifyingQuestionId}'
Output only. The id of the qualifying question.
Output only. The locale of the qualifying question.
Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form: `customers/{customer_id}/localServicesVerificationArtifacts/{verification_artifact_id}`
business registration check verification artifact
Output only. A business registration check verification artifact.
Output only. The type of the verification artifact.
Output only. The ID of the verification artifact.
Output only. The status of the verification artifact.
Output only. A background check verification artifact.
Output only. A license verification artifact.
Output only. An insurance verification artifact.
Output only. The timestamp when this verification artifact was created. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. First name of the licensee.
Output only. The timestamp when this license expires. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. The readonly field containing the information for an uploaded license document.
Output only. Insurance amount. This is measured in "micros" of the currency mentioned in the insurance document.
Output only. The readonly field containing the information for an uploaded insurance document.
Output only. The timestamp when this insurance expires. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
Output only. Insurance document's rejection reason.
Output only. Advertising Partner link properties. These properties are only applicable when the link is for an Advertising Partner.
Output only. The type of the linked product.
Immutable. Resource name of the product link. ProductLink resource names have the form: `customers/{customer_id}/productLinks/{product_link_id} `
Immutable. The customer ID of the Google Merchant Center account. This field is required and should not be empty when creating a new Merchant Center link. It is unable to be modified after the creation of the link.
Immutable. Shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST are associated with a particular vertical (e.g. hotels, things to do, flights, etc.). This field is required for shared sets of type VERTICAL_ADS_ITEM_GROUP_RULE_LIST.
Output only. The ID of this shared set. Read only.
The name of this shared set. Required. Shared Sets must have names that are unique among active shared sets of the same type. The length of this string should be between 1 and 255 UTF-8 bytes, inclusive.
Output only. The status of this shared set. Read only.
Output only. The number of shared criteria within this shared set. Read only.
Immutable. The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.
Immutable. The resource name of the shared set. Shared set resource names have the form: `customers/{customer_id}/sharedSets/{shared_set_id}`
Output only. The number of campaigns associated with this shared set. Read only.
Number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. This field is ignored for `logical_user_list` and `rule_based_user_list` types. Membership to lists of these types depends on the rules defined by the lists.
Output only. Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED.
Output only. Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only.
Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
User list targeting as a collection of conversion or remarketing actions.
Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to.
Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
User list that is a custom combination of user lists and user interests.
User list of CRM users provided by the advertiser.
Output only. Type of this list. This field is read-only.
Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
Output only. An option that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is read-only.
Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open.
Indicates if this user list is eligible for Google Search Network.
Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`.
Output only. Estimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only.
Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. This field is read-only.
Seed UserList from which this list is derived.
The status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.
Flexible rule representation of visitors with one or multiple actions. The flexible user list is defined by two lists of operands – inclusive_operands and exclusive_operands; each operand represents a set of users based on actions they took in a given timeframe. These lists of operands are combined with the AND_NOT operator, so that users represented by the inclusive operands are included in the user list, minus the users represented by the exclusive operands.
Countries targeted by the Lookalike. Two-letter country code as defined by ISO-3166
Seed UserList ID from which this list is derived, provided by user.
Expansion level, reflecting the size of the lookalike audience
Logical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated. Required for creating a logical user list.
Resource name of a user list as an operand.
Output only. The resource name of the mobile app category constant. Mobile app category constant resource names have the form: `mobileAppCategoryConstants/{mobile_app_category_id}`
Output only. The ID of the mobile app category constant.
Output only. The shopping add GTIN recommendation.
marginal roi campaign budget recommendation
Output only. The marginal ROI campaign budget recommendation.
Output only. The keyword match type recommendation.
forecasting campaign budget recommendation
Output only. The forecasting campaign budget recommendation.
Output only. The type of recommendation.
Output only. The shopping add size recommendation.
forecasting set target roas recommendation
Output only. The forecasting set target ROAS recommendation.
upgrade local campaign to performance max recommendation
Output only. The upgrade a Local campaign to a Performance Max campaign recommendation.
Output only. The keyword recommendation.
dynamic image extension opt in recommendation
Output only. Recommendation to enable dynamic image extensions on the account, allowing Google to find the best images from ad landing pages and complement text ads.
migrate dynamic search ads campaign to performance max recommendation
Output only. The Dynamic Search Ads to Performance Max migration recommendation.
performance max final url opt in recommendation
Output only. Recommendation to turn on Final URL expansion for your Performance Max campaigns.
Output only. The campaigns targeted by this recommendation. This field will be set for the following recommendation types: CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET and MOVE_UNUSED_BUDGET
Output only. The set target ROAS recommendation.
responsive search ad improve ad strength recommendation
Output only. The responsive search ad improve ad strength recommendation.
Output only. Recommendation to lower Target ROAS.
shopping fix merchant center account suspension warning recommendation
Output only. The shopping fix Merchant Center account suspension warning recommendation.
Output only. Add expanded text ad recommendation.
Output only. The TargetCPA opt-in recommendation.
improve performance max ad strength recommendation
Output only. The improve Performance Max ad strength recommendation.
forecasting set target cpa recommendation
Output only. The forecasting set target CPA recommendation.
Output only. The MaximizeClicks Opt-In recommendation.
Output only. The budget targeted by this recommendation. This will be set only when the recommendation affects a single campaign budget. This field will be set for the following recommendation types: CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET, MOVE_UNUSED_BUDGET
Output only. The Performance Max Opt In recommendation.
shopping target all offers recommendation
Output only. The shopping target all offers recommendation.
shopping fix suspended merchant center account recommendation
Output only. The shopping fix suspended Merchant Center account recommendation.
Output only. The shopping add color recommendation.
improve demand gen ad strength recommendation
Output only. The improve Demand Gen ad strength recommendation.
responsive search ad asset recommendation
Output only. The responsive search ad asset recommendation.
shopping add more identifiers recommendation
Output only. The shopping add more identifiers recommendation.
raise target cpa bid too low recommendation
Output only. The raise target CPA bid too low recommendation.
Output only. The shopping add age group recommendation.
Output only. The move unused budget recommendation.
Output only. The shopping add gender recommendation.
Output only. The use broad match keyword recommendation.
shopping fix disapproved products recommendation
Output only. The shopping fix disapproved products recommendation.
shopping add products to campaign recommendation
Output only. The shopping add products to campaign recommendation.
maximize conversion value opt in recommendation
Output only. The Maximize Conversion Value opt-in recommendation.
Output only. The call asset recommendation.
refresh customer match list recommendation
Output only. The refresh customer list recommendation.
Output only. The Enhanced Cost-Per-Click Opt-In recommendation.
Output only. The Search Partners Opt-In recommendation.
upgrade smart shopping campaign to performance max recommendation
Output only. The upgrade a Smart Shopping campaign to a Performance Max campaign recommendation.
Output only. The lead form asset recommendation.
maximize conversions opt in recommendation
Output only. The MaximizeConversions Opt-In recommendation.
Output only. The sitelink asset recommendation.
Output only. The set target CPA recommendation.
Output only. Whether the recommendation is dismissed or not.
Output only. The Optimize Ad Rotation recommendation.
Output only. The custom audience opt in recommendation.
Output only. The callout asset recommendation.
Output only. The impact on account performance as a result of applying the recommendation.
shopping migrate regular shopping campaign offers to performance max recommendation
Output only. The shopping migrate Regular Shopping Campaign offers to Performance Max recommendation.
Output only. The Display Expansion opt-in recommendation.
Output only. Recommendation to raise Target CPA.
Output only. The campaign targeted by this recommendation. This field will be set for the following recommendation types: CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN, USE_BROAD_MATCH_KEYWORD, KEYWORD, KEYWORD_MATCH_TYPE, UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, SEARCH_PARTNERS_OPT_IN, DISPLAY_EXPANSION_OPT_IN, SITELINK_EXTENSION, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD, UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX, RAISE_TARGET_CPA_BID_TOO_LOW, FORECASTING_SET_TARGET_ROAS, SHOPPING_ADD_AGE_GROUP, SHOPPING_ADD_COLOR, SHOPPING_ADD_GENDER, SHOPPING_ADD_SIZE, SHOPPING_ADD_GTIN, SHOPPING_ADD_MORE_IDENTIFIERS, SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN, SHOPPING_FIX_DISAPPROVED_PRODUCTS, SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX, DYNAMIC_IMAGE_EXTENSION_OPT_IN, RAISE_TARGET_CPA, LOWER_TARGET_ROAS, FORECASTING_SET_TARGET_CPA, SET_TARGET_CPA, SET_TARGET_ROAS, MAXIMIZE_CONVERSION_VALUE_OPT_IN, IMPROVE_GOOGLE_TAG_COVERAGE, PERFORMANCE_MAX_FINAL_URL_OPT_IN
Immutable. The resource name of the recommendation. `customers/{customer_id}/recommendations/{recommendation_id}`
Output only. The Target ROAS opt-in recommendation.
Output only. The ad group targeted by this recommendation. This will be set only when the recommendation affects a single ad group. This field will be set for the following recommendation types: KEYWORD, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, TEXT_AD
Output only. The campaign budget recommendation.
improve google tag coverage recommendation
Output only. Recommendation to deploy Google Tag on more pages.
Output only. The add responsive search ad recommendation.
Output only. The number of online, servable offers.
Output only. The details of the Merchant Center account.
Output only. The number of online, servable offers that are demoted for missing attributes. Visit the Merchant Center for more details.
Output only. The Merchant Center account ID.
Output only. The name of the Merchant Center account.
Output only. Whether the Merchant Center account is a Multi-Client account (MCA).
Output only. The recommended budget amount in micros.
Output only. The budget amounts and associated impact estimates for some values of possible budget amounts.
Output only. The current budget amount in micros.
Output only. The budget amount for this option.
Output only. The impact estimate if budget is changed to amount specified in this option.
Output only. Base metrics at the time the recommendation was generated.
Output only. Estimated metrics if the recommendation is applied.
Output only. Sum of the conversion value of the conversions.
Output only. Cost (in micros) for advertising, in the local currency for the account.
Output only. Number of video views for a video ad campaign.
Output only. The existing keyword where the match type should be more broad.
Output only. The recommended new match type.
Output only. The recommended target ROAS (revenue per unit of spend). The value is between 0.01 and 1000.0, inclusive.
Output only. The date when the new budget would start being used. This field will be set for the following recommendation types: FORECASTING_SET_TARGET_ROAS , FORECASTING_SET_TARGET_CPA YYYY-MM-DD format, for example, 2018-04-17.
Output only. A list of search terms this keyword matches. The same search term may be repeated for multiple keywords.
Output only. The recommended CPC (cost-per-click) bid.
Output only. The text of the search term.
Output only. Estimated number of historical weekly searches for this search term.
Output only. A link to the Google Ads UI where the customer can manually apply the recommendation.
Output only. The current ad to be updated.
Output only. The relevant information describing the recommended target adjustment.
Output only. The current average target of the campaign or portfolio targeted by this recommendation.
Output only. The factor by which we recommend the target to be adjusted by.
Output only. The shared set resource name of the portfolio bidding strategy where the target is defined. Only populated if the recommendation is portfolio level.
Output only. The feed label of the campaign for which the suspension happened.
Output only. Creation date of the recommended ad. YYYY-MM-DD format, for example, 2018-04-17.
Output only. Date, if present, is the earliest when the recommendation will be auto applied. YYYY-MM-DD format, for example, 2018-04-17.
Output only. The available goals and corresponding options for Target CPA strategy.
Output only. The recommended average CPA target. See required budget amount and impact of using this recommendation in options list.
Output only. The impact estimate if this option is selected.
Output only. The goal achieved by this option.
Output only. The minimum campaign budget, in local currency for the account, required to achieve the target CPA. Amount is specified in micros, where one million is equivalent to one currency unit.
Output only. The asset group resource name.
Output only. The current ad strength score of the asset group.
Output only. The recommended target CPA.
Output only. The recommended new budget amount. Only set if the current budget is too high.
Output only. The number of untargeted offers.
Output only. A list of recommendations to improve the ad strength.
Output only. The resource name of the ad that can be improved.
Output only. The recommended assets. This is populated only with the new headlines and/or descriptions, and is otherwise empty.
Output only. The current average target CPA of the campaign, in micros of customer local currency.
Output only. A number greater than 1.0 indicating the factor by which we recommend the target CPA should be increased.
Output only. The recommendation for the constrained budget to increase.
Output only. The excess budget's resource_name.
Output only. Sample of keywords to be expanded to Broad Match.
Output only. Whether the associated campaign uses a shared budget.
Output only. Total number of keywords in the campaign.
Output only. Total number of keywords to be expanded to Broad Match in the campaign.
Output only. The budget recommended to avoid becoming budget constrained after applying the recommendation.
Output only. The number of products of the campaign.
Output only. The feed label for the campaign.
Output only. The numbers of products of the campaign that are disapproved.
Output only. The reason why no products are attached to the campaign.
Output only. User lists can be shared with other accounts by the owner. targeting_accounts_count is the number of those accounts that can use it for targeting.
Output only. The owner account. This is the account that should update the customer list.
Output only. The customer ID of the account.
Output only. The descriptive name of the account.
Output only. ID of Merchant Center account.
Output only. Country whose products from merchant's inventory should be included.
Output only. The recommended new budget amount.
Output only. New sitelink assets recommended at the campaign level.
Output only. New sitelink assets recommended at the customer level.
Output only. The list of keywords to use for custom audience creation.
Output only. New callout extension assets recommended at the campaign level.
Output only. New callout extension assets recommended at the customer level.
Output only. The feed label of the offers targeted by the campaigns sharing this suggestion.
Output only. Represents the goal towards which the bidding strategy should optimize. Only populated for App Campaigns.
Output only. The minimum campaign budget, in local currency for the account, required to achieve the target ROAS. Amount is specified in micros, where one million is equivalent to one currency unit.
Output only. The postal code of the store's address.
Output only. The resource name of the per store view. Per Store view resource names have the form: `customers/{customer_id}/perStoreViews/{place_id}`
Output only. First line of the store's address.
Output only. The city where the store is located.
Output only. The province or state of the store's address.
Output only. The two-letter country code for the store's location (e.g., "US").
Output only. The phone number of the store.
Output only. The place ID of the per store view.
Output only. Second line of the store's address.
Output only. The resource name of the targeting expansion view. Targeting expansion view resource names have the form: `customers/{customer_id}/targetingExpansionViews/{campaign_id}~{targeting_expansion_type}`
Output only. The operating system of the mobile device.
Output only. The resource name of the mobile device constant. Mobile device constant resource names have the form: `mobileDeviceConstants/{criterion_id}`
Output only. The ID of the mobile device constant.
Output only. The name of the mobile device.
Output only. The manufacturer of the mobile device.
Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView`
Output only. The resource name of the location view. Location view resource names have the form: `customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}`