Library klien Python dihosting di GitHub, dan paketnya tersedia di PyPI.
Persyaratan
Library ini memerlukan Python 3.8 atau yang lebih baru.
Prasyarat
Sebelum menginstal library, Anda memerlukan token developer dan ID pelanggan klien. Petunjuk cara mendapatkannya diuraikan di bagian prasyarat. Perhatikan bahwa Anda akan membuat token OAuth2 lain yang diperlukan di langkah berikutnya.
Kompatibilitas runtime dan dependensi
Library klien Python mempertahankan kompatibilitas dengan runtime Python di bagian Versi yang Didukung yang dipublikasikan oleh Python Software Foundation, kecuali untuk versi dengan status "fitur" atau "pra-rilis".
Saat mengadopsi versi baru runtime Python, kami ingin merilis dari library klien Python yang kompatibel dengan runtime terbaru pada akhir kuartal setelah dirilis. Misalnya, jika runtime baru dirilis pada bulan Oktober, library klien Python versi yang kompatibel akan tersedia pada akhir Maret pada tahun berikutnya.
Runtime Python yang telah mencapai Akhir Siklus Proses (EOL) tidak didukung setelah tanggal Akhir Siklus Proses di bagian Versi yang Tidak Didukung di python.org.
Kami mungkin merilis versi library klien Python yang tidak kompatibel dengan runtime Python yang tidak didukung kapan saja setelah mencapai EOL.
Untuk dependensi, (khususnya, paket apa pun yang dikelola Google yang tercantum sebagai wajib diisi oleh {i>library<i} klien Python), kita akan mempertahankan kompatibilitas dengan paket yang dikelola oleh Google, dan dianggap "didukung" menurut Kebijakan Perubahan yang Dapat Menyebabkan Gangguan OSS.
Untuk mengetahui daftar lengkap runtime dan dependensi Python yang didukung, lihat Dependencies.
Penginstalan
Ikuti petunjuk dalam penginstalan kami dokumentasi untuk menginstal library dari PyPi dan kembali ke halaman ini.
Konfigurasi
Setelah Anda menginstal perpustakaan, Anda perlu mengatur konfigurasi untuk anotasi. Ada beberapa cara untuk mengonfigurasi library, yang dijelaskan dalam configuration.
Autentikasi
Setelah memilih jenis konfigurasi, Anda dapat melanjutkan dengan membuat token OAuth2 yang tersisa yang diperlukan untuk membuat permintaan ke API. Ada beberapa alur OAuth2 yang didukung, yang didokumentasikan dalam daftar di bawah. Untuk mengetahui detail tentang perbedaan antara alur tersebut dan membantu memutuskan mana yang terbaik untuk aplikasi Anda, lihat dokumentasi OAuth.
Membuat permintaan API
Setelah memasukkan token OAuth2 ke dalam konfigurasi, Anda siap membuat permintaan API. Lihat contoh dapatkan kampanye untuk cara sederhana untuk menguji apakah library telah dikonfigurasi dengan benar untuk membuat API permintaan.
Untuk menjalankan contoh get_campaigns.py, di direktori utama lokal Anda
menginstal library klien googleads-python, jalankan perintah berikut:
$ python examples/basic_operations/get_campaigns.py -c \
INSERT_YOUR_CUSTOMER_ID_HERE
Referensi lainnya
Setelah Anda dapat membuat permintaan API, lanjutkan ke penggunaan klien ini {i>library<i}: