商品セットを作成したら、商品を作成して商品セットに追加できます。商品を作成するときに、商品の表示名と商品カテゴリを指定する必要があります。現在サポートされているカテゴリは、homegoods-v2
、apparel-v2
、toys-v2
、packagedgoods-v1
、general-v1
* です。
商品のオプションの説明とラベルを指定することもできます。ラベルは、商品を説明する Key-Value ペアです(例: color=black
、style=mens
)。ラベルを含めて商品検索の結果をフィルタリングすることで、特定の商品の画像のみを検索できます。
商品を作成する
オンライン インポートを使用して個々の商品を作成できます。商品を作成したら、商品に参照画像を追加できます。また、商品を 1 つ以上の商品セットに追加することもできます。
REST とコマンドライン
後述のリクエストのデータを使用する前に、次のように置き換えます。
- project-id: GCP プロジェクト ID
- location-id: 有効なロケーション ID。有効なロケーション識別子は
us-west1
、us-east1
、europe-west1
、asia-east1
です。 - display-name: 選択した文字列の表示名。
- product-description: 選択した文字列の説明。
- product-category: 有効な商品カテゴリ。現在使用可能な商品カテゴリは、
homegoods-v2
、apparel-v2
、toys-v2
、packagedgoods-v1
、general-v1
です。 productLabels
: 商品に関連付けられた 1 つ以上の Key-Value ペア。各 key-string には value-string を関連付ける必要があります。
HTTP メソッドと URL:
POST https://vision.googleapis.com/v1/projects/project-id/locations/location-id/products
JSON 本文のリクエスト:
{ "displayName": "display-name", "description": "product-description", "productCategory": "product-category", "productLabels": [ { "key": "key-string", "value": "value-string" } ] }
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
curl -X POST \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://vision.googleapis.com/v1/projects/project-id/locations/location-id/products
PowerShell
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://vision.googleapis.com/v1/projects/project-id/locations/location-id/products" | Select-Object -Expand Content
リクエスト本文の例:
{ "displayName": "sample-product-1234", "description": "Athletic shorts", "productCategory": "apparel-v2", "productLabels": [ { "key": "style", "value": "womens" }, { "key": "color", "value": "blue" } ] }
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと JSON 形式のレスポンスを返します。
出力は次のようになります。商品 ID(この場合は 37b9811d308c4e42
)を使用して、商品に対して他のオペレーションを実行できます。
{ "name": "projects/project-id/locations/location-id/products/37b9811d308c4e42", "displayName": "sample-product-456", "description": "Athletic shorts", "productCategory": "apparel-v2", "productLabels": [ { "key": "style", "value": "womens" }, { "key": "color", "value": "blue" } ] }
Go
Java
Node.js
Python
商品を商品セットに追加する
商品と商品セットが使用できる場合は、その商品をその商品セットに追加できます。
REST とコマンドライン
後述のリクエストのデータを使用する前に、次のように置き換えます。
- project-id: GCP プロジェクト ID
- location-id: 有効なロケーション ID。有効なロケーション識別子は
us-west1
、us-east1
、europe-west1
、asia-east1
です。 - product-set-id: 操作を実行する商品セットの ID。
- product-name: 商品の完全なリソース名。形式:
projects/project-id/locations/location-id/products/product-id
HTTP メソッドと URL:
POST https://vision.googleapis.com/v1/projects/project-id/locations/location-id/productSets/product-set-id:addProduct
JSON 本文のリクエスト:
{ "product": "product-name" }
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
curl -X POST \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://vision.googleapis.com/v1/projects/project-id/locations/location-id/productSets/product-set-id:addProduct
PowerShell
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://vision.googleapis.com/v1/projects/project-id/locations/location-id/productSets/product-set-id:addProduct" | Select-Object -Expand Content
次のような JSON レスポンスが返されます。
{}
Go
Java
Node.js
Python
商品を商品セットから削除する
既存の商品を商品セットから削除することもできます。
REST とコマンドライン
後述のリクエストのデータを使用する前に、次のように置き換えます。
- project-id: GCP プロジェクト ID
- location-id: 有効なロケーション ID。有効なロケーション識別子は
us-west1
、us-east1
、europe-west1
、asia-east1
です。 - product-set-id: 操作を実行する商品セットの ID。
- product-name: 商品の完全なリソース名。形式:
projects/project-id/locations/location-id/products/product-id
HTTP メソッドと URL:
POST https://vision.googleapis.com/v1/projects/project-id/locations/location-id/productSets/product-set-id:removeProduct
JSON 本文のリクエスト:
{ "product": "product-name" }
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
curl -X POST \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://vision.googleapis.com/v1/projects/project-id/locations/location-id/productSets/product-set-id:removeProduct
PowerShell
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://vision.googleapis.com/v1/projects/project-id/locations/location-id/productSets/product-set-id:removeProduct" | Select-Object -Expand Content
次のような JSON レスポンスが返されます。
{}
Go
Java
Node.js
Python