Ressource Catalogs
La ressource Catalogues vous permet de gérer les catalogues dans votre magasin Microsoft Merchant Center (MMC). Pour plus d’informations sur l’utilisation des ressources Catalogs, consultez Gestion de vos catalogues. Pour obtenir des exemples qui montrent comment ajouter, supprimer et obtenir des catalogues, consultez Exemples de code.
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 que vous utilisez pour gérer vos catalogues, ajoutez le modèle approprié à l’URI de base.
| Modèle | Verbe HTTP | Description | Ressource |
|---|---|---|---|
| {mmcMerchantId}/catalogs | POST | Utilisez pour ajouter un catalogue au magasin. Pour ajouter un catalogue, son nom doit être unique. Vous pouvez ajouter un maximum de 100 catalogues à un magasin. Définissez {mmcMerchantId} sur l’ID du magasin MMC. |
Demande : Catalogue Réponse : Catalogue |
| {mmcMerchantId}/catalogs/{catalogId} | PUT | Utilisez pour mettre à jour un catalogue dans le magasin. Les seuls champs que vous pouvez mettre à jour sont les name champs et isPublishingEnabled , et vous devez spécifier les deux.Définissez {mmcMerchantId} sur l’ID du magasin MMC. |
Demande : Catalogue Réponse : Catalogue |
| {mmcMerchantId}/catalogs/{catalogId} | SUPPRIMER | Utilisez pour supprimer un catalogue du magasin. Définissez {mmcMerchantId} sur l’ID du magasin MMC.Définissez {catalogId} sur l’ID du catalogue. |
Demande : N/A Réponse : N/A |
| {mmcMerchantId}/catalogs/{catalogId} | GET | Utilisez pour obtenir un catalogue à partir du magasin. Définissez {mmcMerchantId} sur l’ID du magasin MMC.Définissez {catalogId} sur l’ID du catalogue. |
Demande : N/A Réponse : Catalogue |
| {mmcMerchantId}/catalogs | GET | Utilisez pour obtenir une liste de catalogues à partir du magasin. Définissez {mmcMerchantId} sur l’ID du magasin MMC. |
Demande : N/A Réponse : Catalogues |
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 |
|---|---|
| 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 catalogue 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 catalogue 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 spécifiez pour la requête.
| Objet | Description |
|---|---|
| Catalogue | Définit un catalogue. |
| Catalogues | Définit la liste des catalogues. |
Catalog
Définit un catalogue.
| Nom | Valeur | Type | Nom de l’élément XML |
|---|---|---|---|
| Id | ID qui identifie de façon unique le catalogue dans le magasin. Ce champ est en lecture seule ; ne définissez pas ce champ. |
Long non signé | <Id> |
| isDefault | Valeur booléenne qui détermine si le catalogue est le catalogue par défaut du magasin. A la valeur true si le catalogue est le catalogue par défaut du magasin ; sinon, false. Lorsque vous créez un magasin, vous obtenez un catalogue par défaut dans lequel les produits sont écrits si vous ne spécifiez pas un autre catalogue. Ce champ est en lecture seule ; ne définissez pas ce champ. |
Valeur booléenne | <is_default> |
| isPublishingEnabled | Valeur booléenne qui détermine si Microsoft peut publier des produits à partir du catalogue. Définissez sur true si Microsoft peut publier des produits à partir du catalogue ; sinon, définissez-la sur false. Vous pouvez mettre à jour ce champ. Vous pouvez également utiliser ce champ pour tester votre application avant de la déployer en production. En définissant ce champ sur false, vous pouvez effectuer des appels de ressources produits sans modifier ou publier vos données de production. |
Valeur booléenne | <is_publishing_enabled> |
| Marché | Marché sur lequel les produits du catalogue sont publiés. NOTE: Tout le monde n’a pas encore cette fonctionnalité. Si ce n’est pas le cas, ne vous inquiétez pas. Voici les marchés possibles que vous pouvez spécifier.
Vous ne pouvez pas mettre à jour ce champ après avoir ajouté le catalogue au magasin. Dans la liste ci-dessus, de-DE est la valeur marchande que vous spécifiez ; n’incluez pas (Allemand-Allemagne) dans votre chaîne de marché. |
Chaîne | <Marché> |
| Nom | Nom du catalogue. Le nom peut contenir un maximum de 70 caractères. Vous pouvez mettre à jour ce champ. |
Chaîne | <name> |
Catalogues
Définit une liste de catalogues.
| Nom | Valeur | Type | Nom de l’élément XML |
|---|---|---|---|
| Catalogues | Liste des catalogues dans le magasin. | Catalog[] | <Catalogues> |
Codes d’état HTTP
Les requêtes peuvent retourner les codes de status HTTP suivants.
| Code d'état | Description |
|---|---|
| 200 | Opération réussie. |
| 201 | Le catalogue a été ajouté. |
| 204 | Le catalogue a été supprimé. |
| 400 | Demande incorrecte Une valeur de paramètre de requête n’est pas valide ou quelque chose dans le corps de la requête n’est pas valide. |
| 401 | Non autorisé Les informations d’identification de l’utilisateur ne sont pas valides. |
| 404 | Introuvable. |
| 500 | Erreur du serveur. |