Prise en main de Java avec l’API Bing Ads

Pour commencer à développer des applications API Bing Ads avec Java, vous pouvez commencer par les exemples fournis ou suivre l’une des procédures pas à pas pour une application web ou de bureau .

Vous aurez besoin d’informations d’identification d’utilisateur ayant accès à Microsoft Advertising en production ou en bac à sable. Pour l’environnement de production, vous aurez besoin d’un jeton de développeur de production. Tous les clients bac à sable peuvent utiliser le jeton de développeur de bac à sable universel, c’est-à-dire BBD37VB98. Pour plus d’informations, consultez Prise en main de l’API Bing Ads et dubac à sable.

Pour vous authentifier via OAuth, vous devez également inscrire une application et obtenir l’identificateur client correspondant. Vous devez également prendre note de la clé secrète client et de l’URI de redirection si vous développez une application web. Pour plus d’informations sur l’inscription d’une application en production et le flux d’octroi de code d’autorisation, consultez Authentification avec OAuth et Authentification avec les SDK. Bien qu’en production, vous deviez utiliser votre propre ID d’application (alias ID client), tous les clients Microsoft Advertising peuvent utiliser l’ID client public « Tutorial Sample App » dans le bac à sable, c’est-à-dire 00001111-aaaa-2222-bbbb-3333cccc4444. Pour plus d’informations, consultez Bac à sable.

Installer le kit de développement logiciel (SDK)

Le kit de développement logiciel (SDK) Java Bing Ads dépend des bibliothèques répertoriées dans le référentiel Maven.

Lorsque vous créez un projet Maven et incluez l’artefact Maven microsoft.bingads comme indiqué ci-dessous, des dépendances supplémentaires sont installées automatiquement. Si vous n’utilisez pas de projet Maven, vous devez inclure la version correcte de chaque dépendance. Pour plus d’informations, consultez la procédure pas à pas : Application web de l’API Bing Ads en Java ou Procédure pas à pas : Application de bureau de l’API Bing Ads dans des exemples d’application Java.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  ...
  <dependencies>
    <dependency>
      <groupId>com.microsoft.bingads</groupId>
      <artifactId>microsoft.bingads</artifactId>
      <version>13.0.10</version>
    </dependency>
  </dependencies>
</project>

Procédures pas à pas

Une fois que le kit de développement logiciel (SDK) Bing Ads Java est installé, vous pouvez parcourir les exemples de code d’API Bing Ads, télécharger les exemples à partir de GitHub ou suivre l’une des procédures pas à pas d’une application web ou de bureau .

Configuration du bac à sable

Pour utiliser l’environnement bac à sable , créez un fichier texte nommé bingads.properties dans le répertoire racine source de votre projet, par exemple ProjectName\src\bingads.properties et ajoutez le texte suivant. Voici le contenu complet du fichier bingads.properties . Si le paramètre d’environnement de bac à sable est incorrect ou manquant, l’environnement par défaut est en mode production.

environment=Sandbox

Vous pouvez également définir l’environnement de chaque ServiceClient individuellement comme suit.

CustomerService = new ServiceClient<ICustomerManagementService>(
    authorizationData,
    ApiEnvironment.SANDBOX,
    ICustomerManagementService.class
);

Que vous définissiez l’environnement ServiceClient globalement ou individuellement, vous devez également définir séparément l’environnement OAuth en bac à sable.

final OAuthDesktopMobileAuthCodeGrant oAuthDesktopMobileAuthCodeGrant = new OAuthDesktopMobileAuthCodeGrant(
    ClientId, 
    ApiEnvironment.SANDBOX
);

Les applications web avec une clé secrète client et un URI de redirection personnalisé doivent utiliser OAuthWebAuthCodeGrant comme suit.

OAuthWebAuthCodeGrant oAuthWebAuthCodeGrant = new OAuthWebAuthCodeGrant(
    ClientId, 
    ClientSecret, 
    new URL(RedirectUri),
    ApiEnvironment.SANDBOX
);

Consignez les en-têtes de requête et de réponse dans la console. TrackingId est inclus dans les en-têtes de réponse.

MessageHandler.getInstance().setTraceOn(true);

Personnalisation du client HTTP

Pour la plupart des applications, nous vous recommandons d’utiliser l’implémentation du client HTTP par défaut dans le Kit de développement logiciel (SDK) Java Bing Ads, qui s’appuie sur le client Apache CXF JAX-RS. Vous pouvez personnaliser le client HTTP pour configurer certaines fonctionnalités, telles que l’activation de la compression si vous utilisez une autre implémentation JAX-RS, la modification du délai d’expiration HTTP, la configuration du proxy ou d’autres paramètres.

Pour ce faire, vous pouvez créer un objet personnalisé HttpClientProvider et le transmettre avant d’effectuer GlobalSettings.setHttpClientProvider() des appels de service. Par exemple :

GlobalSettings.setHttpClientProvider(new HttpClientProvider() 
{ 
    @Override 
    protected ClientBuilder configureClientBuilder(ClientBuilder clientBuilder) { 
        return super.configureClientBuilder(clientBuilder) 
            // override default connect timeout 
            .connectTimeout(90, TimeUnit.SECONDS)
            // override default read timeout
            .readTimeout(5, TimeUnit.MINUTES) 
            // enable compression (if using Jersey client)
            .register(org.glassfish.jersey.message.GZipEncoder.class)
            .register(org.glassfish.jersey.client.filter.EncodingFilter.class);
    }
}); 

Journalisation des appels de service

Pour activer la journalisation des messages de requête et de réponse, vous pouvez définir la com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump propriété sur true:

System.setProperty("com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump", "true");

Par défaut, le SDK Java de Bing Ads utilise Apache CXF pour effectuer des appels de service, qui s’appuie sur Simple Logging Facade for Java pour l’écriture de ses journaux. Pour afficher les messages enregistrés dans la console, vous pouvez ajouter l’implémentation slf4j-simple aux dépendances de votre application. Par exemple :

<dependency> 
    <groupId>org.slf4j</groupId> 
    <artifactId>slf4j-simple</artifactId> 
    <version>2.0.12</version> 
</dependency> 

Voir aussi

Bibliothèques clientes d’API Bing Ads
Exemples de codes d’API Microsoft Advertising
Adresses du service web de l’API Microsoft Advertising
Gestion des erreurs et exceptions de service
Bac à sable