Przegląd

Biblioteka klienta Pythona jest hostowana na GitHubie, a pakiet jest dostępny w repozytorium PyPI.

Wymagania

Biblioteka wymaga Pythona w wersji 3.8 lub nowszej.

Wymagania wstępne

Przed zainstalowaniem biblioteki musisz mieć token dewelopera i identyfikator klienta. Instrukcje dotyczące ich uzyskania znajdziesz w sekcji wymagania wstępne. Pamiętaj, że inne wymagane tokeny OAuth2 wygenerujesz w późniejszych krokach.

Zgodność środowiska wykonawczego i zależności

Biblioteka klienta Python zachowuje zgodność ze środowiskami wykonawczymi Pythona w sekcji Obsługiwane wersje opublikowanej przez Python Software Foundation, z wyjątkiem wersji o stanie „funkcja” lub „wstępna”.

Po przyjęciu nowych wersji środowiska wykonawczego Python staramy się wydać nową wersję biblioteki klienta Python, która będzie zgodna z najnowszym środowiskiem wykonawczym, do końca kwartału po jej wydaniu. Jeśli np. nowy środowisko uruchomieniowe zostanie wydane w październiku, zgodna wersja biblioteki klienta Python będzie dostępna do końca marca następnego roku.

Środowiska wykonawcze Python, które osiągnęły koniec cyklu życia (EOL), nie są obsługiwane po dacie końca cyklu życia w sekcji Nieobsługiwane wersje na stronie python.org.

W dowolnym momencie po zakończeniu ich obsługi możemy udostępnić wersję biblioteki klienta Python, która jest niezgodna z nieobsługiwanymi środowiskami wykonawczymi Pythona.

W przypadku zależności (w szczególności pakietów obsługiwanych przez Google, które są wymienione jako wymagane przez bibliotekę klienta Pythona) będziemy dbać o zgodność z pakietami obsługiwanymi przez Google i uważanymi za „obsługiwane” zgodnie z zasadami Google dotyczącymi wprowadzania zmian w oprogramowaniu open source.

Pełną listę obsługiwanych środowisk wykonawczych i zależnych Pythona znajdziesz na stronie Zależności.

Instalacja

Aby zainstalować bibliotekę z PyPi, postępuj zgodnie z instrukcjami w dokumentacji dotyczącej instalacji i wróć na tę stronę.

Konfiguracja

Po zainstalowaniu biblioteki musisz skonfigurować jej ustawienia. Konfigurację biblioteki można skonfigurować na kilka sposobów, które opisaliśmy w dokumentacji dotyczącej konfiguracji.

Uwierzytelnianie

Po wybraniu typu konfiguracji możesz wygenerować pozostałe tokeny OAuth2 potrzebne do wysyłania żądań do interfejsu API. Istnieje kilka obsługiwanych przepływów OAuth 2, które zostały opisane na liście poniżej. Szczegółowe informacje o różnicach między tymi procesami oraz pomoc w podejmowaniu decyzji, który z nich jest najlepszy dla Twojej aplikacji, znajdziesz w dokumentacji OAuth.

Wysyłanie żądania do interfejsu API

Po dodaniu tokenów OAuth2 do konfiguracji możesz wysłać żądanie do interfejsu API. Aby dowiedzieć się, jak łatwo sprawdzić, czy biblioteka jest prawidłowo skonfigurowana do wysyłania żądań do interfejsu API, zapoznaj się z przykładem get campaigns.

Aby uruchomić przykład get_campaigns.py, w katalogu głównym zainstalowanej lokalnie biblioteki klienta googleads-python uruchom to polecenie:

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

Dodatkowe materiały

Po wysłaniu żądania do interfejsu API możesz korzystać z biblioteki klienta w taki sposób: