En este documento, se describe cómo autenticar la API de Ad Manager. Cómo depende de la interfaz que uses y del entorno en el que código esté en ejecución, pero todas las solicitudes de API deben incluir un token de acceso con el 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 el permiso de la API de Ad Manager. En esta guía, se muestra cómo configurar credenciales predeterminadas de la aplicación.
Si no usas una biblioteca cliente, aún debes crear credenciales. y usarlos para autorizar tus solicitudes.
Para obtener más información sobre la autenticación y autorización, consulta el Usa OAuth 2.0.
Cómo determinar el tipo de autenticación
Tipo de autenticación | Descripción |
---|---|
Cuenta de servicio | Elige esta opción si quieres autenticarte como dedicado
en lugar de a una persona en particular. Obtén más información. |
Aplicación web | Elige esta opción si quieres autenticarte como cualquier usuario
que da permiso a tu aplicación para acceder
sus datos de Ad Manager. Más información |
Desarrollo local | Elige esta opción si quieres autenticarte como propia Cuenta de Google o una cuenta de servicio de tu red local de desarrollo de software. |
Habilita la API de Ad Manager
Habilita la API de Ad Manager en tu Proyecto de Cloud de la Consola de APIs de Google.
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 crea tus credenciales:
Cuenta de servicio
En Google Cloud
Para autenticar una carga de trabajo que se ejecuta en Google Cloud, usas las credenciales de la cuenta de servicio conectada al recurso de procesamiento en el que se encuentra en ejecución.
Por ejemplo, puedes conectar una cuenta de servicio a una instancia instancia de máquina virtual (VM), un servicio de Cloud Run o un trabajo de Dataflow. Este enfoque es el método de autenticación preferido para ejecutar código en un entorno recurso de procesamiento.
Para obtener información sobre los recursos a los que puedes conectar una cuenta de servicio, y ayuda para adjuntar 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; creas un
de configuración de credenciales y establece el GOOGLE_APPLICATION_CREDENTIALS
variable de entorno para señalarla. Este enfoque es más seguro que
creando una clave de cuenta de servicio.
Si no puedes configurar la federación de identidades para cargas de trabajo, debes crea una cuenta de servicio y crea una clave para ella:
Abre la página de credenciales de la Consola de APIs de Google.
En la página Credenciales, selecciona Crear credenciales y, luego, Selecciona Cuenta de servicio.
Haz clic en la dirección de correo electrónico de la cuenta de servicio que quieres crear. una clave.
Haz clic en la pestaña Claves.
Haz clic en el menú desplegable Agregar clave y, luego, selecciona Crear clave nueva.
Selecciona JSON como el tipo de clave y, luego, haz clic en Crear.
Establece la variable de entorno
GOOGLE_APPLICATION_CREDENTIALS
en la ruta de acceso. del archivo JSON.
Linux o macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Aplicación web
Abre la página de credenciales de la Consola de APIs de Google.
Si se te solicita, selecciona el proyecto en el que habilitaste la API de Ad Manager.
En la página Credenciales, selecciona Crear credenciales y, luego, Selecciona ID de cliente de OAuth.
Selecciona el tipo de aplicación Aplicación web.
Completa el formulario y haz clic en Crear. Las aplicaciones que usan lenguajes y los frameworks como PHP, Java, Python, Ruby y .NET deben especificar URI de redireccionamiento. Los URI de redireccionamiento son los extremos a los que se accede servidor puede enviar respuestas. Estos extremos deben cumplir con la Política de las reglas de validación.
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 ejecuta el siguiente comando para inicializarlo :
gcloud init
Crea credenciales de autenticación locales para tu Cuenta de Google y configura el ID del proyecto a 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
También puedes autenticarte como una cuenta de servicio que configura el entorno
la variable GOOGLE_APPLICATION_CREDENTIALS
a 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
- Ve a tu red de Ad Manager.
- Haga clic en la pestaña Administrador.
- Asegúrate de que el acceso a la API esté habilitado.
- Haz clic en el botón Agregar un usuario de cuenta de servicio.
- Completa el formulario con el correo electrónico de la cuenta de servicio. El usuario de la cuenta de servicio se debe agregar a los roles y equipos correspondientes para tu integración de API.
- Haga clic en el botón Guardar. Debería aparecer un mensaje que confirme la adición de tu cuenta de servicio.
- Para ver los usuarios existentes de la cuenta de servicio, vaya a la pestaña Usuarios y, luego, haciendo clic en el filtro Cuenta de servicio.
Aplicación web
- Ve a tu red de Ad Manager.
- Haga clic en la pestaña Administrador.
- Asegúrate de que el acceso a la API esté habilitado.
Desarrollo local
- Ve a tu red de Ad Manager.
- Haga clic en la pestaña Administrador.
- Asegúrate de que el acceso a la API esté habilitado.
Sin una biblioteca cliente
Si no utilizas una biblioteca cliente, te recomendamos enfáticamente una biblioteca OAuth2 para la autenticación.
Para ver instrucciones detalladas sobre cómo obtener tokens de acceso, consulta Uso de OAuth2 con las APIs de Google
Tokens de acceso
Incluye tu token de acceso en una solicitud a la API incluyendo un
Parámetro de consulta access_token
o un valor Bearer
de encabezado HTTP Authorization
.
Cuando sea posible, se prefiere el encabezado HTTP, ya que las cadenas de consulta suelen ser
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 se asocia con uno o más permisos. Un alcance controla la conjunto de recursos y operaciones que permite un token de acceso. Ad Manager La API de REST tiene un solo alcance. La autorización se debe realizar en el nivel de dentro del producto.
Alcance | Permisos |
---|---|
https://www.googleapis.com/auth/admanager
|
Consulta y administra tus campañas. en Google Ad Manager. |