Menyiapkan akses API

Berikut cara menyiapkan akses ke Data Manager API dengan SDK atau REST.

Prasyarat

Sebelum dapat menggunakan Data API, pastikan Anda memiliki hal berikut:

  1. Un projet Google Cloud. Anda dapat menggunakan project yang ada atau membuat project baru khusus untuk Data Manager API.

  2. Akun Google yang memiliki izin serviceusage.services.enable di project Google Cloud Anda, atau memiliki peran yang mencakup izin tersebut. Misalnya, roles/owner dan roles/serviceusage.serviceUsageAdmin keduanya mencakup izin serviceusage.services.enable. Untuk memeriksa izin Anda, lihat Melihat akses saat ini.

  3. Google Cloud CLI terinstal.

Mengaktifkan API

Jika belum melakukannya, aktifkan Data Manager API dengan mengklik Enable the Data Manager API atau ikuti petunjuk untuk melakukan langkah ini secara manual.

Aktifkan Data Manager API

Jika Anda tidak dapat menemukan Data Manager API atau Enable the Data Manager API gagal, pastikan Akun Google Anda memenuhi prasyarat.

Menyiapkan autentikasi

Anda dapat menggunakan salah satu Metode autentikasi di Google selain kunci API. Sebaiknya tinjau cara Memilih metode autentikasi yang tepat untuk kasus penggunaan Anda guna memutuskan pendekatan yang sesuai untuk kasus penggunaan Anda.

Dua metode autentikasi umum adalah akun pengguna dan akun layanan:

  • Akun pengguna: Mewakili orang yang berinteraksi langsung dengan Google API dan layanan.
  • Akun layanan: Mewakili aplikasi, bukan orang, sebagai pengguna. Akun layanan memungkinkan aplikasi Anda mengelola autentikasi dan otorisasi. Misalnya, jika aplikasi perlu mengakses resource Google Cloud.

Integrasi Anda dapat menggunakan Kredensial Default Aplikasi (ADC) untuk otomatis menemukan kredensial dari lingkungan sehingga Anda tidak perlu mengubah kode klien untuk melakukan autentikasi.

Pilih Akun pengguna atau Akun layanan untuk menyiapkan ADC:

Akun pengguna

Berikut langkah-langkah untuk melakukan autentikasi dengan kredensial akun pengguna:

  1. Konfigurasi setelan Platform Google Auth untuk project Anda.

    1. Buka halaman Branding di Konsol Google Cloud.

    2. Pilih project Anda.

    3. Isi formulir dan klik Buat.

  2. Karena cakupan Data Manager API adalah cakupan sensitif, langkah-langkah berikut diperlukan:

    1. Buka setelan Akses Data untuk project Anda.

    2. Klik Tambahkan atau hapus cakupan.

    3. Centang kotak di samping Data Manager API dalam daftar cakupan, lalu klik Perbarui.

    4. Klik Simpan.

    5. Buka Audiens di Konsol Google Cloud dan perbarui Status publikasi dan Jenis pengguna. Pelajari setelan ini lebih lanjut di Mengelola Audiens Aplikasi.

  3. Klik Buat klien OAuth2 untuk membuat klien OAuth2 di project, atau ikuti petunjuk untuk membuat klien OAuth2 Desktop. Anda dapat melewati langkah ini jika sudah memiliki klien OAuth2 Desktop yang ingin digunakan untuk Data Manager API.

    Jika Anda mengklik Buat klien OAuth2, pilih Aplikasi desktop saat diminta untuk Mengonfigurasi klien OAuth agar Anda dapat menggunakan klien di langkah-langkah berikutnya.

    Buat klien OAuth2

    Pada langkah terakhir, klik DOWNLOAD CLIENT CONFIGURATION dan catat lokasi download yang Anda pilih.

  4. Buat file ADC lokal dengan menjalankan perintah berikut. Perintah ini meluncurkan alur web tempat Anda diminta untuk login ke Akun Google yang Anda gunakan dengan API.

    Ganti PATH_TO_CLIENT_JSON dengan nama file JSON yang Anda downloaded.

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Jika Anda ingin menggunakan kredensial yang sama untuk Data Manager API dan Google Ads API, sertakan cakupan Google Ads API dalam daftar --scopes:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Jika Anda ingin menggunakan kredensial yang sama untuk Data Manager API dan Display & Video 360 API, sertakan cakupan Display & Video 360 API dalam daftar --scopes:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

  5. Konfirmasi kredensial disiapkan dengan benar menggunakan perintah berikut. Jika berhasil, perintah akan mencetak token akses ke konsol.

    gcloud auth application-default print-access-token

Akun layanan

