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.

ListingDimensionInfo

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

Listing dimensions for listing group criterion.

JSON representation 
{

  // Union field dimension can be only one of the following:
  "hotelId": {
    object (HotelIdInfo)
  },
  "hotelClass": {
    object (HotelClassInfo)
  },
  "hotelCountryRegion": {
    object (HotelCountryRegionInfo)
  },
  "hotelState": {
    object (HotelStateInfo)
  },
  "hotelCity": {
    object (HotelCityInfo)
  },
  "productBiddingCategory": {
    object (ProductBiddingCategoryInfo)
  },
  "productBrand": {
    object (ProductBrandInfo)
  },
  "productChannel": {
    object (ProductChannelInfo)
  },
  "productChannelExclusivity": {
    object (ProductChannelExclusivityInfo)
  },
  "productCondition": {
    object (ProductConditionInfo)
  },
  "productCustomAttribute": {
    object (ProductCustomAttributeInfo)
  },
  "productItemId": {
    object (ProductItemIdInfo)
  },
  "productType": {
    object (ProductTypeInfo)
  },
  "unknownListingDimension": {
    object (UnknownListingDimensionInfo)
  }
  // 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:
hotelId

object (HotelIdInfo)

Advertiser-specific hotel ID.
hotelClass

object (HotelClassInfo)

Class of the hotel as a number of stars 1 to 5.
hotelCountryRegion

object (HotelCountryRegionInfo)

Country or Region the hotel is located in.
hotelState

object (HotelStateInfo)

State the hotel is located in.
hotelCity

object (HotelCityInfo)

City the hotel is located in.
productBiddingCategory

object (ProductBiddingCategoryInfo)

Bidding category of a product offer.
productBrand

object (ProductBrandInfo)

Brand of a product offer.
productChannel

object (ProductChannelInfo)

Locality of a product offer.
productChannelExclusivity

object (ProductChannelExclusivityInfo)

Availability of a product offer.
productCondition

object (ProductConditionInfo)

Condition of a product offer.
productCustomAttribute

object (ProductCustomAttributeInfo)

Custom attribute of a product offer.
productItemId

object (ProductItemIdInfo)

Item id of a product offer.
productType

object (ProductTypeInfo)

Type of a product offer.
unknownListingDimension

object (UnknownListingDimensionInfo)

Unknown dimension. Set when no other listing dimension is set.

HotelIdInfo

Advertiser-specific hotel ID.

JSON representation 
{
  "value": string
}
Fields
value

string

String value of the hotel ID.

HotelClassInfo

Class of the hotel as a number of stars 1 to 5.

JSON representation 
{
  "value": string
}
Fields
value

string (int64 format)

Long value of the hotel class.

HotelCountryRegionInfo

Country or Region the hotel is located in.

JSON representation 
{
  "countryRegionCriterion": string
}
Fields
countryRegionCriterion

string

The Geo Target Constant resource name.

HotelStateInfo

State the hotel is located in.

JSON representation 
{
  "stateCriterion": string
}
Fields
stateCriterion

string

The Geo Target Constant resource name.

HotelCityInfo

City the hotel is located in.

JSON representation 
{
  "cityCriterion": string
}
Fields
cityCriterion

string

The Geo Target Constant resource name.

ProductBiddingCategoryInfo

Bidding category of a product offer.

JSON representation 
{
  "level": enum (ProductBiddingCategoryLevel),
  "id": string,
  "countryCode": string
}
Fields
level

enum (ProductBiddingCategoryLevel)

Level of the product bidding category.
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
countryCode

string

Two-letter upper-case country code of the product bidding category. It must match the campaign.shopping_setting.sales_country field.

ProductBrandInfo

Brand of the product.

JSON representation 
{
  "value": string
}
Fields
value

string

String value of the product brand.

ProductChannelInfo

Locality of a product offer.

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

enum (ProductChannel)

Value of the locality.

ProductChannel

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.

ProductChannelExclusivityInfo

Availability of a product offer.

JSON representation 
{
  "channelExclusivity": enum (ProductChannelExclusivity)
}
Fields
channelExclusivity

enum (ProductChannelExclusivity)

Value of the availability.

ProductChannelExclusivity

Enum describing the availability of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SINGLE_CHANNEL The item is sold through one channel only, either local stores or online as indicated by its ProductChannel.
MULTI_CHANNEL The item is matched to its online or local stores counterpart, indicating it is available for purchase in both ShoppingProductChannels.

ProductConditionInfo

Condition of a product offer.

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

enum (ProductCondition)

Value of the condition.

ProductCondition

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.

ProductCustomAttributeInfo

Custom attribute of a product offer.

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

enum (ProductCustomAttributeIndex)

Indicates the index of the custom attribute.
value

string

String value of the product custom attribute.

ProductCustomAttributeIndex

The index of the product custom attribute.

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

ProductItemIdInfo

Item id of a product offer.

JSON representation 
{
  "value": string
}
Fields
value

string

Value of the id.

ProductTypeInfo

Type of a product offer.

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

enum (ProductTypeLevel)

Level of the type.
value

string

Value of the type.

ProductTypeLevel

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.

UnknownListingDimensionInfo

Unknown listing dimension.