Method: projects.locations.productSets.import

画像情報のリストに基づいて、指定した商品セットに参照画像をインポートする非同期 API。

google.longrunning.Operation API を使用すると、リクエストの進行状況と結果を追跡できます。Operation.metadata には BatchOperationMetadata が含まれます。(進行状況)Operation.response には ImportProductSetsResponse が含まれます。(結果)

このメソッドの入力ソースは Google Cloud Storage 上の csv ファイルです。CSV ファイルの形式については、ImportProductSetsGcsSource.csv_file_uri をご覧ください。

HTTP リクエスト

POST https://vision.googleapis.com/v1/{parent=projects/*/locations/*}/productSets:import

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。ProductSets がインポートされるプロジェクト。

形式は projects/PROJECT_ID/locations/LOC_ID です。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "inputConfig": {
    object (ImportProductSetsInputConfig)
  }
}
フィールド
inputConfig

object (ImportProductSetsInputConfig)

必須。リクエスト リストの入力コンテンツ。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。

ImportProductSetsInputConfig

productSets.import メソッドの入力コンテンツ。

JSON 表現
{
  "gcsSource": {
    object (ImportProductSetsGcsSource)
  }
}
フィールド
gcsSource

object (ImportProductSetsGcsSource)

各行に ImportProductSetRequests のリストを保持する csv ファイルが存在する Google Cloud Storage のロケーション。

ImportProductSetsGcsSource

各行に ImportProductSetRequests のリストを保持する csv ファイルが存在する Google Cloud Storage のロケーション。

JSON 表現
{
  "csvFileUri": string
}
フィールド
csvFileUri

string

入力 csv ファイルの Google Cloud Storage の URI。

URI は、gs:// で始める必要があります。

入力 csv ファイルでは、各行に画像が 1 つ含まれている必要があります。各行には次の 8 つの列があります。

  1. image-uri
  2. image-id
  3. product-set-id
  4. product-id
  5. product-category
  6. product-display-name
  7. labels
  8. bounding-poly

image-uriproduct-set-idproduct-idproduct-category 列は必須です。その他の列はすべて省略可能です。

product-set-id 値と product-id 値で指定された ProductSet または Product が存在しない場合、その画像に対して新しい ProductSet または Product が作成されます。この場合、product-display-name 列は displayNameproduct-category 列は productCategorylabels 列は productLabels を表します。

image-id 列は省略可能ですが、指定する場合は一意にする必要があります。空の場合、画像に固有の ID が自動的に割り当てられます。

product-display-name 列は省略可能です。空の場合、商品の displayName フィールドはスペース(「 」)に設定されます。displayName は、API を使用して後で更新できます。

product-id が指定された Product が存在している場合、product-display-nameproduct-categorylabels 列は無視されます。

labels 列(省略可)には、次の形式の Key-Value ペアのカンマ区切りリストが含まれます。

"key_1=value_1,key_2=value_2,...,key_n=value_n"

referenceImages.create と同様に、bounding-poly 列(省略可)には画像の関心領域を 1 つ指定します。bounding-poly 列を指定しない場合、関心領域が自動的に検出されます。

bounding-poly 列は 1 行に 1 つだけ指定できます。画像に複数の関心領域が存在する場合は、同じ商品情報と各関心領域の bounding-poly 値が含まれる行を CSV ファイルに追加します。

bounding-poly 列には「p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y」の形式で、カンマ区切りの数字が偶数個含まれている必要があります。絶対的な境界ポリゴンには負でない整数を使用し、正規化された境界ポリゴンには [0, 1] の浮動小数点値を使用する必要があります。

画像の解像度が高すぎる(20MP を超える)場合は、画像のサイズが変更されます。