Wir empfehlen Ihnen, den Client Bibliotheken und Beispiele für Ihre Implementierung. Wenn Ihre Integration jedoch der API spezielle Anforderungen hat, z. B. die Verwendung einer nicht unterstützten Sprache, können Sie direkte Anfragen wie unten beschrieben stellen.
Aufrufstil
REST ist eine Art Softwarearchitektur, die einen bequemen und einheitlichen Ansatz zur Abfrage und Bearbeitung von Daten bietet.
Der Begriff REST steht für Representational State Transfer. Im Zusammenhang mit Google-APIs bezieht es sich auf die Verwendung von HTTP-Verben zum Abrufen und Ändern von Darstellungen von Daten, die von Google gespeichert sind.
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 Googles RESTful APIs spezifiziert der Client eine Aktion mit einem HTTP-Verb wie POST
, GET
, PUT
oder DELETE
. Eine Ressource wird anhand eines weltweit eindeutigen URIs im folgenden Format spezifiziert:
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
Für die unterstützten Vorgänge besteht eine direkte Zuordnung zu REST-HTTP-Verben. Eine Beschreibung finden Sie unter Vorgänge für die AdSense-Verwaltungs-API.
Das spezifische Format für AdSense-Verwaltungs-API-URIs lautet:
https://adsense.googleapis.com/v2/resourceID?parameters
Dabei ist resourceID
die ID für eine Anzeige
Ad-Client, Anzeigenblock, URL-Channel, benutzerdefinierten Channel oder die Berichtsammlung und
parameters
sind beliebige Parameter, die auf
der Abfrage.
Das Format 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 jeden unterstützten Vorgang in der API verwendet wird, ist im Dokument AdSense Management API-Referenz Dokument.
Im Folgenden sehen Sie einige Beispiele, wie dies in der AdSense-Verwaltungs-API funktioniert.
Ad-Clients auflisten:
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
Beachten Sie, dass AdSense keine Dienstkonten unterstützt. Sie können stattdessen muss den Ablauf „Installierte Anwendung“ verwenden.
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 ermöglicht.
OAuth-Client-ID abrufenAlternativ 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:
- Wenn deine Anwendung Zugriff auf Nutzerdaten benötigt, bittet sie Google um einen bestimmten Zugriffsbereich.
- Dem Nutzer wird von Google ein Zustimmungsbildschirm angezeigt, auf dem er gebeten wird, deine Anwendung dazu zu autorisieren, einige seiner Daten abzufragen.
- Wenn der Nutzer zustimmt, erhält deine Anwendung von Google ein kurzlebiges Zugriffstoken.
- Die Anwendung fordert Nutzerdaten an, wobei das Zugriffstoken an die Anfrage angehängt wird.
- 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 Management 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.
Anforderung senden
Der letzte Schritt besteht darin, die API-Anfrage zu stellen. Weitere Informationen finden Sie in der Referenzdokumentation für bestimmte Informationen.