Erste Schritte mit der Ads Data Hub API

In diesem Leitfaden erfahren Sie, wie Sie Apps erstellen, die mithilfe der Ads Data Hub REST API mit Ads Data Hub interagieren. Mit dieser API können Sie sich Ads Data Hub-Kunden anzeigen lassen, die Ihrem Google-Konto zugeordnet sind, sowie Abfragen erstellen und ausführen.

Einrichtung

Um die Ads Data Hub API nutzen zu können, ist Folgendes erforderlich:

  1. Der Nutzer, der die API aktiviert, muss im Google Cloud-Projekt die Berechtigung serviceusage.services.enable haben. Der Nutzer mit der Berechtigung serviceusage.services.enable muss außerdem auf die API zugreifen können.
  2. Aktivieren Sie die Ads Data Hub API in dem Google Cloud-Projekt, in dem die Clientanmeldedaten oder das Dienstkonto erstellt wurden. So aktivieren Sie die API für ein Projekt über die Console:
    1. Rufen Sie die API-Bibliothek der Cloud Console auf.
    2. Wählen Sie das gewünschte Projekt aus der Liste aus.
    3. Suchen Sie nach „Ads Data Hub API“.
    4. Klicken Sie auf der API-Seite auf AKTIVIEREN.
  3. Berechtigungen verwalten:
    1. E-Mail-Adressen oder Dienstkonten, die zum Erstellen der Anmeldedaten verwendet werden, müssen Ads Data Hub mit den entsprechenden Berechtigungen hinzugefügt werden. Bei einem Dienstkonto ist dessen E-Mail-Adresse anzugeben. Bei OAuth ist es die E-Mail-Adresse des Nutzers. So wird sichergestellt, dass für das Dienstkonto oder Endnutzerkonto die Berechtigung vorliegt, Abfragen in Ads Data Hub auszuführen.
  4. (Empfohlen:) Installieren Sie eine Google API-Clientbibliothek:
    1. Die Google API-Clientbibliotheken sind in verschiedenen gängigen Sprachen verfügbar und ermöglichen die Arbeit mit vielen Google APIs. Diese Bibliotheken sind nicht zwingend erforderlich, aber sie erleichtern die Einrichtung der Authentifizierung. Außerdem müssen Sie weniger Code schreiben.
Clientbibliothek Beispiele für Ads Data Hub
Google API-Clientbibliothek für Java Java
Google API-Clientbibliothek für Python

Authentifizieren und autorisieren

Über die Ads Data Hub API können Daten in Ihrem Ads Data Hub-Kundenkonto abgerufen und geändert werden. Deshalb muss bestätigt werden, dass Sie ein autorisierter Nutzer sind. Vor der Interaktion mit der Ads Data Hub API müssen Sie daher einen Autorisierungsvorgang durchlaufen. Dabei erhalten Sie die erforderlichen Berechtigungen für die Interaktion mit der API. Für die Authentifizierung können Sie entweder OAuth 2.0 oder ein Dienstkonto verwenden.

Dienstkonto einrichten

  1. Gehen Sie in der Google API Console zu Ihrem Administratorprojekt.
  2. Sehen Sie unter APIs und Dienste nach, ob die Ads Data Hub API für Ihr Projekt aktiviert ist.
    1. Ist das nicht der Fall, aktivieren Sie sie. Klicken Sie dazu auf + APIs und Dienste aktivieren.
  3. Klicken Sie im Navigationsmenü links auf IAM und Verwaltung > Dienstkonten.
    1. Erstellen Sie ein Dienstkonto, falls noch nicht geschehen.
  4. Klicken Sie unter „Aktionen“ auf das Dreipunkt-Menü () und anschließend auf Schlüssel verwalten.
    1. Klicken Sie auf Schlüssel hinzufügen > Neuen Schlüssel erstellen.
    2. Vergewissern Sie sich, dass „JSON“ ausgewählt ist, und klicken Sie auf Erstellen.
  5. Fügen Sie in Ihrem Ads Data Hub-Konto die E-Mail-Adresse des Dienstkontos als Nutzer hinzu.

Beispielanfrage senden

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

Weitere Informationen

  • Unter diesem Link finden Sie Beispielabfragen in Ads Data Hub, die Sie mit der Ads Data Hub REST API erstellen und ausführen können.
  • Sehen Sie sich die Beispiele genauer an, um sich mit der API vertraut zu machen und sie für Ihren Anwendungsfall anzupassen. Führen Sie dann folgende Aktionen aus:
    • Rufen Sie den Status des Abfragevorgangs ab.
    • Rufen Sie mithilfe einer BigQuery-Clientbibliothek abgeschlossene Abfrageergebnisse ab.
  • Wenden Sie sich an den Ads Data Hub-Support, wenn Sie Fragen oder Feedback zur API haben.