En esta guía, se explica cómo comenzar a escribir aplicaciones que usan la API de REST de Ads Data Hub para interactuar con Ads Data Hub. La API de REST de Ads Data Hub te permite ver los clientes de Ads Data Hub asociados con tu Cuenta de Google, así como crear y ejecutar consultas.
Configuración
Debes completar algunos pasos antes de utilizar la API del Centro de Datos de Anuncios:
- Asegúrate de que se otorgue acceso al usuario que habilita la API
El permiso
serviceusage.services.enable
en el proyecto de Google Cloud El usuario con el permisoserviceusage.services.enable
también deben incluirse en la lista de entidades permitidas para acceder a la API. - Habilita la API del Centro de Datos de Anuncios en el proyecto de Google Cloud en el que se crearon las credenciales de cliente o la cuenta de servicio. Si deseas habilitar la API del Centro de Datos de Anuncios para un proyecto mediante la consola, sigue estos pasos:
- Ve a la Biblioteca de APIs de la consola de Cloud.
- Selecciona el proyecto que deseas usar de la lista de proyectos.
- Busca "API de Ads Data Hub".
- En la página de API, haz clic en HABILITAR.
- Administrar permisos:
- La dirección de correo electrónico o la cuenta de servicio que se usen para crear las credenciales deben al Centro de Datos de Anuncios con la los permisos adecuados. Para una cuenta de servicio, esta es la dirección de correo electrónico de la cuenta de servicio. Para OAuth, que es la dirección de correo electrónico del usuario. Esto garantiza que el servicio o la cuenta del usuario final tiene permiso para realizar consultas en Centro de Datos de Anuncios.
- Instala una biblioteca cliente de la API de Google (recomendado):
- Las bibliotecas cliente de la API de Google están disponibles en varias lenguajes, y te permite trabajar con muchas APIs de Google. Si bien esto no es las bibliotecas cliente reducen la cantidad de código que tienes escribir y facilitar la configuración de la autenticación.
Biblioteca cliente | Muestras del Centro de Datos de Anuncios |
---|---|
Biblioteca cliente de las API de Google para Java | Java |
Biblioteca cliente de las APIs de Google para Python |
Autentica y autoriza
La API del Centro de Datos de Anuncios puede acceder a los datos de su cliente del Centro de Datos de Anuncios y modificarlos por lo que se debe verificar que eres un usuario autorizado. Por este motivo, antes de empezar a interactuar con la API de Ads Data Hub, a través de un flujo de autorización. Un flujo de autorización te proporciona la los permisos necesarios para interactuar con la API. Puedes autenticarte con OAuth 2.0 o una cuenta de servicio.
Configuración de la cuenta de servicio
- Ve a la Consola de APIs de Google y navega hasta tu proyecto de administrador.
- Verifica que la API del Centro de Datos de Anuncios esté habilitada para tu proyecto en APIs y
Servicios
- Si no lo está, haz clic en + Habilitar APIs y servicios y habilita los anuncios API de Data Hub.
- En el menú de navegación de la izquierda, haz clic en IAM y Administrador > Cuentas de servicio.
- Si aún no creaste una cuenta de servicio, crear una.
- Haz clic en el menú de 3 puntos (
- Haz clic en Agregar clave > Crear clave nueva
- Después de asegurarte de que "JSON" haz clic en Crear.
) que aparece
"Acciones" y, luego, haz clic en Administrar claves.
- Agrega la dirección de correo electrónico de la cuenta de servicio como usuario en tu Centro de Datos de Anuncios de servicio predeterminada.
Enviar una solicitud de muestra
#!/usr/bin/env python3 """This sample shows how to retrieve all accounts associated with the user. """ import json from google.oauth2.service_account import Credentials from googleapiclient.discovery import build SCOPES = ['https://www.googleapis.com/auth/adsdatahub'] DISCOVERY_URL = 'https://adsdatahub.googleapis.com/$discovery/rest?version=v1' creds = Credentials.from_service_account_file( 'service-account.json').with_scopes(SCOPES) developer_key = 'YOUR_DEVELOPER_KEY' # Replace with your developer key. service = build('AdsDataHub', 'v1', credentials=creds, developerKey=developer_key, discoveryServiceUrl=DISCOVERY_URL) # Replace with your ADH account ID. adh_account_id = input('ADH account ID (e.g. "customers/123456789"): ').strip() queries = service.customers().analysisQueries().list( parent=adh_account_id).execute() print(json.dumps(queries, sort_keys=True, indent=4))
Próximos pasos
- Consulta las consultas de muestra en el Centro de Datos de Anuncios para ver ejemplos de las consultas que puedes crear y ejecutar con la API de REST del Centro de Datos de Anuncios.
- Amplía las muestras para familiarizarte con la API y personalizarla según tu caso de uso. Luego, intenta lo siguiente:
- Estado de la operación de consulta de la encuesta.
- Usa una biblioteca cliente de BigQuery para recuperar los resultados de la consulta completados.
- Comunícate con el equipo de asistencia del CDA si tienes preguntas o comentarios sobre la API.