Langue

Prise en main de l’API Bing Ads

Tout utilisateur Microsoft Advertising disposant d’un jeton de développeur peut commencer à utiliser l’API Bing Ads. Pour les annonceurs qui placent un grand nombre d’annonces ou les développeurs qui créent des outils publicitaires, l’API Bing Ads fournit une interface de programme à Microsoft Advertising.

Vous pouvez développer votre application API Bing Ads dans n’importe quelle langue prenant en charge les services web. Pour commencer avec un SDK spécifique, consultez Prise en main de C# | Java | PHP | Python.

Obtenir un jeton d’accès utilisateur

Prenons l’utilisateur auquel vous voulez vous connecter, par exemple. example@contoso.com L’API Bing Ads n’accepte pas cette adresse de courrier et ce mot de passe. Au lieu de cela, vous devez définir l’élément d’en-tête AuthenticationToken qui contient un jeton d’accès utilisateur. Vous pouvez imaginer un jeton d’accès comme représentant un nom d’utilisateur et un mot de passe.

Comment obtenir un jeton d’accès pour un utilisateur ? En tant que développeur d’applications, vous utilisez une URL d’autorisation Microsoft pour inviter l’utilisateur Microsoft Advertising à donner son consentement. Une fois qu’un utilisateur a donné son consentement, vous pouvez obtenir un jeton d’accès et agir en son nom. Le jeton d’accès représente les informations d’identification de l’utilisateur qui a accès à un ou plusieurs comptes Microsoft Advertising.

  1. Inscrire une application

  2. Demander le consentement de l’utilisateur pour que votre application gère ses comptes Microsoft Advertising

  3. Obtenir des jetons d’accès et d’actualisation

  4. Effectuer votre premier appel d’API

Conseil

Pour plus d’informations sur l’obtention de jetons d’accès et d’actualisation à l’aide des SDK Bing Ads, consultez Authentification avec les SDK.

Obtenir un jeton de développeur

Pour utiliser les API Bing Ads, vous devez disposer d’un jeton de développeur et d’informations d’identification d’utilisateur valides. Si vous n’avez pas encore de compte Microsoft Advertising, vous pouvez vous inscrire via l’application web Microsoft Advertising.

Remarque

Le bac à sable et les environnements de production utilisent des informations d’identification distinctes. Vous pouvez créer un compte Sandboxici. Tout le monde peut utiliser le jeton de développeur de bac à sable universel, c’est-à-dire BBD37VB98.

Vous pouvez suivre ces étapes pour obtenir un jeton de développeur pour la production.

Remarque

À compter du 31 mai 2025, la page du portail des développeurs sera déconseillée et remplacée par une nouvelle version ici. Veuillez mettre à jour vos signets et commencer à utiliser la nouvelle page pour éviter toute perturbation. Pour toute question ou assistance, contactez le support technique.

  1. Connectez-vous avec des informations d’identification Super Administration à l’onglet de compte du portail Microsoft Advertising Developer.
  2. Choisissez l’utilisateur que vous souhaitez associer au jeton de développeur. En règle générale, une application n’a besoin que d’un seul jeton universel, quel que soit le nombre d’utilisateurs pris en charge.
  3. Cliquez sur le bouton Demander un jeton .

Le jeton de développeur universel peut être utilisé pour s’authentifier avec des informations d’identification d’utilisateur Microsoft Advertising. Vous pouvez utiliser le même jeton de développeur universel, que votre application soit utilisée par un ou plusieurs utilisateurs Microsoft Advertising. Depuis juillet 2019, il s’agit du type de jeton par défaut.

Le jeton de développeur à utilisateur unique ne peut être utilisé que pour authentifier un seul utilisateur afin d’accéder à un seul client. Ce type de jeton a été déconseillé au profit du jeton universel. Si vous voyez toujours qu’un seul jeton d’utilisateur est attribué à l’un de vos utilisateurs, vous pouvez sélectionner « Mettre à niveau vers universel ».

