Introducción al uso de Java con la API de Bing Ads

Para empezar a desarrollar aplicaciones de API de Bing Ads con Java, puede empezar con los ejemplos proporcionados o seguir uno de los tutoriales de una aplicación web o de escritorio .

Necesitarás credenciales de usuario con acceso a Microsoft Advertising, ya sea en producción o en espacio aislado. Para el entorno de producción, necesitará un token de desarrollador de producción. Todos los clientes de espacio aislado pueden usar el token de desarrollador de espacio aislado universal, es decir, BBD37VB98. Para obtener más información, consulta Introducción a la API y elespacio aislado de Microsoft Advertising

Para autenticarse a través de OAuth, también debe registrar una aplicación y obtener el identificador de cliente correspondiente. También debe anotar el secreto de cliente y el URI de redireccionamiento si está desarrollando una aplicación web. Para obtener más información sobre el registro de una aplicación en producción y el flujo de concesión de código de autorización, consulte Autenticación con OAuth y Autenticación con los SDK. Aunque en producción debes usar tu propio id. de aplicación (también conocido como id. de cliente), todos los clientes de Microsoft Advertising pueden usar el id. de cliente público "Aplicación de ejemplo de tutorial" en el espacio aislado, es decir, 00001111-aaaa-2222-bbbb-3333cccc4444. Para obtener más información, consulte Espacio aislado.

Instalar el SDK

El SDK de Java de Bing Ads depende de las bibliotecas enumeradas en el repositorio de Maven.

Al crear un proyecto Maven e incluir el artefacto Maven microsoft.bingads como se muestra a continuación, se instalan automáticamente dependencias adicionales. Si no usa un proyecto Maven, debe incluir la versión correcta de cada dependencia. Para obtener más información, consulte el Tutorial: Aplicación web de la API de Bing Ads en Java o Tutorial: Ejemplos de aplicación de escritorio de la API de Bing Ads en 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>

Tutoriales

Una vez instalado el SDK de Java de Bing Ads, puede examinar los ejemplos de código de la API de Bing Ads, descargar los ejemplos de GitHub o seguir uno de los tutoriales de aplicación de una aplicación web o de escritorio .

Configuración del espacio aislado

Para usar el entorno de Sandbox , cree un nuevo archivo de texto llamado bingads.properties dentro del directorio raíz de origen del proyecto, por ejemplo, ProjectName\src\bingads.properties y agregue el siguiente texto. A continuación se muestra el contenido completo del archivo bingads.properties . Si falta el formato o la configuración del entorno de espacio aislado es incorrecta, el entorno predeterminado es el de producción.

environment=Sandbox

También puede establecer el entorno de cada ServiceClient individualmente como se indica a continuación.

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

Ya sea que establezca el entorno de ServiceClient global o individualmente, por separado también deberá establecer el entorno de OAuth en espacio aislado.

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

Las aplicaciones web con un secreto de cliente y un URI de redirección personalizado deben usar OAuthWebAuthCodeGrant como se indica a continuación.

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

Registre los encabezados de solicitud y respuesta en la consola. TrackingId se incluye en los encabezados de respuesta.

MessageHandler.getInstance().setTraceOn(true);

Personalización del cliente HTTP

Para la mayoría de las aplicaciones, recomendamos usar la implementación de cliente HTTP predeterminada en el SDK de Java de Bing Ads, que se basa en el cliente Apache CXF JAX-RS. Es posible que desee personalizar el cliente HTTP para configurar algunas características, como habilitar la compresión si utiliza una implementación JAX-RS diferente, para cambiar el tiempo de espera HTTP, la configuración del proxy u otras opciones.

Para ello, puede crear un objeto personalizado HttpClientProvider al que se puede pasar antes de realizar llamadas de GlobalSettings.setHttpClientProvider() servicio. Por ejemplo:

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

Llamadas al servicio de registro

Para habilitar el registro de los mensajes de solicitud y respuesta, puede establecer la com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump propiedad en true:

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

De forma predeterminada, el SDK de Java de Bing Ads usa Apache CXF para realizar llamadas de servicio, que se basa en Simple Logging Facade for Java para escribir sus registros. Para generar mensajes registrados en la consola, puede agregar la implementación a las dependencias de la slf4j-simple aplicación. Por ejemplo:

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

Consulta también

Bibliotecas cliente de la API de Bing Ads
Ejemplos de código de API de Bing Ads
Direcciones de servicios web de la API de Microsoft Advertising
Control de errores y excepciones de servicio
Espacio aislado