Premiers pas avec l'API Ads Data Hub

Ce guide explique comment développer des applications utilisant l'API REST Ads Data Hub pour interagir avec Ads Data Hub. L'API REST Ads Data Hub permet d'afficher les clients Ads Data Hub associés à votre compte Google, ainsi que de créer et d'exécuter des requêtes.

Configuration

Avant d'utiliser l'API Ads Data Hub :

  1. Assurez-vous que l'utilisateur qui active l'API dispose de l'autorisation serviceusage.services.enable dans le projet Google Cloud. L'utilisateur disposant de l'autorisation serviceusage.services.enable doit également être ajouté à la liste d'autorisation pour accéder à l'API.
  2. Activez l'API Ads Data Hub dans le projet Google Cloud dans lequel les identifiants client ou le compte de service ont été créés. Pour activer l'API Ads Data Hub pour un projet à l'aide de la console :
    1. Accédez à la bibliothèque d'API Cloud Console.
    2. Sélectionnez le projet à utiliser dans la liste des projets.
    3. Recherchez "API Ads Data Hub".
    4. Sur la page de l'API, cliquez sur ACTIVER.
  3. Gérez les autorisations :
    1. L'adresse e-mail ou le compte de service utilisé pour créer les identifiants doit être ajouté à Ads Data Hub avec les autorisations appropriées. Pour un compte de service, il s'agit de son adresse e-mail. Pour OAuth, il s'agit de l'adresse e-mail de l'utilisateur. Le compte de service ou le compte de l'utilisateur final est ainsi autorisé à exécuter des requêtes dans Ads Data Hub.
  4. (Recommandé) Installez une bibliothèque cliente des API Google :
    1. Les bibliothèques clientes des API Google sont disponibles dans plusieurs langages courants et permettent d'utiliser de nombreuses API Google. Bien qu'elles ne soient pas obligatoires, les bibliothèques clientes réduisent la quantité de code à écrire et simplifient la configuration de l'authentification.
Bibliothèque cliente Extraits Ads Data Hub
Bibliothèque cliente des API Google pour Java Java
Bibliothèque cliente des API Google pour Python

Authentification et autorisation

L'API Ads Data Hub peut accéder aux données de votre compte client Ads Data Hub et les modifier. Elle doit donc vérifier que vous êtes un utilisateur autorisé. De ce fait, avant de commencer à utiliser l'API Ads Data Hub, vous devez suivre un flux d'autorisation. Ce flux vous fournit les autorisations nécessaires pour interagir avec l'API. Vous pouvez vous authentifier à l'aide d'OAuth 2.0 ou d'un compte de service.

Configurer un compte de service

  1. Accédez à la console Google APIs, puis à votre projet administrateur.
  2. Vérifiez que l'API Ads Data Hub est activée pour votre projet sous API et services.
    1. Si ce n'est pas le cas, cliquez sur + Activer les API et les services, puis activez l'API Ads Data Hub.
  3. Dans le menu de navigation de gauche, cliquez sur IAM et administration > Comptes de service.
    1. Si ce n'est pas déjà fait, créez un compte de service.
  4. Cliquez sur le menu à trois points () sous "Actions", puis sur Gérer les clés.
    1. Cliquez sur Ajouter une clé > Créer une clé.
    2. Après vous être assuré que "JSON" est sélectionné, cliquez sur Créer.
  5. Ajoutez l'adresse e-mail du compte de service en tant qu'utilisateur dans votre compte Ads Data Hub.

Envoyer un exemple de requête

#!/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))

Étapes suivantes

  • Consultez des exemples de requêtes dans Ads Data Hub pour voir celles que vous pouvez créer et exécuter avec l'API REST Ads Data Hub.
  • Développez les exemples pour vous familiariser avec l'API et la personnaliser pour votre cas d'utilisation. Ensuite :
    • Interrogez l'état de l'opération de la requête.
    • Utilisez une bibliothèque cliente BigQuery pour récupérer les résultats de la requête terminée.
  • Pour toute question ou pour tout commentaire sur l'API, contactez l'assistance ADH.
Précédent
Configurer votre compte
Suivant
Utiliser l'UI Web