Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

AssetGroupListingGroupFilter

Stay organized with collections Save and categorize content based on your preferences.

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

JSON representation
{
  "resourceName": string,
  "assetGroup": string,
  "id": string,
  "type": enum (ListingGroupFilterType),
  "vertical": enum (ListingGroupFilterVertical),
  "caseValue": {
    object (ListingGroupFilterDimension)
  },
  "parentListingGroupFilter": string
}
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.

vertical

enum (ListingGroupFilterVertical)

Immutable. The vertical the current node tree represents. All nodes in the same tree must belong to the same vertical.

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.

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.

ListingGroupFilterVertical

The type of the listing group filter vertical.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SHOPPING Represents the shopping vertical.

ListingGroupFilterDimension

Listing dimensions for the asset group listing group filter.

JSON representation
{

  // Union field dimension can be only one of the following:
  "productBiddingCategory": {
    object (ProductBiddingCategory)
  },
  "productBrand": {
    object (ProductBrand)
  },
  "productChannel": {
    object (ProductChannel)
  },
  "productCondition": {
    object (ProductCondition)
  },
  "productCustomAttribute": {
    object (ProductCustomAttribute)
  },
  "productItemId": {
    object (ProductItemId)
  },
  "productType": {
    object (ProductType)
  }
  // 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:
productBiddingCategory

object (ProductBiddingCategory)

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

ProductBiddingCategory

One element of a bidding 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 (ListingGroupFilterBiddingCategoryLevel),
  "id": string
}
Fields
level

enum (ListingGroupFilterBiddingCategoryLevel)

Indicates the level of the category in the taxonomy.

id

string (int64 format)

ID of the product bidding category.

This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436

ListingGroupFilterBiddingCategoryLevel

The level of the listing group filter bidding 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.