Method: projects.locations.products.purge

HTTP 请求
路径参数
请求正文
- JSON 表示法
响应正文
授权范围
ProductSetPurgeConfig
- JSON 表示法

此异步 API 可删除 ProductSet 中的所有 Product 或不在 ProductSet 中的所有 Product。

如果 Product 既是指定 ProductSet 的成员，又属于其他 ProductSet，则 Product 仍会被删除。

此操作完成前，建议不要删除指定的 ProductSet。此外，建议您不要在此操作运行时将批量删除涉及的任何 Product 添加到新的 ProductSet，因为这些 Product 最终可能会被删除。

products.purge 操作无法撤销。因此，我们建议您在开始执行 products.purge 之前保留 productSets.import 中使用的 csv 文件（如果这是您最初构建商品集的方式），以防在删除后需要重新导入数据。

如果您计划从 ProductSet 中清除所有 Product，然后重新使用空的 ProductSet 重新将空 Product 导入到空 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`	`string` 必需。应该从中删除 Product 的项目和位置。格式为 `projects/PROJECT_ID/locations/LOC_ID`。

parent

string

必需。应该从中删除 Product 的项目和位置。

格式为 projects/PROJECT_ID/locations/LOC_ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法

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,

  // 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`。要删除的 Product。`target` 只能是下列其中一项：
`productSetPurgeConfig`	`object (ProductSetPurgeConfig)` 指定要删除的 Product 所在的 ProductSet。
`deleteOrphanProducts`	`boolean` 如果 deleteOrphanProducts 为 true，则会删除不在任何 ProductSet 中的所有 Product。

响应正文

如果成功，则响应正文包含一个 Operation 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅身份验证概览。

ProductSetPurgeConfig

用于控制要删除的 Product 所在的 ProductSet 的配置。

JSON 表示法
{ "productSetId": string }

字段

字段
`productSetId`	`string` 包含待删除 Product 的 ProductSet。如果 Product 隶属于 productSetId 及其他 ProductSet，那么 Product 仍将予以删除。

productSetId