Zalecamy używanie biblioteki klienta z Apache Maven lub Gradle.
Tworzenie nowego projektu Maven/Gradle
Utwórz nowy projekt Maven lub Gradle w wybranym środowisku IDE. Nasze artefakty są publikowane w centralnym repozytorium Maven.
Zalecamy używanie zestawienia materiałów (BOM) interfejsu Google Ads API do zarządzania wersjami zależności. To najlepszy sposób na uniknięcie konfliktów zależności z bibliotekami takimi jak Guava i GAX, które są też używane przez inne frameworki. BOM zapewnia, że używasz dokładnych wersji tych zależności, które zostały przetestowane z biblioteką klienta Google Ads.
Zależność Maven to:
<!-- Import the Bill of Materials (BOM) to ensure you're using compatible
versions of all google-ads libraries. -->
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads-bom</artifactId>
<version>40.0.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<!-- Add the google-ads dependency, without a version. The version is
managed by the BOM. -->
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
</dependency>
Zależność Gradle to:
// Import the Bill of Materials (BOM).
implementation platform('com.google.api-ads:google-ads-bom:40.0.0')
// Add the google-ads dependency, without a version.
implementation 'com.google.api-ads:google-ads'
Możesz też utworzyć go na podstawie źródła. Na potrzeby tego przewodnika zakładamy, że masz już skonfigurowany projekt z wymaganymi zależnościami.
Jeśli kompilujesz z kodu źródłowego, upewnij się, że w IDE masz włączone przetwarzanie adnotacji.
Deklarowanie zależności objętych BOM
Lista materiałów (BOM) interfejsu Google Ads API
obejmuje zarządzanie wersjami kilku popularnych bibliotek, takich jak Guava, Protobuf, GAX i gRPC. Aby uniknąć potencjalnych konfliktów zależności, nie możesz określać wersji podczas deklarowania zależności, które obejmuje BOM.
Lista BOM automatycznie zarządza wersjami tych bibliotek, zapewniając ich zgodność.
Aby na przykład zadeklarować zależność Guava w Mavenie, użyj tego kodu:
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<!-- NO VERSION SPECIFIED -->
</dependency>
W Gradle:
implementation 'com.google.guava:guava' // NO VERSION SPECIFIED
Pomijając wersję, pozwalasz BOM-owi zarządzać nią, co pomaga zapobiegać problemom spowodowanym przez niezgodne wersje zależności. Typowe wskaźniki konfliktów zależności to NoSuchMethodError lub ClassNotFoundException, które często można rozwiązać, upewniając się, że wszystkie zależności zarządzane przez BOM nie mają określonej wersji.
Uzyskiwanie danych logowania do uwierzytelniania w interfejsie API
Dostęp do interfejsu Google Ads API wymaga danych logowania OAuth i tokena programisty interfejsu Google Ads API. Z tej sekcji dowiesz się, czym są te dane, jak są wykorzystywane i jak je uzyskać.
Token programisty (umożliwiający dostęp do interfejsu API)
Token programisty jest połączony z kontem menedżera i można go znaleźć w interfejsie internetowym Google Ads.
Token programisty jest powiązany z kontem menedżera, ale nie zapewnia dostępu do tego konta. Token programisty przyznaje dostęp do interfejsu API w ogóle, a dostęp na poziomie konta jest konfigurowany za pomocą OAuth.
Dane uwierzytelniające OAuth (na potrzeby dostępu do kont Google Ads)
Aby autoryzować użytkowników kont Google z dostępem do kont Google Ads, musisz podać zestaw danych logowania OAuth.
Ogólnie używane są 2 ścieżki OAuth: aplikacja na komputer (zainstalowana) lub aplikacja internetowa. Główna różnica między nimi polega na tym, że aplikacje na komputery muszą otwierać przeglądarkę systemową i podawać lokalny identyfikator URI przekierowania, aby obsługiwać odpowiedzi z serwera autoryzacji Google, natomiast aplikacje internetowe mogą przekierowywać dowolną przeglądarkę innej firmy, aby dokończyć autoryzację i przesyłać dane logowania z powrotem na serwer. Biblioteka obsługuje też rzadziej używany przepływ konta usługi.
- Jeśli autoryzujesz za pomocą własnych danych logowania (proces aplikacji na komputer)
- Zapoznaj się z procesem uwierzytelniania aplikacji komputerowej za pomocą OAuth. Zawiera wszystkie informacje potrzebne do autoryzacji za pomocą własnych danych logowania.
- Jeśli autoryzujesz się jako użytkownik Google innej firmy (przepływ internetowy)
- Zapoznaj się z procesem aplikacji internetowej OAuth. Ten artykuł zawiera przykład konfiguracji autoryzacji OAuth dla dowolnych użytkowników zewnętrznych.
- Jeśli autoryzujesz się jako użytkownik domeny Google Apps (proces konta usługi)
- Zapoznaj się z procesem konta usługi OAuth. Zawiera przykład konfiguracji autoryzacji OAuth dla użytkowników domeny Google Apps.
Jeśli masz dostęp do konta klienta Google Ads za pomocą konta menedżera Google Ads, musisz też podać identyfikator klienta logowania zgodnie z poniższymi instrukcjami.
Identyfikator klienta logowania (umożliwia dostęp do kont Google Ads za pomocą konta menedżera)
Opcjonalnie podaj identyfikator klienta konta menedżera, które zapewnia dostęp do konta wyświetlania reklam. Musisz to określić, jeśli masz dostęp do konta klienta za pomocą konta menedżera. Nie musisz podawać wszystkich kont menedżera na ścieżce do identyfikatora klienta, tylko identyfikator menedżera najwyższego poziomu, którego używasz do określania uprawnień dostępu. Więcej informacji znajdziesz w odpowiedniej dokumentacji.
Skonfiguruj bibliotekę klienta za pomocą swoich danych logowania
Bibliotekę klienta możesz skonfigurować za pomocą pliku konfiguracyjnego, zmiennych środowiskowych lub programowo. W tym przewodniku użyjemy podejścia opartego na pliku konfiguracyjnym i skupimy się na przepływach na komputerach i w internecie. Używanie pliku konfiguracji jest zwykle dobrym rozwiązaniem, jeśli masz tylko jeden zestaw danych logowania (np. zarządzasz kontami w ramach jednego konta menedżera).
Utwórz plik ~/ads.properties z tą zawartością:
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
Zastąp obiekty zastępcze danymi logowania uzyskanymi w poprzednim kroku.
Jeśli token odświeżania dotyczy konta menedżera, jako klienta logowania podaj identyfikator klienta tego konta:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Sprawdź dane logowania
Aby mieć pewność, że wszystko jest poprawnie skonfigurowane, uruchomimy przykład GetCampaigns.
Najpierw przejdź do katalogu google-ads-examples.
cd google-ads-examples
Ten przykład wymaga parametru --customerId, którego wartością jest identyfikator klienta konta Google Ads bez myślników.
Aby uruchomić za pomocą Gradle:
./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Zobacz inne przykłady
Pakiet examples w google-ads-examples zawiera kilka przydatnych przykładów. Większość przykładów wymaga parametrów. Parametry możesz przekazywać jako argumenty (zalecane) lub edytować wartości INSERT_XXXXX_HERE w kodzie źródłowym. Aby wyświetlić instrukcję użycia, przekaż --help jako jedyny argument.
W przypadku Gradle:
./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Możesz też użyć zadania listExamples w Gradle, aby wyświetlić listę wszystkich przykładów, przykładów w podkatalogu lub przykładów, w których opis zawiera wyszukiwane słowo.
# 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'