Dokumen ini menjelaskan cara melakukan autentikasi ke Ad Manager API. Bagaimana Anda otentikasi tergantung pada antarmuka yang Anda gunakan dan lingkungan tempat kode program berjalan, tetapi semua permintaan API harus menyertakan token akses dengan Cakupan Ad Manager API.
Library klien Ad Manager menggunakan Kredensial Default Aplikasi untuk membuat token akses dengan cakupan Ad Manager API. Panduan ini menunjukkan cara mengkonfigurasi Kredensial Default Aplikasi.
Jika tidak menggunakan library klien, Anda masih harus membuat kredensial dan menggunakannya untuk mengizinkan permintaan Anda.
Untuk informasi selengkapnya tentang autentikasi dan otorisasi, lihat dokumentasi Panduan Menggunakan OAuth 2.0.
Menentukan jenis autentikasi
Jenis autentikasi | Deskripsi |
---|---|
Akun Layanan | Pilih opsi ini jika Anda ingin melakukan otentikasi sebagai
akun, bukan orang tertentu. Pelajari lebih lanjut. |
Aplikasi web | Pilih ini jika Anda ingin melakukan autentikasi sebagai pengguna
yang memberikan izin kepada aplikasi Anda untuk mengakses
data Ad Manager mereka. Pelajari lebih lanjut |
Pengembangan lokal | Pilih opsi ini jika Anda ingin melakukan autentikasi sebagai milik Anda Akun Google atau Akun Layanan dari lokal Anda lingkungan pengembangan Anda. |
Mengaktifkan Ad Manager API
Aktifkan Ad Manager API di Project Cloud Konsol API Google.
Jika diminta, pilih project, atau buat project baru.
Buat kredensial
Klik tab untuk jenis autentikasi Anda dan ikuti petunjuk untuk membuat kredensial Anda:
Akun Layanan
Di Google Cloud
Untuk mengautentikasi workload yang berjalan di Google Cloud, Anda menggunakan kredensial akun layanan yang terpasang ke resource komputasi tempat kode Anda berada sedang berjalan.
Misalnya, Anda dapat memasang akun layanan ke virtual Compute Engine instance mesin (VM), layanan Cloud Run, atau tugas Dataflow. Pendekatan ini adalah metode autentikasi pilihan untuk kode yang berjalan di Google Cloud resource komputasi.
Untuk mengetahui informasi tentang resource mana yang dapat ditambahi akun layanan, serta membantu melampirkan akun layanan ke resource. Lihat dokumentasi dokumentasi tentang cara melampirkan akun layanan.
Lokal atau di penyedia cloud lain
Metode yang dipilih untuk menyiapkan autentikasi dari luar Google Cloud adalah
untuk menggunakan federasi identitas workload; Anda membuat
file konfigurasi kredensial dan menyetel GOOGLE_APPLICATION_CREDENTIALS
variabel lingkungan
untuk menunjukkannya. Pendekatan ini lebih aman dibandingkan
membuat kunci akun layanan.
Jika tidak dapat mengonfigurasi workload identity federation, Anda harus membuat akun layanan dan membuat kunci untuk akun layanan:
Di halaman Credentials, pilih Create credentials, lalu pilih Service Account.
Klik alamat email akun layanan yang ingin dibuat apa kuncinya.
Klik tab Kunci.
Klik menu dropdown Add key, lalu pilih Create new key.
Pilih JSON sebagai jenis kunci dan klik Create.
Tetapkan variabel lingkungan
GOOGLE_APPLICATION_CREDENTIALS
ke jalur dari file JSON.
Linux atau macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Aplikasi web
Jika diminta, pilih project tempat Anda mengaktifkan Ad Manager API.
Di halaman Credentials, pilih Create credentials, lalu pilih OAuth client ID.
Pilih jenis aplikasi Web application.
Isi formulir, lalu klik Buat. Aplikasi yang menggunakan bahasa dan seperti PHP, Java, Python, Ruby, dan .NET harus menentukan URI pengalihan. URI pengalihan adalah endpoint tempat OAuth 2.0 server dapat mengirimkan respons. Endpoint ini harus mematuhi aturan validasi.
Setelah membuat kredensial, download file client_secret.json. Simpan file dengan aman di lokasi yang hanya dapat diakses oleh aplikasi Anda.
Dari sini, ikuti langkah-langkah untuk mendapatkan token akses OAuth 2.0
Pengembangan lokal
Siapkan Kredensial Default Aplikasi (ADC) di lingkungan lokal Anda.
Instal Google Cloud CLI, lalu lakukan inisialisasi dengan menjalankan perintah berikut berikut:
gcloud init
Buat kredensial autentikasi lokal untuk Akun Google Anda dan setel project ID ke project tempat Ad Manager API diaktifkan:
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID
Cara lainnya, lakukan autentikasi sebagai setelan Akun Layanan
variabel GOOGLE_APPLICATION_CREDENTIALS
ke jalur file kunci Anda.
Linux atau macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Mengonfigurasi jaringan Ad Manager
Akun Layanan
- 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. Tujuan pengguna akun layanan harus ditambahkan ke peran dan tim yang sesuai untuk integrasi API Anda.
- Klik tombol Simpan. Sebuah pesan akan muncul, mengonfirmasi penambahan akun layanan Anda.
- Lihat pengguna akun layanan yang ada dengan membuka tab Pengguna, dengan mengklik filter Akun Layanan.
Aplikasi web
- Buka jaringan Ad Manager Anda.
- Klik tab Admin.
- Pastikan akses API diaktifkan.
Pengembangan Lokal
- Buka jaringan Ad Manager Anda.
- Klik tab Admin.
- Pastikan akses API diaktifkan.
Tanpa library klien
Jika Anda tidak menggunakan library klien, kami tetap sangat merekomendasikan penggunaan sebuah pustaka OAuth2 untuk otentikasi.
Untuk petunjuk terperinci tentang cara mendapatkan token akses, lihat Menggunakan OAuth2 dengan Google API.
Token akses
Sertakan token akses Anda dalam permintaan ke API dengan menyertakan
Parameter kueri access_token
atau nilai Bearer
header HTTP Authorization
.
Jika memungkinkan, {i>header<i} HTTP lebih disukai, karena string kueri cenderung
terlihat di log server.
Contoh:
GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX
GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg
Cakupan
Setiap token akses dikaitkan dengan satu atau beberapa cakupan. Ruang lingkup mengontrol sekumpulan sumber daya dan operasi yang diizinkan oleh token akses. Ad Manager REST API hanya memiliki satu cakupan. Otorisasi harus dilakukan pada pengguna level dalam produk.
Cakupan | Izin |
---|---|
https://www.googleapis.com/auth/admanager
|
Melihat dan mengelola kampanye Anda tentang Google Ad Manager. |