Zalecamy używanie biblioteki klienta z oprogramowaniem Apache Maven (lub Gradle).
Utwórz nowy projekt Maven/Gradle
Utwórz nowy projekt Maven/Gradle w wybranym IDE. Nasze artefakty są publikowane w centralnym repozytorium Maven.
Zależność Maven:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>29.0.0</version>
</dependency>
Zależność od Gradle:
implementation 'com.google.api-ads:google-ads:29.0.0'
Możesz też tworzyć na podstawie źródła. Na potrzeby tego przewodnika zakładamy, że masz projekt skonfigurowany z dostępnymi wymaganymi zależnościami.
Uzyskiwanie danych logowania do uwierzytelniania za pomocą interfejsu API
Dostęp do interfejsu Google Ads API wymaga danych logowania OAuth i tokena programisty interfejsu Google Ads API. W tej sekcji wyjaśniamy, co to są, jak są używane i jak je uzyskać.
Token programisty (aby uzyskać 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 połączony z kontem menedżera, ale 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 przez OAuth.
Dane logowania OAuth (aby uzyskać dostęp do kont Google Ads)
Aby upoważnić użytkowników konta Google z dostępem do kont Google Ads, musisz podać zestaw danych logowania OAuth.
Najczęściej są wykorzystywane dwa procesy OAuth: aplikacja komputerowa (zainstalowana) lub aplikacja internetowa. Główna różnica między nimi polega na tym, że aplikacje komputerowe muszą otwierać przeglądarkę systemową i dostarczać lokalny identyfikator URI przekierowania do obsługi odpowiedzi z serwera autoryzacji Google. Aplikacje internetowe mogą natomiast przekierowywać dowolną przeglądarkę innej firmy, aby dokończyć autoryzację i przesłać dane logowania z powrotem na Twój serwer. Biblioteka obsługuje też rzadziej używany przepływ konta usługi.
- Jeśli dokonujesz autoryzacji za pomocą własnych danych logowania (przepływ aplikacji komputerowej)
- Zapoznaj się z przepływem aplikacji komputerowej OAuth. Obejmuje to wszystkie szczegóły potrzebne do autoryzacji przy użyciu własnych danych logowania.
- Jeśli użytkownik jest upoważniony jako użytkownik Google (przepływ witryny)
- Zapoznaj się z opisem procesu aplikacji internetowej OAuth. Tutaj znajdziesz przykład konfiguracji autoryzacji OAuth dla wybranych użytkowników zewnętrznych.
- Jeśli przeprowadzasz autoryzację jako użytkownik domeny Google Apps (przepływ konta usługi)
- Zapoznaj się z Przepływem konta usługi OAuth. Ten przykład pokazuje, jak skonfigurować autoryzację 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 w sposób opisany poniżej.
Identyfikator klienta logowania (w celu uzyskania dostępu do kont Google Ads za pomocą konta menedżera)
Opcjonalnie podaj identyfikator klienta konta menedżera, które przyznaje dostęp do konta wyświetlania reklam. Musisz go podać, jeśli masz dostęp do konta klienta za pomocą konta menedżera. Nie ma potrzeby podawania wszystkich kont menedżera na ścieżce do identyfikatora klienta. Jest to tylko identyfikator najwyższego poziomu, którego używasz w celu uzyskania uprawnień dostępu. Więcej informacji znajdziesz w powiązanej dokumentacji.
Skonfiguruj bibliotekę klienta za pomocą swoich danych logowania
Bibliotekę klienta możesz skonfigurować przy użyciu pliku konfiguracji lub zmiennych środowiskowych albo automatycznie. W tym przewodniku użyjemy metody z plikami konfiguracji, koncentrując się na przepływach w internecie i na komputerach. Korzystanie z pliku konfiguracji to zwykle dobre rozwiązanie, jeśli masz tylko jeden zestaw danych logowania (np. zarządzasz kontami w ramach jednego menedżera).
Utwórz plik ~/ads.properties o tej 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 symbole zastępcze swoimi danymi logowania uzyskanymi w poprzednim kroku.
Jeśli token odświeżania jest przeznaczony dla konta menedżera, podaj identyfikator klienta tego konta jako klienta logowania:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Zweryfikuj dane logowania
Aby sprawdzić, czy wszystko jest skonfigurowane prawidłowo, użyjemy przykładu GetKampanie.
Najpierw przejdź do katalogu google-ads-examples.
$ cd google-ads-examples
W tym przykładzie wymagany jest parametr --customerId, w którym wartością jest identyfikator klienta konta Google Ads bez myślników.
Aby uruchomić 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. Możesz je przekazać jako argumenty (zalecane) lub edytować wartości INSERT_XXXXX_HERE w kodzie źródłowym. Aby zobaczyć przykładową instrukcję użytkowania, 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ć wszystkie przykłady, przykłady w podkatalogu lub przykłady, w 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'