Ressource ProductStatuses

Article
11/13/2024

Remarque

La ressource Store est disponible uniquement pour les participants bêta fermés. Pour plus d’informations sur la participation au programme bêta fermé ou open-beta, contactez votre responsable de compte.

Tous les éléments de programmation du Store et la documentation sont susceptibles d’être modifiés pendant la version bêta.

Utilisez la ressource ProductStatuses pour obtenir la status des offres de produits dans un magasin.

Base URI

Voici l’URI de base auquel vous ajoutez les modèles .

https://content.api.ads.microsoft.com/v9.1/bmc

Par exemple, pour obtenir une vue récapitulative des status d’offres de produits dans un magasin, utilisez le point de terminaison suivant :

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

Modèles

Il s’agit des modèles que vous ajoutez à l’URI de base pour créer un point de terminaison HTTP.

/stores/{merchantId}/productstatusessummary

Verbe HTTP	Description	Ressource
Obtenir	Obtient une vue récapitulative de la status des offres de produits dans un magasin. Le service retourne le nombre d’offres approuvées, désapprouvées et arrivant à expiration dans le magasin. Définissez `{merchantId}` sur l’ID du magasin à partir duquel obtenir les états. Cela peut prendre jusqu’à deux heures entre le moment où la status d’une offre change et le moment où elle est reflétée dans la vue récapitulative.	Demande : N/A Réponse : ProductStatusesSummary

/stores/{merchantId}/productstatuses

Verbe HTTP	Description	Ressource
Obtenir	Obtient une vue détaillée des status d’offres de produits dans un magasin. Les détails sont retournés uniquement pour les produits dont la status est Désapprouvée ou Avertissement. Définissez `{merchantId}` sur l’ID du magasin à partir duquel vous souhaitez obtenir les états. Le paramètre de requête max-results détermine le nombre d’offres retournées par le service. Pour parcourir toutes les offres, utilisez le paramètre de requête de jeton de continuation .	Demande : N/A Réponse : ProductStatuses

Paramètres de requête

La requête peut inclure les paramètres de requête suivants :

Paramètre Description

max-results Facultatif. Utilisez pour spécifier le nombre maximal d’éléments à retourner dans une demande de liste telle que /stores/{merchantId}/productstatuses. La valeur maximale que vous pouvez spécifier est 250. La valeur par défaut est 25.

continuation-token Facultatif. Utilisez pour paginer la liste des états des produits d’un magasin. Le jeton identifie la page suivante des états du produit à retourner. Ne spécifiez pas ce paramètre dans la première demande de liste. Si le magasin contient plus que le nombre de produits demandé (voir le paramètre de requête max-results ), la réponse inclut le nextPageToken champ . Dans la requête suivante, définissez continuation-token sur la valeur du jeton dans nextPageToken.

Paramètre	Description
max-results	Facultatif. Utilisez pour spécifier le nombre maximal d’éléments à retourner dans une demande de liste telle que `/stores/{merchantId}/productstatuses`. La valeur maximale que vous pouvez spécifier est 250. La valeur par défaut est 25.
continuation-token	Facultatif. Utilisez pour paginer la liste des états des produits d’un magasin. Le jeton identifie la page suivante des états du produit à retourner. Ne spécifiez pas ce paramètre dans la première demande de liste. Si le magasin contient plus que le nombre de produits demandé (voir le paramètre de requête max-results ), la réponse inclut le `nextPageToken` champ . Dans la requête suivante, définissez continuation-token sur la valeur du jeton dans `nextPageToken`.

En-têtes

Voici les en-têtes de demande et de réponse.

En-tête	Description
AuthenticationToken	En-tête de la demande. Définissez cet en-tête sur un jeton d’accès OAuth. Pour plus d’informations sur l’obtention d’un jeton d’accès, consultez Authentification de vos informations d’identification.
Content-Type	En-tête de la demande. Toutes les requêtes POST doivent spécifier cet en-tête et il doit être défini sur `application/json`.
CustomerAccountId	En-tête de la demande. ID de compte de tout compte que vous gérez pour le compte du client spécifié dans l’en-tête `CustomerId` . Le compte que vous spécifiez n’a pas d’importance. Spécifiez cet en-tête uniquement si vous gérez un compte pour le compte du client.
Customerid	En-tête de la demande. ID client du client dont vous gérez le magasin. Spécifiez cet en-tête uniquement si vous gérez le magasin pour le compte du client. Si vous définissez cet en-tête, vous devez également définir l’en-tête `CustomerAccountId` .
DeveloperToken	En-tête de la demande. Jeton de développeur de l’application cliente. Chaque demande doit inclure cet en-tête. Pour plus d’informations sur l’obtention d’un jeton, consultez Avez-vous vos informations d’identification Microsoft Advertising et votre jeton de développeur ?
WebRequestActivityId	En-tête de réponse. ID de l’entrée de journal qui contient les détails de la demande. Vous devez toujours capturer cet ID si une erreur se produit. Si vous n’êtes pas en mesure de déterminer et de résoudre le problème, incluez cet ID avec les autres informations que vous fournissez à l’équipe de support technique.

