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 versi baru library klien Python yang kompatibel dengan runtime terbaru pada akhir kuartal setelah rilisnya. Misalnya, jika runtime baru dirilis pada bulan Oktober, library klien Python versi yang kompatibel akan tersedia pada akhir Maret 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 dapat 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 diperlukan oleh library klien Python), kami akan mempertahankan kompatibilitas dengan paket yang dikelola Google, dan dianggap "didukung" sesuai dengan Kebijakan Perubahan yang Mengganggu OSS Google.
Untuk mengetahui daftar lengkap runtime dan dependensi Python yang didukung, lihat halaman Dependensi.
Penginstalan
Ikuti petunjuk dalam dokumentasi penginstalan kami untuk menginstal library dari PyPi dan kembali ke halaman ini.
Konfigurasi
Setelah menginstal library, Anda harus menyiapkan konfigurasi untuk library tersebut. Ada beberapa cara untuk mengonfigurasi library, yang dijelaskan dalam dokumentasi konfigurasi kami.
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 dan membantu memutuskan mana yang terbaik untuk aplikasi Anda, lihat dokumentasi OAuth kami.
Membuat permintaan API
Setelah memasukkan token OAuth2 ke dalam konfigurasi, Anda siap membuat permintaan API. Lihat contoh get campaigns untuk cara sederhana menguji apakah library dikonfigurasi dengan benar untuk membuat permintaan API.
Untuk menjalankan contoh get_campaigns.py, di direktori root library klien googleads-python yang diinstal secara lokal, 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 library klien berikut: