Updates a catalog item. Partial updating is supported. Non-existing items will be created.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: recommendationengine1-beta1 --scope <scope> projects locations-catalogs-catalog-items-patch ...

Required Scalar Argument

  • <name> (string)
    • Required. Full resource name of catalog item, such as projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudRecommendationengineV1beta1CatalogItem:
  description: string
  id: string
  item-group-id: string
  language-code: string
  product-metadata:
    available-quantity: string
    canonical-product-uri: string
    costs: { string: number }
    currency-code: string
    exact-price:
      display-price: number
      original-price: number
    price-range:
      max: number
      min: number
    stock-state: string
  tags: [string]
  title: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . description=gubergren
    • Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.
  • id=rebum.
    • Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.
  • item-group-id=est
    • Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.
  • language-code=ipsum
    • Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.
  • product-metadata available-quantity=ipsum
    • Optional. The available quantity of the item.
  • canonical-product-uri=est
    • Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..
  • costs=key=0.8000651323113592
    • Optional. A map to pass the costs associated with the product. For example: {"manufacturing": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)
    • the value will be associated with the given key
  • currency-code=ea
    • Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.
  • exact-price display-price=0.017825676742989738
    • Optional. Display price of the product.

  • original-price=0.353169646817869

    • Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.

  • ..price-range max=0.11853734747270994

    • Required. The maximum product price.

  • min=0.24638057468506236

    • Required. The minimum product price.

  • .. stock-state=sed

    • Optional. Online stock state of the catalog item. Default is IN_STOCK.

  • .. tags=no

    • Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.
    • Each invocation of this argument appends the given value to the array.
  • title=stet
    • Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").