Search Ads 360 API mewajibkan semua permintaan untuk menentukan token akses OAuth 2.0 untuk autentikasi. Anda dapat mengikuti alur kerja autentikasi OAuth 2.0 standar untuk membuat token dan meneruskannya ke Search Ads 360 API. Sebaiknya gunakan alur kerja yang dijelaskan di bawah karena cocok untuk upload konversi dan download laporan yang sepenuhnya otomatis.
Untuk alternatif alur kerja yang dijelaskan di bawah, lihat Menggunakan
OAuth 2.0 untuk Aplikasi Terinstal atau
Menggunakan OAuth 2.0 untuk Aplikasi Server ke Server. Jika Anda menggunakan alur kerja alternatif,
tentukan nilai berikut sebagai parameter scope
saat Anda meminta kode otorisasi
OAuth 2.0:
https://www.googleapis.com/auth/doubleclicksearch
Jika Anda mengikuti rute server ke server, tambahkan akun layanan sebagai pengguna Search Ads 360.
Alur kerja otorisasi yang direkomendasikan
- Buka Konsol API Google dan pilih project Anda.
Jika Anda belum membuat project Konsol Google API dan kredensial OAuth, ikuti petunjuk di Membuat project Konsol Google API dan kredensial OAuth untuk klien Anda.
Untuk menemukan client ID dan secret OAuth project Anda, lakukan hal berikut:
- Buka halaman Credentials.
- Di kolom Nama, klik nama klien OAuth Anda.
- Client ID dan rahasia tercantum pada halaman.
- Buka browser web dan login ke Google
dengan Akun Google yang memiliki izin untuk mengakses data di Search Ads 360.
Ini adalah Akun Google yang akan digunakan klien API Anda untuk mengautentikasi dengan Search Ads 360. Jika pemegang Akun Google keluar dari perusahaan Anda dan Anda menghapus akses Search Ads 360 dari akun, Anda harus mengulangi alur kerja otorisasi ini dan menentukan Akun Google yang berbeda.
- Dapatkan token refresh dengan memanggil skrip utilitas Search Ads 360 sebagai berikut:
sa360Api.py --login
Skrip ini akan memandu Anda melalui proses penggunaan client ID dan secret Oauth untuk mendapatkan token refresh. Token refresh hanya berlaku untuk Akun Google yang Anda gunakan untuk login selama langkah sebelumnya.
Sebagai bagian dari proses ini, skrip akan membuat URL dan meminta Anda untuk membuka URL di browser web.
-
Saat browser meminta Anda mengizinkan akses klien OAuth ke data Search Ads 360, pastikan Akun Google yang Anda gunakan untuk login sebelumnya muncul. (Jika login ke beberapa Akun Google, Anda mungkin akan melihat akun yang berbeda.)
Di akhir proses, skrip
sa360Api.py
akan menghasilkan string yang dipisahkan koma. Nilai pertama adalah client ID yang Anda berikan, nilai kedua adalah secret klien yang Anda berikan, dan nilai ketiga adalah token refresh. Dalam contoh output berikut, token refresh dalam teks tebal:
123456789123.apps.googleusercontent.com,ABCDEFGHIJKLMNOPQR_abcdef,1/HIJklM01OPQR23NOP456rst890uvw
- Simpan client ID, secret klien, dan token refresh di database backend atau
lokasi aman lainnya yang dapat diakses oleh aplikasi Anda.
Simpan seluruh string yang dipisahkan koma di lokasi yang mudah jika Anda berencana menggunakan
sa360Api.py
untuk mengirim contoh permintaan JSON ke Search Ads 360 API. Anda akan meneruskan seluruh string sebagai parameter setiap kali memanggil skrip. - Tambahkan kode ke aplikasi Anda yang melakukan hal berikut:
- Gunakan client ID, rahasia klien, dan token refresh untuk mendapatkan token akses OAuth 2.0 yang baru.
- Kirim permintaan ke Search Ads 360 API menggunakan token akses baru.
Jika Anda menggunakan library klien, bagian berikutnya, Menyiapkan Aplikasi, menjelaskan cara menambahkan kode otorisasi ini ke aplikasi Anda.
Jika Anda tidak menggunakan salah satu library klien, lihat Menggunakan OAuth 2.0 untuk Aplikasi yang Diinstal untuk mendapatkan saran tentang cara mendapatkan token akses baru.