Berikut langkah-langkah untuk Menggunakan peniruan akun layanan untuk melakukan autentikasi. Langkah-langkah ini menggunakan peniruan identitas, bukan kunci akun layanan, karena kunci akun layanan dapat menjadi risiko keamanan jika tidak dikelola dengan hati-hati.

  1. Klik tombol Buat akun layanan berikut atau ikuti petunjuk untuk memilih atau membuat akun layanan.

    Buat akun layanan

  2. Berikan peran IAM Konsumen Penggunaan Layanan kepada akun layanan (roles/serviceusage.serviceUsageConsumer), yang mencakup izin serviceusage.services.use yang memungkinkan akun layanan mengirim permintaan API untuk project.

    gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:SERVICE_ACCOUNT_EMAIL" \
  --role="roles/serviceusage.serviceUsageConsumer"

  3. Berikan Akun Google Anda peran IAM Pembuat Token Akun Layanan (roles/iam.serviceAccountTokenCreator) di akun layanan.

    gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
  --member="user:USER_EMAIL" \
  --role="roles/iam.serviceAccountTokenCreator"

  4. Konfigurasi ADC Anda dengan menjalankan perintah berikut:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform"

    Jika Anda ingin menggunakan kredensial yang sama untuk Data Manager API dan Google Ads API, sertakan cakupan Google Ads API dalam daftar --scopes:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform"

    Jika Anda ingin menggunakan kredensial yang sama untuk Data Manager API dan Display & Video 360 API, sertakan cakupan Display & Video 360 API dalam daftar --scopes:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform"

    Saat diminta untuk login, login sebagai Akun Google Anda yang memiliki peran Pembuat Token Akun Layanan.

  5. Konfirmasi kredensial disiapkan dengan benar menggunakan perintah berikut. Jika berhasil, perintah akan mencetak token akses ke konsol.

    gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"

Untuk mempelajari lebih lanjut autentikasi dan kredensial untuk aplikasi Anda, lihat Metode autentikasi di Google dan Cara kerja Kredensial Default Aplikasi works.

Menyiapkan akses akun

Akun pengguna

Pilih tab yang sesuai dengan kasus penggunaan Anda.

  • Pilih Pengiklan jika Anda menggunakan kredensial untuk Akun Google yang merupakan pengguna di akun pengiklan yang ingin Anda kelola.
  • Pilih Partner Data jika Anda menggunakan kredensial untuk Akun Google yang merupakan pengguna di akun partner data, dan Anda ingin mengelola akun pengiklan yang memiliki link partner ke akun partner data.

Pengiklan

Berikan akses ke Destination kepada email yang terkait dengan pengguna.

Ikuti petunjuk untuk menambahkan email pengguna ke akun Google Ads atau akun pengelola Google Ads induk.

Display &Video 360

Ikuti petunjuk untuk menambahkan email pengguna ke akun.

Google Analytics

Ikuti petunjuk untuk menambahkan email pengguna ke akun.

Partner Data

Berikan akses ke akun partner data Anda kepada email yang terkait dengan pengguna. Biasanya, partner data menggunakan akun layanan untuk akses API. Namun, jika Anda menggunakan akun pengguna untuk pengujian atau tujuan lainnya, Anda harus memberikan akses akun pengguna ke akun partner data.

Tambahkan email pengguna ke akun partner data melalui UI Google Ads dengan mengikuti petunjuk ini.

Akun layanan

Pilih tab yang sesuai dengan kasus penggunaan Anda.

  • Pilih Pengiklan jika Anda menggunakan kredensial untuk Akun Google yang merupakan pengguna di akun pengiklan yang ingin Anda kelola.
  • Pilih Partner Data jika Anda menggunakan kredensial untuk Akun Google yang merupakan pengguna di akun partner data, dan Anda ingin mengelola akun pengiklan yang memiliki link partner ke akun partner data.

Pengiklan

Berikan akses ke Destination kepada email yang terkait dengan akun layanan Anda.

Selesaikan Penyiapan akses akun untuk menambahkan akun layanan ke akun Google Ads atau akun pengelola Google Ads induk.

Display &Video 360

Ikuti petunjuk untuk membuat pengguna Display & Video 360 yang terkait dengan akun layanan.

Google Analytics

Ikuti petunjuk untuk menambahkan email akun layanan ke akun.

Partner Data

Berikan akses ke akun partner data Anda kepada email yang terkait dengan akun layanan Anda.

Akses akun partner data dikelola melalui UI Google Ads. Untuk menambahkan akun layanan dan menetapkan tingkat aksesnya, ikuti langkah-langkah di Penyiapan akses akun.

Langkah berikutnya

Instal library klien dan jalankan contoh kode untuk mencoba permintaan Data Manager API pertama Anda.

Berikutnya
Menginstal library klien