非同步 API,用於刪除 ProductSet 中的所有產品,或不屬於任何 ProductSet 的所有產品。
如果產品是指定 ProductSet 的成員,且屬於其他 ProductSet,系統仍會刪除該產品。
建議您在完成這項作業後再刪除指定的 ProductSet。此外,在執行這項作業時,建議不要將批次刪除作業中涉及的任何產品新增至新的 ProductSet,因為這些產品可能仍會遭到刪除。
無法復原 products.purge 作業。因此,建議您在啟動 products.purge 前,保留 productSets.import 中使用的 CSV 檔案 (如果您原本是使用這種方式建立產品集),以防刪除後需要重新匯入資料。
如果您打算從 ProductSet 中清除所有產品,然後重複使用空白 ProductSet,以便將新產品重新匯入空白 ProductSet,則必須等到該 ProductSet 的 products.purge 作業完成。
google.longrunning.Operation API 可用來追蹤要求的進度和結果。Operation.metadata 包含 BatchOperationMetadata。(進度)
HTTP 要求
POST https://vision.googleapis.com/v1/{parent=projects/*/locations/*}/products:purge
這個網址使用 gRPC 轉碼語法。
路徑參數
| 參數 | |
|---|---|
parent |
這是必要旗標,產品應刪除的專案和位置。 格式為 |
要求主體
要求主體包含下列結構的資料:
| JSON 表示法 | |
|---|---|
{ "force": boolean, // Union field |
|
| 欄位 | ||
|---|---|---|
force |
預設值為 false。將這個值覆寫為 true,即可實際執行清除作業。 |
|
聯集欄位 target。要刪除的產品。target 只能是下列其中一項: |
||
productSetPurgeConfig |
指定哪個 ProductSet 包含要刪除的產品。 |
|
deleteOrphanProducts |
如果 deleteOrphanProducts 為 true,則系統會刪除所有不在任何 ProductSet 中的產品。 |
|
回應主體
如果成功,回應主體會包含 Operation 的執行個體。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-vision
詳情請參閱驗證總覽一文。
產品集清除設定
設定,用於控管哪個 ProductSet 包含要刪除的產品。
| JSON 表示法 | |
|---|---|
{ "productSetId": string } |
|
| 欄位 | |
|---|---|
productSetId |
包含要刪除的產品的 ProductSet。如果產品是 productSetId 的組成元素,且屬於其他 ProductSet,系統仍會刪除該產品。 |