Method: projects.locations.products.purge

ProductSet 内のすべての Product を削除するか、ProductSet 内にない Product をすべて削除する非同期 API。

Product が、他の ProductSet だけでなく、指定された ProductSet のメンバーである場合、その Product は削除されます。

このオペレーションが完了するまで、指定された ProductSet を削除しないことをおすすめします。オペレーションの実行中は、バッチ削除に関連する Products を新しい ProductSet に追加しないことをおすすめします。追加しても、これらの Products は最終的に削除される可能性があります。

products.purge オペレーションを元に戻すことはできません。削除後にデータを再度インポートする必要がある場合は、products.purge を開始する前に、productSets.import で使用されている csv ファイルを残しておくことをおすすめします（この方法で ProductSet を作成している場合）。

ProductSet からすべての Products を削除し、空の ProductSet を使用して新しい Products を空の ProductSet に再度インポートする場合は、ProductSet に対する products.purge オペレーションが完了するまで待つ必要があります。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。Products を削除するプロジェクトとロケーション。

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

リクエストの本文

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

JSON 表現 
{
  "force": boolean,

  // Union field target can be only one of the following:
  "productSetPurgeConfig": {
    object (ProductSetPurgeConfig)
  },
  "deleteOrphanProducts": boolean
  // End of list of possible types for union field target.
}
フィールド
force

boolean

デフォルト値は false です。実際に削除を実行するには、この値を true にオーバーライドします。
共用体フィールド target。削除する Products。target は次のいずれかになります。
productSetPurgeConfig

object (ProductSetPurgeConfig)

削除する Product が含まれる ProductSet を指定します。
deleteOrphanProducts

boolean

deleteOrphanProducts が true の場合、ProductSet に含まれない Products はすべて削除されます。

レスポンスの本文

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

認証スコープ

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

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

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

ProductSetPurgeConfig

削除する商品が含まれる ProductSet を制御するための構成。

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

string

削除する商品が含まれる ProductSet。Product が他の ProductSet に加えて productSetId のメンバーである場合でも、Product は削除されます。