Direkte Anfragen stellen

Wir empfehlen die Verwendung der Client-Bibliotheken und Beispiele für Ihre Implementierung. Wenn die Integration mit der API jedoch besondere Anforderungen stellt, zum Beispiel die Verwendung einer nicht unterstützten Sprache, können Sie wie im Folgenden beschrieben auch direkte Anfragen stellen.

Inhalt

Aufrufstil

REST steht für einen Softwarearchitekturstil, der einen praktischen und einheitlichen Ansatz für die Anfrage und Änderung von Daten bietet.

Das Akronym REST steht für "Representational State Transfer". Wenn es um Google-APIs geht, bezieht sich dies auf HTTP-Verben für den Abruf und die Änderung von Daten, die von Google gespeichert wurden.

In einem RESTful-System werden Ressourcen in einem Datenspeicher gespeichert. Ein Client sendet eine Anfrage, dass der Server eine bestimmte Aktion ausführen soll, z. B. eine Ressource erstellen, abrufen, aktualisieren oder löschen. Der Server führt die Aktion aus und sendet eine Antwort, häufig in Form einer Darstellung der angegebenen Ressource.

In den RESTful-APIs von Google gibt der Client eine Aktion mithilfe eines HTTP-Verbs an, beispielsweise POST, GET, PUT oder DELETE. Die Ressource wird mit einem global eindeutigen URI in folgendem Format festgelegt:

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

Da alle API-Ressourcen über eindeutige URIs verfügen, auf die per HTTP zugegriffen werden kann, können mit REST Daten zwischengespeichert werden. Zudem wurde diese Architektur so optimiert, dass sie sich für die im Web verteilte Infrastruktur eignet.

Weitere für Sie möglicherweise interessante Informationen zu REST finden Sie in den folgenden Dokumenten von Drittanbietern:

REST in der AdSense Management API

Für die unterstützten Vorgänge besteht eine direkte Zuordnung zu REST-HTTP-Verben. Dies wird in AdSense Management API-Vorgänge beschrieben.

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

https://www.googleapis.com/adsense/v1.4/resourceID?parameters

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

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

https://www.googleapis.com/adsense/v1.4/adclients
https://www.googleapis.com/adsense/v1.4/adclients/adClientId
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits/adUnitId
https://www.googleapis.com/adsense/v1.4/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.

Unten finden Sie einige Beispiele für die Funktionsweise in der AdSense Management API.

Liste der Ad-Clients:

GET https://www.googleapis.com/adsense/v1.4/adclients/

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

GET https://www.googleapis.com/adsense/v1.4/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 erhalten Sie unter json.org.

Anfragen autorisieren

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

Informationen zu Autorisierungsprotokollen

In Ihrer Anwendung muss OAuth 2.0 verwendet werden, damit Anfragen autorisiert werden können. Andere Autorisierungsprotokolle werden nicht unterstützt.

Anfragen mit OAuth 2.0 autorisieren

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

Die Details des Autorisierungsablaufs für OAuth 2.0 richten sich nach der Art der Anwendung, die Sie schreiben. Der folgende allgemeine Ablauf gilt für alle Anwendungsarten:

  1. Wenn Sie Ihre Anwendung erstellt haben, registrieren Sie sie in der Google Developers Console. Von Google werden dann Informationen bereitgestellt, die Sie später benötigen, beispielsweise eine Client-ID und ein Client-Schlüssel.
  2. Aktivieren Sie die AdSense Management API in der Google Developers Console. Überspringen Sie diesen Schritt, falls die API nicht in der Developers Console aufgeführt wird.
  3. Wenn die Anwendung Zugriff auf Nutzerdaten benötigt, fordert sie von Google einen bestimmten Zugriffsumfang (Scope) an.
  4. Daraufhin wird ein Dialog angezeigt, in dem der Nutzer zustimmen muss, dass die Anwendung einige Nutzerdaten anfordert.
  5. Stimmt der Nutzer zu, erteilt Google Ihrer Anwendung ein Zugriffstoken, das für kurze Zeit gültig ist.
  6. Ihre Anwendung fordert Nutzerdaten an und das Zugriffstoken wird der Anfrage beigefügt.
  7. Wenn Google ermittelt, dass Ihre Anfrage und das Token gültig sind, werden die angeforderten Daten zurückgegeben.

Einige Anfragen enthalten zusätzliche Schritte, beispielsweise die Verwendung von Aktualisierungstoken zum Erhalt neuer Zugriffstoken. Ausführliche Informationen zu den Workflows für verschiedene Anwendungsarten finden Sie in der OAuth 2.0-Dokumentation von Google.

Im Folgenden sind die Informationen zum Zugriffsumfang (Scope) von OAuth 2.0 für die AdSense Management API angegeben:

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

Für die Anfrage des Zugriffs per OAuth 2.0 benötigt Ihre Anwendung die Informationen zum Zugriffsumfang sowie Informationen, die von Google während der Registrierung der Anwendung bereitgestellt werden (z. B. Client-ID bzw. Client-Schlüssel).

Tipp: Die Google APIs-Client-Bibliotheken können einen Teil des Autorisierungsprozesses für Sie übernehmen. Sie sind für verschiedene Programmiersprachen verfügbar. Weitere Informationen erhalten Sie auf der Seite Bibliotheken und Beispiele.

Eine Anfrage senden

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