Sebaiknya gunakan library klien dengan Apache Maven (atau Gradle).
Membuat project Maven/Gradle baru
Buat project Maven/Gradle baru di IDE pilihan Anda. Artefak kami dipublikasikan ke Maven Central repositori Anda.
Dependensi Maven adalah:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>33.0.0</version>
</dependency>
Dependensi Gradle adalah:
implementation 'com.google.api-ads:google-ads:33.0.0'
Anda juga dapat membuat dari sumber. Untuk tujuan , diasumsikan bahwa Anda memiliki konfigurasi project dengan dependensi yang diperlukan yang tersedia.
Mendapatkan kredensial untuk mengautentikasi dengan API
Akses ke Google Ads API memerlukan kredensial OAuth dan developer Google Ads API sebelumnya yang benar. Bagian ini menjelaskan definisi, cara menggunakannya, dan penggunaannya diperoleh.
Token developer (untuk akses ke API)
Token developer ditautkan ke pengelola akun Anda dan dapat ditemukan di antarmuka web Google Ads.
Meskipun token pengembang ditautkan ke akun pengelola, token ini tidak memberikan akses ke akun tersebut. Token developer memberikan akses ke API secara umum, dan akses tingkat akun dikonfigurasi melalui OAuth.
Kredensial OAuth (untuk akses ke akun Google Ads)
Untuk memberikan otorisasi sebagai pengguna akun Google yang memiliki akses ke akun Google Ads, Anda harus memberikan sekumpulan kredensial OAuth.
Ada dua alur OAuth yang umumnya digunakan: aplikasi desktop (terinstal) atau aplikasi web. Perbedaan utama di antara keduanya adalah aplikasi desktop harus membuka browser sistem dan menyediakan URI pengalihan lokal untuk menangani respons dari server otorisasi Google, sedangkan aplikasi web dapat mengalihkan browser pihak ketiga untuk menyelesaikan otorisasi dan mengirim kembali kredensial ke server Anda. Library ini juga mendukung akun layanan yang jarang digunakan alur kerja.
- Jika Anda memberikan otorisasi menggunakan kredensial Anda sendiri (alur aplikasi desktop)
- Lihat aplikasi desktop OAuth alur. Ini mencakup semua detail yang Anda butuhkan untuk memberi otorisasi dengan kredensial Anda sendiri.
- Jika Anda memberikan otorisasi sebagai pengguna Google pihak ketiga (alur web)
- Lihat alur aplikasi web OAuth. Ini memberikan contoh cara menyiapkan otorisasi OAuth untuk pihak ketiga arbitrer pengguna.
- Jika Anda memberi otorisasi sebagai pengguna Domain Google Apps (alur akun layanan)
- Lihat akun layanan OAuth alur. Hal ini memberikan contoh menyiapkan otorisasi OAuth untuk pengguna Domain Google Apps.
Jika akses Anda ke akun pelanggan Google Ads melalui pengelola Google Ads Anda juga harus menentukan ID pelanggan login seperti yang dijelaskan di bawah.
ID pelanggan login (untuk akses ke akun Google Ads melalui akun pengelola)
(Opsional) Tentukan ID pelanggan akun pengelola yang memberikan akses ke akun penayangan. Ini harus ditentukan jika akses Anda ke pelanggan adalah melalui akun pengelola. Tidak perlu menentukan semua pengelola akun di jalur menuju ID pelanggan, hanya ID pengelola paling atas yang gunakan untuk izin akses. Untuk detail selengkapnya, lihat dokumen terkait dokumentasi tambahan.
Mengonfigurasi library klien dengan kredensial Anda
Anda dapat mengkonfigurasi pustaka klien dengan file konfigurasi, variabel lingkungan, atau secara terprogram. Untuk panduan ini, kita akan menggunakan file konfigurasi pendekatan dan fokus pada {i>desktop<i} dan alur web. Menggunakan file konfigurasi umumnya merupakan pendekatan yang baik jika Anda hanya memiliki satu set (misalnya, Anda mengelola beberapa akun di bawah satu pengelola).
Buat file ~/ads.properties dengan konten berikut:
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
Ganti placeholder dengan kredensial Anda yang diperoleh di langkah sebelumnya.
Selain itu, jika token refresh Anda ditujukan untuk akun pengelola, Anda harus tetapkan ID pelanggan akun ini sebagai pelanggan login:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Validasi kredensial
Untuk memastikan bahwa semuanya disiapkan dengan benar, kita akan menjalankan perintah GetCampaigns contoh.
Pertama, buka direktori google-ads-examples.
$ cd google-ads-examples
Contoh ini memerlukan parameter --customerId dengan nilai berupa
ID pelanggan akun Google Ads tanpa tanda hubung.
Untuk menjalankan dengan Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Pelajari contoh lainnya
Paket contoh di google-ads-examples
berisi beberapa contoh yang berguna. Sebagian besar contoh membutuhkan
parameter. Anda dapat meneruskan parameter sebagai argumen (direkomendasikan) atau
edit nilai INSERT_XXXXX_HERE dalam kode sumber. Untuk melihat pernyataan penggunaan
misalnya, teruskan --help sebagai satu-satunya argumen.
Dengan Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Anda juga dapat menggunakan tugas listExamples di Gradle untuk menampilkan daftar semua contoh,
contoh dalam subdirektori, atau contoh dengan deskripsi yang menyertakan istilah
jangka panjang.
# 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'