Ressource d’état
La ressource Status vous permet d’obtenir les status des offres de produits que vous avez chargées dans le catalogue spécifié. Une fois que vous avez chargé des offres dans le catalogue, elles passent par un processus de validation et de révision éditoriale. Ce processus peut prendre jusqu’à 36 heures. L’offre n’est incluse dans le rapport qu’une fois le processus de révision terminé.
Pour obtenir une vue d’ensemble du fonctionnement du processus, consultez Comment obtenir l’état des offres de produits ?
Pour obtenir un exemple de code qui montre comment obtenir les status du catalogue et télécharger le rapport, consultez Téléchargement du rapport d’état du catalogue.
Base URI
Voici l’URI de base auquel vous ajoutez les modèles.
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
Modèles
Pour créer les points de terminaison utilisés pour obtenir les status d’offres de produits dans un catalogue, ajoutez le modèle approprié à l’URI de base.
Remarque
{bmcMerchantId}/catalogs/{catalogId}/status est déconseillé et nous vous déconseillons de l’utiliser.
| Modèle | Verbe HTTP | Description | Ressource |
|---|---|---|---|
{bmcMerchantId}/catalogs/{catalogId}/status |
GET | Utilisez pour obtenir le nombre d’offres chargées qui ont réussi ou échoué à la validation et à la révision éditoriale. Définissez {bmcMerchantId} sur l’ID du magasin MMC.Définissez {catalogId} sur l’ID du catalogue. |
Demande : N/A Réponse : État |
Paramètres de requête
Les points de terminaison peuvent inclure les paramètres de requête suivants.
| Paramètre | Description |
|---|---|
| alt | Facultatif. Utilisez pour spécifier le type de contenu utilisé dans la demande et la réponse. Les valeurs possibles sont json et xml. La valeur par défaut est json. |
En-têtes
Voici les en-têtes de demande et de réponse.
| En-tête | Description |
|---|---|
| Accepter | En-tête de la demande.<p>Inclure cet en-tête lorsque vous téléchargez le rapport. Vous devez définir cet en-tête sur application/x-zip-compressed. |
| AuthenticationToken | En-tête de la demande. Définissez cet en-tête sur un jeton d’authentification OAuth. Pour plus d’informations sur l’obtention d’un jeton, consultez Authentification de vos informations d’identification. |
| Emplacement du contenu | En-tête de réponse. URL qui identifie le magasin dans lequel le produit a été inséré. Cet en-tête est inclus dans la réponse d’une demande d’insertion. |
| CustomerAccountId | En-tête de la demande. ID de compte de l’un des comptes que vous gérez au nom 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 d’accès 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 ? |
| Emplacement | En-tête de réponse. URL qui identifie le magasin dans lequel le produit a été inséré. Cet en-tête est inclus dans la réponse d’une demande d’insertion. |
| 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.
Chaque objet définit le nom de clé JSON et le nom d’élément XML que vous utilisez en fonction du type de contenu que vous avez spécifié pour la requête.
| Objet | Description |
|---|---|
| État | Définit la status des offres de produits qui ont été chargées dans le catalogue. |
Statut
Définit la status des offres de produits qui ont été chargées dans le catalogue. Le nom XML de l’objet est <catalogStatus>.
| Nom | Valeur | Type | Nom de l’élément XML |
|---|---|---|---|
| catalogId | ID du catalogue signalé. | ulong | <catalog_id> |
| publishedCount | Nombre d’offres ayant fait l’objet d’une validation et d’une révision éditoriale. | ulong | <published_count> |
| rejectedCount | Nombre d’offres ayant échoué à la validation et à la révision éditoriale. Ce nombre indique le nombre de lignes dans le corps du rapport (voir Format du rapport). | ulong | <rejected_count> |
| rejectionReportUrl | URL que vous utilisez pour télécharger le rapport. L’objet inclut ce champ uniquement lorsque rejectedCount est supérieur à zéro.Le rapport est compressé et doit être décompressé avant de pouvoir le lire. |
string | <catalog_id> |
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 Une valeur de paramètre de requête n’est pas valide ou l’URL du rapport (voir rejectionReportUrl) n’est plus valide. |
| 401 | Non autorisé Les informations d’identification de l’utilisateur ne sont pas valides. |
| 404 | Introuvable. Status n’est pas disponible pour le catalogue spécifié ou l’ID de catalogue ou de magasin n’est pas valide. |
| 500 | Erreur du serveur. |
Format de rapport
Le fichier de rapport que vous téléchargez est contenu dans un dossier compressé Zip (*.zip). Vous devez décompresser le dossier et son contenu avant de pouvoir lire le rapport. Le rapport est un fichier délimité par des virgules nommé MerchantCatalogReport.csv.
Le rapport est divisé en une section d’en-tête et une section de corps de rapport. La première ligne contient les noms de colonnes suivants pour la section d’en-tête.
| Nom de colonne | Description |
|---|---|
| Nom du catalogue | Nom du catalogue. |
| ID de catalogue | ID du catalogue. |
| ID du magasin | ID du magasin qui contient le catalogue. |
| Heure de chargement | Ne pas utiliser. Si ce champ existe, ignorez-le. |
La deuxième ligne contient les données d’en-tête.
La troisième ligne est vide.
La quatrième ligne contient les noms de colonnes suivants pour le corps du rapport, qui commence sur la cinquième ligne.
| Nom de colonne | Description |
|---|---|
| ID d’élément | OfferId de l’offre qui a échoué à la validation ou à la révision éditoriale. Le rapport contient des ID uniques. |
| Message | Erreur signalée. |
| Type | Type d’erreur. Les valeurs possibles sont Error ou Warning. |
| Valeurs | Valeur de données à l’origine de l’erreur, si l’erreur a été provoquée par une valeur non valide. |
| Extrait de l’offre | Liste délimitée par des points-virgules de sous-ensemble des données de l’offre. Le format est le titre ; productType ; lien ; imageLink ; prix ; salePrice ; saleStartDate ; saleEndDate. Toutes les erreurs n’incluent pas tous les composants. |
Pour obtenir un exemple de rapport, consultez Exemple de rapport.