Objets de requête et de réponse

Voici les objets de requête et de réponse utilisés par l’API.

Objet	Description
Erreur	Définit une erreur.
ErrorResponse	Définit l’objet d’erreur de niveau supérieur.
ProductStatus	Définit la status d’une offre de produit.
ProductStatuses	Définit une liste des offres de produits qui rencontrent des problèmes.
ProductStatusesSummary	Définit une vue récapitulative des status d’offres de produits dans un magasin.
ProductStatusItemLevelIssue	Définit un problème avec l’offre de produit.

Error

Définit une erreur.

Nom	Valeur	Type
code	Raison de l’échec de la demande.	Chaîne
message	Description de l’erreur.	Chaîne

ErrorResponse

Définit l’objet d’erreur de niveau supérieur.

Nom	Valeur	Type
erreurs	Liste des erreurs qui se sont produites lors du traitement de la demande.	Erreur[]

ProductStatus

Définit la status d’une offre de produit.

Nom	Valeur	Type
creationDate	Date et heure de création de l’offre de produit.	Date/heure
expirationDate	Date et heure d’expiration de l’offre de produit.	Date/heure
itemLevelIssues	Liste des problèmes liés à l’offre de produit.	ProductStatusItemLevelIssue[]
lastUpdateDate	Date et heure de la dernière mise à jour de l’offre de produit.	Date/heure
Productid	ID du produit.	String
status	La status d’approbation du produit. Les valeurs possibles sont les suivantes : Désapprouvé Avertissement Les produits désapprouvés ne sont pas servis. Les avertissements indiquent que le produit présente des problèmes que vous devez résoudre, mais ils n’empêchent pas l’offre de produit de servir. Vous devez résoudre les problèmes et soumettre à nouveau l’offre de produit.	Chaîne
title	Titre du produit	Chaîne

ProductStatuses

Définit une liste des offres de produits qui rencontrent des problèmes.

Nom	Valeur	Type
nextPageToken	Jeton sur lequel définir le paramètre de requête continuation-token si d’autres offres de produit sont disponibles.	String
resources	Liste des offres de produits qui présentent des problèmes. Le paramètre de requête max-results détermine le nombre maximal d’offres dans la liste . le nombre réel retourné peut être inférieur.	ProductStatus[]

ProductStatusesSummary

Définit une vue récapitulative des status d’offres de produits dans un magasin. Si le magasin vient d’être créé, toutes les valeurs sont égales à zéro.

Nom	Valeur	Type
Approuvé	Nombre total de produits approuvés dans le magasin.	Entier
Désapprouvé	Nombre total de produits du magasin qui sont rejetés en raison d’erreurs.	Entier
Expirant	Nombre total de produits dans le magasin qui expireront dans les 72 prochaines heures.	Entier
merchantId	ID du magasin dans lequel se trouvent les produits.	Long non signé
Attente	Nombre total de produits en attente d’examen.	Entier

ProductStatusItemLevelIssue

Définit un problème avec l’offre de produit.

Nom	Valeur	Type
Attributename	Nom de la propriété de l’offre de produit à l’origine du problème. Tous les problèmes n’identifient pas une propriété. Par exemple, l’objet n’inclut pas ce champ si le problème est dû à plusieurs propriétés.	Chaîne
code	Code d’erreur qui identifie le problème. Par exemple, TitleTooLongErr.	String
description	Description qui explique le problème avec la propriété .	Chaîne
servabilité	Valeur qui indique si le problème empêche l’offre de servir. Les valeurs possibles sont les suivantes : Désapprouvé Affectés En cas de désapprobation, l’offre ne servira pas.	Chaîne

Codes d’état HTTP

Les requêtes peuvent retourner les codes de status HTTP suivants.

Code d'état	Description
200	Opération réussie.
400	Demande incorrecte La requête spécifie probablement un paramètre de requête ou une valeur de paramètre non valide.
401	Non autorisé Les informations d’identification de l’utilisateur ne sont pas valides.
404	Introuvable. Le magasin demandé est introuvable.
500	Erreur du serveur.

Codes d’erreur

Les requêtes peuvent retourner les codes d’erreur suivants.

Code d'erreur	Description
ContinuationTokenInvalidErr	La valeur du paramètre de requête de continuation-jeton n’est pas valide. Veillez à définir le paramètre à l’aide de la valeur dans le champ de l’objet `nextPageToken`ProductStatuses.

Partager via