Hintergrund

Vorbereitung

  1. Bitten Sie Ihren Kundenbetreuer, die richtigen Berechtigungen für Konten einzurichten, auf die Ihre Anwendung zugreift.
  2. Wenn Sie mit den Konzepten von Authorized Buyers nicht vertraut sind, können Sie die Authorized Buyers-Hilfe aufrufen und mit der Benutzeroberfläche experimentieren. Wenn Ihre Anwendung Echtzeitgebote ausführen soll, lesen Sie die Dokumentation zum RTB-Protokoll.
  3. Rufen Sie die APIs-Konsole auf, um ein neues Projekt einzurichten. Melden Sie sich entweder in Ihrem Google-Entwicklerkonto an oder erstellen Sie ein Konto. Sie werden dann aufgefordert, ein Projekt zu erstellen und einige Nutzungsbedingungen zu akzeptieren.

Übergeordnete und untergeordnete Konten

Wenn Sie in einer Kontostruktur mit übergeordneten und untergeordneten Konten arbeiten, können Sie möglicherweise effektiver arbeiten, wenn Sie verstehen, wie sie interagieren. Im Folgenden finden Sie eine kurze Zusammenfassung:

Untergeordnete Konten

Ein Nutzer mit Anmeldedaten, die Zugriff auf ein untergeordnetes Konto gewähren, kann nur mit seinem Konto verknüpfte Ressourcen ansehen und ändern. Untergeordnete Konten können keine Ressourcen von anderen untergeordneten oder übergeordneten Konten ansehen oder ändern.

Übergeordnete Konten

Ein Nutzer mit Anmeldedaten, die Zugriff auf ein übergeordnetes Konto gewähren, kann neben allen verknüpften untergeordneten Konten auch Ressourcen für das übergeordnete Konto aufrufen und ändern. Auf Vorgänge, bei denen die gesamte Ressource aufgelistet wird, erhält dieser Nutzer eine Antwort mit Daten für sein Konto und alle untergeordneten Konten. Bei anderen Arten von Anfragen, die auf Ressourcen für untergeordnete Konten abzielen, muss ein übergeordnetes Konto den Pfadparameter accountId für das untergeordnete Konto anstelle eines eigenen accountId angeben.

Das REST API-Datenmodell

Eine Ressource ist eine einzelne Datenentität mit einer eindeutigen Kennung. Die Ressource „Konten“ stellt einen Eintrag in einem Authorized Buyers-Konto dar und ist die Stammdatenklasse für die Ad Exchange Buyer API. Die Methoden der API beziehen sich auf einzelne Kontenressourcen und Sammlungen von Kontenressourcen.

Eine Kontenressource umfasst: eine Konto-ID, beim Cookie-Abgleich verwendete Informationen, Bieterstandorte, die URL, an die Gebotsanfragen gesendet werden, und eine Anfrage zur Angabe der maximalen Anzahl von Abfragen pro Sekunde, die von der Ad Exchange gesendet werden sollen.

Neben der Ressource und Sammlung von Konten werden in der Ad Exchange-API für Käufer folgende Datenstrukturen definiert:

Bieterstandort

Bieterstandorte sind Strukturen, die mit Kontenressourcen zurückgegeben werden, um die URL anzugeben, an die die Anzeigenplattform Gebotsanfragen senden soll, sowie die maximale Anzahl von Abfragen pro Sekunde, die von der Anzeigenplattform gesendet werden sollen. Hier ist ein Beispiel für einen Bieterstandort im JSON-Format: 

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

Elemente

Elemente stellen eine Liste der Konten zur Verfügung. Hier ist ein Beispiel für Elemente im JSON-Format: 

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

Unterstützte Vorgänge

In der Ad Exchange-API für Käufer können Sie drei verschiedene Methoden für Sammlungen und Ressourcen aufrufen, wie in der folgenden Tabelle beschrieben. Für alle Vorgänge ist eine Autorisierung erforderlich.

Vorgang Beschreibung REST-HTTP-Zuordnungen
list Listet alle Konten auf, auf die der aktuell authentifizierte Nutzer zugreifen kann. Für einen Sammlungs-URI ist dies GET.
get Ruft eine bestimmte Kontenressource ab. Für einen Ressourcen-URI ist dies GET.
Aktualisieren Aktualisiert eine bestimmte Kontenressource. Für einen Ressourcen-URI ist dies PUT, wobei Sie Daten für die aktualisierte Ressource übergeben.

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 Ad Exchange-API für Käufer

Die unterstützten Vorgänge lassen sich direkt den REST-HTTP-Verben zuordnen, wie unter API-Vorgänge beschrieben.

Das spezifische Format für API-URIs lautet:

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

Dabei ist resourceID die ID für eine Kontenressource und parameters alle Parameter, die auf die Abfrage angewendet werden können. Weitere Informationen finden Sie unter Standardabfrageparameter und in der Referenzdokumentation.

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

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

Die vollständige Gruppe von URIs, die für die einzelnen unterstützten Vorgänge in der API verwendet wird, ist in der Referenzdokumentation zusammengefasst.

Im Folgenden sehen Sie ein Beispiel für die Funktionsweise in der Ad Exchange-API für Käufer.

Rufen Sie die Kontenliste des authentifizierten Nutzers ab:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

Datenformat

JSON

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.