Bevor Sie mit dem Coding Ihrer ersten Clientanwendung beginnen können, sind noch einige Vorbereitungen zu treffen, falls noch nicht geschehen.
Google-Konto erstellen und Search Ads 360-Berechtigungen erhalten
Wenn Sie die Search Ads 360 API verwenden möchten, benötigen Sie ein Google-Konto und die entsprechenden Berechtigungen, die diesem Konto in Search Ads 360 gewährt wurden:
Wenn Sie noch kein Google-Konto haben, erstellen Sie eines.
Bitten Sie einen Search Ads 360-Agenturmanager, einen Search Ads 360-Nutzer für Ihr Google-Konto zu erstellen.
Zum Herunterladen von Berichten benötigen Sie die Berechtigung zum Ansehen für die Werbetreibenden, mit denen Sie zusammenarbeiten.
Wenn Sie Conversions hinzufügen oder bearbeiten möchten, benötigen Sie die Berechtigung zum Bearbeiten für die Werbetreibenden, mit denen Sie zusammenarbeiten. In einer gemeinsam genutzten Floodlight-Konfiguration benötigen Sie Bearbeitungsberechtigungen für jeden untergeordneten Werbetreibenden, in den Sie Conversions hochladen möchten. Sie benötigen weder Zugriff auf den übergeordneten Werbetreibenden noch auf untergeordnete Werbetreibende, in die Sie keine Conversions hochladen. Wenn Sie Klick-IDs verwenden, um Conversions Besuchen zuzuordnen, benötigen Sie Bearbeitungszugriff auf das Werbetreibendenkonto, das die Klick-ID generiert hat. Wenn Sie eine Klick-ID von einem Werbetreibenden angeben, auf den Sie keinen Bearbeitungszugriff haben, ist die Anfrage nicht erfolgreich.
Der Agenturmanager kann Ihr Konto als Werbetreibendennutzer mit Zugriff auf bestimmte Werbetreibende oder mit einer höheren Zugriffsebene wie Agenturnutzer mit Zugriff auf alle Werbetreibenden in der Agentur einrichten.
API-Conversion-Dienst aktivieren
Wenn Sie Daten zu Conversions hochladen möchten, muss sich ein Search Ads 360-Nutzer mit den Berechtigungen eines Agenturmanagers in der Search Ads 360-Benutzeroberfläche anmelden und den Conversion-API-Dienst aktivieren. Eine Anleitung finden Sie in der Search Ads 360-Hilfe.
Google API Console-Projekt und OAuth-Anmeldedaten für Ihren Kunden erstellen
- Starten Sie das
Einrichtungstool der Google API Console.
Das Einrichtungstool führt Sie durch das Erstellen eines Projekts (oder die Verwendung eines vorhandenen Projekts), das Aktivieren der Search Ads 360 API und das Erstellen von OAuth 2.0-Anmeldedaten. - Wählen Sie auf der Seite Anwendung registrieren ein vorhandenes Projekt oder die Option Projekt erstellen aus. Klicken Sie anschließend auf Weiter:
- Nachdem die Search Ads 360 API in der Google API Console aktiviert wurde, klicken Sie auf die Schaltfläche Zu den Anmeldedaten.
- Geben Sie auf der Seite Anmeldedaten erstellen die folgenden Informationen ein:
- Welche API verwenden Sie?: Search Ads 360 API
- Auf welche Daten greifen Sie zu?: Nutzerdaten
- Klicken Sie auf die Schaltfläche Weiter.
Im Einrichtungstool können Sie jetzt eine OAuth 2.0-Client-ID erstellen.
- Folgen Sie der Anleitung im Einrichtungstool.
sa360Api.py installieren
In Search Ads 360 gibt es ein Dienstprogramm-Script, das die Autorisierung vereinfacht. Sie können dieses Skript auch zum Senden und Empfangen von Daten im JSON-Format verwenden, wenn Sie versuchen möchten, Daten zu senden und zu empfangen, bevor Sie eine vollständige Anwendung entwerfen und schreiben. Sie können viele der JSON-Beispiele aus dieser Dokumentationswebsite kopieren und direkt in das Skript eingeben.
So installieren Sie das Script:
- Installieren Sie Python 2.7.
Das Skript funktioniert nicht mit Python 3.x. - Installieren Sie cURL.
- Laden Sie sa360Api.zip herunter.
sa360Api.py
aussa360Api.zip
extrahieren.- Machen Sie
sa360Api.py
ausführbar.
Informationen zu REST-Grundlagen
Es gibt zwei Möglichkeiten, die API aufzurufen:
- Clientbibliotheken verwenden
- HTTP-Anfragen senden und die Antworten parsen
Wenn Sie keine Clientbibliotheken verwenden möchten, müssen Sie die Grundlagen von REST verstehen.
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 Search Ads 360 API
Die Search Ads 360 API-Vorgänge sind REST-HTTP-Verben direkt zugeordnet.
Das spezifische Format für Search Ads 360 API-URIs ist:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
Eine vollständige Liste der URIs für jeden unterstützten Vorgang in der API finden Sie in der API-Referenz.
Informationen zu JSON-Grundlagen
Wenn Sie REST verwenden, müssen Sie das JSON-Format für den Anfragetext verwenden. Sie können angeben, dass die Antworten entweder im JSON- oder CSV-Format vorliegen sollen.
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.