Wir empfehlen, die Clientbibliothek mit Apache Maven (oder Gradle) zu verwenden.
Neues Maven-/Gradle-Projekt erstellen
Erstellen Sie in der IDE Ihrer Wahl ein neues Maven-/Gradle-Projekt. 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>35.0.0</version>
</dependency>
Die Gradle-Abhängigkeit lautet:
implementation 'com.google.api-ads:google-ads:35.0.0'
Sie können auch aus der Quelle erstellen. In dieser Anleitung wird davon ausgegangen, dass Sie ein Projekt mit den erforderlichen Abhängigkeiten eingerichtet 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-Entwicklertoken erforderlich. In diesem Abschnitt wird erläutert, was sie sind, wie sie verwendet und wie sie abgerufen werden.
Entwicklertoken (für den Zugriff auf die API)
Das Entwicklertoken ist mit einem Verwaltungskonto verknüpft und in der Google Ads-Weboberfläche zu finden.
Das Entwickler-Token ist zwar mit einem Verwaltungskonto verknüpft, bietet aber keinen Zugriff auf dieses Konto. Stattdessen gewährt das Entwicklertoken Zugriff auf die API im Allgemeinen und der Zugriff auf Kontoebene wird über OAuth konfiguriert.
OAuth-Anmeldedaten (für den Zugriff auf Google Ads-Konten)
Wenn Sie Google-Kontonutzer mit Zugriff auf Google Ads-Konten autorisieren möchten, müssen Sie OAuth-Anmeldedaten angeben.
Es gibt zwei OAuth-Abläufe, die allgemein verwendet werden: Desktop-Apps (installierte Apps) oder Web-Apps. Der Hauptunterschied zwischen den beiden besteht darin, dass Desktop-Apps den Systembrowser öffnen und einen lokalen Weiterleitungs-URI angeben müssen, um Antworten vom Autorisierungsserver von Google zu verarbeiten. Web-Apps können hingegen einen beliebigen Drittanbieter-Browser weiterleiten, um die Autorisierung abzuschließen und die Anmeldedaten an Ihren Server zurückzusenden. Die Bibliothek unterstützt auch den weniger häufig verwendeten Dienstkontoablauf.
- Wenn Sie die Verwendung Ihrer eigenen Anmeldedaten autorisieren (Desktopanwendung)
- Sehen Sie sich den OAuth-Ablauf für Desktop-Apps an. Dieser enthält alle Details, die Sie für die Autorisierung mit Ihren eigenen Anmeldedaten benötigen.
- Autorisierung als Google-Nutzer eines Drittanbieters (Web-Anfrage)
- Siehe OAuth-Web-App-Ablauf. Hier sehen Sie ein Beispiel für die Einrichtung der OAuth-Autorisierung für beliebige Drittanbieternutzer.
- Autorisierung als Google Apps-Domainnutzer (Dienstkontoablauf)
- Sehen Sie sich den OAuth-Dienstkontoablauf an. 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 außerdem wie unten beschrieben eine Kunden-Log-in-ID angeben.
Anmeldekundennummer (für den Zugriff auf Google Ads-Konten über ein Verwaltungskonto)
Optional können Sie die Kundennummer eines Verwaltungskontos angeben, das Zugriff auf das Konto für die Anzeigenbereitstellung gewährt. Diese Angabe ist erforderlich, wenn Sie über ein Verwaltungskonto auf das Kundenkonto zugreifen. Sie müssen nicht alle Verwaltungskonten auf dem Pfad zur Kundennummer angeben, sondern nur die oberste Verwaltungs-ID, die Sie für Zugriffsberechtigungen verwenden. Weitere Informationen finden Sie in der zugehörigen Dokumentation.
Clientbibliothek mit deinen Anmeldedaten konfigurieren
Sie können die Clientbibliothek entweder mit einer Konfigurationsdatei, mit Umgebungsvariablen oder programmgesteuert konfigurieren. In dieser Anleitung verwenden wir den Ansatz mit der Konfigurationsdatei und konzentrieren uns auf die Desktop- und Webabläufe. Die Verwendung einer Konfigurationsdatei ist in der Regel eine gute Lösung, wenn Sie nur einen Satz von Anmeldedaten haben (z. B. wenn Sie Konten unter einem einzigen Administrator 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 Anmeldedaten, die Sie im vorherigen Schritt abgerufen haben.
Wenn Ihr Aktualisierungstoken für ein Verwaltungskonto gilt, sollten Sie außerdem die Kundennummer dieses Kontos als Anmeldekunden angeben:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Anmeldedaten validieren
Um sicherzustellen, dass alles richtig eingerichtet ist, führen wir das Beispiel GetCampaigns aus.
Rufen Sie zuerst das Verzeichnis google-ads-examples auf.
$ cd google-ads-examples
Für dieses Beispiel ist ein --customerId-Parameter erforderlich, dessen Wert die Kundennummer Ihres Google Ads-Kontos ohne Bindestriche ist.
So führen Sie das Script 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 eine Nutzungserklärung sehen möchten, geben Sie --help als einziges Argument an.
Mit Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Mit der Aufgabe listExamples in Gradle können Sie auch alle Beispiele, Beispiele in einem Unterverzeichnis oder Beispiele auflisten, deren Beschreibung einen Suchbegriff enthält.
# 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'