Zalecamy używanie biblioteki klienta z Apache Maven (lub Gradle).
Tworzenie nowego projektu Maven lub Gradle
Utwórz nowy projekt Maven/Gradle w wybranym środowisku IDE. Nasze artefakty są publikowane w centralnym repozytorium Maven.
Zależność Maven:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>36.0.0</version>
</dependency>
Zależność Gradle:
implementation 'com.google.api-ads:google-ads:36.0.0'
Możesz też utworzyć wersję na podstawie kodu źródłowego. W tym przewodniku zakładamy, że masz skonfigurowany projekt z dostępnymi wymaganymi zależnościami.
Uzyskiwanie danych logowania do uwierzytelniania w interfejsie API
Dostęp do interfejsu Google Ads API wymaga danych logowania OAuth i tokenu programisty Google Ads API. W tej sekcji wyjaśniamy, czym są te dane, jak się ich używa i jak się je uzyskuje.
Token programisty (dostęp do interfejsu API)
Token programisty jest powiązany z kontem menedżera i można go znaleźć w interfejsie internetowym Google Ads.
Chociaż token programisty jest połączony z kontem menedżera, nie zapewnia dostępu do tego konta. Zamiast tego 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 (dostęp do kont Google Ads)
Aby autoryzować użytkowników kont Google z dostępem do kont Google Ads, musisz podać zestaw danych logowania OAuth.
Dostępne są 2 główne przepływy OAuth: aplikacja internetowa lub aplikacja na komputer (zainstalowana). Główna różnica między nimi polega na tym, że aplikacje na komputer muszą otworzyć przeglądarkę systemową i podać lokalny identyfikator URI przekierowania, aby obsłużyć odpowiedzi z serwera autoryzacji Google, podczas gdy aplikacje internetowe mogą przekierować dowolną przeglądarkę innej firmy, aby dokończyć autoryzację i odesłać poświadczenia z powrotem do serwera. Biblioteka obsługuje też rzadziej używany proces dotyczący konta usługi.
- Jeśli autoryzujesz za pomocą własnych danych logowania (proces w aplikacji na komputer)
- Zapoznaj się z przepływem danych w przypadku aplikacji na komputery. Obejmuje to wszystkie dane potrzebne do autoryzacji za pomocą własnych danych logowania.
- Jeśli autoryzację wykonujesz jako użytkownik Google innej firmy (proces w przeglądarce)
- Zapoznaj się z procesem uwierzytelniania aplikacji internetowej OAuth. Poniżej znajdziesz przykład konfiguracji autoryzacji OAuth dla dowolnych użytkowników spoza organizacji.
- Jeśli autoryzujesz jako użytkownik domeny Google Apps (proces autoryzacji za pomocą konta usługi)
- Zobacz proces konfiguracji konta usługi OAuth. Poniżej znajdziesz przykład konfigurowania autoryzacji OAuth dla użytkowników domen Google Apps.
Jeśli dostęp do konta klienta Google Ads masz za pomocą konta menedżera Google Ads, musisz też podać identyfikator klienta logowania w sposób opisany poniżej.
Identyfikator klienta logowania (dostęp do kont Google Ads przez konto menedżera)
Opcjonalnie możesz podać identyfikator klienta konta menedżera, który daje dostęp do konta wyświetlania reklam. Musisz to podać, jeśli dostęp do konta klienta masz na koncie menedżera. Nie musisz podawać wszystkich kont menedżera na ścieżce do identyfikatora klienta. Wystarczy podać najwyższy identyfikator menedżera, którego używasz do uprawnień dostępu. Więcej informacji znajdziesz w odpowiedniej dokumentacji.
Konfigurowanie biblioteki klienta za pomocą swoich poświadczeń
Bibliotekę klienta możesz skonfigurować za pomocą pliku konfiguracyjnego, zmiennych środowiskowych lub programowo. W tym przewodniku użyjemy podejścia opartego na pliku konfiguracji i skoncentrujemy się na przepływach na komputerze i w przeglądarce. Korzystanie z pliku konfiguracji jest zwykle dobrym rozwiązaniem, jeśli masz tylko 1 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 swoimi danymi logowania uzyskanymi w poprzednim kroku.
Jeśli token odświeżania jest przeznaczony dla konta menedżera, jako klienta logowania musisz podać identyfikator klienta tego konta:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Sprawdzanie danych logowania
Aby mieć pewność, że wszystko jest prawidłowo skonfigurowane, uruchomy przykład GetCampaigns.
Najpierw przejdź do katalogu google-ads-examples.
$ cd google-ads-examples
W tym przykładzie musisz użyć parametru --customerId, którego wartością jest identyfikator klienta Twojego konta Google Ads bez myślników.
Aby uruchomić Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Inne przykłady
Pakiet Przykłady w google-ads-examples zawiera kilka przydatnych przykładów. Większość przykładów wymaga parametrów. Parametry możesz przekazać jako argumenty (zalecane) lub edytować wartości INSERT_XXXXX_HERE w kodzie źródłowym. Aby wyświetlić oświadczenie o użytkowaniu, jako jedyny argument podaj wartość --help.
W przypadku Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Możesz też użyć zadania listExamples w Gradle, aby wyświetlić wszystkie przykłady, przykłady w podkatalogu lub przykłady, których opis zawiera wyszukiwane hasło.
# 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'