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 sind veröffentlicht im Maven Central .
Die Maven-Abhängigkeit ist:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>33.0.0</version>
</dependency>
Die Gradle-Abhängigkeit ist:
implementation 'com.google.api-ads:google-ads:33.0.0'
Sie können auch Builds aus der Quelle erstellen. In diesem Beispiel wird angenommen, dass Sie eine Projekteinrichtung mit den erforderlichen Abhängigkeiten haben, verfügbar.
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 erforderlich. Token. In diesem Abschnitt wird erläutert, was diese sind, wie sie verwendet und erhalten haben.
Entwicklertoken (für den Zugriff auf die API)
Das Entwickler-Token ist mit einem Administrator verknüpft. und finden Sie in der Google Ads-Weboberfläche.
Das Entwickler-Token ist zwar mit einem Verwaltungskonto verknüpft, auf dieses Konto zugreifen können. Stattdessen gewährt das Entwickler-Token Zugriff auf API im Allgemeinen und der Zugriff auf Kontoebene wird über OAuth konfiguriert.
OAuth-Anmeldedaten (für den Zugriff auf Google Ads-Konten)
So autorisieren Sie Nutzer von Google-Konten mit Zugriff auf Google Ads-Konten: muss einen Satz von OAuth-Anmeldedaten bereitstellen.
Im Allgemeinen werden zwei OAuth-Abläufe verwendet: (installierte) Desktop-Apps. oder eine Webanwendung. Der Hauptunterschied zwischen den beiden besteht darin, dass Desktop-Apps den Systembrowser öffnen und einen lokalen Weiterleitungs-URI angeben, um Antworten von Google-Autorisierungsserver, während Web-Apps beliebig viele Drittanbieter-Browser, um die Autorisierung abzuschließen und die Anmeldedaten an den auf Ihrem Server. Die Bibliothek unterstützt auch das weniger häufig verwendete Dienstkonto Ablauf.
- Autorisierung mit eigenen Anmeldedaten (Workflow für Desktop-Apps)
- Weitere Informationen finden Sie in der OAuth-Desktop-App . Dazu gehören alle Details, die Sie mit Ihren eigenen Anmeldedaten autorisieren müssen.
- Autorisierung als externer Google-Nutzer (Webablauf)
- Weitere Informationen finden Sie in der Anleitung für OAuth-Webanwendungen. Dieses wird anhand eines Beispiels veranschaulicht, wie die OAuth-Autorisierung für beliebige Drittanbieter- Nutzern.
- Wenn Sie den Nutzer als Google Apps Domain-Nutzer autorisieren (Dienstkonto-Ablauf)
- Weitere Informationen finden Sie im OAuth-Dienstkonto . Dies ist ein Beispiel dafür, wie Sie OAuth-Autorisierung für Nutzer von Google Apps-Domains einrichten.
Wenn der Zugriff auf das Google Ads-Kundenkonto über einen Google Ads-Manager erfolgt -Konto müssen Sie wie unten beschrieben auch eine Kundennummer für die Anmeldung angeben.
Log-in-Kundennummer (für den Zugriff auf Google Ads-Konten über ein Verwaltungskonto)
Geben Sie optional die Kundennummer eines Verwaltungskontos an, über das Zugriff auf Konto zur Anzeigenauslieferung. Dies muss angegeben werden, wenn Sie Zugriff auf den Konto über ein Verwaltungskonto. Es müssen nicht alle Verwaltungskonten angegeben werden im Pfad zur Kundennummer angezeigt wird, ist nur die oberste Verwaltungskonto-ID, die Sie für Zugriffsberechtigungen nutzen. Weitere Informationen finden Sie in der entsprechenden Dokumentation.
Clientbibliothek mit Ihren Anmeldedaten konfigurieren
Sie können die Clientbibliothek mit einer Konfigurationsdatei konfigurieren, Umgebungsvariablen oder programmatisch. Für diesen Leitfaden verwenden wir und sich auf die Desktop- und Web-Workflows konzentrieren. Mit einem ist eine Konfigurationsdatei ein guter Ansatz, wenn Sie nur einen Satz Anmeldedaten (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 Sie ein Aktualisierungstoken für ein Verwaltungskonto verwenden, geben Sie die Kundennummer dieses Kontos als Login-Kunde an:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Anmeldedaten überprüfen
Um sicherzustellen, dass alles korrekt eingerichtet ist, führen wir die Methode GetCampaigns Beispiel
Rufen Sie zuerst das Verzeichnis google-ads-examples auf.
$ cd google-ads-examples
Für dieses Beispiel ist ein --customerId-Parameter erforderlich, wobei der Wert Ihr
Kundennummer des Google Ads-Kontos ohne Bindestriche.
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 einige nützliche Beispiele. Die meisten Beispiele erfordern
Parameter. Sie können die Parameter entweder als Argumente übergeben (empfohlen) oder
Bearbeiten Sie die INSERT_XXXXX_HERE-Werte im Quellcode. So rufen Sie eine Nutzungserklärung auf:
Übergeben Sie in einem Beispiel --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 aufzulisten.
Beispiele in einem Unterverzeichnis oder Beispiele, bei denen die Beschreibung eine Suchanfrage 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'