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 lautet:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>31.0.0</version>
</dependency>
Die Gradle-Abhängigkeit lautet:
implementation 'com.google.api-ads:google-ads:31.0.0'
Sie können auch einen Build aus der Quelle erstellen. In dieser Anleitung wird davon ausgegangen, dass Sie eine Projekteinrichtung mit den erforderlichen Abhängigkeiten haben.
Anmeldedaten zur 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 sie sind, wie sie verwendet werden und wie sie abgerufen werden.
Entwicklertoken (für den Zugriff auf die API)
Das Entwicklertoken ist mit einem Verwaltungskonto verknüpft und befindet sich auf der Google Ads-Weboberfläche.
Das Entwicklertoken ist zwar mit einem Verwaltungskonto verknüpft, bietet aber keinen Zugriff auf dieses Konto. Stattdessen wird über das Entwicklertoken allgemein Zugriff auf die API gewährt und der Zugriff auf Kontoebene wird über OAuth konfiguriert.
OAuth-Anmeldedaten (für den Zugriff auf Google Ads-Konten)
Zur Autorisierung als Nutzer von Google-Konten mit Zugriff auf Google Ads-Konten müssen Sie einen Satz 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 zur Verarbeitung der Antworten vom Autorisierungsserver von Google angeben müssen. Webanwendungen können hingegen einen beliebigen Drittanbieterbrowser weiterleiten, um die Autorisierung abzuschließen und die Anmeldedaten zurück an Ihren Server zu senden. Die Bibliothek unterstützt auch weniger häufig verwendete Dienstkonten.
- Wenn Sie die Autorisierung mit Ihren eigenen Anmeldedaten durchführen (Workflow für Desktop-Apps)
- Weitere Informationen findest du im Leitfaden zur OAuth-Desktop-App. Dies umfasst alle Details, die Sie für die Autorisierung mit Ihren eigenen Anmeldedaten benötigen.
- Wenn Sie als Drittanbieter-Google-Nutzer autorisieren (Webablauf)
- Weitere Informationen finden Sie im Hilfeartikel OAuth-Webanwendungen-Workflow. Hier sehen Sie ein Beispiel für das Einrichten der OAuth-Autorisierung für beliebige Nutzer von Drittanbietern.
- Wenn Sie als Nutzer einer Google Apps-Domain autorisieren (Vorgang für Dienstkonten)
- Weitere Informationen findest du im Abschnitt zum OAuth-Dienstkonto-Vorgang. Hier sehen Sie ein Beispiel für die Einrichtung der OAuth-Autorisierung für Nutzer von Google Apps-Domains.
Wenn Sie über ein Google Ads-Verwaltungskonto auf das Google Ads-Kundenkonto zugreifen, müssen Sie zusätzlich wie unten beschrieben eine Log-in-Kundennummer angeben.
Log-in-Kundennummer (für den Zugriff auf Google Ads-Konten über ein Verwaltungskonto)
Optional können Sie die Kundennummer eines Verwaltungskontos angeben, über das Zugriff auf das Konto zur Anzeigenauslieferung gewährt wird. Sie muss angegeben werden, wenn Sie über ein Verwaltungskonto auf das Kundenkonto 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, Umgebungsvariablen oder programmatisch konfigurieren. In dieser Anleitung verwenden wir den Ansatz für die Konfigurationsdatei und konzentrieren uns dabei auf die Abläufe im Desktop- und Web-Modus. Die Verwendung einer Konfigurationsdatei ist im Allgemeinen ein guter Ansatz, wenn Sie nur einen Satz 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 Ihre im vorherigen Schritt abgerufenen Anmeldedaten.
Wenn Ihr Aktualisierungstoken für ein Verwaltungskonto gilt, sollten Sie außerdem die Kundennummer dieses Kontos als Log-in-Kunde angeben:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Anmeldedaten validieren
Damit alles korrekt eingerichtet ist, verwenden wir das GetCampaigns-Beispiel.
Rufen Sie zuerst das Verzeichnis google-ads-examples auf.
$ cd google-ads-examples
In diesem Beispiel ist der Parameter --customerId erforderlich, wobei der Wert die Kundennummer Ihres Google Ads-Kontos ohne Bindestriche ist.
So führen Sie es mit Gradle aus:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Weitere Beispiele ansehen
Das Paket examples in google-ads-examples enthält mehrere nützliche Beispiele. Für die meisten Beispiele sind Parameter erforderlich. Sie können die Parameter entweder als Argumente übergeben (empfohlen) oder die INSERT_XXXXX_HERE-Werte im Quellcode bearbeiten. Wenn Sie ein Beispiel für eine Nutzungsanweisung 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'