Authentication

Dokumen ini menjelaskan cara melakukan autentikasi ke Ad Manager API. Cara Anda melakukan autentikasi bergantung pada antarmuka yang Anda gunakan dan lingkungan tempat kode Anda 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 mengonfigurasi Kredensial Default Aplikasi.

Jika tidak menggunakan library klien, Anda tetap harus membuat kredensial dan menggunakannya untuk mengizinkan permintaan Anda.

Untuk mengetahui informasi selengkapnya tentang autentikasi dan otorisasi, lihat panduan Menggunakan OAuth 2.0.

Menentukan jenis autentikasi Anda

Jenis autentikasi Deskripsi
Akun Layanan Pilih opsi ini jika Anda ingin melakukan autentikasi sebagai akun khusus, bukan orang tertentu.
Pelajari lebih lanjut.
Aplikasi web Pilih opsi ini jika Anda ingin melakukan autentikasi sebagai pengguna mana pun 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 Akun Google Anda sendiri atau Akun Layanan dari lingkungan pengembangan lokal Anda.

Mengaktifkan Ad Manager API

  1. Aktifkan Ad Manager API di Project Cloud Google API Anda.

  2. Jika diminta, pilih project, atau buat project baru.

Buat kredensial

Klik tab untuk jenis autentikasi Anda dan ikuti petunjuk untuk membuat kredensial:

Akun Layanan

Di Google Cloud

Untuk mengautentikasi workload yang berjalan di Google Cloud, Anda menggunakan kredensial akun layanan yang dilampirkan ke resource komputasi tempat kode Anda berjalan.

Misalnya, Anda dapat memasang akun layanan ke instance virtual machine (VM) Compute Engine, layanan Cloud Run, atau tugas Dataflow. Pendekatan ini adalah metode autentikasi yang direkomendasikan untuk kode yang berjalan di resource komputasi Google Cloud.

Untuk mengetahui informasi tentang resource mana yang dapat Anda lampirkan dengan akun layanan, dan bantuan terkait pelampiran akun layanan ke resource, lihat dokumentasi tentang cara melampirkan akun layanan.

Lingkungan lokal atau di penyedia cloud lain

Metode yang direkomendasikan untuk menyiapkan autentikasi dari luar Google Cloud adalah dengan menggunakan workload identity federation; Anda membuat file konfigurasi kredensial dan menetapkan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS untuk menunjukkannya. Pendekatan ini lebih aman daripada membuat kunci akun layanan.

Jika tidak dapat mengonfigurasi workload identity federation, Anda harus membuat akun layanan dan membuat kunci untuk akun layanan:

  1. Buka halaman Kredensial Konsol API Google.

  2. Di halaman Kredensial, pilih Buat kredensial, lalu pilih Akun Layanan.

  3. Klik alamat email akun layanan yang ingin Anda buatkan kunci.

  4. Klik tab Kunci.

  5. Klik menu drop-down Kunci, lalu pilih Buat kunci baru.

  6. Pilih JSON sebagai jenis kunci dan klik Create.

  7. Tetapkan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS ke jalur file JSON.

Linux atau macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Aplikasi web

  1. Buka halaman Kredensial Konsol API Google.

  2. Jika diminta, pilih project tempat Anda mengaktifkan Ad Manager API.

  3. Di halaman Credentials, pilih Create credentials, lalu pilih OAuth client ID.

  4. Pilih jenis aplikasi Web application.

  5. Isi formulir, lalu klik Buat. Aplikasi yang menggunakan bahasa dan framework seperti PHP, Java, Python, Ruby, dan .NET harus menentukan URI pengalihan yang diizinkan. URI pengalihan adalah endpoint tempat server OAuth 2.0 dapat mengirim respons. Endpoint ini harus mematuhi aturan validasi Google.

  6. 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:

gcloud init

Buat kredensial autentikasi lokal untuk Akun Google Anda dan tetapkan ID project 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

Atau, lakukan autentikasi sebagai Akun Layanan dengan menetapkan variabel lingkungan 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 Anda

Akun Layanan

  1. Buka jaringan Ad Manager Anda.
  2. Klik tab Admin.
  3. Pastikan Akses API diaktifkan.
  4. Klik tombol Tambahkan pengguna akun layanan.
  5. Isi formulir menggunakan email akun layanan. Pengguna akun layanan harus ditambahkan ke peran dan tim yang sesuai untuk integrasi API Anda.
  6. Klik tombol Simpan. Pesan akan muncul, yang mengonfirmasi penambahan akun layanan Anda.
  7. Lihat pengguna akun layanan yang ada dengan membuka tab Pengguna, lalu mengklik filter Akun Layanan.

Aplikasi web

  1. Buka jaringan Ad Manager Anda.
  2. Klik tab Admin.
  3. Pastikan Akses API diaktifkan.

Pengembangan Lokal

  1. Buka jaringan Ad Manager Anda.
  2. Klik tab Admin.
  3. Pastikan Akses API diaktifkan.

Tanpa library klien

Jika Anda tidak menggunakan library klien, sebaiknya tetap gunakan library OAuth2 untuk autentikasi.

Untuk petunjuk mendetail tentang cara mendapatkan token akses, lihat Menggunakan OAuth2 dengan Google API.

Token akses

Sertakan token akses Anda dalam permintaan ke API dengan menyertakan nilai parameter kueri access_token atau nilai header HTTP Authorization Bearer. Jika memungkinkan, header HTTP lebih disarankan 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. Cakupan mengontrol kumpulan resource dan operasi yang diizinkan oleh token akses. Ad Manager API memiliki dua cakupan. Sebaiknya gunakan cakupan admanager.readonly yang lebih sempit jika aplikasi Anda tidak perlu menulis data.

Cakupan Izin
https://www.googleapis.com/auth/admanager Melihat dan mengelola kampanye Anda di Google Ad Manager.
https://www.googleapis.com/auth/admanager.readonly Lihat kampanye dan data Anda di Google Ad Manager.