Comienza a usar la API de Ads Data Hub

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 este producto. La API de REST de Ads Data Hub te permite ver los clientes de Ads Data Hub asociados con tu cuenta de Google, crear consultas y ejecutarlas.

Configuración

Existen algunos pasos que debes completar antes de usar la API de Ads Data Hub:

  1. Asegúrate de que el usuario que habilita la API tenga permiso serviceusage.services.enable en el proyecto de Google Cloud. El usuario con el permiso serviceusage.services.enable también debe estar incluido en la lista de entidades permitidas para acceder a la API.
  2. Habilita la API de Ads Data Hub en el proyecto de Google Cloud en el que se crearon las credenciales de cliente o la cuenta de servicio. Para habilitar la API de Ads Data Hub para un proyecto con la consola, sigue estos pasos:
    1. Ve a la Biblioteca de API de Cloud Console.
    2. Selecciona el proyecto que deseas usar de la lista de proyectos.
    3. Busca "API de Ads Data Hub".
    4. En la página de API, haz clic en HABILITAR.
  3. Administrar permisos:
    1. La dirección de correo electrónico o la cuenta de servicio que se usó para crear las credenciales se debe agregar a Ads Data Hub con los permisos adecuados. En el caso de 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 tenga permiso para ejecutar consultas en el centro de datos de anuncios.
  4. (Recomendado) Instala una biblioteca cliente de la API de Google:
    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 obligatorio, las bibliotecas cliente reducen la cantidad de código que debes escribir y simplifican la configuración de la autenticación.
Biblioteca cliente Muestras de Ads Data Hub
Biblioteca cliente de las API de Google para Java Java
Biblioteca cliente de la API de Google para Python

Autentica y autoriza

La API de Ads Data Hub puede acceder a los datos de tu cuenta de cliente del Centro de datos de anuncios y cambiarlos, por lo que debe verificar que eres un usuario autorizado. Por este motivo, antes de comenzar a interactuar con la API de Ads Data Hub, deberás realizar 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 de Ads Data Hub esté habilitada para tu proyecto en APIs y servicios.
    1. De lo contrario, haz clic en + Habilitar APIs y servicios y habilita la API de Ads Data Hub.
  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 esté seleccionado "JSON", haz clic en Crear.
  5. Agrega la dirección de correo electrónico de la cuenta de servicio como usuario en tu cuenta de Ads Data Hub.

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 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 consultas de muestra en el Centro de Datos de Anuncios para ver ejemplos de consultas que puedes crear y ejecutar con la API de REST de Ads Data Hub.
  • Expande los ejemplos para familiarizarte con la API y personalizarla para tu caso de uso. Luego, intenta lo siguiente:
  • Comunícate con el equipo de asistencia de ADH si tienes preguntas o comentarios sobre la API.