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 repositori pusat Maven.
Dependensi Maven adalah:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>38.0.0</version>
</dependency>
Dependensi Gradle adalah:
implementation 'com.google.api-ads:google-ads:38.0.0'
Anda juga dapat membangun dari sumber. Untuk tujuan panduan ini, diasumsikan bahwa Anda telah menyiapkan project dengan dependensi yang diperlukan.
Jika Anda membangun dari sumber, pastikan Anda mengaktifkan pemrosesan anotasi di IDE Anda.
Mendapatkan kredensial untuk mengautentikasi dengan API
Akses ke Google Ads API memerlukan kredensial OAuth dan token developer Google Ads API. Bagian ini menjelaskan apa itu, cara menggunakannya, dan cara mendapatkannya.
Token developer (untuk akses ke API)
Token developer ditautkan ke akun pengelola dan dapat ditemukan di antarmuka web Google Ads.
Meskipun token developer ditautkan ke akun pengelola, token tersebut tidak memberikan akses ke akun tersebut. Sebagai gantinya, 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 serangkaian kredensial OAuth.
Ada dua alur OAuth yang umumnya digunakan: aplikasi desktop (terinstal) atau aplikasi web. Perbedaan utama antara keduanya adalah aplikasi desktop harus membuka browser sistem dan memberikan URI pengalihan lokal untuk menangani respons dari server otorisasi Google, sedangkan aplikasi web dapat mengalihkan browser pihak ketiga yang arbitrer untuk menyelesaikan otorisasi dan mengirimkan kembali kredensial ke server Anda. Pustaka ini juga mendukung alur akun layanan yang kurang umum digunakan.
- Jika Anda memberikan otorisasi menggunakan kredensial Anda sendiri (alur aplikasi desktop)
- Lihat alur aplikasi desktop OAuth. Hal ini mencakup semua detail yang Anda perlukan untuk memberikan otorisasi dengan kredensial Anda sendiri.
- Jika Anda memberikan otorisasi sebagai pengguna Google pihak ketiga (alur web)
- Lihat alur aplikasi web OAuth. Bagian ini memberikan contoh cara menyiapkan otorisasi OAuth untuk pengguna pihak ketiga arbitrer.
- Jika Anda memberi otorisasi sebagai pengguna Domain Google Apps (alur akun layanan)
- Lihat alur akun layanan OAuth. Contoh ini memberikan contoh cara menyiapkan otorisasi OAuth untuk pengguna Domain Google Apps.
Jika akses Anda ke akun pelanggan Google Ads adalah melalui akun 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)
Atau, tentukan ID pelanggan akun pengelola yang memberikan akses ke akun penayangan. Parameter ini harus ditentukan jika akses Anda ke akun pelanggan dilakukan melalui akun pengelola. Anda tidak perlu menentukan semua akun pengelola di jalur ke ID pelanggan, cukup ID pengelola teratas yang Anda gunakan untuk izin akses. Untuk mengetahui detail selengkapnya, lihat dokumentasi terkait.
Mengonfigurasi library klien dengan kredensial Anda
Anda dapat mengonfigurasi library klien dengan file konfigurasi, variabel lingkungan, atau secara terprogram. Untuk panduan ini, kita akan menggunakan pendekatan file konfigurasi dan berfokus pada alur desktop dan web. Menggunakan file konfigurasi umumnya merupakan pendekatan yang baik jika Anda hanya memiliki satu set kredensial (misalnya, Anda mengelola akun di 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 pada langkah sebelumnya.
Selain itu, jika token refresh Anda ditujukan untuk akun pengelola, Anda harus menentukan ID pelanggan akun ini sebagai pelanggan login:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Memvalidasi kredensial
Untuk memastikan semuanya disiapkan dengan benar, kita akan menjalankan contoh GetCampaigns.
Pertama, buka direktori google-ads-examples.
cd google-ads-examples
Contoh ini memerlukan parameter --customerId dengan nilai ID pelanggan akun Google Ads Anda tanpa tanda hubung.
Untuk menjalankan dengan Gradle:
./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Pelajari contoh lainnya
Paket examples di google-ads-examples
berisi beberapa contoh yang berguna. Sebagian besar contoh memerlukan
parameter. Anda dapat meneruskan parameter sebagai argumen (direkomendasikan) atau
mengedit nilai INSERT_XXXXX_HERE dalam kode sumber. Untuk melihat pernyataan penggunaan
untuk contoh, teruskan --help sebagai satu-satunya argumen.
Dengan Gradle:
./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Anda juga dapat menggunakan tugas listExamples di Gradle untuk mencantumkan semua contoh, contoh di subdirektori, atau contoh yang deskripsinya menyertakan istilah penelusuran.
# 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'