Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates or removes asset group listing group filters. Operation statuses are returned.
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates or removes asset group listing group filters. Operation statuses are returned.
Args:
customerId: string, Required. The ID of the customer whose asset group listing group filters are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters. partial_failure is not supported because the tree needs to be validated together.
"operations": [ # Required. The list of operations to perform on individual asset group listing group filters.
{ # A single operation (create, remove) on an asset group listing group filter.
"create": { # AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group. # Create operation: No resource name is expected for the new asset group listing group filter.
"assetGroup": "A String", # Immutable. The asset group which this asset group listing group filter is part of.
"caseValue": { # Listing dimensions for the asset group listing group filter. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # One element of a category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # 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", # Indicates the level of the category in the taxonomy.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"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.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"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.
},
"webpage": { # Filters for URLs in a page feed and URLs from the advertiser web domain. Several root nodes with this dimension are allowed in an asset group and their conditions are considered in OR. # Filters for URLs in a page feed and URLs from the advertiser web domain.
"conditions": [ # The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
{ # Matching condition for URL filtering.
"customLabel": "A String", # Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
"urlContains": "A String", # Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
},
],
},
},
"id": "A String", # Output only. The ID of the ListingGroupFilter.
"listingSource": "A String", # Immutable. The source of listings filtered by this listing group filter.
"parentListingGroupFilter": "A String", # Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
"path": { # The path defining of dimensions defining a listing group filter. # Output only. The path of dimensions defining this listing group filter.
"dimensions": [ # Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
{ # Listing dimensions for the asset group listing group filter.
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # One element of a category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # 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", # Indicates the level of the category in the taxonomy.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"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.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"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.
},
"webpage": { # Filters for URLs in a page feed and URLs from the advertiser web domain. Several root nodes with this dimension are allowed in an asset group and their conditions are considered in OR. # Filters for URLs in a page feed and URLs from the advertiser web domain.
"conditions": [ # The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
{ # Matching condition for URL filtering.
"customLabel": "A String", # Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
"urlContains": "A String", # Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
},
],
},
},
],
},
"resourceName": "A String", # Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
"type": "A String", # Immutable. Type of a listing group filter node.
},
"remove": "A String", # Remove operation: A resource name for the removed asset group listing group filter is expected, in this format: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}` An entity can be removed only if it's not referenced by other parent_listing_group_id. If multiple entities are being deleted, the mutates must be in the correct order.
"update": { # AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group. # Update operation: The asset group listing group filter is expected to have a valid resource name.
"assetGroup": "A String", # Immutable. The asset group which this asset group listing group filter is part of.
"caseValue": { # Listing dimensions for the asset group listing group filter. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # One element of a category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # 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", # Indicates the level of the category in the taxonomy.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"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.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"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.
},
"webpage": { # Filters for URLs in a page feed and URLs from the advertiser web domain. Several root nodes with this dimension are allowed in an asset group and their conditions are considered in OR. # Filters for URLs in a page feed and URLs from the advertiser web domain.
"conditions": [ # The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
{ # Matching condition for URL filtering.
"customLabel": "A String", # Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
"urlContains": "A String", # Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
},
],
},
},
"id": "A String", # Output only. The ID of the ListingGroupFilter.
"listingSource": "A String", # Immutable. The source of listings filtered by this listing group filter.
"parentListingGroupFilter": "A String", # Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
"path": { # The path defining of dimensions defining a listing group filter. # Output only. The path of dimensions defining this listing group filter.
"dimensions": [ # Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
{ # Listing dimensions for the asset group listing group filter.
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # One element of a category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # 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", # Indicates the level of the category in the taxonomy.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"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.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"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.
},
"webpage": { # Filters for URLs in a page feed and URLs from the advertiser web domain. Several root nodes with this dimension are allowed in an asset group and their conditions are considered in OR. # Filters for URLs in a page feed and URLs from the advertiser web domain.
"conditions": [ # The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
{ # Matching condition for URL filtering.
"customLabel": "A String", # Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
"urlContains": "A String", # Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
},
],
},
},
],
},
"resourceName": "A String", # Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
"type": "A String", # Immutable. Type of a listing group filter node.
},
"updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
},
],
"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 asset group listing group filter mutate.
"results": [ # All results for the mutate.
{ # The result for the asset group listing group filter mutate.
"assetGroupListingGroupFilter": { # AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group. # The mutated AssetGroupListingGroupFilter with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"assetGroup": "A String", # Immutable. The asset group which this asset group listing group filter is part of.
"caseValue": { # Listing dimensions for the asset group listing group filter. # Dimension value with which this listing group is refining its parent. Undefined for the root group.
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # One element of a category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # 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", # Indicates the level of the category in the taxonomy.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"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.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"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.
},
"webpage": { # Filters for URLs in a page feed and URLs from the advertiser web domain. Several root nodes with this dimension are allowed in an asset group and their conditions are considered in OR. # Filters for URLs in a page feed and URLs from the advertiser web domain.
"conditions": [ # The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
{ # Matching condition for URL filtering.
"customLabel": "A String", # Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
"urlContains": "A String", # Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
},
],
},
},
"id": "A String", # Output only. The ID of the ListingGroupFilter.
"listingSource": "A String", # Immutable. The source of listings filtered by this listing group filter.
"parentListingGroupFilter": "A String", # Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
"path": { # The path defining of dimensions defining a listing group filter. # Output only. The path of dimensions defining this listing group filter.
"dimensions": [ # Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
{ # Listing dimensions for the asset group listing group filter.
"productBrand": { # Brand of the product. # Brand of a product offer.
"value": "A String", # String value of the product brand.
},
"productCategory": { # One element of a category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level). # 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", # Indicates the level of the category in the taxonomy.
},
"productChannel": { # Locality of a product offer. # Locality of a product offer.
"channel": "A String", # Value of the locality.
},
"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.
},
"productItemId": { # Item id of a product offer. # Item id of a product offer.
"value": "A String", # Value of the id.
},
"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.
},
"webpage": { # Filters for URLs in a page feed and URLs from the advertiser web domain. Several root nodes with this dimension are allowed in an asset group and their conditions are considered in OR. # Filters for URLs in a page feed and URLs from the advertiser web domain.
"conditions": [ # The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
{ # Matching condition for URL filtering.
"customLabel": "A String", # Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
"urlContains": "A String", # Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
},
],
},
},
],
},
"resourceName": "A String", # Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
"type": "A String", # Immutable. Type of a listing group filter node.
},
"resourceName": "A String", # Returned for successful operations.
},
],
}