Aufrufe der Search Ads 360 Reporting API werden in der Regel über Ihre Clientbibliothek ausgeführt. Weitere Informationen finden Sie unter Erläuterung zu Clientbibliotheken. Kenntnisse über die Struktur der zugrunde liegenden Anfragedetails können jedoch beim Testen und Debuggen hilfreich sein.
Die Search Ads 360 Reporting API ist eine gRPC API mit REST-Bindungen. Das bedeutet, dass Sie die API auf zwei alternative Arten aufrufen können:
- Bevorzugte Methode
- Mit einer Clientbibliothek:
- Erstellen Sie den Anfragetext als Protokollpuffer.
- Senden Sie die Anfrage über HTTP/2 an den Server.
- Deserialisiert 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 Ressourcennamenstrings identifiziert. Diese Strings dienen auch bei Verwendung der REST-Schnittstelle als URLs.
Weitere Informationen zu unterstützten Ressourcen und ihrer Pfaddarstellung finden Sie unter Referenz > REST. Dasselbe Format wird auch für andere Dienste verwendet.
Zusammengesetzte IDs
Wenn die ID eines Objekts nicht global eindeutig ist, wird eine zusammengesetzte ID für dieses Objekt erstellt, indem der übergeordneten ID und einer Tilde (~) vorangestellt wird.
Da beispielsweise die Anzeigen-ID einer Anzeigengruppe nicht global eindeutig ist, wird ihr die ID des übergeordneten Objekts (Anzeigengruppe) vorangestellt. Daraus ergibt sich eine eindeutige zusammengesetzte ID.
Beispiel: AdGroupId aus 123 + ~ + AdGroupAdId von 45678
= Anzeigen-ID der zusammengesetzten Anzeigengruppe von 123~45678.
Anfrageheader
Die HTTP-Header (oder gRPC-Metadaten) in den folgenden Abschnitten sollten im Text der Anfrage enthalten sein.
Autorisierung
Sie müssen im folgenden Format ein OAuth2-Zugriffstoken angeben:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
Mit dem Token sollte entweder ein Verwaltungskonto identifiziert werden, das im Auftrag eines Kunden handelt, oder ein Werbetreibender, der sein untergeordnetes Verwaltungskonto oder Kundenkonto direkt verwaltet. Weitere Informationen finden Sie unter Search Ads 360-Verwaltungskonten und Authentifizierung.
Header für Log-in-Kundennummer
Der Header login-customer-id ist erforderlich, wenn über ein Verwaltungskonto auf ein untergeordnetes Verwaltungs- oder Kundenkonto zugegriffen wird. Sie ist nicht erforderlich, wenn Sie direkt auf ein untergeordnetes Verwaltungskonto oder Kundenkonto zugreifen. Obwohl es nicht unbedingt erforderlich ist, empfehlen wir, login-customer-id immer für authentifizierte Nutzer anzugeben, die Zugriff auf mehr als ein Konto haben. So werden Unklarheiten vermieden und der Kontext wird nicht unbeabsichtigt auf das falsche Konto gesetzt.
Die Anfrage sollte die Kundennummer des autorisierten Nutzers ohne Bindestriche (-) enthalten. Beispiel:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Das Festlegen von login-customer-id entspricht der Auswahl 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-nachfolgende Metadaten) werden mit dem Antworttext zurückgegeben. Wir empfehlen, diese Werte zu Debugging-Zwecken zu protokollieren.
Antrags-ID
Der Header request-id ist ein String, der die Anfrage eindeutig identifiziert.