REST Resource: projects.locations.products

リソース: Product

Product には ReferenceImages が含まれます。

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "productCategory": string,
  "productLabels": [
    {
      object (KeyValue)
    }
  ]
}
フィールド
name

string

商品のリソース名。

形式: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

商品の作成では、このフィールドは無視されます。

displayName

string

この Product のユーザー指定の名前。空にすることはできません4,096 文字以内で指定してください。

description

string

この商品とともに保存されるユーザー提供のメタデータ。4,096 文字以内で指定してください。

productCategory

string

参照画像によって特定する商品のカテゴリ。homegoods-v2、apparel-v2、toys-v2、packagedgoods-v1 のいずれかを指定します。従来のカテゴリ(homegoods、apparel、toys)は引き続きサポートされますが、これらは廃止される予定です。新しい商品の場合、商品検索の精度を高めるため、homegoods-v2、apparel-v2、toys-v2 を使用してください。既存の商品もこれらのカテゴリに移行することをおすすめします。

このフィールドは変更できません。

productLabels[]

object (KeyValue)

商品に関連付けることができる Key-Value ペア。クエリ時に、productLabels に基づいて制約を指定できます。

整数値は「1199」のように、文字列として指定できます。整数値が含まれる文字列のみが範囲ベースの制限と一致します。これは間もなくサポートされます。

複数の値を同じキーに割り当てることができます。1 つの商品に最大 100 個の productLabels を設定できます。

KeyValue

Key-Value ペアとして表される商品ラベル。

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

商品に適用されたラベルのキー。空白にすることはできません。128 バイト以下にする必要があります。

value

string

商品に適用されたラベルの値。空白にすることはできません。128 バイト以下にする必要があります。

メソッド

create

新しい商品リソースを作成して返します。

delete

商品とその参照画像を完全に削除します。

get

Product に関連付けられた情報を取得します。

list

不特定の順序で商品を一覧表示します。

patch

Product リソースを変更します。