Für Aufrufe der Google Ads API benötigen Sie sowohl OAuth 2.0-Anmeldedaten als auch ein Entwicklertoken. Wenn Sie API-Aufrufe mit einem Google Ads-Verwaltungskonto ausführen, müssen Sie außerdem in jeder Anfrage einen login-customer-id-Header angeben. Auf dieser Seite wird beschrieben, wie Sie diese Werte festlegen. Außerdem werden mehrere zusätzliche API-spezifische HTTP-Header dokumentiert, die bei Verwendung der REST-Schnittstelle gesendet und empfangen werden.
OAuth 2.0-Anmeldedaten
Die Google Ads API verwendet OAuth 2.0 zur Autorisierung von API-Anfragen. Sowohl der OAuth 2.0 Nutzer authentifizierungsablauf als auch der Dienst kontoablauf werden unterstützt. Weitere Informationen finden Sie unter OAuth 2.0 in der Google Ads API.
Wenn Sie Google APIs noch nicht kennen, können Sie mit der gcloud CLI oder dem OAuth 2.0 Playground mit OAuth 2.0-Anmeldedaten und der Google Ads API experimentieren, bevor Sie Code für Ihre App schreiben.
Wir empfehlen, eine der OAuth 2.0-Bibliotheken unter https://oauth.net/code/ zu verwenden, um die OAuth 2.0 Autorisierungsworkflows zu implementieren. Die curl-Anleitung ist jedoch aufgeführt, falls Sie sie selbst implementieren müssen.
Dienstkonten
Folgen Sie der Anleitung, um ein Google Cloud-Projekt für die Google Ads API zu konfigurieren. Notieren Sie sich die E-Mail-Adresse des Dienstkontos und den Dienstkontoschlüssel. Folgen Sie dann der allgemeinen Anleitung im Leitfaden zu Dienst konten, um das Dienstkonto für den Zugriff auf Ihr Google Ads-Konto einzurichten.
Nutzerauthentifizierung
Folgen Sie der Anleitung, um ein Google Cloud Console-Projekt für die Google Ads API zu konfigurieren. Notieren Sie sich die Client-ID und den Clientschlüssel. Folgen Sie dann der Anleitung für den Desktop-App-Ablauf
oder der Anleitung für den Web-App-Ablauf, um ein Aktualisierungstoken und ein Zugriffstoken zu generieren. Der scope, der für den Zugriff auf die Google Ads API verwendet werden soll, ist https://www.googleapis.com/auth/adwords.
Neue Zugriffstokens generieren
Dienstkonten
Wenn Sie die E-Mail-Adresse des Dienstkontos und den Dienstkontoschlüssel, haben, folgen Sie der Anleitung unter OAuth 2.0 für Server-zu-Server Anwendungen verwenden, um eine JWT-Anspruchsgruppe zu generieren, die dann gegen ein OAuth 2.0-Zugriffstoken ausgetauscht werden kann. Achten Sie darauf, dass Sie beim Folgen der Anleitung den Tab HTTP/REST auswählen. Der OAuth 2.0-scope, der für den Zugriff auf die Google Ads API verwendet werden soll, ist https://www.googleapis.com/auth/adwords. Außerdem können Sie den Parameter sub beim Erstellen der JWT-Anspruchsgruppe überspringen, da die Einrichtungsschritte dem Dienstkonto direkten Zugriff auf das Google Ads-Konto gewähren. So ist es nicht erforderlich, sich als Google Ads-Nutzer auszugeben.
Verwenden Sie dann das Zugriffstoken im HTTP-Header Authorization jedes API-Aufrufs an die Google Ads API:
GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
Nutzerauthentifizierung
Sobald Sie eine OAuth 2.0-Client-ID, einen Clientschlüssel und ein Aktualisierungstoken haben, können Sie mit dem
curl Befehlszeilentool ein neues Zugriffstoken für die Verwendung in API-Aufrufen generieren:
curl \
--data "grant_type=refresh_token" \
--data "client_id=CLIENT_ID" \
--data "client_secret=CLIENT_SECRET" \
--data "refresh_token=REFRESH_TOKEN" \
https://www.googleapis.com/oauth2/v3/tokenVerwenden Sie dann das von der curl-Anfrage zurückgegebene Zugriffstoken im HTTP-Header Authorization jedes API-Aufrufs an die Google Ads API:
GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
Anfrageheader
In den folgenden Abschnitten werden die HTTP-Header beschrieben, die für Anfragen an die Google Ads API erforderlich sind oder verwendet werden.
Entwickler-Token
Für Aufrufe der Google Ads API ist auch ein Entwicklertoken erforderlich. Wenn Sie bereits ein Entwicklertoken haben, finden Sie es unter https://ads.google.com/aw/apicenter. Melden Sie sich bei Aufforderung in Ihrem Google Ads-Verwaltungskonto an. Wenn Sie noch keines haben, folgen Sie der Anleitung, um sich für ein Entwickler token zu registrieren.
Sie müssen den Wert Ihres Entwicklertokens in den HTTP-Header developer-token jedes API-Aufrufs an die Google Ads API einfügen:
GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
Log-in-Kundennummer
Bei Google Ads API-Aufrufen, die von einem Administrator an ein Kundenkonto gesendet werden (d. h. wenn Sie sich als Administrator anmelden, um API-Aufrufe an eines seiner Kundenkonten zu senden), müssen Sie auch den HTTP-Header login-customer-id angeben. Dieser Wert entspricht der Google Ads-Kundennummer des Administrators, der den API-Aufruf sendet.
Das Einfügen dieses Headers entspricht der Auswahl eines Kontos in der Google Ads-Benutzeroberfläche nach der Anmeldung oder dem Klicken auf Ihr Profilbild rechts oben auf der Seite. Wenn Sie die Kundennummer angeben, entfernen Sie alle Bindestriche (—). Beispiel: 1234567890, nicht 123-456-7890. Weitere Informationen zur Log-in-Kundennummer finden Sie im Leitfaden zum Google Ads-Zugriffsmodell
guide.
GET /v24/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
Verknüpfte Kundennummer
Der Header „Verknüpfte Kundennummer“ wird nur von [Drittanbieter-App-Analysetools verwendet, wenn sie Conversions in ein verknüpftes Google Ads-Konto hochladen. Weitere Informationen finden Sie im Leitfaden zur Struktur von API-Aufrufen.
...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID
Antwortheader
Die folgenden Header werden in HTTP-Antworten von der API zurückgegeben.
Anfrage-ID
Die request-id ist ein String, der die API-Anfrage eindeutig identifiziert. Beim Debuggen oder Beheben von Problemen mit bestimmten API-Aufrufen ist die request-id ein wichtiger Bezeichner, den Sie bei der Kontaktaufnahme mit dem Google-Entwicklersupport zur Hand haben sollten.
request-id: 2a5Cj89VV7CNhya1DZjjrC