Aufrufe der Search Ads 360 Reporting API erfolgen in der Regel über Ihre Clientbibliothek. Weitere Informationen finden Sie unter Erläuterung zu Clientbibliotheken. Kenntnisse über die Struktur der zugrunde liegenden Anfragedetails können jedoch beim Testen und Beheben von Fehlern hilfreich sein.
Die Search Ads 360 Reporting API ist eine gRPC API mit REST-Bindungen. Sie haben also zwei Möglichkeiten, die API aufzurufen:
- Bevorzugte Methode
- Clientbibliothek verwenden:
- Erstellen Sie den Anfragetext als Protokollzwischenspeicher.
- Senden Sie die Anfrage mit HTTP/2 an den Server.
- Deserialisieren Sie die Antwort in einen Protokollpuffer.
- Ergebnisse interpretieren:
- Optionale alternative Methode
- REST verwenden:
- Erstellen Sie den Anfragetext als JSON-Objekt.
- Senden Sie die Anfrage mit HTTP 1.1 an den Server.
- Deserialisieren Sie die Antwort als JSON-Objekt.
- Ergebnisse interpretieren:
Weitere Informationen finden Sie unter Google Cloud APIs.
Die folgenden Abschnitte gelten sowohl für gRPC- als auch für REST-Protokolle.
Ressourcennamen
Die meisten Objekte in der API werden anhand ihrer Ressourcennamen-Strings identifiziert. Diese Strings dienen auch als URLs, wenn die REST-Schnittstelle verwendet wird.
Weitere Informationen zu unterstützten Ressourcen und ihrer Pfaddarstellung finden Sie unter Referenz > REST. Für andere Dienste wird dasselbe Format verwendet.
Zusammengesetzte IDs
Wenn die ID eines Objekts nicht global eindeutig ist, wird eine zusammengesetzte ID für dieses Objekt erstellt, indem die übergeordnete ID und ein Tilde (~) vorangestellt werden.
Da die Anzeigen-ID einer Anzeigengruppe beispielsweise nicht global eindeutig ist, wird ihr die ID des übergeordneten Objekts (Anzeigengruppe) vorangestellt, was zu einer eindeutigen zusammengesetzten ID führt.
Beispiel: AdGroupId von 123 + ~ + AdGroupAdId von 45678
= Anzeigen-ID der zusammengesetzten Anzeigengruppe 123~45678.
Anfrageheader
Die HTTP-Header (oder gRPC-Metadaten) in den folgenden Abschnitten sollten im Textkörper der Anfrage enthalten sein.
Autorisierung
Sie müssen ein OAuth2-Zugriffstoken in das Formular einfügen:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
Das Token sollte entweder ein Verwaltungskonto identifizieren, das im Namen eines Kunden handelt, oder einen Werbetreibenden, der sein eigenes untergeordnetes Verwaltungskonto oder Kundenkonto direkt verwaltet. Weitere Informationen finden Sie unter Search Ads 360-Verwaltungskonten und Authentifizierung.
Kopfzeile für Kundennummer beim Anmelden
Die Kopfzeile login-customer-id ist erforderlich, wenn Sie über ein Verwaltungskonto auf ein untergeordnetes Verwaltungskonto oder ein Kundenkonto zugreifen. Sie ist nicht erforderlich, wenn Sie direkt auf ein untergeordnetes Verwaltungskonto oder ein Kundenkonto zugreifen. Auch wenn es nicht unbedingt erforderlich ist, empfehlen wir, die login-customer-id immer für authentifizierte Nutzer anzugeben, die Zugriff auf mehr als ein Konto haben. So wird Unklarheit vermieden und verhindert, dass der Kontext versehentlich auf das falsche Konto gesetzt wird.
Die Anfrage muss die Kundennummer des autorisierten Nutzers ohne Bindestriche (-) enthalten, z. B.:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Das Festlegen der login-customer-id entspricht dem Auswählen eines Kontos in der Search Ads 360-Benutzeroberfläche, nachdem Sie sich angemeldet oder oben rechts auf Ihr Profilbild geklickt haben.
Antwortheader
Die folgenden Header (oder gRPC-Trailing-Metadaten) werden mit dem Antworttext zurückgegeben. Wir empfehlen, diese Werte zu protokollieren, um Fehler zu beheben.
Antrags‑ID
Der request-id-Header ist ein String, der die Anfrage eindeutig identifiziert.