Semua panggilan API Google Ad Manager harus diotorisasi melalui OAuth2, standar terbuka yang memungkinkan pengguna memberikan izin ke aplikasi pihak ketiga, sehingga aplikasi dapat berinteraksi dengan layanan web atas nama pengguna. OAuth2 memungkinkan aplikasi klien Ad Manager API Anda mengakses akun Ad Manager pengguna tanpa harus menangani atau menyimpan nama pengguna atau sandi pengguna.
Membuat kredensial OAuth2
Lakukan langkah-langkah berikut untuk membuat kredensial OAuth2.
1. Menentukan jenis autentikasi
Periksa tabel di bawah untuk melihat jenis autentikasi yang paling sesuai untuk aplikasi Ad Manager API Anda:
Pilih jenis autentikasi OAuth2 Anda | |
---|---|
Service account |
Pilih ini jika Anda hanya memerlukan akses ke data Ad Manager Anda sendiri. Pelajari lebih lanjut. |
Aplikasi web |
Pilih opsi ini jika Anda ingin mengautentikasi sebagai pengguna yang memberikan izin ke aplikasi Anda untuk mengakses data Ad Manager miliknya. Pelajari lebih lanjut. |
2. Membuat kredensial OAuth2
Setelah menentukan jenis autentikasi, klik tab yang sesuai di bawah dan ikuti petunjuk untuk membuat kredensial OAuth2:
- Buka halaman Kredensial Konsol API Google.
- Dari drop-down project, pilih Buat project baru, masukkan nama untuk project, dan jika perlu, edit Project ID yang disediakan. Klik Create.
- Pada halaman Credentials, pilih Create credentials, lalu pilih Service account key.
- Pilih Akun layanan baru, lalu pilih JSON.
- Klik Buat untuk mendownload file yang berisi kunci pribadi.
- Buka halaman Kredensial Konsol API Google.
- Dari drop-down project, pilih Buat project baru, masukkan nama untuk project (dan jika perlu, edit Project ID yang disediakan), lalu klik Buat.
- Pada halaman Kredensial, pilih Create credentials, lalu pilih OAuth client ID.
- Anda mungkin akan diminta untuk menetapkan nama produk di halaman Layar Izin. Jika ya, klik Konfigurasi layar izin, berikan informasi yang diminta, lalu klik Simpan untuk kembali ke halaman Kredensial.
- Pilih Web Application untuk Application Type. Ikuti petunjuk untuk memasukkan asal JavaScript, URI pengalihan, atau keduanya.
- Klik Create.
- Pada halaman yang muncul, salin client ID dan rahasia klien ke papan klip, karena Anda akan membutuhkannya saat mengonfigurasi library klien.
3. Mengonfigurasi jaringan Ad Manager Anda
Jika Anda adalah developer pihak ketiga, Anda mungkin perlu meminta klien melakukan langkah ini untuk Anda.
- Buka jaringan Ad Manager Anda.
- Klik tab Admin.
- Pastikan Akses API diaktifkan.
- Klik tombol Add a service account user.
- Isi formulir menggunakan email akun layanan. Pengguna akun layanan harus diberi izin untuk mengakses entitas seolah-olah pengguna akun layanan tersebut akan mengakses entitas di UI.
- Klik tombol Simpan. Sebuah pesan akan muncul, yang mengonfirmasi penambahan akun layanan Anda.
- Lihat pengguna akun layanan yang ada dengan membuka tab Users lalu mengklik filter Service Account.
- Buka jaringan Ad Manager Anda.
- Klik tab Admin.
- Pastikan Akses API diaktifkan.
4. Mengonfigurasi dan menggunakan library klien
Ikuti panduan yang sesuai di bawah ini untuk menggunakan kredensial di library klien Anda:
Java
.NET
Python
PHP
Ruby
Jika memilih untuk tidak menggunakan salah satu library klien kami, Anda harus menerapkan alur akun layanan atau aplikasi web OAuth2 sendiri.
Video di balik layar
Library klien kami otomatis menangani detail yang dibahas di bawah ini, jadi baca hanya jika Anda tertarik dengan apa yang terjadi di balik layar. Bagian ini ditujukan bagi pengguna tingkat lanjut yang sudah memahami spesifikasi OAuth2 dan mengetahui cara menggunakan OAuth2 dengan Google API.
Header permintaan HTTP
Header HTTP dalam setiap permintaan ke Ad Manager API harus menyertakan token akses dalam formulir ini:
Authorization: Bearer ACCESS_TOKEN
Contoh:
POST … HTTP/1.1 Host: … Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg Content-Type: text/xml;charset=UTF-8 Content-Length: … <?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"> … </soap:Envelope>
Cakupan
Satu token akses dapat memberikan berbagai tingkat akses ke beberapa API. Parameter variabel yang disebut scope
mengontrol kumpulan resource dan operasi yang diizinkan oleh token akses. Selama permintaan token akses, aplikasi Anda mengirimkan satu atau beberapa nilai dalam parameter scope
.
Ad Manager hanya memiliki satu cakupan, yang ditampilkan di bawah ini. Otorisasi harus dilakukan di tingkat pengguna dalam produk.
Cakupan | Izin |
---|---|
https://www.googleapis.com/auth/dfp |
Melihat dan mengelola kampanye Anda di Ad Manager. |