Method: projects.locations.products.purge

API assíncrona para eliminar todos os produtos num ProductSet ou todos os produtos que não estão em nenhum ProductSet.

Se um produto for membro do ProductSet especificado, além de outros ProductSets, o produto é eliminado na mesma.

Recomendamos que não elimine o ProductSet especificado até que esta operação esteja concluída. Também recomendamos que não adicione nenhum dos produtos envolvidos na eliminação em lote a um novo ProductSet enquanto esta operação estiver em execução, porque esses produtos podem acabar por ser eliminados.

Não é possível anular a operação products.purge. Por conseguinte, recomenda-se que mantenha os ficheiros CSV usados em productSets.import (se foi assim que criou originalmente o conjunto de produtos) antes de iniciar products.purge, caso precise de voltar a importar os dados após a eliminação.

Se o plano for limpar todos os produtos de um ProductSet e, em seguida, reutilizar o ProductSet vazio para reimportar novos produtos para o ProductSet vazio, tem de aguardar até que a operação products.purge termine para esse ProductSet.

A API google.longrunning.Operation pode ser usada para acompanhar o progresso e os resultados do pedido. Operation.metadata contém BatchOperationMetadata. (progresso)

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O projeto e a localização nos quais os produtos devem ser eliminados.

O formato é projects/PROJECT_ID/locations/LOC_ID.

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação 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.
}
Campos
force

boolean

O valor predefinido é false. Substitua este valor por verdadeiro para realizar efetivamente a limpeza.

Campo de união target. Os produtos a eliminar. target só pode ser uma das seguintes opções:
productSetPurgeConfig

object (ProductSetPurgeConfig)

Especifique o ProductSet que contém os produtos a eliminar.

deleteOrphanProducts

boolean

Se deleteOrphanProducts for verdadeiro, todos os produtos que não estejam em nenhum ProductSet são eliminados.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Operation.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.

ProductSetPurgeConfig

Configuração para controlar que ProductSet contém os produtos a eliminar.

Representação JSON 
{
  "productSetId": string
}
Campos
productSetId

string

O ProductSet que contém os produtos a eliminar. Se um produto for membro de productSetId, além de outros ProductSets, o produto é eliminado na mesma.