Introduzione all'utilizzo di Java con l'API di Bing Ads

Importante

Si consiglia di utilizzare Java 11 o versioni successive. La versione minima di Java supportata è la 1.8. È necessario escludere CXF dalle dipendenze quando si utilizza 1.8. Puoi creare questo file di esempio con Maven.

Per iniziare a sviluppare applicazioni API di Bing Ads con Java, è possibile iniziare con gli esempi forniti o seguire una delle procedure dettagliate per un'applicazione Web o desktop .

Avrai bisogno di credenziali utente con accesso a Microsoft Advertising in ambiente di produzione o sandbox. Per l'ambiente di produzione è necessario un token di sviluppo di produzione. Tutti i client sandbox possono usare il token sviluppatore sandbox universale, ad esempio BBD37VB98. Per ulteriori informazioni, vedere Introduzione all'API e alla sandbox di Bing Ads.

Per eseguire l'autenticazione tramite OAuth, è anche necessario registrare un'applicazione e ottenere l'identificatore client corrispondente. Se si sviluppa un'applicazione Web, è inoltre necessario prendere nota del segreto client e dell'URI di reindirizzamento. Per ulteriori informazioni sulla registrazione di un'applicazione in produzione e sul flusso di concessione del codice di autorizzazione, vedere Autenticazione con OAuth e Autenticazione con gli SDK. Anche se nell'ambiente di produzione è necessario utilizzare il proprio ID applicazione (detto anche ID client), tutti i clienti di Microsoft Advertising possono utilizzare l'ID client pubblico "App di esempio di esercitazione" nella sandbox, ad esempio 00001111-aaaa-2222-bbbb-3333cccc4444. Per altre informazioni, vedi Sandbox.

Installare l'SDK

Java SDK di Bing Ads dipende dalle librerie elencate nel repository Maven.

Quando si crea un progetto Maven e si include l'artefatto Maven microsoft.bingads come illustrato di seguito, le dipendenze aggiuntive vengono installate automaticamente. Se non si usa un progetto Maven, è necessario includere la versione corretta di ogni dipendenza. Per ulteriori informazioni, vedere Procedura dettagliata: applicazione Web API Bing Ads in Java o Procedura dettagliata: applicazione desktop API Bing Ads in Java esempi.

<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>

Nota

La versione 13.0.10 è inclusa come esempio. Per informazioni dettagliate sulla versione più recente della dipendenza dell'SDK, consultare l'README.md GitHub Java SDK di Bing Ads.

Procedure dettagliate

Dopo aver installato Java SDK di Bing Ads, è possibile sfogliare gli esempi di codice dell'API di Bing Ads, scaricare gli esempi da GitHub o seguire una delle procedure dettagliate per un'applicazione Web o desktop .

Configurazione della sandbox

Per usare l'ambiente sandbox , creare un nuovo file di testo denominato bingads.properties all'interno della directory radice di origine del progetto, ad esempio ProjectName\src\bingads.properties e aggiungere il testo seguente. Di seguito è riportato il contenuto completo del file bingads.properties . Se l'impostazione dell'ambiente sandbox non è valida o è mancante, l'ambiente predefinito è l'ambiente di produzione.

environment=Sandbox

È inoltre possibile impostare l'ambiente per ogni ServiceClient singolarmente come indicato di seguito.

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

Indipendentemente dal fatto che si imposti l'ambiente ServiceClient a livello globale o singolarmente, separatamente sarà necessario impostare anche l'ambiente OAuth su sandbox.

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

Le applicazioni Web con segreto client e URI di reindirizzamento personalizzato devono usare OAuthWebAuthCodeGrant come indicato di seguito.

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

Registra le intestazioni di richiesta e risposta nella console. TrackingId è incluso nelle intestazioni della risposta.

MessageHandler.getInstance().setTraceOn(true);

Personalizzazione del client HTTP

Per la maggior parte delle applicazioni, è consigliabile utilizzare l'implementazione client HTTP predefinita nell'SDK Java di Bing Ads, che si basa sul client Apache CXF JAX-RS. È possibile personalizzare il client HTTP per configurare alcune funzionalità, ad esempio l'abilitazione della compressione se si utilizza un'implementazione JAX-RS diversa, per modificare il timeout HTTP, la configurazione del proxy o altre impostazioni.

A tale scopo, è possibile creare un oggetto personalizzato HttpClientProvider e passarlo prima di effettuare chiamate al GlobalSettings.setHttpClientProvider() servizio. Ad esempio:

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);
    }
});

Registrazione delle chiamate al servizio

Per abilitare la registrazione per i messaggi di richiesta e risposta, è possibile impostare la com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump proprietà su true:

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

Per impostazione predefinita, Bing Ads Java SDK utilizza Apache CXF per effettuare chiamate al servizio, che si basa su Simple Logging Facade per Java per la scrittura dei log. Per inviare messaggi registrati alla console, è possibile aggiungere l'implementazione slf4j-simple alle dipendenze dell'applicazione. Ad esempio:

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

Vedere anche

Librerie client dell'API di Microsoft Advertising
Esempi di codice API di Microsoft Advertising
Indirizzi dei servizi Web dell'API di Microsoft Advertising
Gestione degli errori e delle eccezioni del servizio
Sandbox

  • Ultimo aggiornamento: