Method: projects.locations.products.purge

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

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

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

Não é possível desfazer a operação products.purge. Portanto, recomendamos manter os arquivos CSV usados em productSets.import antes de iniciar products.purge, se essa foi a maneira como você criou o ProductSet. Isso será útil se for necessário importar novamente os dados após a exclusão.

Se o plano for excluir permanentemente todos os Products em um ProductSet e reutilizar o ProductSet vazio para importar novos Products, você precisará aguardar até que a operação products.purge tenha sido concluída no 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 com os Products que serão 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 por true para realizar a exclusão permanente.

Campo de união target. Os Products a serem excluídos. target só pode ser de um dos seguintes tipos:
productSetPurgeConfig

object (ProductSetPurgeConfig)

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

deleteOrphanProducts

boolean

Se deleteOrphanProducts for true, todos os Products que não estiverem em um 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 Products a serem excluídos.

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

string

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