Autorisierung und HTTP-Header

Sie benötigen OAuth 2.0-Anwendungsanmeldedaten, wenn Sie die Search Ads 360 Reporting API aufrufen. Wenn Sie API-Aufrufe als Search Ads 360-Verwaltungskonto ausführen, müssen Sie auch 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 beim Verwenden der REST-Schnittstelle gesendet und empfangen werden.

OAuth 2.0-Anmeldedaten

Die Search Ads 360 Reporting API verwendet Anmeldedaten der Anwendung zum Identifizieren und Autorisieren von API-Anfragen. OAuth 2.0-Clients können konfiguriert werden. Alle Aufrufe der Search Ads 360 Reporting API müssen über OAuth2 autorisiert werden. Mit OAuth2 kann Ihre Search Ads 360 Reporting API-Clientanwendung auf das Search Ads 360-Konto eines Nutzers zugreifen, ohne die Anmeldedaten des Nutzers verarbeiten oder speichern zu müssen.

Wenn Sie neu bei Google APIs sind, können Sie oauth2l oder den OAuth 2.0 Playground verwenden, um mit Anmeldedaten für Anwendungen und der Search Ads 360 Reporting API zu experimentieren, bevor Sie den Code für Ihre App schreiben. Sie können auch ein OAuth-Aktualisierungstoken generieren, indem Sie das bereitgestellte Skript zum Generieren von Nutzeranmeldedaten ausführen.

Neue Zugriffstokens generieren

Sobald Sie eine Client-ID, ein Client-Secret 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/token

Das von der curl-Anfrage zurückgegebene Zugriffstoken verwenden Sie dann im Authorization-HTTP-Header jedes API-Aufrufs der Search Ads 360 Reporting API:

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

Anfrageheader

Kundennummer für die Anmeldung

Für Search Ads 360 Reporting API-Aufrufe, die von einem Manager an ein Kundenkonto gesendet werden (d. h. wenn Sie sich als Manager anmelden, um API-Aufrufe an eines seiner Kundenkonten zu senden), müssen Sie auch den login-customer-id-HTTP-Header angeben. Dieser Wert entspricht der Search Ads 360-Kundennummer des Verwaltungskontos, über das der API-Aufruf erfolgt.

Wenn Sie diesen Header einfügen, entspricht das der Auswahl eines Kontos in der Search Ads 360-Benutzeroberfläche nach der Anmeldung oder dem Klicken auf Ihr Profilbild oben rechts auf der Seite. Achten Sie darauf, dass Sie beim Angeben der Kundennummer alle Bindestriche (–) entfernen, z. B. 1234567890 statt 123-456-7890.

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

Antwortheader

Die folgenden Header werden in HTTP-Antworten von der API zurückgegeben.

Antrags‑ID

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 zur Hand haben sollten, wenn Sie sich an den Google-Entwicklersupport wenden.

request-id: 2a5Cj89VV7CNhya1DZjjrC