Partager via

Stocker la ressource

  • Article

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 Store pour gérer les magasins appartenant à l’utilisateur. Vous pouvez ajouter des magasins, obtenir un magasin spécifique ou obtenir tous les magasins appartenant à l’utilisateur. En savoir plus.

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 ajouter un magasin ou obtenir une liste de magasins appartenant à l’utilisateur, utilisez le point de terminaison suivant :

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

Modèles

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

Modèle /stores

Verbe HTTP Description Ressource
POST Ajoute un magasin. Les limites suivantes s’appliquent et sont susceptibles d’être modifiées :
  • Un client peut ajouter un maximum de 14 magasins qui spécifient la même URL de magasin.
  • Un client peut ajouter un maximum de 1 024 magasins.
 Demande : StoreCreate
Réponse : Store
GET Obtient la liste des magasins appartenant à l’utilisateur. Demande : N/A
Réponse : StoreCollection

Modèle /stores/{merchantId}

Verbe HTTP Description Ressource
GET Obtient le magasin spécifié. Définissez {merchantId} sur l’ID du magasin que vous souhaitez obtenir. Demande : N/A
Réponse : Store

Paramètres de requête

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

Paramètre Description
dry-run Facultatif. Utilisez pour tester ou déboguer votre application. Les appels qui incluent ce paramètre n’affectent pas les données de production (les magasins ne sont pas ajoutés) ; Toutefois, la réponse contient toutes les erreurs générées par l’appel.

Tenez compte des limitations suivantes lors de l’utilisation de ce paramètre.
  • Les opérations d’ajout ne retournent pas d’ID.
  • Le service ne génère pas ou ne retourne pas de messages d’erreur secondaires tels que la qualité des données, les problèmes éditoriaux et les validations liées à la base de données.
Pour plus d’informations sur le test de votre application, consultez Bac à sable.

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.
Store Définit un magasin dans Microsoft Merchant Center.
StoreCollection Définit une collection de magasins dans Microsoft Merchant Center.
StoreCreate Définit un magasin à ajouter à Microsoft Merchant Center.
StoreStatus Définit la status du magasin.

Error

Définit une erreur.

Nom Valeur Type
code Raison de l’échec de la demande. Par exemple, le code est InvalidStoreNameErr si la validation du storeName champ a échoué. 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[]

Store

Définit un magasin dans Microsoft Merchant Center.

Nom Valeur Type
isBlockAggregator Valeur booléenne qui indique si vous souhaitez empêcher les agrégateurs de diffuser des publicités de votre magasin. Les agrégateurs regroupent les offres de produits de plusieurs entreprises, souvent non liées. Par défaut, les agrégateurs peuvent inclure votre catalogue dans leurs annonces.

Est vrai si vous souhaitez empêcher vos produits d’apparaître dans les annonces des agrégateurs sur Bing. Si vous avez deux magasins (un pour le États-Unis et un pour le Royaume-Uni) qui utilisent http://www.contoso.com et que l’un d’eux bloque les agrégateurs, alors les deux magasins agrégateurs de blocs.		 Valeur booléenne
isSslCheckout Valeur booléenne qui indique si votre magasin est activé par SSL. Tous les magasins doivent avoir des pages de connexion et de validation SSL. Est vrai si le site web de votre magasin est activé par SSL. Valeur booléenne
merchantId ID du magasin. Long non signé
notificationEmail Liste des destinataires auxquels recevoir des e-mails de notification. Les e-mails vous avertissent quand le magasin est approuvé ou s’il y a des erreurs de validation avec le magasin. String[]
notificationLanguage Langue utilisée pour écrire les e-mails de notification. La langue se présente sous la forme, <langue-pays></région>. Par exemple, en-US. String
storeDescription Description qui décrit l’utilisation du magasin. Chaîne
Storename Nom du magasin. Chaîne
storeStatus La status du magasin. StoreStatus
storeUrl URL de destination du magasin. L’URL de destination est la page web vers laquelle les utilisateurs sont dirigés lorsqu’ils cliquent sur votre annonce. String

StoreCollection

Définit une liste de magasins.

Nom Valeur Type
Magasins Liste des magasins appartenant à l’utilisateur. Store[]

StoreCreate

Définit un magasin à ajouter à Microsoft Merchant Center.

Nom Valeur Type Requis
isBlockAggregator Valeur booléenne qui indique si vous souhaitez empêcher les agrégateurs de diffuser des publicités de votre magasin. Les agrégateurs regroupent les offres de produits de plusieurs entreprises, souvent non liées. Par défaut, les agrégateurs peuvent inclure votre catalogue dans leurs annonces.

Définissez sur true pour empêcher vos produits d’apparaître dans les annonces des agrégateurs sur Bing. Si vous avez deux magasins (un pour le États-Unis et un pour le Royaume-Uni) qui utilisent http://www.contoso.com et que l’un d’eux bloque les agrégateurs, alors les deux magasins agrégateurs de blocs.

