Direkte Anfragen stellen

Wir empfehlen die Verwendung der Clientbibliotheken und Beispiele für Ihre Implementierung. Wenn die Einbindung in die API jedoch besondere Anforderungen hat, z. B. die Verwendung einer nicht unterstützten Sprache, können Sie wie unten beschrieben direkte Anfragen stellen.

Anrufstil

REST ist eine Art Softwarearchitektur, die einen bequemen und einheitlichen Ansatz zur Abfrage und Bearbeitung von Daten bietet.

REST steht für "Representational State Transfer". Im Kontext der Google APIs ist damit die Verwendung von HTTP-Verben gemeint, um Darstellungen von Daten, die bei Google gespeichert sind, abzufragen und zu bearbeiten.

In einem als "RESTful" bezeichneten System werden Ressourcen in einem Datenspeicher abgelegt; ein Client sendet eine Aufforderung, der Server möge eine bestimmte Aktion ausführen (z. B. eine Ressource erstellen, abfragen, aktualisieren oder löschen), und der Server führt die Aktion aus und sendet eine Antwort, oft in Form einer Darstellung der angegebenen Ressource.

In den RESTful APIs von Google gibt der Client eine Aktion mit einem HTTP-Verb wie POST, GET, PUT oder DELETE an. Die Ressource wird durch einen global eindeutigen URI der folgenden Form angegeben:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Weil alle API-Ressourcen eindeutige, über HTTP zugängliche URIs haben, ermöglicht REST das Caching von Daten und ist optimal geeignet, mit der verteilten Infrastruktur des Webs zu arbeiten.

Dafür können die Methodendefinitionen in der Dokumentation der HTTP 1.1-Standards hilfreich sein. Hier finden Sie auch die Spezifikationen für GET, POST, PUT und DELETE.

REST in der AdSense-Verwaltungs-API

Die unterstützten Vorgänge lassen sich direkt den REST-HTTP-Verben zuordnen. Dies wird unter AdSense Management API-Vorgänge beschrieben.

Das spezifische Format für AdSense-Verwaltungs-API-URIs lautet:

https://adsense.googleapis.com/v2/resourceID?parameters

Dabei ist resourceID die ID für einen Ad-Client, Anzeigenblock, URL-Channel, benutzerdefinierten Channel oder die Berichtsammlung. parameters sind alle Parameter, die auf die Abfrage angewendet werden können.

Anhand des Formats der resourceID-Pfaderweiterungen können Sie die Ressource identifizieren, auf der Sie derzeit arbeiten. Beispiel:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

Die vollständige Gruppe von URIs, die für die einzelnen unterstützten Vorgänge in der API verwendet wird, ist im Dokument AdSense Management API-Referenz zusammengefasst.

Im Folgenden finden Sie einige Beispiele für die Funktionsweise in der AdSense-Verwaltungs-API.

Liste der Ad-Clients:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

Liste der Anzeigenblöcke im Ad-Client ca-pub-1234567890123456 auf:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

Datenformat

JSON (JavaScript Object Notation) ist ein gängiges sprachunabhängiges Datenformat, das eine einfache Textdarstellung beliebiger Datenstrukturen bietet. Weitere Informationen finden Sie unter json.org.

Anfragen autorisieren

AdSense unterstützt keine Dienstkonten. Verwenden Sie stattdessen den Ablauf für installierte Anwendungen.

Jede Anfrage, die Ihre Anwendung an die AdSense-Verwaltungs-API sendet, muss ein Autorisierungstoken enthalten. Anhand dieses Tokens wird deine Anwendung Google gegenüber identifiziert.

Autorisierungsprotokolle

Ihre Anwendung muss zur Autorisierung von Anfragen OAuth 2.0 verwenden. Andere Autorisierungsprotokolle werden nicht unterstützt. Wenn deine Anwendung Über Google anmelden verwendet, werden einige Schritte der Autorisierung automatisch ausgeführt.

Anfragen mit OAuth 2.0 autorisieren

Alle Anfragen an die AdSense-Verwaltungs-API müssen von einem authentifizierten Nutzer autorisiert werden.

Dieser Vorgang wird mit einer OAuth-Client-ID vereinfacht.

OAuth-Client-ID abrufen

Alternativ können Sie auf der Seite "Anmeldedaten" einen Schlüssel erstellen.

Die Details dieses Autorisierungsablaufs für OAuth 2.0 hängen davon ab, welche Art von Anwendung du schreibst. Die folgende allgemeine Vorgehensweise gilt für alle Arten von Anwendungen:

  1. Wenn deine Anwendung Zugriff auf Nutzerdaten benötigt, bittet sie Google um einen bestimmten Zugriffsbereich.
  2. Dem Nutzer wird von Google ein Zustimmungsbildschirm angezeigt, auf dem er gebeten wird, deine Anwendung dazu zu autorisieren, einige seiner Daten abzufragen.
  3. Wenn der Nutzer zustimmt, erhält deine Anwendung von Google ein kurzlebiges Zugriffstoken.
  4. Die Anwendung fordert Nutzerdaten an, wobei das Zugriffstoken an die Anfrage angehängt wird.
  5. Stellt Google fest, dass Ihre Anfrage und das Token gültig sind, werden die angeforderten Daten zurückgegeben.

Einige Abläufe enthalten zusätzliche Schritte, beispielsweise die Verwendung von Aktualisierungstoken zum Erhalt neuer Zugriffstoken. Weitere Informationen über die Abläufe für die unterschiedlichen Anwendungstypen findest du in der OAuth 2.0-Dokumentation.

Im Folgenden finden Sie die Informationen zum Umfang von OAuth 2.0 für die AdSense-Verwaltungs-API:

Umfang Bedeutung
https://www.googleapis.com/auth/adsense Lese-/Schreibzugriff auf AdSense-Daten
https://www.googleapis.com/auth/adsense.readonly Lesezugriff auf AdSense-Daten

Zur Anforderung eines Zugriffs mit OAuth 2.0 benötigt Ihre Anwendung die Informationen zum Umfang sowie die Informationen, die Google bei der Registrierung Ihrer Anwendung bereitstellt, z. B. die Client-ID und den Clientschlüssel.

Tipp: Die Google APIs-Clientbibliotheken können einige Schritte des Autorisierungsvorgangs für Sie übernehmen. Sie sind für verschiedene Programmiersprachen verfügbar. Weitere Informationen erhältst du auf der Seite Bibliotheken und Beispiele.

Anfragen senden

Der letzte Schritt besteht darin, die API-Anfrage zu senden. Weitere Informationen finden Sie in der Referenzdokumentation.