Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes criteria. Operation statuses are returned. List of thrown errors: [AdGroupCriterionError]() [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CollectionSizeError]() [ContextError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MultiplierError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes criteria. Operation statuses are returned. List of thrown errors: [AdGroupCriterionError]() [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CollectionSizeError]() [ContextError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MultiplierError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()
Args:
customerId: string, Required. ID of the customer whose criteria are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for AdGroupCriterionService.MutateAdGroupCriteria.
"operations": [ # Required. The list of operations to perform on individual criteria.
{ # A single operation (create, remove, update) on an ad group criterion.
"create": { # An ad group criterion. The ad_group_criterion report only returns criteria that were explicitly added to the ad group. # Create operation: No resource name is expected for the new criterion.
"adGroup": "A String", # Immutable. The ad group to which the criterion belongs.
"ageRange": { # An age range criterion. # Immutable. Age range.
"type": "A String", # Type of the age range.
},
"appPaymentModel": { # An app payment model criterion. # Immutable. App Payment Model.
"type": "A String", # Type of the app payment model.
},
"approvalStatus": "A String", # Output only. Approval status of the criterion.
"audience": { # An audience criterion. # Immutable. Audience.
"audience": "A String", # The Audience resource name.
},
"bidModifier": 3.14, # 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.
"brandList": { # A Brand List Criterion is used to specify a list of brands. The list is represented as a SharedSet id type BRAND_HINT. A criterion of this type can be either targeted or excluded. # Immutable. Brand list criterion.
"sharedSet": "A String", # Shared set resource name of the brand list.
},
"combinedAudience": { # A combined audience criterion. # Immutable. Combined Audience.
"combinedAudience": "A String", # The CombinedAudience resource name.
},
"cpcBidMicros": "A String", # The CPC (cost-per-click) bid.
"cpmBidMicros": "A String", # The CPM (cost-per-thousand viewable impressions) bid.
"cpvBidMicros": "A String", # The CPV (cost-per-view) bid.
"creationTime": "A String", # Output only. The timestamp when this ad group criterion was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
"criterionId": "A String", # Output only. The ID of the criterion.
"customAffinity": { # A custom affinity criterion. A criterion of this type is only targetable. # Immutable. Custom Affinity.
"customAffinity": "A String", # The CustomInterest resource name.
},
"customAudience": { # A custom audience criterion. # Immutable. Custom Audience.
"customAudience": "A String", # The CustomAudience resource name.
},
"customIntent": { # A custom intent criterion. A criterion of this type is only targetable. # Immutable. Custom Intent.
"customIntent": "A String", # The CustomInterest resource name.
},
"disapprovalReasons": [ # 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.
"A String",
],
"displayName": "A String", # Output only. The display name of the criterion.
"effectiveCpcBidMicros": "A String", # Output only. The effective CPC (cost-per-click) bid.
"effectiveCpcBidSource": "A String", # Output only. Source of the effective CPC bid.
"effectiveCpmBidMicros": "A String", # Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
"effectiveCpmBidSource": "A String", # Output only. Source of the effective CPM bid.
"effectiveCpvBidMicros": "A String", # Output only. The effective CPV (cost-per-view) bid.
"effectiveCpvBidSource": "A String", # Output only. Source of the effective CPV bid.
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this ad group criterion. An effective label is a label inherited or directly assigned to this ad group criterion.
"A String",
],
"effectivePercentCpcBidMicros": "A String", # Output only. The effective Percent CPC bid amount.
"effectivePercentCpcBidSource": "A String", # Output only. Source of the effective Percent CPC bid.
"engineId": "A String", # Output only. ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group_criterion.criterion_id" instead.
"engineStatus": "A String", # Output only. The Engine Status for ad group criterion.
"extendedDemographic": { # Represents an extended demographic criterion. # Immutable. Extended demographic criterion.
"extendedDemographicId": "A String", # Taxonomy id of the extended demographic group.
},
"finalMobileUrls": [ # The list of possible final mobile URLs after all cross-domain redirects.
"A String",
],
"finalUrlSuffix": "A String", # URL template for appending params to final URL.
"finalUrls": [ # The list of possible final URLs after all cross-domain redirects for the ad.
"A String",
],
"gender": { # A gender criterion. # Immutable. Gender.
"type": "A String", # Type of the gender.
},
"incomeRange": { # An income range criterion. # Immutable. Income range.
"type": "A String", # Type of the income range.
},
"keyword": { # A keyword criterion. # Immutable. Keyword.
"matchType": "A String", # The match type of the keyword.
"text": "A String", # The text of the keyword (at most 80 characters and 10 words).
},
"labels": [ # Output only. The resource names of labels attached to this ad group criterion.
"A String",
],
"language": { # A language criterion. # Immutable. Language.
"languageConstant": "A String", # The language constant resource name.
},
"lastModifiedTime": "A String", # Output only. The datetime when this ad group criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"lifeEvent": { # Represents a life event criterion. # Immutable. Life event campaign criterion.
"lifeEventId": "A String", # Taxonomy id of the life event.
},
"listingGroup": { # A listing group criterion. # Immutable. Listing group.
"caseValue": { # Listing dimensions for listing group criterion. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"activityCity": { # The city where the travel activity is available. # The city where the travel activity is available.
"value": "A String", # String value of the activity city. The Geo Target Constant resource name.
},
"activityCountry": { # The country where the travel activity is available. # The country where the travel activity is available.
"value": "A String", # String value of the activity country. The Geo Target Constant resource name.
},
"activityId": { # Advertiser-specific activity ID. # Advertiser-specific activity ID.
"value": "A String", # String value of the activity ID.
},
"activityRating": { # Rating of the activity as a number 1 to 5, where 5 is the best. # Rating of the activity as a number 1 to 5, where 5 is the best.
"value": "A String", # Long value of the activity rating.
},
"activityState": { # The state where the travel activity is available. # The state where the travel activity is available.
"value": "A String", # String value of the activity state. The Geo Target Constant resource name.
},
"hotelCity": { # City the hotel is located in. # City the hotel is located in.
"cityCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelClass": { # Class of the hotel as a number of stars 1 to 5. # Class of the hotel as a number of stars 1 to 5.
"value": "A String", # Long value of the hotel class.
},
"hotelCountryRegion": { # Country or Region the hotel is located in. # Country or Region the hotel is located in.
"countryRegionCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelId": { # Advertiser-specific hotel ID. # Advertiser-specific hotel ID.
"value": "A String", # String value of the hotel ID.
},
"hotelState": { # State the hotel is located in. # State the hotel is located in.
"stateCriterion": "A String", # The Geo Target Constant resource name.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # Category of a product offer. # Category of a product offer.
"categoryId": "A String", # 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
"level": "A String", # Level of the product category.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productChannelExclusivity": { # Availability of a product offer. # Availability of a product offer.
"channelExclusivity": "A String", # Value of the availability.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productGrouping": { # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product grouping.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productLabels": { # Labels 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.
"value": "A String", # String value of the product labels.
},
"productLegacyCondition": { # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product legacy condition.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
"productTypeFull": { # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product full type.
},
"unknownListingDimension": { # Unknown listing dimension. # Unknown dimension. Set when no other listing dimension is set.
},
},
"parentAdGroupCriterion": "A String", # Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
"path": { # The path of dimensions defining a listing group. # The path of dimensions defining this listing group.
"dimensions": [ # The complete path of dimensions through the listing group hierarchy, from the root (excluding the root itself) to this listing group.
{ # Listing dimensions for listing group criterion.
"activityCity": { # The city where the travel activity is available. # The city where the travel activity is available.
"value": "A String", # String value of the activity city. The Geo Target Constant resource name.
},
"activityCountry": { # The country where the travel activity is available. # The country where the travel activity is available.
"value": "A String", # String value of the activity country. The Geo Target Constant resource name.
},
"activityId": { # Advertiser-specific activity ID. # Advertiser-specific activity ID.
"value": "A String", # String value of the activity ID.
},
"activityRating": { # Rating of the activity as a number 1 to 5, where 5 is the best. # Rating of the activity as a number 1 to 5, where 5 is the best.
"value": "A String", # Long value of the activity rating.
},
"activityState": { # The state where the travel activity is available. # The state where the travel activity is available.
"value": "A String", # String value of the activity state. The Geo Target Constant resource name.
},
"hotelCity": { # City the hotel is located in. # City the hotel is located in.
"cityCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelClass": { # Class of the hotel as a number of stars 1 to 5. # Class of the hotel as a number of stars 1 to 5.
"value": "A String", # Long value of the hotel class.
},
"hotelCountryRegion": { # Country or Region the hotel is located in. # Country or Region the hotel is located in.
"countryRegionCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelId": { # Advertiser-specific hotel ID. # Advertiser-specific hotel ID.
"value": "A String", # String value of the hotel ID.
},
"hotelState": { # State the hotel is located in. # State the hotel is located in.
"stateCriterion": "A String", # The Geo Target Constant resource name.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # Category of a product offer. # Category of a product offer.
"categoryId": "A String", # 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
"level": "A String", # Level of the product category.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productChannelExclusivity": { # Availability of a product offer. # Availability of a product offer.
"channelExclusivity": "A String", # Value of the availability.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productGrouping": { # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product grouping.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productLabels": { # Labels 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.
"value": "A String", # String value of the product labels.
},
"productLegacyCondition": { # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product legacy condition.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
"productTypeFull": { # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product full type.
},
"unknownListingDimension": { # Unknown listing dimension. # Unknown dimension. Set when no other listing dimension is set.
},
},
],
},
"type": "A String", # Type of the listing group.
},
"location": { # A location criterion. # Immutable. Location.
"geoTargetConstant": "A String", # The geo target constant resource name.
},
"mobileAppCategory": { # A mobile app category criterion. # Immutable. Mobile app category.
"mobileAppCategoryConstant": "A String", # The mobile app category constant resource name.
},
"mobileApplication": { # A mobile application criterion. # Immutable. Mobile application.
"appId": "A String", # A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (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.
"name": "A String", # Name of this mobile application.
},
"negative": True or False, # 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.
"parentalStatus": { # A parental status criterion. # Immutable. Parental status.
"type": "A String", # Type of the parental status.
},
"percentCpcBidMicros": "A String", # 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].
"placement": { # A placement criterion. This can be used to modify bids for sites when targeting the content network. # Immutable. Placement.
"url": "A String", # URL of the placement. For example, "http://www.domain.com".
},
"positionEstimates": { # Estimates for criterion bids at various positions. # Output only. Estimates for criterion bids at various positions.
"estimatedAddClicksAtFirstPositionCpc": "A String", # 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.
"estimatedAddCostAtFirstPositionCpc": "A String", # Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
"firstPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
"firstPositionCpcMicros": "A String", # 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.
"topOfPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
},
"primaryStatus": "A String", # Output only. The primary status for the ad group criterion.
"primaryStatusReasons": [ # Output only. The primary status reasons for the ad group criterion.
"A String",
],
"qualityInfo": { # A container for ad group criterion quality information. # Output only. Information regarding the quality of the criterion.
"creativeQualityScore": "A String", # Output only. The performance of the ad compared to other advertisers.
"postClickQualityScore": "A String", # Output only. The quality score of the landing page.
"qualityScore": 42, # Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
"searchPredictedCtr": "A String", # Output only. The click-through rate compared to that of other advertisers.
},
"resourceName": "A String", # Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
"status": "A String", # The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.
"systemServingStatus": "A String", # Output only. Serving status of the criterion.
"topic": { # A topic criterion. Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs"). # Immutable. Topic.
"path": [ # 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.
"A String",
],
"topicConstant": "A String", # The Topic Constant resource name.
},
"trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
"type": "A String", # Output only. The type of the criterion.
"urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
{ # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
"key": "A String", # The key matching the parameter tag name.
"value": "A String", # The value to be substituted.
},
],
"userInterest": { # Represents a particular interest-based topic to be targeted. # Immutable. User Interest.
"userInterestCategory": "A String", # The UserInterest resource name.
},
"userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # Immutable. User List.
"userList": "A String", # The User List resource name.
},
"verticalAdsItemGroupRuleList": { # A criterion for targeting a shared set of rules for item groups in Vertical Ads (e.g., for hotel ads). # Immutable. Vertical ads item group rule list criterion.
"sharedSet": "A String", # The shared set resource name of the vertical ads item group rule list.
},
"videoLineup": { # A Video lineup criterion. # Immutable. Video lineup criterion.
"videoLineupId": "A String", # ID for a Video lineup. Contact your Google business development representative for details.
},
"webpage": { # Represents a criterion for targeting webpages of an advertiser's website. # Immutable. Webpage
"conditions": [ # 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.
{ # Logical expression for targeting webpages of an advertiser's website.
"argument": "A String", # Argument of webpage targeting condition.
"operand": "A String", # Operand of webpage targeting condition.
"operator": "A String", # Operator of webpage targeting condition.
},
],
"coveragePercentage": 3.14, # 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.
"criterionName": "A String", # The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
"sample": { # List of sample urls that match the website target # List of sample urls that match the website target. This field is read-only.
"sampleUrls": [ # Webpage sample urls
"A String",
],
},
},
"youtubeChannel": { # A YouTube Channel criterion. # Immutable. YouTube Channel.
"channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
},
"youtubeVideo": { # A YouTube Video criterion. # Immutable. YouTube Video.
"videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
},
},
"exemptPolicyViolationKeys": [ # The list of policy violation keys that should not cause a PolicyViolationError to be reported. Not all policy violations are exemptable, refer to the is_exemptible field in the returned PolicyViolationError. Resources violating these polices will be saved, but will not be eligible to serve. They may begin serving at a later time due to a change in policies, re-review of the resource, or a change in advertiser certificates.
{ # Key of the violation. The key is used for referring to a violation when filing an exemption request.
"policyName": "A String", # Unique ID of the violated policy.
"violatingText": "A String", # The text that violates the policy if specified. Otherwise, refers to the policy in general (for example, when requesting to be exempt from the whole policy). If not specified for criterion exemptions, the whole policy is implied. Must be specified for ad exemptions.
},
],
"remove": "A String", # Remove operation: A resource name for the removed criterion is expected, in this format: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
"update": { # An ad group criterion. The ad_group_criterion report only returns criteria that were explicitly added to the ad group. # Update operation: The criterion is expected to have a valid resource name.
"adGroup": "A String", # Immutable. The ad group to which the criterion belongs.
"ageRange": { # An age range criterion. # Immutable. Age range.
"type": "A String", # Type of the age range.
},
"appPaymentModel": { # An app payment model criterion. # Immutable. App Payment Model.
"type": "A String", # Type of the app payment model.
},
"approvalStatus": "A String", # Output only. Approval status of the criterion.
"audience": { # An audience criterion. # Immutable. Audience.
"audience": "A String", # The Audience resource name.
},
"bidModifier": 3.14, # 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.
"brandList": { # A Brand List Criterion is used to specify a list of brands. The list is represented as a SharedSet id type BRAND_HINT. A criterion of this type can be either targeted or excluded. # Immutable. Brand list criterion.
"sharedSet": "A String", # Shared set resource name of the brand list.
},
"combinedAudience": { # A combined audience criterion. # Immutable. Combined Audience.
"combinedAudience": "A String", # The CombinedAudience resource name.
},
"cpcBidMicros": "A String", # The CPC (cost-per-click) bid.
"cpmBidMicros": "A String", # The CPM (cost-per-thousand viewable impressions) bid.
"cpvBidMicros": "A String", # The CPV (cost-per-view) bid.
"creationTime": "A String", # Output only. The timestamp when this ad group criterion was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
"criterionId": "A String", # Output only. The ID of the criterion.
"customAffinity": { # A custom affinity criterion. A criterion of this type is only targetable. # Immutable. Custom Affinity.
"customAffinity": "A String", # The CustomInterest resource name.
},
"customAudience": { # A custom audience criterion. # Immutable. Custom Audience.
"customAudience": "A String", # The CustomAudience resource name.
},
"customIntent": { # A custom intent criterion. A criterion of this type is only targetable. # Immutable. Custom Intent.
"customIntent": "A String", # The CustomInterest resource name.
},
"disapprovalReasons": [ # 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.
"A String",
],
"displayName": "A String", # Output only. The display name of the criterion.
"effectiveCpcBidMicros": "A String", # Output only. The effective CPC (cost-per-click) bid.
"effectiveCpcBidSource": "A String", # Output only. Source of the effective CPC bid.
"effectiveCpmBidMicros": "A String", # Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
"effectiveCpmBidSource": "A String", # Output only. Source of the effective CPM bid.
"effectiveCpvBidMicros": "A String", # Output only. The effective CPV (cost-per-view) bid.
"effectiveCpvBidSource": "A String", # Output only. Source of the effective CPV bid.
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this ad group criterion. An effective label is a label inherited or directly assigned to this ad group criterion.
"A String",
],
"effectivePercentCpcBidMicros": "A String", # Output only. The effective Percent CPC bid amount.
"effectivePercentCpcBidSource": "A String", # Output only. Source of the effective Percent CPC bid.
"engineId": "A String", # Output only. ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group_criterion.criterion_id" instead.
"engineStatus": "A String", # Output only. The Engine Status for ad group criterion.
"extendedDemographic": { # Represents an extended demographic criterion. # Immutable. Extended demographic criterion.
"extendedDemographicId": "A String", # Taxonomy id of the extended demographic group.
},
"finalMobileUrls": [ # The list of possible final mobile URLs after all cross-domain redirects.
"A String",
],
"finalUrlSuffix": "A String", # URL template for appending params to final URL.
"finalUrls": [ # The list of possible final URLs after all cross-domain redirects for the ad.
"A String",
],
"gender": { # A gender criterion. # Immutable. Gender.
"type": "A String", # Type of the gender.
},
"incomeRange": { # An income range criterion. # Immutable. Income range.
"type": "A String", # Type of the income range.
},
"keyword": { # A keyword criterion. # Immutable. Keyword.
"matchType": "A String", # The match type of the keyword.
"text": "A String", # The text of the keyword (at most 80 characters and 10 words).
},
"labels": [ # Output only. The resource names of labels attached to this ad group criterion.
"A String",
],
"language": { # A language criterion. # Immutable. Language.
"languageConstant": "A String", # The language constant resource name.
},
"lastModifiedTime": "A String", # Output only. The datetime when this ad group criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"lifeEvent": { # Represents a life event criterion. # Immutable. Life event campaign criterion.
"lifeEventId": "A String", # Taxonomy id of the life event.
},
"listingGroup": { # A listing group criterion. # Immutable. Listing group.
"caseValue": { # Listing dimensions for listing group criterion. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"activityCity": { # The city where the travel activity is available. # The city where the travel activity is available.
"value": "A String", # String value of the activity city. The Geo Target Constant resource name.
},
"activityCountry": { # The country where the travel activity is available. # The country where the travel activity is available.
"value": "A String", # String value of the activity country. The Geo Target Constant resource name.
},
"activityId": { # Advertiser-specific activity ID. # Advertiser-specific activity ID.
"value": "A String", # String value of the activity ID.
},
"activityRating": { # Rating of the activity as a number 1 to 5, where 5 is the best. # Rating of the activity as a number 1 to 5, where 5 is the best.
"value": "A String", # Long value of the activity rating.
},
"activityState": { # The state where the travel activity is available. # The state where the travel activity is available.
"value": "A String", # String value of the activity state. The Geo Target Constant resource name.
},
"hotelCity": { # City the hotel is located in. # City the hotel is located in.
"cityCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelClass": { # Class of the hotel as a number of stars 1 to 5. # Class of the hotel as a number of stars 1 to 5.
"value": "A String", # Long value of the hotel class.
},
"hotelCountryRegion": { # Country or Region the hotel is located in. # Country or Region the hotel is located in.
"countryRegionCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelId": { # Advertiser-specific hotel ID. # Advertiser-specific hotel ID.
"value": "A String", # String value of the hotel ID.
},
"hotelState": { # State the hotel is located in. # State the hotel is located in.
"stateCriterion": "A String", # The Geo Target Constant resource name.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # Category of a product offer. # Category of a product offer.
"categoryId": "A String", # 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
"level": "A String", # Level of the product category.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productChannelExclusivity": { # Availability of a product offer. # Availability of a product offer.
"channelExclusivity": "A String", # Value of the availability.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productGrouping": { # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product grouping.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productLabels": { # Labels 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.
"value": "A String", # String value of the product labels.
},
"productLegacyCondition": { # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product legacy condition.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
"productTypeFull": { # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product full type.
},
"unknownListingDimension": { # Unknown listing dimension. # Unknown dimension. Set when no other listing dimension is set.
},
},
"parentAdGroupCriterion": "A String", # Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
"path": { # The path of dimensions defining a listing group. # The path of dimensions defining this listing group.
"dimensions": [ # The complete path of dimensions through the listing group hierarchy, from the root (excluding the root itself) to this listing group.
{ # Listing dimensions for listing group criterion.
"activityCity": { # The city where the travel activity is available. # The city where the travel activity is available.
"value": "A String", # String value of the activity city. The Geo Target Constant resource name.
},
"activityCountry": { # The country where the travel activity is available. # The country where the travel activity is available.
"value": "A String", # String value of the activity country. The Geo Target Constant resource name.
},
"activityId": { # Advertiser-specific activity ID. # Advertiser-specific activity ID.
"value": "A String", # String value of the activity ID.
},
"activityRating": { # Rating of the activity as a number 1 to 5, where 5 is the best. # Rating of the activity as a number 1 to 5, where 5 is the best.
"value": "A String", # Long value of the activity rating.
},
"activityState": { # The state where the travel activity is available. # The state where the travel activity is available.
"value": "A String", # String value of the activity state. The Geo Target Constant resource name.
},
"hotelCity": { # City the hotel is located in. # City the hotel is located in.
"cityCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelClass": { # Class of the hotel as a number of stars 1 to 5. # Class of the hotel as a number of stars 1 to 5.
"value": "A String", # Long value of the hotel class.
},
"hotelCountryRegion": { # Country or Region the hotel is located in. # Country or Region the hotel is located in.
"countryRegionCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelId": { # Advertiser-specific hotel ID. # Advertiser-specific hotel ID.
"value": "A String", # String value of the hotel ID.
},
"hotelState": { # State the hotel is located in. # State the hotel is located in.
"stateCriterion": "A String", # The Geo Target Constant resource name.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # Category of a product offer. # Category of a product offer.
"categoryId": "A String", # 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
"level": "A String", # Level of the product category.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productChannelExclusivity": { # Availability of a product offer. # Availability of a product offer.
"channelExclusivity": "A String", # Value of the availability.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productGrouping": { # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product grouping.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productLabels": { # Labels 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.
"value": "A String", # String value of the product labels.
},
"productLegacyCondition": { # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product legacy condition.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
"productTypeFull": { # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product full type.
},
"unknownListingDimension": { # Unknown listing dimension. # Unknown dimension. Set when no other listing dimension is set.
},
},
],
},
"type": "A String", # Type of the listing group.
},
"location": { # A location criterion. # Immutable. Location.
"geoTargetConstant": "A String", # The geo target constant resource name.
},
"mobileAppCategory": { # A mobile app category criterion. # Immutable. Mobile app category.
"mobileAppCategoryConstant": "A String", # The mobile app category constant resource name.
},
"mobileApplication": { # A mobile application criterion. # Immutable. Mobile application.
"appId": "A String", # A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (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.
"name": "A String", # Name of this mobile application.
},
"negative": True or False, # 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.
"parentalStatus": { # A parental status criterion. # Immutable. Parental status.
"type": "A String", # Type of the parental status.
},
"percentCpcBidMicros": "A String", # 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].
"placement": { # A placement criterion. This can be used to modify bids for sites when targeting the content network. # Immutable. Placement.
"url": "A String", # URL of the placement. For example, "http://www.domain.com".
},
"positionEstimates": { # Estimates for criterion bids at various positions. # Output only. Estimates for criterion bids at various positions.
"estimatedAddClicksAtFirstPositionCpc": "A String", # 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.
"estimatedAddCostAtFirstPositionCpc": "A String", # Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
"firstPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
"firstPositionCpcMicros": "A String", # 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.
"topOfPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
},
"primaryStatus": "A String", # Output only. The primary status for the ad group criterion.
"primaryStatusReasons": [ # Output only. The primary status reasons for the ad group criterion.
"A String",
],
"qualityInfo": { # A container for ad group criterion quality information. # Output only. Information regarding the quality of the criterion.
"creativeQualityScore": "A String", # Output only. The performance of the ad compared to other advertisers.
"postClickQualityScore": "A String", # Output only. The quality score of the landing page.
"qualityScore": 42, # Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
"searchPredictedCtr": "A String", # Output only. The click-through rate compared to that of other advertisers.
},
"resourceName": "A String", # Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
"status": "A String", # The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.
"systemServingStatus": "A String", # Output only. Serving status of the criterion.
"topic": { # A topic criterion. Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs"). # Immutable. Topic.
"path": [ # 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.
"A String",
],
"topicConstant": "A String", # The Topic Constant resource name.
},
"trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
"type": "A String", # Output only. The type of the criterion.
"urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
{ # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
"key": "A String", # The key matching the parameter tag name.
"value": "A String", # The value to be substituted.
},
],
"userInterest": { # Represents a particular interest-based topic to be targeted. # Immutable. User Interest.
"userInterestCategory": "A String", # The UserInterest resource name.
},
"userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # Immutable. User List.
"userList": "A String", # The User List resource name.
},
"verticalAdsItemGroupRuleList": { # A criterion for targeting a shared set of rules for item groups in Vertical Ads (e.g., for hotel ads). # Immutable. Vertical ads item group rule list criterion.
"sharedSet": "A String", # The shared set resource name of the vertical ads item group rule list.
},
"videoLineup": { # A Video lineup criterion. # Immutable. Video lineup criterion.
"videoLineupId": "A String", # ID for a Video lineup. Contact your Google business development representative for details.
},
"webpage": { # Represents a criterion for targeting webpages of an advertiser's website. # Immutable. Webpage
"conditions": [ # 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.
{ # Logical expression for targeting webpages of an advertiser's website.
"argument": "A String", # Argument of webpage targeting condition.
"operand": "A String", # Operand of webpage targeting condition.
"operator": "A String", # Operator of webpage targeting condition.
},
],
"coveragePercentage": 3.14, # 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.
"criterionName": "A String", # The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
"sample": { # List of sample urls that match the website target # List of sample urls that match the website target. This field is read-only.
"sampleUrls": [ # Webpage sample urls
"A String",
],
},
},
"youtubeChannel": { # A YouTube Channel criterion. # Immutable. YouTube Channel.
"channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
},
"youtubeVideo": { # A YouTube Video criterion. # Immutable. YouTube Video.
"videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
},
},
"updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
},
],
"partialFailure": True or False, # If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
"responseContentType": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
"validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for an ad group criterion mutate.
"partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"results": [ # All results for the mutate.
{ # The result for the criterion mutate.
"adGroupCriterion": { # An ad group criterion. The ad_group_criterion report only returns criteria that were explicitly added to the ad group. # The mutated ad group criterion with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"adGroup": "A String", # Immutable. The ad group to which the criterion belongs.
"ageRange": { # An age range criterion. # Immutable. Age range.
"type": "A String", # Type of the age range.
},
"appPaymentModel": { # An app payment model criterion. # Immutable. App Payment Model.
"type": "A String", # Type of the app payment model.
},
"approvalStatus": "A String", # Output only. Approval status of the criterion.
"audience": { # An audience criterion. # Immutable. Audience.
"audience": "A String", # The Audience resource name.
},
"bidModifier": 3.14, # 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.
"brandList": { # A Brand List Criterion is used to specify a list of brands. The list is represented as a SharedSet id type BRAND_HINT. A criterion of this type can be either targeted or excluded. # Immutable. Brand list criterion.
"sharedSet": "A String", # Shared set resource name of the brand list.
},
"combinedAudience": { # A combined audience criterion. # Immutable. Combined Audience.
"combinedAudience": "A String", # The CombinedAudience resource name.
},
"cpcBidMicros": "A String", # The CPC (cost-per-click) bid.
"cpmBidMicros": "A String", # The CPM (cost-per-thousand viewable impressions) bid.
"cpvBidMicros": "A String", # The CPV (cost-per-view) bid.
"creationTime": "A String", # Output only. The timestamp when this ad group criterion was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
"criterionId": "A String", # Output only. The ID of the criterion.
"customAffinity": { # A custom affinity criterion. A criterion of this type is only targetable. # Immutable. Custom Affinity.
"customAffinity": "A String", # The CustomInterest resource name.
},
"customAudience": { # A custom audience criterion. # Immutable. Custom Audience.
"customAudience": "A String", # The CustomAudience resource name.
},
"customIntent": { # A custom intent criterion. A criterion of this type is only targetable. # Immutable. Custom Intent.
"customIntent": "A String", # The CustomInterest resource name.
},
"disapprovalReasons": [ # 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.
"A String",
],
"displayName": "A String", # Output only. The display name of the criterion.
"effectiveCpcBidMicros": "A String", # Output only. The effective CPC (cost-per-click) bid.
"effectiveCpcBidSource": "A String", # Output only. Source of the effective CPC bid.
"effectiveCpmBidMicros": "A String", # Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
"effectiveCpmBidSource": "A String", # Output only. Source of the effective CPM bid.
"effectiveCpvBidMicros": "A String", # Output only. The effective CPV (cost-per-view) bid.
"effectiveCpvBidSource": "A String", # Output only. Source of the effective CPV bid.
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this ad group criterion. An effective label is a label inherited or directly assigned to this ad group criterion.
"A String",
],
"effectivePercentCpcBidMicros": "A String", # Output only. The effective Percent CPC bid amount.
"effectivePercentCpcBidSource": "A String", # Output only. Source of the effective Percent CPC bid.
"engineId": "A String", # Output only. ID of the ad group criterion in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group_criterion.criterion_id" instead.
"engineStatus": "A String", # Output only. The Engine Status for ad group criterion.
"extendedDemographic": { # Represents an extended demographic criterion. # Immutable. Extended demographic criterion.
"extendedDemographicId": "A String", # Taxonomy id of the extended demographic group.
},
"finalMobileUrls": [ # The list of possible final mobile URLs after all cross-domain redirects.
"A String",
],
"finalUrlSuffix": "A String", # URL template for appending params to final URL.
"finalUrls": [ # The list of possible final URLs after all cross-domain redirects for the ad.
"A String",
],
"gender": { # A gender criterion. # Immutable. Gender.
"type": "A String", # Type of the gender.
},
"incomeRange": { # An income range criterion. # Immutable. Income range.
"type": "A String", # Type of the income range.
},
"keyword": { # A keyword criterion. # Immutable. Keyword.
"matchType": "A String", # The match type of the keyword.
"text": "A String", # The text of the keyword (at most 80 characters and 10 words).
},
"labels": [ # Output only. The resource names of labels attached to this ad group criterion.
"A String",
],
"language": { # A language criterion. # Immutable. Language.
"languageConstant": "A String", # The language constant resource name.
},
"lastModifiedTime": "A String", # Output only. The datetime when this ad group criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"lifeEvent": { # Represents a life event criterion. # Immutable. Life event campaign criterion.
"lifeEventId": "A String", # Taxonomy id of the life event.
},
"listingGroup": { # A listing group criterion. # Immutable. Listing group.
"caseValue": { # Listing dimensions for listing group criterion. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"activityCity": { # The city where the travel activity is available. # The city where the travel activity is available.
"value": "A String", # String value of the activity city. The Geo Target Constant resource name.
},
"activityCountry": { # The country where the travel activity is available. # The country where the travel activity is available.
"value": "A String", # String value of the activity country. The Geo Target Constant resource name.
},
"activityId": { # Advertiser-specific activity ID. # Advertiser-specific activity ID.
"value": "A String", # String value of the activity ID.
},
"activityRating": { # Rating of the activity as a number 1 to 5, where 5 is the best. # Rating of the activity as a number 1 to 5, where 5 is the best.
"value": "A String", # Long value of the activity rating.
},
"activityState": { # The state where the travel activity is available. # The state where the travel activity is available.
"value": "A String", # String value of the activity state. The Geo Target Constant resource name.
},
"hotelCity": { # City the hotel is located in. # City the hotel is located in.
"cityCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelClass": { # Class of the hotel as a number of stars 1 to 5. # Class of the hotel as a number of stars 1 to 5.
"value": "A String", # Long value of the hotel class.
},
"hotelCountryRegion": { # Country or Region the hotel is located in. # Country or Region the hotel is located in.
"countryRegionCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelId": { # Advertiser-specific hotel ID. # Advertiser-specific hotel ID.
"value": "A String", # String value of the hotel ID.
},
"hotelState": { # State the hotel is located in. # State the hotel is located in.
"stateCriterion": "A String", # The Geo Target Constant resource name.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # Category of a product offer. # Category of a product offer.
"categoryId": "A String", # 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
"level": "A String", # Level of the product category.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productChannelExclusivity": { # Availability of a product offer. # Availability of a product offer.
"channelExclusivity": "A String", # Value of the availability.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productGrouping": { # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product grouping.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productLabels": { # Labels 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.
"value": "A String", # String value of the product labels.
},
"productLegacyCondition": { # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product legacy condition.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
"productTypeFull": { # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product full type.
},
"unknownListingDimension": { # Unknown listing dimension. # Unknown dimension. Set when no other listing dimension is set.
},
},
"parentAdGroupCriterion": "A String", # Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
"path": { # The path of dimensions defining a listing group. # The path of dimensions defining this listing group.
"dimensions": [ # The complete path of dimensions through the listing group hierarchy, from the root (excluding the root itself) to this listing group.
{ # Listing dimensions for listing group criterion.
"activityCity": { # The city where the travel activity is available. # The city where the travel activity is available.
"value": "A String", # String value of the activity city. The Geo Target Constant resource name.
},
"activityCountry": { # The country where the travel activity is available. # The country where the travel activity is available.
"value": "A String", # String value of the activity country. The Geo Target Constant resource name.
},
"activityId": { # Advertiser-specific activity ID. # Advertiser-specific activity ID.
"value": "A String", # String value of the activity ID.
},
"activityRating": { # Rating of the activity as a number 1 to 5, where 5 is the best. # Rating of the activity as a number 1 to 5, where 5 is the best.
"value": "A String", # Long value of the activity rating.
},
"activityState": { # The state where the travel activity is available. # The state where the travel activity is available.
"value": "A String", # String value of the activity state. The Geo Target Constant resource name.
},
"hotelCity": { # City the hotel is located in. # City the hotel is located in.
"cityCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelClass": { # Class of the hotel as a number of stars 1 to 5. # Class of the hotel as a number of stars 1 to 5.
"value": "A String", # Long value of the hotel class.
},
"hotelCountryRegion": { # Country or Region the hotel is located in. # Country or Region the hotel is located in.
"countryRegionCriterion": "A String", # The Geo Target Constant resource name.
},
"hotelId": { # Advertiser-specific hotel ID. # Advertiser-specific hotel ID.
"value": "A String", # String value of the hotel ID.
},
"hotelState": { # State the hotel is located in. # State the hotel is located in.
"stateCriterion": "A String", # The Geo Target Constant resource name.
},
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # Category of a product offer. # Category of a product offer.
"categoryId": "A String", # 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
"level": "A String", # Level of the product category.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"productChannelExclusivity": { # Availability of a product offer. # Availability of a product offer.
"channelExclusivity": "A String", # Value of the availability.
},
"productCondition": { # Condition of a product offer. # Condition of a product offer.
"condition": "A String", # Value of the condition.
},
"productCustomAttribute": { # Custom attribute of a product offer. # Custom attribute of a product offer.
"index": "A String", # Indicates the index of the custom attribute.
"value": "A String", # String value of the product custom attribute.
},
"productGrouping": { # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Grouping of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product grouping.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"productLabels": { # Labels 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.
"value": "A String", # String value of the product labels.
},
"productLegacyCondition": { # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Legacy condition of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product legacy condition.
},
"productType": { # Type of a product offer. # Type of a product offer.
"level": "A String", # Level of the type.
"value": "A String", # Value of the type.
},
"productTypeFull": { # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns. # Full type of a product offer. This listing dimension is deprecated and it is supported only in Display campaigns.
"value": "A String", # String value of the product full type.
},
"unknownListingDimension": { # Unknown listing dimension. # Unknown dimension. Set when no other listing dimension is set.
},
},
],
},
"type": "A String", # Type of the listing group.
},
"location": { # A location criterion. # Immutable. Location.
"geoTargetConstant": "A String", # The geo target constant resource name.
},
"mobileAppCategory": { # A mobile app category criterion. # Immutable. Mobile app category.
"mobileAppCategoryConstant": "A String", # The mobile app category constant resource name.
},
"mobileApplication": { # A mobile application criterion. # Immutable. Mobile application.
"appId": "A String", # A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (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.
"name": "A String", # Name of this mobile application.
},
"negative": True or False, # 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.
"parentalStatus": { # A parental status criterion. # Immutable. Parental status.
"type": "A String", # Type of the parental status.
},
"percentCpcBidMicros": "A String", # 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].
"placement": { # A placement criterion. This can be used to modify bids for sites when targeting the content network. # Immutable. Placement.
"url": "A String", # URL of the placement. For example, "http://www.domain.com".
},
"positionEstimates": { # Estimates for criterion bids at various positions. # Output only. Estimates for criterion bids at various positions.
"estimatedAddClicksAtFirstPositionCpc": "A String", # 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.
"estimatedAddCostAtFirstPositionCpc": "A String", # Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
"firstPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
"firstPositionCpcMicros": "A String", # 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.
"topOfPageCpcMicros": "A String", # Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
},
"primaryStatus": "A String", # Output only. The primary status for the ad group criterion.
"primaryStatusReasons": [ # Output only. The primary status reasons for the ad group criterion.
"A String",
],
"qualityInfo": { # A container for ad group criterion quality information. # Output only. Information regarding the quality of the criterion.
"creativeQualityScore": "A String", # Output only. The performance of the ad compared to other advertisers.
"postClickQualityScore": "A String", # Output only. The quality score of the landing page.
"qualityScore": 42, # Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
"searchPredictedCtr": "A String", # Output only. The click-through rate compared to that of other advertisers.
},
"resourceName": "A String", # Immutable. The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
"status": "A String", # The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.
"systemServingStatus": "A String", # Output only. Serving status of the criterion.
"topic": { # A topic criterion. Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs"). # Immutable. Topic.
"path": [ # 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.
"A String",
],
"topicConstant": "A String", # The Topic Constant resource name.
},
"trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
"type": "A String", # Output only. The type of the criterion.
"urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
{ # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
"key": "A String", # The key matching the parameter tag name.
"value": "A String", # The value to be substituted.
},
],
"userInterest": { # Represents a particular interest-based topic to be targeted. # Immutable. User Interest.
"userInterestCategory": "A String", # The UserInterest resource name.
},
"userList": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # Immutable. User List.
"userList": "A String", # The User List resource name.
},
"verticalAdsItemGroupRuleList": { # A criterion for targeting a shared set of rules for item groups in Vertical Ads (e.g., for hotel ads). # Immutable. Vertical ads item group rule list criterion.
"sharedSet": "A String", # The shared set resource name of the vertical ads item group rule list.
},
"videoLineup": { # A Video lineup criterion. # Immutable. Video lineup criterion.
"videoLineupId": "A String", # ID for a Video lineup. Contact your Google business development representative for details.
},
"webpage": { # Represents a criterion for targeting webpages of an advertiser's website. # Immutable. Webpage
"conditions": [ # 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.
{ # Logical expression for targeting webpages of an advertiser's website.
"argument": "A String", # Argument of webpage targeting condition.
"operand": "A String", # Operand of webpage targeting condition.
"operator": "A String", # Operator of webpage targeting condition.
},
],
"coveragePercentage": 3.14, # 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.
"criterionName": "A String", # The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
"sample": { # List of sample urls that match the website target # List of sample urls that match the website target. This field is read-only.
"sampleUrls": [ # Webpage sample urls
"A String",
],
},
},
"youtubeChannel": { # A YouTube Channel criterion. # Immutable. YouTube Channel.
"channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
},
"youtubeVideo": { # A YouTube Video criterion. # Immutable. YouTube Video.
"videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
},
},
"resourceName": "A String", # Returned for successful operations.
},
],
}