Par défaut est faux.		 Booléen Non
isSslCheckout Valeur booléenne qui indique si votre magasin est activé par SSL. Tous les magasins doivent avoir des pages de connexion et de validation SSL. Définissez sur true si le site web de votre magasin est activé par SSL. Si la valeur est false , le magasin est désapprouve.

Par défaut est vrai.		 Booléen Non
notificationEmail Liste des destinataires auxquels recevoir des e-mails de notification. Les e-mails vous avertissent quand le magasin est approuvé ou s’il y a des erreurs de validation avec le magasin. Le nombre maximal d’adresses e-mail que vous pouvez spécifier est de 14. String[] Oui
notificationLanguage Langue utilisée pour écrire les e-mails de notification. La langue se présente sous la forme, <langue-pays></région>. Voici les valeurs possibles qui ne respectent pas la casse que vous pouvez spécifier.
  • en-US (anglais-États-Unis)
  • en-AU (Anglais-Australie)
  • en-GB (Anglais-Royaume-Uni)
  • fr-FR (Français-France)
  • de-DE (Allemand-Allemagne)
  • ja-JP (Japonais-Japon)
 Chaîne Oui
storeDescription Description qui décrit l’utilisation du magasin. La description est limitée à un maximum de 350 caractères et peut contenir uniquement des caractères alphanumériques ([a-zA-Z0-9]). Chaîne Non
Storename Nom du magasin. Étant donné que le nom du magasin apparaît dans vos annonces de produits, veillez à utiliser un nom qui représente précisément votre site web. Le nom doit :
  • Être unique au sein de Bing Merchant Center
  • Ne pas contenir plus de 70 caractères
  • Contiennent uniquement des caractères alphanumériques ([a-zA-Z0-9])
 Chaîne Oui
storeUrl URL de destination du magasin. L’URL de destination est la page web vers laquelle les utilisateurs sont dirigés lorsqu’ils cliquent sur votre annonce. L’URL ne doit pas rediriger vers un autre emplacement. L’URL doit être bien formée et comporter un maximum de 1 024 caractères. Vous devez vérifier et revendiquer l’URL de votre site web. Les magasins sont désapprouvés si Microsoft ne peut pas vérifier que votre site web est conforme au protocole SSL. Les sites web des commerçants doivent avoir des pages de connexion et de paiement SSL. Vérifiez que vos certificats SSL sont valides. Chaîne Oui

StoreStatus

Définit la status du magasin.

Nom Valeur Type
message La raison pour laquelle le magasin a été désapprouve. L’objet inclut ce champ uniquement si status est Désapprobé. Chaîne
status La status du magasin. Voici les valeurs possibles.
  • Approuvé
  • Désapprouvé
  • ManualReview
Si le magasin est désapprouvré, consultez message pour la raison.

Un magasin initialement approuvé automatiquement peut passer de Approuvé à ManualReview. Vous ne pouvez pas ajouter de produits à un magasin qui fait l’objet d’une révision manuelle et les produits du magasin ne seront pas servis.

Selon la raison de la désapprobation, vous pouvez résoudre le problème à l’aide de l’application Microsoft Ads. Sinon, vous devez créer un magasin avec les valeurs appropriées.		 String

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 magasin a été ajouté avec succès.
400 Demande incorrecte Le corps de la requête POST contient probablement des données non valides ou est mal formé.
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
AdultAdvertiserErr Les annonceurs adultes ne peuvent pas créer de magasins.
DomainNotOwnedByCustomerErr Le domaine spécifié dans le champ storeUrl n’appartient pas au client. Assurez-vous que le client a vérifié qu’il est propriétaire du domaine.
DuplicateStoreNameErr Il existe un autre magasin avec le nom de magasin spécifié ; les noms des magasins doivent être uniques avec Microsoft Merchant Center.
ExceededMaxStoresForCustomerErr Le client a dépassé le nombre de magasins qu’il peut créer. Pour connaître les limites, consultez Ajouter un magasin POST.
ExceededMaxStoresForDestinationUrlErr Le client a dépassé le nombre de magasins qu’il peut créer à l’aide de la même URL de destination. Pour connaître les limites, consultez Ajouter un magasin POST.
InvalidStoreDescriptionErr La description du magasin n’est pas valide. Pour connaître les limites, consultez storeDescription.
InvalidStoreDestinationUrlErr L’URL de destination du magasin que vous avez spécifiée dans le champ storeUrl n’est pas valide.
InvalidStoreNameErr Le nom du magasin n’est pas valide. Pour connaître les limites, consultez storeName.
MarketNotSupportedErr Le marché que vous avez spécifié dans le champ notificationLanguage n’est pas valide.
NoDomainsFoundForCustomerErr Il n’existe aucun domaine vérifié appartenant au client.