Un jeton de développeur permet un accès par programme aux comptes autorisés pour un utilisateur. L’obtention d’un jeton de développeur pour l’accès à l’API n’accorde pas d’autorisations supplémentaires aux comptes Microsoft Advertising. Chaque utilisateur Microsoft Advertising se voit attribuer un rôle, par exemple, Super Administration ou Gestionnaire de campagnes des annonceurs pour chaque client auquel il peut accéder. Avec un jeton de développeur, les mêmes comptes disponibles dans l’application web Microsoft Advertising sont disponibles pour l’utilisateur par programme via l’API.

Où utiliser les informations d’identification d’API

Lorsque vous appelez une opération de service telle que GetCampaignsByAccountId, vous devez spécifier des éléments d’en-tête de demande tels que DeveloperToken, CustomerId et CustomerAccountId.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">GetCampaignsByAccountId</Action>
    <ApplicationToken i:nil="false">ValueHere</ApplicationToken>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCampaignsByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountId>ValueHere</AccountId>
      <CampaignType>ValueHere</CampaignType>
    </GetCampaignsByAccountIdRequest>
  </s:Body>
</s:Envelope>

Si vous utilisez l’un des SDK Microsoft Advertising, les éléments d’en-tête de demande sont définis à l’aide de AuthorizationData. Pour plus d’informations sur la bibliothèque d’authentification du Kit de développement logiciel ( SDK), consultez Authentification avec les kits de développement logiciel (SDK).

var authorizationData = new AuthorizationData
{
    Authentication = <AuthenticationGoesHere>, 
    CustomerId = <CustomerIdGoesHere>,
    AccountId = <AccountIdGoesHere>,
    DeveloperToken = "<DeveloperTokenGoesHere>"
};

static AuthorizationData authorizationData = new AuthorizationData();
authorizationData.setAuthentication(<AuthenticationGoesHere>);
authorizationData.setCustomerId("<CustomerIdGoesHere>");
authorizationData.setAccountId("<AccountIdGoesHere>");
authorizationData.setDeveloperToken("<DeveloperTokenGoesHere>");

$authorizationData = (new AuthorizationData())
    ->withAuthentication($AuthenticationGoesHere)
    ->withCustomerId($CustomerIdGoesHere)
    ->withAccountId($AccountIdGoesHere)
    ->withDeveloperToken($DeveloperTokenGoesHere);

authorization_data = AuthorizationData(
    authentication = <AuthenticationGoesHere>,
    customer_id = <CustomerIdGoesHere>,
    account_id = <AccountIdGoesHere>,
    developer_token = '<DeveloperTokenGoesHere>'
)

Obtenir vos ID de compte et client

Pour obtenir l’ID client et l’ID de compte d’un utilisateur, vous pouvez vous connecter à l’application web Microsoft Advertising et cliquer sur l’onglet Campagnes . L’URL contient une paire clé/valeur CID dans la chaîne de requête qui identifie votre ID client et une paire clé/valeur d’aide qui identifie votre ID de compte. Par exemple, https://ui.ads.microsoft.com/campaign/Campaigns.m?cid=FindCustomerIdHere& aid=FindAccountIdHere#/customer/FindCustomerIdHere/account/FindAccountIdHere/campaign.

Conseil

Ne confondez pas le numéro de compte avec l’identificateur du compte. Le numéro de compte est le numéro de compte généré par le système qui est utilisé pour identifier le compte dans l’application web Microsoft Advertising. Le numéro de compte est au format xxxxxxxx, où xxxxxxxx est une série de huit caractères alphanumériques. Les demandes de service d’API utilisent uniquement l’identificateur de compte et n’utilisent jamais le numéro de compte.

Avec l’API de gestion des clients, vous pouvez obtenir les identifiants de client et de compte pour chaque utilisateur authentifié.

Appelez GetUser avec vos informations d’identification Microsoft Advertising et DeveloperToken. Dans le corps, définissez le UserId nil. La réponse inclura un objet User contenant l’UserId.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:ApplicationToken i:nil="true" xmlns:h="https://bingads.microsoft.com/Customer/v13" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
    <h:AuthenticationToken xmlns:h="https://bingads.microsoft.com/Customer/v13">OAuthAccessTokenGoesHere</h:AuthenticationToken>
    <h:DeveloperToken xmlns:h="https://bingads.microsoft.com/Customer/v13">DeveloperTokenGoesHere</h:DeveloperToken>
  </s:Header>
  <s:Body>
    <GetUserRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserId i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
    </GetUserRequest>
  </s:Body>
