Cómo comenzar

Recomendamos usar la biblioteca cliente con Apache Maven (o Gradle).

Cómo crear un nuevo proyecto de Maven/Gradle

Crea un nuevo proyecto de Maven/Gradle en el IDE que prefieras. Nuestros artefactos se publican en el repositorio central de Maven.

La dependencia de Maven es la siguiente:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>29.0.0</version>
</dependency>

La dependencia de Gradle es la siguiente:

implementation 'com.google.api-ads:google-ads:29.0.0'

También puedes compilar a partir del código fuente. Para los fines de esta guía, se supone que tienes una configuración de proyecto con las dependencias necesarias disponibles.

Obtén credenciales para autenticar con la API

El acceso a la API de Google Ads requiere credenciales de OAuth y un token de desarrollador de la API de Google Ads. En esta sección, se explica qué son, cómo se usan y cómo se obtienen.

Token del desarrollador (para acceder a la API)

El token de desarrollador está vinculado a una cuenta de administrador y se puede encontrar en la interfaz web de Google Ads.

Aunque el token de desarrollador está vinculado a una cuenta de administrador, no proporciona acceso a esa cuenta. En cambio, el token de desarrollador otorga acceso a la API en general, y el acceso a nivel de la cuenta se configura a través de OAuth.

Credenciales de OAuth (para acceder a las cuentas de Google Ads)

Para autorizar como usuarios de la Cuenta de Google con acceso a las cuentas de Google Ads, debes proporcionar un conjunto de credenciales de OAuth.

Hay dos flujos de OAuth que se usan generalmente: la app para computadoras de escritorio (instalada) o la aplicación web. La diferencia principal entre ambas es que las apps de escritorio deben abrir el navegador del sistema y proporcionar un URI de redireccionamiento local para manejar las respuestas del servidor de autorización de Google, mientras que las apps web pueden redireccionar un navegador arbitrario de terceros para completar la autorización y enviar las credenciales a tu servidor. La biblioteca también admite el flujo de cuenta de servicio menos utilizado.

Si autorizas el uso de tus propias credenciales (flujo de la app de escritorio)
Consulta el flujo de la aplicación para computadoras de escritorio de OAuth. Esto incluye todos los detalles que necesitas para autorizar con tus propias credenciales.
Si autorizas como usuario externo de Google (flujo web)
Consulta el flujo de aplicación web de OAuth. Aquí se muestra un ejemplo de cómo configurar la autorización de OAuth para usuarios arbitrarios de terceros.
Si autorizas como usuario de un dominio de Google Apps (flujo de la cuenta de servicio)
Consulta el flujo de cuentas de servicio de OAuth. Este es un ejemplo de cómo configurar una autorización de OAuth para usuarios de un dominio de Google Apps.

Si accedes a la cuenta de cliente de Google Ads a través de una cuenta de administrador de Google Ads, también debes especificar un ID de cliente de acceso como se describe a continuación.

ID de cliente de acceso (para acceder a las cuentas de Google Ads a través de una cuenta de administrador)

De manera opcional, especifica el ID de cliente de una cuenta de administrador que brinda acceso a la cuenta de entrega. Esto debe especificarse si tu acceso a la cuenta de cliente se realiza a través de una cuenta de administrador. No es necesario especificar todas las cuentas de administrador en la ruta al ID de cliente, solo el ID de administrador superior que utilizas para los permisos de acceso. Para obtener más detalles, consulta la documentación relacionada.

Configura la biblioteca cliente con tus credenciales

Puedes configurar la biblioteca cliente con un archivo de configuración, variables de entorno o de manera programática. En esta guía, usaremos el enfoque del archivo de configuración y nos enfocaremos en los flujos web y de escritorio. Por lo general, usar un archivo de configuración es un buen enfoque si solo tienes un conjunto de credenciales (por ejemplo, si administras cuentas en un único administrador).

Crea un archivo ~/ads.properties con el siguiente contenido:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE

Reemplaza los marcadores de posición por las credenciales que obtuviste en el paso anterior.

Además, si tu token de actualización es para una cuenta de administrador, debes especificar el ID de cliente de esta cuenta como el cliente de acceso:

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Valida las credenciales

Para asegurarnos de que todo esté configurado correctamente, ejecutaremos el ejemplo de GetCampaigns.

Primero, navega al directorio google-ads-examples.

$ cd google-ads-examples

En este ejemplo, se requiere un parámetro --customerId, en el que el valor es el ID de cliente de tu cuenta de Google Ads sin guiones.

Para ejecutarlo con Gradle, haz lo siguiente:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"

Explora otros ejemplos

El paquete examples en google-ads-examples contiene varios ejemplos útiles. La mayoría de los ejemplos requieren parámetros. Puedes pasar los parámetros como argumentos (recomendado) o editar los valores de INSERT_XXXXX_HERE en el código fuente. Para ver una declaración de uso de ejemplo, pasa --help como único argumento.

Con Gradle:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

También puedes usar la tarea listExamples en Gradle para enumerar todos los ejemplos, los ejemplos de un subdirectorio o los ejemplos en los que la descripción incluye un término de búsqueda.

# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'