This is the documentation for Recommendations AI only. To try Retail Search and the unified Retail console in the restricted GA phase, contact Cloud sales. If you are not planning to use Retail Search, remain on the Recommendations console until further notice.

If you are using the v1beta version of Recommendations AI, migrate to the Retail API version.

Method: projects.locations.catalogs.branches.products.setInventory

Updates inventory information for a Product while respecting the last update timestamps of each inventory field.

This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by products.get or products.list.

When inventory is updated with products.create and products.patch, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the products.create or products.patch request.

If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used.

If no inventory fields are set in [UpdateProductRequest.set_mask][], then any existing inventory information will be preserved.

Pre-existing inventory information can only be updated with products.setInventory, products.addFulfillmentPlaces, and products.removeFulfillmentPlaces.

This feature is only available for users who have Retail placements.search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail placements.search.

HTTP request

POST https://retail.googleapis.com/v2/{inventory.name=projects/*/locations/*/catalogs/*/branches/*/products/**}:setInventory

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
inventory.name

string

Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/productId.

Request body

The request body contains data with the following structure:

JSON representation
{
  "inventory": {
    "expireTime": string,
    "ttl": string,
    "name": string,
    "id": string,
    "type": enum (Type),
    "primaryProductId": string,
    "collectionMemberIds": [
      string
    ],
    "gtin": string,
    "categories": [
      string
    ],
    "title": string,
    "brands": [
      string
    ],
    "description": string,
    "languageCode": string,
    "attributes": {
      string: {
        "text": [
          string
        ],
        "numbers": [
          number
        ],
        "searchable": boolean,
        "indexable": boolean
      },
      ...
    },
    "tags": [
      string
    ],
    "priceInfo": {
      "currencyCode": string,
      "price": number,
      "originalPrice": number,
      "cost": number,
      "priceEffectiveTime": string,
      "priceExpireTime": string,
      "priceRange": {
        object (PriceRange)
      }
    },
    "rating": {
      "ratingCount": integer,
      "averageRating": number,
      "ratingHistogram": [
        integer
      ]
    },
    "availableTime": string,
    "availability": enum (Availability),
    "availableQuantity": integer,
    "fulfillmentInfo": [
      {
        "type": string,
        "placeIds": [
          string
        ]
      }
    ],
    "uri": string,
    "images": [
      {
        "uri": string,
        "height": integer,
        "width": integer
      }
    ],
    "audience": {
      "genders": [
        string
      ],
      "ageGroups": [
        string
      ]
    },
    "colorInfo": {
      "colorFamilies": [
        string
      ],
      "colors": [
        string
      ]
    },
    "sizes": [
      string
    ],
    "materials": [
      string
    ],
    "patterns": [
      string
    ],
    "conditions": [
      string
    ],
    "promotions": [
      {
        "promotionId": string
      }
    ],
    "publishTime": string,
    "retrievableFields": string,
    "variants": [
      {
        "name": string,
        "id": string,
        "type": enum (Type),
        "primaryProductId": string,
        "collectionMemberIds": [
          string
        ],
        "gtin": string,
        "categories": [
          string
        ],
        "title": string,
        "brands": [
          string
        ],
        "description": string,
        "languageCode": string,
        "attributes": {
          string: {
            "text": [
              string
            ],
            "numbers": [
              number
            ],
            "searchable": boolean,
            "indexable": boolean
          },
          ...
        },
        "tags": [
          string
        ],
        "priceInfo": {
          object (PriceInfo)
        },
        "rating": {
          object (Rating)
        },
        "availableTime": string,
        "availability": enum (Availability),
        "availableQuantity": integer,
        "fulfillmentInfo": [
          {
            object (FulfillmentInfo)
          }
        ],
        "uri": string,
        "images": [
          {
            object (Image)
          }
        ],
        "audience": {
          object (Audience)
        },
        "colorInfo": {
          object (ColorInfo)
        },
        "sizes": [
          string
        ],
        "materials": [
          string
        ],
        "patterns": [
          string
        ],
        "conditions": [
          string
        ],
        "promotions": [
          {
            object (Promotion)
          }
        ],
        "publishTime": string,
        "retrievableFields": string,
        "variants": [
          {
            object (Product)
          }
        ],

        // Union field expiration can be only one of the following:
        "expireTime": string,
        "ttl": string
        // End of list of possible types for union field expiration.
      }
    ]
  },
  "setMask": string,
  "setTime": string,
  "allowMissing": boolean
}
Fields
inventory.id

string

Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.

inventory.type

enum (Type)

Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.

inventory.primaryProductId

string

Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown.

For Type.PRIMARY Products, this field can only be empty or set to the same value as id.

For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID.

inventory.collectionMemberIds[]

string

The id of the collection members when type is Type.COLLECTION.

Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.

inventory.gtin

string

