Menyiapkan akses API

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

Prasyarat

  1. Project Google Cloud atau Akun Google yang ingin Anda miliki projectnya.

    • Jika Anda tidak memiliki project, proses penyiapan di bagian berikutnya akan membuatnya untuk Anda.
    • Jika Anda sudah memiliki project, pastikan Akun Google Anda memiliki peran yang dapat mengaktifkan API di project, seperti Pemilik, Editor, atau Admin Penggunaan Layanan. Untuk memeriksa peran Anda, buka halaman IAM di konsol Google Cloud, pilih project Anda, lalu temukan Akun Google Anda dalam daftar.

      Untuk mengetahui detail selengkapnya, lihat Melihat akses saat ini.

  2. Google Cloud CLI diinstal.

Mengaktifkan API

Jika belum, aktifkan Data Manager API di project Google Cloud Anda 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 Google.
  • 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 Create.

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

    1. Buka setelan Akses Data untuk project Anda.

    2. Klik Add or remove scopes.

    3. Dalam daftar cakupan, temukan Data Manager API dan centang kotak untuk setiap cakupan yang diperlukan aplikasi Anda:

      • .../auth/datamanager: Pilih cakupan ini untuk operasi API standar, seperti mengelola data pelanggan, audiens, dan peristiwa. Ini adalah cakupan utama yang digunakan di seluruh panduan ini.

      • .../auth/datamanager.partnerlink: Pilih cakupan ini hanya jika Anda adalah partner data yang membuat atau menghapus link partner di akun pengiklan.

    4. Klik Update.

    5. Klik Save.

    6. Buka Audiens di konsol Google Cloud dan konfigurasi setelan untuk pengembangan awal:

      • Tetapkan Status publikasi ke Pengujian.
      • Tetapkan Jenis pengguna ke Internal (jika project Anda berada di organisasi Google Workspace) atau Eksternal (jika tidak).
      • Jika menggunakan Eksternal, tambahkan Akun Google yang Anda gunakan untuk membuat kredensial sebagai Pengguna pengujian.

      Pelajari lebih lanjut setelan ini di Mengelola Audiens Aplikasi.

  3. Klik Create OAuth2 client 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 Anda gunakan untuk Data Manager API.

    Jika Anda mengklik Create OAuth2 client, pilih aplikasi desktop saat diminta untuk Configure your OAuth client sehingga 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 bahwa kredensial telah 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 membuat akun layanan dan menggunakan akun layanan peniruan identitas untuk melakukan autentikasi di lingkungan pengembangan lokal. 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 Create service account berikut atau ikuti petunjuk untuk memilih atau membuat akun layanan.

    Buat akun layanan
  2. Berikan peran IAM Service Usage Consumer 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 bahwa kredensial telah 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. Akun partner data hanya dikeluarkan setelah melalui proses persetujuan. Untuk memulai, isi formulir minat.

Pengiklan

Berikan akses email yang terkait dengan pengguna ke Destination.

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 email yang terkait dengan pengguna ke akun partner data Anda. 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. Akun partner data hanya dikeluarkan setelah melalui proses persetujuan. Untuk memulai, isi formulir minat.

Pengiklan

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

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 email yang terkait dengan akun layanan Anda ke akun partner data 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