Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes criteria. Operation statuses are returned. List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [CampaignCriterionError]() [CollectionSizeError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [FunctionError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes criteria. Operation statuses are returned. List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [CampaignCriterionError]() [CollectionSizeError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [FunctionError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Args:
customerId: string, Required. The ID of the customer whose criteria are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CampaignCriterionService.MutateCampaignCriteria.
"operations": [ # Required. The list of operations to perform on individual criteria.
{ # A single operation (create, update, remove) on a campaign criterion.
"create": { # A campaign criterion. # Create operation: No resource name is expected for the new criterion.
"adSchedule": { # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day. # Immutable. Ad Schedule.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # 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.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # 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.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
"ageRange": { # An age range criterion. # Immutable. Age range.
"type": "A String", # Type of the age range.
},
"bidModifier": 3.14, # 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.
"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 campaign criterion.
"sharedSet": "A String", # Shared set resource name of the brand list.
},
"campaign": "A String", # Immutable. The campaign to which the criterion belongs.
"carrier": { # Represents a Carrier Criterion. # Immutable. Carrier.
"carrierConstant": "A String", # The Carrier constant resource name.
},
"combinedAudience": { # A combined audience criterion. # Immutable. Combined Audience.
"combinedAudience": "A String", # The CombinedAudience resource name.
},
"contentLabel": { # Content Label for category exclusion. # Immutable. ContentLabel.
"type": "A String", # Content label type, required for CREATE operations.
},
"criterionId": "A String", # Output only. The ID of the criterion. This field is ignored during mutate.
"device": { # A device criterion. # Immutable. Device.
"type": "A String", # Type of the device.
},
"displayName": "A String", # Output only. The display name of the criterion. This field is ignored for mutates.
"extendedDemographic": { # Represents an extended demographic criterion. # Immutable. Extended demographic criterion.
"extendedDemographicId": "A String", # Taxonomy id of the extended demographic group.
},
"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.
},
"ipBlock": { # An IpBlock criterion used for excluding IP addresses. We support excluding individual IP addresses or CIDR blocks. Create one IpBlockInfo criterion for each individual IP address or CIDR block you want to exclude. You can exclude up to 500 IP addresses per campaign. For more details, see [Exclude IP addresses](//support.google.com/google-ads/answer/2456098). IPv4 examples: * Individual address: 192.168.0.1 * Individual address as CIDR block: 192.168.0.1/32 * CIDR block: 192.168.0.0/24 IPv6 examples: * Individual address: 2001:db8:a0b:12f0::1 * Individual address as CIDR block: 2001:db8:a0b:12f0::1/128 * CIDR block: 2001:db8::/48 # Immutable. IpBlock. You can exclude up to 500 IP addresses per campaign.
"ipAddress": "A String", # The IP address or the CIDR block to be excluded.
},
"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).
},
"keywordTheme": { # A Smart Campaign keyword theme. # Immutable. Smart Campaign Keyword Theme.
"freeFormKeywordTheme": "A String", # Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
"keywordThemeConstant": "A String", # The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
},
"language": { # A language criterion. # Immutable. Language.
"languageConstant": "A String", # The language constant resource name.
},
"lastModifiedTime": "A String", # Output only. The datetime when this campaign 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.
},
"listingScope": { # A listing scope criterion. # Immutable. Listing scope.
"dimensions": [ # Scope of the campaign criterion.
{ # 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.
},
},
],
},
"localServiceId": { # A Local Services Ads service ID. Represents a service type (such as install_faucet) that a Local Services Campaign can target. # Immutable. GLS service campaign criterion.
"serviceId": "A String", # The criterion resource name.
},
"location": { # A location criterion. # Immutable. Location.
"geoTargetConstant": "A String", # The geo target constant resource name.
},
"locationGroup": { # A radius around a list of locations specified through a feed. # Immutable. Location Group
"enableCustomerLevelLocationAssetSet": True or False, # 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.
"feedItemSets": [ # 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.
"A String",
],
"geoTargetConstants": [ # Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
"A String",
],
"locationGroupAssetSets": [ # 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.
"A String",
],
"radius": "A String", # Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
"radiusUnits": "A String", # Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.
},
"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.
},
"mobileDevice": { # A mobile device criterion. # Immutable. Mobile Device.
"mobileDeviceConstant": "A String", # The mobile device constant resource name.
},
"negative": True or False, # Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
"operatingSystemVersion": { # Represents an operating system version to be targeted. # Immutable. Operating system version.
"operatingSystemVersionConstant": "A String", # The operating system version constant resource name.
},
"parentalStatus": { # A parental status criterion. # Immutable. Parental status.
"type": "A String", # Type of the parental status.
},
"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".
},
"proximity": { # A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. # Immutable. Proximity.
"address": { # Address for proximity criterion. # Full address.
"cityName": "A String", # Name of the city.
"countryCode": "A String", # Country code.
"postalCode": "A String", # Postal code.
"provinceCode": "A String", # Province or state code.
"provinceName": "A String", # Province or state name.
"streetAddress": "A String", # Street address line 1.
"streetAddress2": "A String", # 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.
},
"geoPoint": { # Geo point for proximity criterion. # Latitude and longitude.
"latitudeInMicroDegrees": 42, # Micro degrees for the latitude.
"longitudeInMicroDegrees": 42, # Micro degrees for the longitude.
},
"radius": 3.14, # The radius of the proximity.
"radiusUnits": "A String", # The unit of measurement of the radius. Default is KILOMETERS.
},
"resourceName": "A String", # Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
"status": "A String", # The 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.
},
"type": "A String", # Output only. The type of the criterion.
"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.
},
"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",
],
},
},
"webpageList": { # Represents a list of webpage criteria. # Immutable. Webpage list. This criterion is not publicly available.
"sharedSet": "A String", # Shared set resource name of the webpage list.
},
"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.
},
},
"remove": "A String", # Remove operation: A resource name for the removed criterion is expected, in this format: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
"update": { # A campaign criterion. # Update operation: The criterion is expected to have a valid resource name. Note that for smart campaigns, you cannot use the update method to edit the geolocation target.
"adSchedule": { # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day. # Immutable. Ad Schedule.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # 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.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # 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.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
"ageRange": { # An age range criterion. # Immutable. Age range.
"type": "A String", # Type of the age range.
},
"bidModifier": 3.14, # 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.
"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 campaign criterion.
"sharedSet": "A String", # Shared set resource name of the brand list.
},
"campaign": "A String", # Immutable. The campaign to which the criterion belongs.
"carrier": { # Represents a Carrier Criterion. # Immutable. Carrier.
"carrierConstant": "A String", # The Carrier constant resource name.
},
"combinedAudience": { # A combined audience criterion. # Immutable. Combined Audience.
"combinedAudience": "A String", # The CombinedAudience resource name.
},
"contentLabel": { # Content Label for category exclusion. # Immutable. ContentLabel.
"type": "A String", # Content label type, required for CREATE operations.
},
"criterionId": "A String", # Output only. The ID of the criterion. This field is ignored during mutate.
"device": { # A device criterion. # Immutable. Device.
"type": "A String", # Type of the device.
},
"displayName": "A String", # Output only. The display name of the criterion. This field is ignored for mutates.
"extendedDemographic": { # Represents an extended demographic criterion. # Immutable. Extended demographic criterion.
"extendedDemographicId": "A String", # Taxonomy id of the extended demographic group.
},
"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.
},
"ipBlock": { # An IpBlock criterion used for excluding IP addresses. We support excluding individual IP addresses or CIDR blocks. Create one IpBlockInfo criterion for each individual IP address or CIDR block you want to exclude. You can exclude up to 500 IP addresses per campaign. For more details, see [Exclude IP addresses](//support.google.com/google-ads/answer/2456098). IPv4 examples: * Individual address: 192.168.0.1 * Individual address as CIDR block: 192.168.0.1/32 * CIDR block: 192.168.0.0/24 IPv6 examples: * Individual address: 2001:db8:a0b:12f0::1 * Individual address as CIDR block: 2001:db8:a0b:12f0::1/128 * CIDR block: 2001:db8::/48 # Immutable. IpBlock. You can exclude up to 500 IP addresses per campaign.
"ipAddress": "A String", # The IP address or the CIDR block to be excluded.
},
"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).
},
"keywordTheme": { # A Smart Campaign keyword theme. # Immutable. Smart Campaign Keyword Theme.
"freeFormKeywordTheme": "A String", # Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
"keywordThemeConstant": "A String", # The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
},
"language": { # A language criterion. # Immutable. Language.
"languageConstant": "A String", # The language constant resource name.
},
"lastModifiedTime": "A String", # Output only. The datetime when this campaign 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.
},
"listingScope": { # A listing scope criterion. # Immutable. Listing scope.
"dimensions": [ # Scope of the campaign criterion.
{ # 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.
},
},
],
},
"localServiceId": { # A Local Services Ads service ID. Represents a service type (such as install_faucet) that a Local Services Campaign can target. # Immutable. GLS service campaign criterion.
"serviceId": "A String", # The criterion resource name.
},
"location": { # A location criterion. # Immutable. Location.
"geoTargetConstant": "A String", # The geo target constant resource name.
},
"locationGroup": { # A radius around a list of locations specified through a feed. # Immutable. Location Group
"enableCustomerLevelLocationAssetSet": True or False, # 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.
"feedItemSets": [ # 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.
"A String",
],
"geoTargetConstants": [ # Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
"A String",
],
"locationGroupAssetSets": [ # 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.
"A String",
],
"radius": "A String", # Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
"radiusUnits": "A String", # Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.
},
"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.
},
"mobileDevice": { # A mobile device criterion. # Immutable. Mobile Device.
"mobileDeviceConstant": "A String", # The mobile device constant resource name.
},
"negative": True or False, # Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
"operatingSystemVersion": { # Represents an operating system version to be targeted. # Immutable. Operating system version.
"operatingSystemVersionConstant": "A String", # The operating system version constant resource name.
},
"parentalStatus": { # A parental status criterion. # Immutable. Parental status.
"type": "A String", # Type of the parental status.
},
"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".
},
"proximity": { # A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. # Immutable. Proximity.
"address": { # Address for proximity criterion. # Full address.
"cityName": "A String", # Name of the city.
"countryCode": "A String", # Country code.
"postalCode": "A String", # Postal code.
"provinceCode": "A String", # Province or state code.
"provinceName": "A String", # Province or state name.
"streetAddress": "A String", # Street address line 1.
"streetAddress2": "A String", # 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.
},
"geoPoint": { # Geo point for proximity criterion. # Latitude and longitude.
"latitudeInMicroDegrees": 42, # Micro degrees for the latitude.
"longitudeInMicroDegrees": 42, # Micro degrees for the longitude.
},
"radius": 3.14, # The radius of the proximity.
"radiusUnits": "A String", # The unit of measurement of the radius. Default is KILOMETERS.
},
"resourceName": "A String", # Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
"status": "A String", # The 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.
},
"type": "A String", # Output only. The type of the criterion.
"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.
},
"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",
],
},
},
"webpageList": { # Represents a list of webpage criteria. # Immutable. Webpage list. This criterion is not publicly available.
"sharedSet": "A String", # Shared set resource name of the webpage list.
},
"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 campaign 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.
"campaignCriterion": { # A campaign criterion. # The mutated campaign criterion with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"adSchedule": { # Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day. # Immutable. Ad Schedule.
"dayOfWeek": "A String", # Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
"endHour": 42, # 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.
"endMinute": "A String", # Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
"startHour": 42, # 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.
"startMinute": "A String", # Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
},
"ageRange": { # An age range criterion. # Immutable. Age range.
"type": "A String", # Type of the age range.
},
"bidModifier": 3.14, # 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.
"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 campaign criterion.
"sharedSet": "A String", # Shared set resource name of the brand list.
},
"campaign": "A String", # Immutable. The campaign to which the criterion belongs.
"carrier": { # Represents a Carrier Criterion. # Immutable. Carrier.
"carrierConstant": "A String", # The Carrier constant resource name.
},
"combinedAudience": { # A combined audience criterion. # Immutable. Combined Audience.
"combinedAudience": "A String", # The CombinedAudience resource name.
},
"contentLabel": { # Content Label for category exclusion. # Immutable. ContentLabel.
"type": "A String", # Content label type, required for CREATE operations.
},
"criterionId": "A String", # Output only. The ID of the criterion. This field is ignored during mutate.
"device": { # A device criterion. # Immutable. Device.
"type": "A String", # Type of the device.
},
"displayName": "A String", # Output only. The display name of the criterion. This field is ignored for mutates.
"extendedDemographic": { # Represents an extended demographic criterion. # Immutable. Extended demographic criterion.
"extendedDemographicId": "A String", # Taxonomy id of the extended demographic group.
},
"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.
},
"ipBlock": { # An IpBlock criterion used for excluding IP addresses. We support excluding individual IP addresses or CIDR blocks. Create one IpBlockInfo criterion for each individual IP address or CIDR block you want to exclude. You can exclude up to 500 IP addresses per campaign. For more details, see [Exclude IP addresses](//support.google.com/google-ads/answer/2456098). IPv4 examples: * Individual address: 192.168.0.1 * Individual address as CIDR block: 192.168.0.1/32 * CIDR block: 192.168.0.0/24 IPv6 examples: * Individual address: 2001:db8:a0b:12f0::1 * Individual address as CIDR block: 2001:db8:a0b:12f0::1/128 * CIDR block: 2001:db8::/48 # Immutable. IpBlock. You can exclude up to 500 IP addresses per campaign.
"ipAddress": "A String", # The IP address or the CIDR block to be excluded.
},
"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).
},
"keywordTheme": { # A Smart Campaign keyword theme. # Immutable. Smart Campaign Keyword Theme.
"freeFormKeywordTheme": "A String", # Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.
"keywordThemeConstant": "A String", # The resource name of a Smart Campaign keyword theme constant. `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
},
"language": { # A language criterion. # Immutable. Language.
"languageConstant": "A String", # The language constant resource name.
},
"lastModifiedTime": "A String", # Output only. The datetime when this campaign 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.
},
"listingScope": { # A listing scope criterion. # Immutable. Listing scope.
"dimensions": [ # Scope of the campaign criterion.
{ # 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.
},
},
],
},
"localServiceId": { # A Local Services Ads service ID. Represents a service type (such as install_faucet) that a Local Services Campaign can target. # Immutable. GLS service campaign criterion.
"serviceId": "A String", # The criterion resource name.
},
"location": { # A location criterion. # Immutable. Location.
"geoTargetConstant": "A String", # The geo target constant resource name.
},
"locationGroup": { # A radius around a list of locations specified through a feed. # Immutable. Location Group
"enableCustomerLevelLocationAssetSet": True or False, # 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.
"feedItemSets": [ # 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.
"A String",
],
"geoTargetConstants": [ # Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
"A String",
],
"locationGroupAssetSets": [ # 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.
"A String",
],
"radius": "A String", # Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
"radiusUnits": "A String", # Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.
},
"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.
},
"mobileDevice": { # A mobile device criterion. # Immutable. Mobile Device.
"mobileDeviceConstant": "A String", # The mobile device constant resource name.
},
"negative": True or False, # Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
"operatingSystemVersion": { # Represents an operating system version to be targeted. # Immutable. Operating system version.
"operatingSystemVersionConstant": "A String", # The operating system version constant resource name.
},
"parentalStatus": { # A parental status criterion. # Immutable. Parental status.
"type": "A String", # Type of the parental status.
},
"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".
},
"proximity": { # A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. # Immutable. Proximity.
"address": { # Address for proximity criterion. # Full address.
"cityName": "A String", # Name of the city.
"countryCode": "A String", # Country code.
"postalCode": "A String", # Postal code.
"provinceCode": "A String", # Province or state code.
"provinceName": "A String", # Province or state name.
"streetAddress": "A String", # Street address line 1.
"streetAddress2": "A String", # 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.
},
"geoPoint": { # Geo point for proximity criterion. # Latitude and longitude.
"latitudeInMicroDegrees": 42, # Micro degrees for the latitude.
"longitudeInMicroDegrees": 42, # Micro degrees for the longitude.
},
"radius": 3.14, # The radius of the proximity.
"radiusUnits": "A String", # The unit of measurement of the radius. Default is KILOMETERS.
},
"resourceName": "A String", # Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
"status": "A String", # The 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.
},
"type": "A String", # Output only. The type of the criterion.
"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.
},
"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",
],
},
},
"webpageList": { # Represents a list of webpage criteria. # Immutable. Webpage list. This criterion is not publicly available.
"sharedSet": "A String", # Shared set resource name of the webpage list.
},
"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.
},
],
}