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 zentralen Maven-Repository veröffentlicht.
Die Maven-Abhängigkeit lautet:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>38.0.0</version>
</dependency>
Die Gradle-Abhängigkeit lautet:
implementation 'com.google.api-ads:google-ads:38.0.0'
Sie können auch aus der Quelle erstellen. Für diese Anleitung wird davon ausgegangen, dass Sie ein Projekt mit den erforderlichen Abhängigkeiten eingerichtet haben.
Wenn Sie aus dem Quellcode erstellen, müssen Sie die Annotationsverarbeitung in Ihrer IDE aktivieren.
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 abgerufen werden.
Entwickler-Token (für den Zugriff auf die API)
Das Entwicklertoken ist mit einem Verwaltungskonto verknüpft und kann in der Google Ads-Weboberfläche gefunden werden.
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. Der Zugriff auf Kontoebene wird über OAuth konfiguriert.
OAuth-Anmeldedaten (für den Zugriff auf Google Ads-Konten)
Wenn Sie sich als Google-Kontonutzer mit Zugriff auf Google Ads-Konten autorisieren möchten, müssen Sie OAuth-Anmeldedaten angeben.
Es gibt zwei OAuth-Abläufe, die im Allgemeinen verwendet werden: Desktop-App (installiert) oder Web-App. 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 einen beliebigen Drittanbieterbrowser weiterleiten, um die Autorisierung abzuschließen und die Anmeldedaten an Ihren Server zurückzusenden. Die Bibliothek unterstützt auch den weniger häufig verwendeten Dienstkonto-Ablauf.
- Wenn Sie die Autorisierung mit Ihren eigenen Anmeldedaten vornehmen (Desktop-App-Ablauf)
- OAuth-Ablauf für Desktop-Apps Dazu gehören alle Details, die Sie für die Autorisierung mit Ihren eigenen Anmeldedaten benötigen.
- Wenn Sie sich als Google-Drittanbieternutzer autorisieren (Webvorgang)
- Weitere Informationen finden Sie unter OAuth-Web-App-Vorgang. In diesem Beispiel wird gezeigt, wie Sie die OAuth-Autorisierung für beliebige Drittanbieter einrichten.
- Wenn Sie als Google Apps-Domainnutzer autorisieren (Dienstkonto-Ablauf)
- Weitere Informationen finden Sie unter OAuth-Dienstkonto. Hier finden Sie ein Beispiel für die Einrichtung der OAuth-Autorisierung für Google Apps-Domainnutzer.
Wenn Sie über ein Google Ads-Verwaltungskonto auf das Google Ads-Kundenkonto zugreifen, müssen Sie auch eine Anmelde-Kundennummer angeben (siehe unten).
Kundennummer für die Anmeldung (für den Zugriff auf Google Ads-Konten über ein Verwaltungskonto)
Geben Sie optional die Kunden-ID eines Verwaltungskontos an, das Zugriff auf das Konto für die Anzeigenbereitstellung bietet. Dies 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 Manager-ID, die Sie für Zugriffsrechte 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 programmgesteuert konfigurieren. In dieser Anleitung verwenden wir die Konfigurationsdatei und konzentrieren uns auf die Desktop- und Web-Abläufe. Die Verwendung einer Konfigurationsdatei ist in der Regel eine gute Vorgehensweise, wenn Sie nur einen Satz Anmeldedaten haben, z. B. wenn Sie Konten unter einem einzelnen 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 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 validieren
Damit alles richtig eingerichtet ist, führen wir das GetCampaigns-Beispiel aus.
Wechseln Sie zuerst in das Verzeichnis google-ads-examples.
cd google-ads-examples
Für dieses Beispiel ist ein --customerId-Parameter erforderlich, dessen Wert Ihre Google Ads-Kundennummer ohne Bindestriche ist.
So führen Sie den Test 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 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 den Task listExamples in Gradle auch verwenden, um alle Beispiele, Beispiele in einem Unterverzeichnis oder Beispiele aufzulisten, in denen die 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'