Recomendamos usar la biblioteca cliente con Apache Maven (o Gradle).
Crea un nuevo proyecto de Maven/Gradle
Crea un nuevo proyecto de Maven/Gradle en el IDE que elijas. 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>23.0.0</version>
</dependency>
La dependencia de Gradle es la siguiente:
implementation 'com.google.api-ads:google-ads:23.0.0'
También puedes compilar desde la fuente. Para los fines de esta guía, supondremos que tienes una configuración de proyecto con las dependencias necesarias disponibles.
Obtén credenciales para autenticar con la API
Para acceder a la API de Google Ads, se requieren 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 IU de Google Ads. Para obtener más detalles, consulta esta guía.
Credenciales de OAuth (para acceder a las cuentas de Google Ads)
Para autorizarte como usuario de una 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 suelen usar: la app de escritorio (instalada) o la app web. La diferencia principal entre ambos es que las apps de escritorio deben abrir el navegador del sistema y proporcionar un URI de redireccionamiento local para controlar las respuestas del servidor de autorización de Google, mientras que las apps web pueden redireccionar un navegador de terceros arbitrario para completar la autorización y enviar las credenciales al servidor. La biblioteca también admite el flujo de cuentas de servicio menos usado.
- Si autoriza con sus propias credenciales (flujo de aplicación para computadoras de escritorio)
- Consulta el flujo de la app de escritorio de OAuth. Esto incluye todos los detalles que necesitas para autorizar con tus propias credenciales.
- Si la autorización es de un usuario externo de Google (flujo web)
- Consulta el flujo de la aplicación web de OAuth. Esto proporciona un ejemplo de cómo configurar la autorización OAuth para usuarios de terceros arbitrarios.
- Si se autoriza como usuario del dominio de Google Apps (flujo de cuenta de servicio)
- Consulta el flujo de la cuenta de servicio de OAuth. Esto muestra un ejemplo de cómo configurar la autorización OAuth para los usuarios del dominio de Google Apps.
Si tu acceso a la cuenta de cliente de Google Ads se realiza 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 otorgue acceso a la cuenta de entrega. Esto debe especificarse si tu acceso a la cuenta de cliente es 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 usas 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. El uso de un archivo de configuración suele ser una buena estrategia si solo tienes un conjunto de credenciales (por ejemplo, administras cuentas bajo un solo 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 sea el ID de cliente de tu cuenta de Google Ads sin guiones.
Para ejecutar 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 INSERT_XXXXX_HERE
en el código fuente. Para ver una declaración de uso de un ejemplo, pasa --help
como el ú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, ejemplos en un subdirectorio o ejemplos en los que la descripción incluya 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'