Comienza a usar la API del Centro de Datos de Anuncios

En esta guía, se explica cómo comenzar a escribir aplicaciones que usan la API de REST del Centro de Datos de Anuncios para interactuar con el Centro de Datos de Anuncios. La API de REST del Centro de Datos de Anuncios te permite ver a los clientes del Centro de Datos de Anuncios asociados con tu Cuenta de Google, crear y ejecutar consultas.

Configuración

Antes de utilizar la API del Centro de Datos de Anuncios, debes completar algunos pasos:

  1. Asegúrate de que al usuario que habilita la API se le otorgue el permiso serviceusage.services.enable en el proyecto de Google Cloud. El usuario con el permiso serviceusage.services.enable también debe estar en la lista de entidades permitidas para acceder a la API.
  2. 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 con la consola, sigue estos pasos:
    1. Ve a la Biblioteca de API de la consola de Cloud.
    2. Selecciona el proyecto que quieres usar de la lista de proyectos.
    3. Busca "API del Centro de Datos de Anuncios".
    4. En la página de API, haz clic en HABILITAR.
  3. Administra los permisos:
    1. La dirección de correo electrónico o la cuenta de servicio que se usa para crear las credenciales se debe agregar al Centro de Datos de Anuncios con los permisos adecuados. Para una cuenta de servicio, esta es la dirección de correo electrónico de la cuenta de servicio. Para OAuth, esta es la dirección de correo electrónico del usuario. Esto garantiza que la cuenta de servicio o la cuenta del usuario final tengan permiso para ejecutar consultas en el Centro de Datos de Anuncios.
  4. Instala una biblioteca cliente de la API de Google (recomendado):
    1. Las bibliotecas cliente de la API de Google están disponibles en varios lenguajes populares y te permiten trabajar con muchas APIs de Google. Si bien esto no es necesario, las bibliotecas cliente reducen la cantidad de código que tienes que escribir y facilitan 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

Valida y autoriza

La API del Centro de Datos de Anuncios puede acceder a los datos de tu cuenta de cliente del Centro de Datos de Anuncios y modificarlos, por lo que debe verificar que eres un usuario autorizado. Por lo tanto, antes de comenzar a interactuar con la API del Centro de Datos de Anuncios, deberás seguir un flujo de autorización. Un flujo de autorización te proporciona 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

  1. Ve a la Consola de API de Google y navega a tu proyecto de administrador.
  2. Verifica que la API del Centro de Datos de Anuncios esté habilitada para tu proyecto en APIs y servicios.
    1. Si no lo está, haz clic en + Habilitar APIs y servicios y habilita la API del Centro de Datos de Anuncios.
  3. En el menú de navegación de la izquierda, haz clic en IAM y administración > Cuentas de servicio.
    1. Si aún no creaste una cuenta de servicio, crea una.
  4. Haz clic en el menú de 3 puntos () en “Acciones” y, luego, en Administrar claves.
    1. Haz clic en Agregar clave > Crear clave nueva.
    2. Después de asegurarte de que la opción "JSON" esté seleccionada, haz clic en Crear.
  5. Agrega la dirección de correo electrónico de la cuenta de servicio como un usuario en tu cuenta del Centro de Datos de Anuncios.

Envía 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 customer ID.
customer_name = input('Customer name (e.g. "customers/123"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=customer_name).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 las consultas completados.
  • Comunícate con el equipo de asistencia del CDA si tienes preguntas o comentarios sobre la API.
Anterior
Cómo configurar su cuenta
Siguiente
Usa la IU web