Method: projects.locations.products.purge

API assíncrona para excluir todos os produtos em um ProductSet ou todos os produtos que não estão em ProductSet.

Se um produto for um membro do ProductSet especificado e de outros ProductSets, o Product ainda será excluído.

É recomendável não excluir o ProductSet especificado até que essa operação seja concluída. Também é recomendável não adicionar nenhum dos produtos envolvidos na exclusão em lote a um novo ProductSet enquanto essa operação estiver em execução, porque esses produtos ainda poderão ser excluídos.

Não é possível desfazer a operação products.purge. Portanto, é recomendável manter os arquivos csv usados em productSets.import (caso tenha sido usados para criar o conjunto de produtos) antes de iniciar a operação products.purge, caso seja necessário importar novamente os dados após a exclusão.

Se o plano for eliminar todos os produtos de um ProductSet e reutilizar o ProductSet vazio para importar novos produtos para ele, você precisará aguardar até que a operação products.purge seja concluída para esse ProductSet.

A API google.longrunning.Operation pode ser usada para acompanhar o progresso e os resultados da solicitação. Operation.metadata contém BatchOperationMetadata (progresso).

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O projeto e o local em que os produtos devem ser excluídos.

O formato é projects/PROJECT_ID/locations/LOC_ID.

Corpo da solicitação

O corpo da solicitação 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 padrão é falso. Substitua esse valor como "true" para realizar a limpeza.

Campo de união target. Os produtos a serem excluídos. target pode ser apenas de um dos tipos a seguir:
productSetPurgeConfig

object (ProductSetPurgeConfig)

Especifique qual ProductSet contém os produtos a serem excluídos.

deleteOrphanProducts

boolean

Se deleteOrphanProducts for "true", todos os produtos que não estiverem em nenhum ProductSet serão excluídos.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

ProductSetPurgeConfig

Configuração para controlar qual ProductSet contém os produtos a serem excluídos.

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

string

O ProductSet que contém os produtos a serem excluídos. Se um produto for membro do productSetId e de outros ProductSets, ele ainda será excluído.