</s:Envelope>

Appelez ensuite SearchAccounts avec le UserId retourné à l’étape précédente. Le ou les comptes de l’annonceur renvoyés comprendront les identifiants de compte et de client.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:ApplicationToken i:nil="true" xmlns:h="https://bingads.microsoft.com/Customer/v13" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
    <h:AuthenticationToken xmlns:h="https://bingads.microsoft.com/Customer/v13">OAuthAccessTokenGoesHere</h:AuthenticationToken>
    <h:DeveloperToken xmlns:h="https://bingads.microsoft.com/Customer/v13">DeveloperTokenGoesHere</h:DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:a="https://bingads.microsoft.com/Customer/v13/Entities" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Predicate>
          <a:Field>UserId</a:Field>
          <a:Operator>Equals</a:Operator>
          <a:Value>UserIdGoesHere</a:Value>
        </a:Predicate>
      </Predicates>
      <Ordering i:nil="true" xmlns:a="https://bingads.microsoft.com/Customer/v13/Entities" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
      <PageInfo xmlns:a="https://bingads.microsoft.com/Customer/v13/Entities" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Index>0</a:Index>
        <a:Size>10</a:Size>
      </PageInfo>
    </SearchAccountsRequest>
  </s:Body>
</s:Envelope>

Conseil

Voir Exemple de code de recherche de comptes d’utilisateurs pour un exemple de code qui retourne des comptes pour l’utilisateur authentifié actuel.

Référence des éléments d’en-tête

Les opérations du service d’API Bing Ads utilisent le protocole SOAP (Simple Object Access Protocol) pour échanger les messages de demande et de réponse avec l’opération de service. Pour plus d’informations, consultez Protocole des services API Microsoft Ads.

Chaque demande SOAP doit inclure les en-têtes SOAP suivants, qui contiennent les informations d’identification de l’utilisateur.

Remarque

Les éléments CustomerAccountId et CustomerId ne s’appliquent pas aux services de facturation et de gestion des clients.

Élément Description Type de données
Jeton d’application Cet élément d’en-tête n’est pas utilisé et doit être ignoré. chaîne
AuthenticationToken Jeton d’accès OAuth qui représente un utilisateur de compte Microsoft disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. chaîne
CustomerAccountId (en anglais seulement) Identificateur du compte propriétaire des entités de la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont requis. Cet élément est requis pour la plupart des opérations de service et, de manière recommandée, vous devez toujours le définir. chaîne
ID client Identifiant du client qui contient et possède le compte. Si vous gérez le compte d’un autre client, vous devez utiliser cet ID client plutôt que votre propre ID client. Cet élément est requis pour la plupart des opérations de service et, de manière recommandée, vous devez toujours le définir. chaîne
Jeton de développeur Jeton de développeur utilisé pour accéder à l’API Bing Ads. chaîne

Besoin d’aide ?

Pour obtenir des conseils sur la résolution des problèmes, reportez-vous à la section Gestion des erreurs et exceptions de service.

Le forum Microsoft Q&A est disponible pour la communauté des développeurs afin de poser et de répondre à des questions sur les API Bing Ads et les scripts Microsoft Advertising. Microsoft surveille les forums et répond aux questions auxquelles la communauté n’a pas encore répondu.

Importante

Pour vous assurer que votre question s’affiche, identifiez-la avec « advertising-api ».

Si l’enquête implique des informations personnelles ou de compte sensibles, ou si vous ne trouvez pas les informations dont vous avez besoin pour résoudre votre problème via Microsoft Q&A, contactez le support Microsoft Advertising. Pour résoudre le problème efficacement, fournissez un support avec les détails demandés dans Support de maintenance.

Voir aussi

Vue d’ensemble de l’API Microsoft Advertising
Concepts de l’API Microsoft Advertising

  • Last updated on