AssetGroupListingGroupFilter

AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.

JSON representation 
{
  "resourceName": string,
  "assetGroup": string,
  "id": string,
  "type": enum (ListingGroupFilterType),
  "listingSource": enum (ListingGroupFilterListingSource),
  "caseValue": {
    object (ListingGroupFilterDimension)
  },
  "parentListingGroupFilter": string,
  "path": {
    object (ListingGroupFilterDimensionPath)
  }
}
Fields
resourceName

string

Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form:

customers/{customerId}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}
assetGroup

string

Immutable. The asset group which this asset group listing group filter is part of.
id

string (int64 format)

Output only. The ID of the ListingGroupFilter.
type

enum (ListingGroupFilterType)

Immutable. Type of a listing group filter node.
listingSource

enum (ListingGroupFilterListingSource)

Immutable. The source of listings filtered by this listing group filter.
caseValue

object (ListingGroupFilterDimension)

Dimension value with which this listing group is refining its parent. Undefined for the root group.
parentListingGroupFilter

string

Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
path

object (ListingGroupFilterDimensionPath)

Output only. The path of dimensions defining this listing group filter.

ListingGroupFilterType

The type of the listing group filter.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SUBDIVISION Subdivision of products along some listing dimensions.
UNIT_INCLUDED An included listing group filter leaf node.
UNIT_EXCLUDED An excluded listing group filter leaf node.

ListingGroupFilterListingSource

The source of listings filtered by a listing group filter node.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SHOPPING Listings from a Shopping source, like products from Google Merchant Center.
WEBPAGE Listings from a webpage source, like URLs from a page feed or from the advertiser web domain.

ListingGroupFilterDimension

Listing dimensions for the asset group listing group filter.

JSON representation 
{

  // Union field dimension can be only one of the following:
  "productCategory": {
    object (ProductCategory)
  },
  "productBrand": {
    object (ProductBrand)
  },
  "productChannel": {
    object (ProductChannel)
  },
  "productCondition": {
    object (ProductCondition)
  },
  "productCustomAttribute": {
    object (ProductCustomAttribute)
  },
  "productItemId": {
    object (ProductItemId)
  },
  "productType": {
    object (ProductType)
  },
  "webpage": {
    object (Webpage)
  }
  // End of list of possible types for union field dimension.
}
Fields
Union field dimension. Dimension of one of the types below is always present. dimension can be only one of the following:
productCategory

object (ProductCategory)

Category of a product offer.
productBrand

object (ProductBrand)

Brand of a product offer.
productChannel

object (ProductChannel)

Locality of a product offer.
productCondition

object (ProductCondition)

Condition of a product offer.
productCustomAttribute

object (ProductCustomAttribute)

Custom attribute of a product offer.
productItemId

object (ProductItemId)

Item id of a product offer.
productType

object (ProductType)

Type of a product offer.
webpage

object (Webpage)

Filters for URLs in a page feed and URLs from the advertiser web domain.

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

JSON representation 
{
  "level": enum (ListingGroupFilterProductCategoryLevel),
  "categoryId": string
}
Fields
level

enum (ListingGroupFilterProductCategoryLevel)

Indicates the level of the category in the taxonomy.
categoryId

string (int64 format)

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

ListingGroupFilterProductCategoryLevel

The level of the listing group filter product category.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LEVEL1 Level 1.
LEVEL2 Level 2.
LEVEL3 Level 3.
LEVEL4 Level 4.
LEVEL5 Level 5.

ProductBrand

Brand of the product.

JSON representation 
{
  "value": string
}
Fields
value

string

String value of the product brand.

ProductChannel

Locality of a product offer.

JSON representation 
{
  "channel": enum (ListingGroupFilterProductChannel)
}
Fields
channel

enum (ListingGroupFilterProductChannel)

Value of the locality.

ListingGroupFilterProductChannel

Enum describing the locality of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ONLINE The item is sold online.
LOCAL The item is sold in local stores.

ProductCondition

Condition of a product offer.

JSON representation 
{
  "condition": enum (ListingGroupFilterProductCondition)
}
Fields
condition

enum (ListingGroupFilterProductCondition)

Value of the condition.

ListingGroupFilterProductCondition

Enum describing the condition of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NEW The product condition is new.
REFURBISHED The product condition is refurbished.
USED The product condition is used.

ProductCustomAttribute

Custom attribute of a product offer.

JSON representation 
{
  "index": enum (ListingGroupFilterCustomAttributeIndex),
  "value": string
}
Fields
index

enum (ListingGroupFilterCustomAttributeIndex)

Indicates the index of the custom attribute.
value

string

String value of the product custom attribute.

ListingGroupFilterCustomAttributeIndex

The index of customer attributes.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
INDEX0 First listing group filter custom attribute.
INDEX1 Second listing group filter custom attribute.
INDEX2 Third listing group filter custom attribute.
INDEX3 Fourth listing group filter custom attribute.
INDEX4 Fifth listing group filter custom attribute.

ProductItemId

Item id of a product offer.

JSON representation 
{
  "value": string
}
Fields
value

string

Value of the id.

ProductType

Type of a product offer.

JSON representation 
{
  "level": enum (ListingGroupFilterProductTypeLevel),
  "value": string
}
Fields
level

enum (ListingGroupFilterProductTypeLevel)

Level of the type.
value

string

Value of the type.

ListingGroupFilterProductTypeLevel

Enum describing the level of the type of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LEVEL1 Level 1.
LEVEL2 Level 2.
LEVEL3 Level 3.
LEVEL4 Level 4.
LEVEL5 Level 5.

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.

JSON representation 
{
  "conditions": [
    {
      object (WebpageCondition)
    }
  ]
}
Fields
conditions[]

object (WebpageCondition)

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 urlContains 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 customLabel conditions, URL1 will be matched but not URL2. With Label2 as the only customLabel condition then both URL1 and URL2 will be matched.

WebpageCondition

Matching condition for URL filtering.

JSON representation 
{

  // Union field condition can be only one of the following:
  "customLabel": string,
  "urlContains": string
  // End of list of possible types for union field condition.
}
Fields
Union field condition. Condition for filtering the URLs. condition can be only one of the following:
customLabel

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

string

Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.

ListingGroupFilterDimensionPath

The path defining of dimensions defining a listing group filter.

JSON representation 
{
  "dimensions": [
    {
      object (ListingGroupFilterDimension)
    }
  ]
}
Fields
dimensions[]

object (ListingGroupFilterDimension)

Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.