Wir empfehlen, die Clientbibliothek mit Apache Maven (oder Gradle) zu verwenden.
Neues Maven-/Gradle-Projekt erstellen
Erstellen Sie ein neues Maven-/Gradle-Projekt in der IDE Ihrer Wahl. Unsere Artefakte werden im Maven Central Repository veröffentlicht.
Die Maven-Abhängigkeit ist:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>31.0.0</version>
</dependency>
Die Gradle-Abhängigkeit ist:
implementation 'com.google.api-ads:google-ads:31.0.0'
Sie können auch Builds aus der Quelle erstellen. Für die Zwecke dieser Anleitung wird davon ausgegangen, dass Sie eine Projekteinrichtung mit den erforderlichen Abhängigkeiten haben.
Anmeldedaten für die Authentifizierung bei der API abrufen
Für den Zugriff auf die Google Ads API sind OAuth-Anmeldedaten und ein Google Ads API-Entwickler-Token erforderlich. In diesem Abschnitt wird erläutert, was diese sind, wie sie verwendet werden und wie sie erhalten werden.
Entwicklertoken (für den Zugriff auf die API)
Das Entwicklertoken ist mit einem Verwaltungskonto verknüpft und befindet sich in der Google Ads-Weboberfläche.
Das Entwickler-Token ist zwar mit einem Verwaltungskonto verknüpft, gewährt aber keinen Zugriff auf dieses Konto. Stattdessen gewährt das Entwickler-Token allgemein Zugriff auf die API und der Zugriff auf Kontoebene wird über OAuth konfiguriert.
OAuth-Anmeldedaten (für den Zugriff auf Google Ads-Konten)
Wenn Sie Nutzer von Google-Konten mit Zugriff auf Google Ads-Konten autorisieren möchten, müssen Sie einen Satz von OAuth-Anmeldedaten angeben.
Im Allgemeinen werden zwei OAuth-Abläufe verwendet: Desktopanwendungen (installierte Anwendungen) oder Webanwendungen. Der Hauptunterschied zwischen den beiden besteht darin, dass Desktopanwendungen den Systembrowser öffnen und einen lokalen Weiterleitungs-URI bereitstellen müssen, um Antworten vom Autorisierungsserver von Google zu verarbeiten. Webanwendungen können dagegen einen beliebigen Drittanbieter-Browser umleiten, um die Autorisierung abzuschließen und die Anmeldedaten an Ihren Server zu senden. Die Bibliothek unterstützt auch den weniger häufig verwendeten Dienstkonto-Vorgang.
- Autorisierung mit eigenen Anmeldedaten (Workflow für Desktop-Apps)
- Weitere Informationen finden Sie unter OAuth-Desktop-Anwendung. Dazu gehören alle Details, die Sie für die Autorisierung mit Ihren eigenen Anmeldedaten benötigen.
- Autorisierung als externer Google-Nutzer (Webablauf)
- Weitere Informationen finden Sie in der Anleitung für OAuth-Webanwendungen. Das folgende Beispiel zeigt, wie die OAuth-Autorisierung für beliebige Drittanbieter-Nutzer eingerichtet wird.
- Wenn Sie den Nutzer als Google Apps Domain-Nutzer autorisieren (Dienstkonto-Ablauf)
- Weitere Informationen finden Sie unter OAuth-Dienstkontoablauf. Im Folgenden wird anhand eines Beispiels erläutert, wie die OAuth-Autorisierung für Nutzer von Google Apps-Domains eingerichtet wird.
Wenn Ihr Zugriff auf das Google Ads-Kundenkonto über ein Google Ads-Verwaltungskonto erfolgt, müssen Sie außerdem eine Log-in-Kundennummer wie unten beschrieben angeben.
Log-in-Kundennummer (für den Zugriff auf Google Ads-Konten über ein Verwaltungskonto)
Geben Sie optional die Kundennummer eines Verwaltungskontos an, das Zugriff auf das Konto zur Anzeigenauslieferung gewährt. Dies muss angegeben werden, wenn Sie auf das Kundenkonto über ein Verwaltungskonto zugreifen. Sie müssen nicht alle Verwaltungskonten im Pfad zur Kundennummer angeben, sondern nur die oberste Verwaltungskonto-ID, die Sie für Zugriffsberechtigungen verwenden. Weitere Informationen finden Sie in der zugehörigen Dokumentation.
Clientbibliothek mit Ihren Anmeldedaten konfigurieren
Sie können die Clientbibliothek entweder mit einer Konfigurationsdatei, mit Umgebungsvariablen oder programmatisch konfigurieren. In diesem Leitfaden verwenden wir die Konfigurationsdatei und konzentrieren uns auf die Abläufe „Desktop“ und „Web“. Die Verwendung einer Konfigurationsdatei ist im Allgemeinen ein guter Ansatz, wenn Sie nur einen Satz von Anmeldedaten haben (z. B. wenn Sie Konten unter einem einzigen Verwaltungskonto verwalten).
Erstellen Sie eine ~/ads.properties-Datei mit folgendem Inhalt:
api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
Ersetzen Sie die Platzhalter durch die Anmeldedaten, die Sie im vorherigen Schritt erhalten haben.
Wenn Ihr Aktualisierungstoken für ein Verwaltungskonto gilt, sollten Sie außerdem die Kundennummer dieses Kontos als Anmeldekunde angeben:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Anmeldedaten überprüfen
Um sicherzugehen, dass alles richtig eingerichtet ist, führen wir das GetCampaigns-Beispiel aus.
Rufen Sie zuerst das Verzeichnis google-ads-examples auf.
$ cd google-ads-examples
Für dieses Beispiel ist ein --customerId-Parameter erforderlich. Der Wert muss dabei die Kundennummer Ihres Google Ads-Kontos ohne Bindestriche enthalten.
So führen Sie es mit Gradle aus:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Weitere Beispiele ansehen
Das examples-Paket in google-ads-examples enthält mehrere nützliche Beispiele. Die meisten Beispiele erfordern Parameter. Sie können entweder die Parameter als Argumente übergeben (empfohlen) oder die INSERT_XXXXX_HERE-Werte im Quellcode bearbeiten. Wenn Sie eine Nutzungsanweisung für ein Beispiel sehen möchten, übergeben Sie --help als einziges Argument.
Mit Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Sie können auch die Aufgabe listExamples in Gradle verwenden, um alle Beispiele, Beispiele in einem Unterverzeichnis oder Beispiele, bei denen die Beschreibung einen Suchbegriff enthält, aufzulisten.
# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'