The Global Trade Item Number (GTIN) of the product.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property gtin. Schema.org property Product.isbn, Product.gtin8, Product.gtin12, Product.gtin13, or Product.gtin14.

If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.

inventory.categories[]

string

Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality.

To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s).

For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as:

 "categories": [
   "Shoes & Accessories > Shoes",
   "Sports & Fitness > Athletic Clothing > Shoes"
 ]

Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned.

At most 250 values are allowed per Product. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category.

inventory.title

string

Required. Product title.

This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.

inventory.brands[]

string

The brands of the product.

A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property brand. Schema.org property Product.brand.

inventory.description

string

Product description.

This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.

inventory.languageCode

string

Language of the title/description and other string attributes. Use language tags defined by BCP 47.

For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance.

For product search this field is in use. It defaults to "en-US" if unset.

inventory.attributes[]

map (key: string, value: object)

Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here.

Features that can take on one of a limited number of possible values. Two types of features can be set are:

Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer.

For example: { "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

  • Max entries count: 200.
  • The key must be a UTF-8 encoded string with a length limit of 128 characters.
  • For indexable attribute, the key must match the pattern: [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
inventory.attributes[].text[]

string

The textual values of this custom attribute. For example, ["yellow", "green"] when the key is "color".

At most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

inventory.attributes[].numbers[]

number

The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm".

At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned.

Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

inventory.attributes[].searchable

boolean

If true, custom attribute values are searchable by text queries in SearchService.Search.

This field is ignored in a UserEvent.

Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.

inventory.attributes[].indexable

boolean

If true, custom attribute values are indexed, so that it can be filtered, faceted or boosted in SearchService.Search.

This field is ignored in a UserEvent.

See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.

inventory.tags[]

string

Custom tags associated with the product.

At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter.

Corresponding properties: Google Merchant Center property custom_label_0–4.

inventory.priceInfo

object (PriceInfo)

Product price and cost information.

Corresponding properties: Google Merchant Center property price.

inventory.rating

object (Rating)

The rating of this product.

inventory.availableTime

string (Timestamp format)

The timestamp when this Product becomes available for SearchService.Search.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

inventory.availability

enum (Availability)

The online availability of the Product. Default to Availability.IN_STOCK.

Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.

inventory.availableQuantity

integer

The available quantity of the item.

inventory.fulfillmentInfo[]

object (FulfillmentInfo)

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

All the elements must have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned.

inventory.uri

string

Canonical URL directly linking to the product detail page.

It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded.

This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url.

inventory.images[]

object (Image)

Product images for the product.Highly recommended to put the main image to the first.

A maximum of 300 images are allowed.

Corresponding properties: Google Merchant Center property image_link. Schema.org property Product.image.

inventory.audience

object (Audience)

The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.

inventory.colorInfo

object (ColorInfo)

The color of the product.

Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.

inventory.sizes[]

string

The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value].

For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches".

A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size.

inventory.materials[]

string

The material of the product. For example, "leather", "wooden".

A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property material. Schema.org property Product.material.

inventory.patterns[]

string

The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley".

A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern.

inventory.conditions[]

string

The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used".

A maximum of 5 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property condition. Schema.org property Offer.itemCondition.

inventory.promotions[]

object (Promotion)

The promotions applied to the product. A maximum of 10 values are allowed per Product.

inventory.publishTime

string (Timestamp format)

The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from availableTime, given it purely describes product freshness regardless of when it is available on search and recommendation.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

inventory.retrievableFields

string (FieldMask format)

Indicates which fields in the Products are returned in SearchResponse.

Supported fields for all types:

Supported fields only for Type.PRIMARY and Type.COLLECTION:

Supported fields only for Type.VARIANT:

  • Only the first image in images

To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes.

For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default:

For Type.VARIANT, the following fields are always returned in by default:

Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned.

Note: Returning more fields in SearchResponse may increase response payload size and serving latency.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

inventory.variants[]

object (Product)

Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primaryProductId for all the product variants. Only populated for Type.PRIMARY Products.

Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.

setMask

string (FieldMask format)

Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

setTime

string (Timestamp format)

The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

allowMissing

boolean

If set to true, and the Product with name Product.name is not found, the inventory update will still be processed and retained for at most 1 day until the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

Union field expiration.

expiration can be only one of the following:

inventory.expireTime

string (Timestamp format)

The timestamp when this product becomes unavailable for SearchService.Search.

If it is set, the Product is not available for SearchService.Search after expireTime. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts.

expireTime must be later than availableTime and publishTime, otherwise an INVALID_ARGUMENT error is thrown.

Corresponding properties: Google Merchant Center property expiration_date.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

inventory.ttl

string (Duration format)

Input only. The TTL (time to live) of the product.

If it is set, it must be a non-negative value, and expireTime is set as current timestamp plus ttl. The derived expireTime is returned in the output and ttl is left blank when retrieving the Product.

If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • retail.products.update

For more information, see the IAM documentation.