Method: projects.locations.products.purge

API asynchrone permettant de supprimer tous les Products d'un ProductSet ou tous ceux qui ne figurent pas dans un ProductSet.

Si un Product fait partie du ProductSet spécifié en plus d'autres ProductSets, il est toujours supprimé.

Il est recommandé de ne pas supprimer le ProductSet spécifié avant la fin de cette opération. Nous vous recommandons également de ne pas ajouter de Products concernés par la suppression groupée à un nouveau ProductSet pendant l'exécution de l'opération. En effet, ces Products finiront par être supprimés.

Il n'est pas possible d'annuler l'opération products.purge. Par conséquent, il est recommandé de conserver les fichiers CSV utilisés dans productSets.import (s'il s'agissait du moyen utilisé pour créer l'ensemble de produits) avant de lancer products.purge, au cas où vous auriez besoin de réimporter les données après la suppression.

Si vous envisagez de supprimer définitivement tous les Products d'un ProductSet, puis de réutiliser le ProductSet vide pour y réimporter de nouveaux Products, vous devez attendre la fin de l'opération products.purge pour ce ProductSet.

L'API google.longrunning.Operation permet de suivre la progression et les résultats de la requête. Operation.metadata contient BatchOperationMetadata. (progression)

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Projet et emplacement dans lesquels les Products doivent être supprimés.

Format : projects/PROJECT_ID/locations/LOC_ID.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
force

boolean

La valeur par défaut est "false". Remplacez cette valeur par "true" pour lancer l'opération de suppression.

Champ d'union target. Products à supprimer. target ne peut être qu'un des éléments suivants :
productSetPurgeConfig

object (ProductSetPurgeConfig)

Indiquez le ProductSet contenant les Products à supprimer.

deleteOrphanProducts

boolean

Si le champ "deleteOrphanProducts" est défini sur "true", tous les Products qui ne figurent dans aucun ProductSet sont supprimés.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Présentation de l'authentification.

ProductSetPurgeConfig

Configuration permettant de contrôler le ProductSet contenant les Products à supprimer.

Représentation JSON 
{
  "productSetId": string
}
Champs
productSetId

string

ProductSet contenant les Products à supprimer. Si un Product figure dans le champ "productSetId" en plus d'autres ProductSets, il est supprimé.