Authentication

En este documento, se describe cómo autenticarse en la API de Ad Manager. La forma en que te autenticas depende de la interfaz que usas y del entorno en el que se ejecuta tu código, pero todas las solicitudes a la API deben incluir un token de acceso con un alcance de la API de Ad Manager.

Las bibliotecas cliente de Ad Manager usan credenciales predeterminadas de la aplicación para generar tokens de acceso con los alcances de la API de Ad Manager. En esta guía, se muestra cómo configurar las credenciales predeterminadas de la aplicación.

Si no usas una biblioteca cliente, debes crear credenciales y usarlas para autorizar tus solicitudes.

Para obtener más información sobre la autenticación y la autorización, consulta la guía Uso de OAuth 2.0.

Cómo determinar tu tipo de autenticación

Tipo de autenticación Descripción
Cuenta de servicio Elige esta opción si quieres autenticarte como una cuenta dedicada en lugar de una persona en particular.
Más información
Aplicación web Elige esta opción si deseas autenticarte como cualquier usuario que otorgue permiso a tu aplicación para acceder a sus datos de Ad Manager.
Más información
Desarrollo local Elige esta opción si deseas autenticarte como tu propia Cuenta de Google o como una cuenta de servicio desde tu entorno de desarrollo local.

Habilita la API de Ad Manager

  1. Habilita la API de Ad Manager en tu proyecto de Google Cloud de la consola de APIs de Google.

  2. Si se te solicita, selecciona un proyecto o crea uno nuevo.

Crear credenciales

Haz clic en la pestaña de tu tipo de autenticación y sigue las instrucciones para crear tus credenciales:

Cuenta de servicio

En Google Cloud

Para autenticar una carga de trabajo que se ejecuta en Google Cloud, debes usar las credenciales de la cuenta de servicio conectada al recurso de procesamiento en el que se ejecuta tu código.

Por ejemplo, puedes conectar una cuenta de servicio a una instancia de máquina virtual (VM) de Compute Engine, a un servicio de Cloud Run o a un trabajo de Dataflow. Este enfoque es el método de autenticación preferido para el código que se ejecuta en un recurso de procesamiento de Google Cloud.

Para obtener información sobre los recursos a los que puedes conectar una cuenta de servicio y ayuda para conectar la cuenta de servicio al recurso, consulta la documentación sobre cómo conectar una cuenta de servicio.

Local o en un proveedor de servicios en la nube diferente

El método preferido para configurar la autenticación desde fuera de Google Cloud es usar la federación de identidades para cargas de trabajo; debes crear un archivo de configuración de credenciales y establecer la variable de entorno GOOGLE_APPLICATION_CREDENTIALS para que apunte a él. Este enfoque es más seguro que crear una clave de cuenta de servicio.

Si no puedes configurar la federación de identidades para cargas de trabajo, debes crear una cuenta de servicio y una clave para ella:

  1. Abre la página Credenciales de la consola de APIs de Google.

  2. En la página Credenciales, selecciona Crear credenciales y, luego, Cuenta de servicio.

  3. Haz clic en la dirección de correo electrónico de la cuenta de servicio para la que quieres crear una clave.

  4. Haz clic en la pestaña Claves.

  5. Haz clic en el menú desplegable Agregar clave y, luego, selecciona Crear clave nueva.

  6. Selecciona JSON como el tipo de clave y, luego, haz clic en Crear.

  7. Establece la variable de entorno GOOGLE_APPLICATION_CREDENTIALS en la ruta del archivo JSON.

Linux o macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Aplicación web

  1. Abre la página Credenciales de la consola de APIs de Google.

  2. Si se te solicita, selecciona el proyecto en el que habilitaste la API de Ad Manager.

  3. En la página Credenciales, selecciona Crear credenciales y, luego, ID de cliente de OAuth.

  4. Selecciona el tipo de aplicación Aplicación web.

  5. Completa el formulario y haz clic en Crear. Las aplicaciones que usan lenguajes y frameworks como PHP, Java, Python, Ruby y .NET deben especificar URIs de redireccionamiento autorizadas. Los URIs de redireccionamiento son los extremos a los que el servidor de OAuth 2.0 puede enviar respuestas. Estos extremos deben cumplir con las reglas de validación de Google.

  6. Después de crear tus credenciales, descarga el archivo client_secret.json. Almacena el archivo de forma segura en una ubicación a la que solo pueda acceder tu aplicación.

Desde aquí, sigue los pasos para obtener tokens de acceso de OAuth 2.0.

Desarrollo local

Configura las credenciales predeterminadas de la aplicación (ADC) en tu entorno local.

Instala Google Cloud CLI y, luego, inicialízala con el siguiente comando:

gcloud init

Crea credenciales de autenticación locales para tu Cuenta de Google y configura el ID del proyecto en un proyecto en el que esté habilitada la API de Ad Manager:

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

Como alternativa, puedes autenticarte como una cuenta de servicio configurando la variable de entorno GOOGLE_APPLICATION_CREDENTIALS en la ruta de tu archivo de claves.

Linux o macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Configura tu red de Ad Manager

Cuenta de servicio

  1. Ve a tu red de Ad Manager.
  2. Haz clic en la pestaña Administrador.
  3. Asegúrate de que API access esté habilitado.
  4. Haz clic en el botón Agregar un usuario de la cuenta de servicio.
  5. Completa el formulario con el correo electrónico de la cuenta de servicio. El usuario de la cuenta de servicio debe agregarse a los roles y equipos adecuados para la integración de tu API.
  6. Haga clic en el botón Guardar. Debería aparecer un mensaje que confirme que se agregó tu cuenta de servicio.
  7. Para ver los usuarios existentes de la cuenta de servicio, ve a la pestaña Usuarios y, luego, haz clic en el filtro Cuenta de servicio.

Aplicación web

  1. Ve a tu red de Ad Manager.
  2. Haz clic en la pestaña Administrador.
  3. Asegúrate de que API access esté habilitado.

Desarrollo local

  1. Ve a tu red de Ad Manager.
  2. Haz clic en la pestaña Administrador.
  3. Asegúrate de que API access esté habilitado.

Sin una biblioteca cliente

Si no usas una biblioteca cliente, te recomendamos que uses una biblioteca de OAuth2 para la autenticación.

Para obtener instrucciones detalladas sobre cómo obtener tokens de acceso, consulta Cómo usar OAuth2 con las APIs de Google.

Tokens de acceso

Incluye tu token de acceso en una solicitud a la API con un parámetro de consulta access_token o un valor de encabezado HTTP Authorization Bearer. Cuando sea posible, se recomienda usar el encabezado HTTP, ya que las cadenas de consulta suelen ser visibles en los registros del servidor.

Por ejemplo:

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX

GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

Alcance

Cada token de acceso está asociado con uno o más permisos. Un alcance controla el conjunto de recursos y operaciones que permite un token de acceso. La API de Ad Manager tiene dos alcances. Te recomendamos que uses el alcance admanager.readonly más limitado si tu aplicación no necesita escribir datos.

Alcance Permisos
https://www.googleapis.com/auth/admanager Consulta y administra tus campañas en Google Ad Manager.
https://www.googleapis.com/auth/admanager.readonly Consulta tus campañas y datos en Google Ad Manager.