Data Studio API

Data Studio API memungkinkan Anda menelusuri dan mengelola aset Data Studio.

Kasus penggunaan utama untuk API ini adalah memungkinkan organisasi Google Workspace atau Cloud Identity mengotomatiskan pengelolaan dan migrasi aset Data Studio.

Poin Penting: API ini hanya tersedia untuk pengguna yang tergabung dalam organisasi dengan Google Workspace atau Cloud Identity.

Ringkasan persyaratan

Langkah-langkah berikut diperlukan untuk menggunakan Data Studio API:

1. Mengonfigurasi aplikasi untuk menggunakan API.
2. Menggunakan konsol Google Admin untuk memberi otorisasi aplikasi.
3. Mendapatkan token akses OAuth 2.0 dan memanggil API.

Langkah-langkah di atas dapat dilakukan oleh organisasi yang sama atau berbeda berdasarkan skenario umum berikut:

• Aplikasi internal yang dikembangkan untuk organisasi. Organisasi mengonfigurasi dan memberi otorisasi aplikasi untuk semua pengguna organisasi mereka.
• Aplikasi pihak ketiga yang dikembangkan untuk pengguna/pelanggan eksternal (yaitu developer dan pengguna tergabung dalam organisasi yang berbeda). Developer mengonfigurasi aplikasi, tetapi organisasi pengguna memberi otorisasi aplikasi pihak ketiga.

1. Mengonfigurasi aplikasi untuk menggunakan API

Selesaikan langkah-langkah berikut untuk mengonfigurasi aplikasi Anda:

• Mengaktifkan API
• Membuat klien OAuth

Mengaktifkan API

Untuk mengaktifkan API untuk project Anda:

1. Buka [Data Studio API] di Konsol API Google.
2. Jika diminta, pilih project, atau buat project baru.
3. Klik Enable.
4. Jika diminta, baca dan setujui Persyaratan Layanan API.

Membuat Klien OAuth

Langkah-langkah berikut untuk membuat Klien OAuth adalah panduan umum dan harus disesuaikan untuk memenuhi persyaratan aplikasi Anda.

Penting: Jangan tambahkan cakupan Data Studio ke Klien OAuth Anda. Cakupan akan ditambahkan oleh admin Workspace saat mereka memberi otorisasi aplikasi.

1. Buka Konfigurasi layar izin OAuth.
   1. Pilih Internal, klik Buat.
   2. Isi kolom yang wajib diisi, klik Simpan.
2. Buka Kredensial.
   1. Klik CREATE CREDENTIALS.
   2. Pilih OAuth client ID.
   3. Pilih Application Type yang sesuai. (Aplikasi web adalah yang paling umum).
   4. Isi kolom yang wajib diisi, klik Buat.
3. Catat Client ID karena digunakan untuk memberi otorisasi aplikasi.

2. Memberi otorisasi aplikasi untuk organisasi

Aplikasi yang menggunakan Data Studio API hanya dapat mengautentikasi dan memberi otorisasi pengguna Google Workspace jika organisasi pengguna telah memberi otorisasi aplikasi menggunakan Delegasi tingkat domain untuk mengontrol akses API.

Konfigurasi delegasi tingkat domain dengan Client ID OAuth aplikasi dan Cakupan yang diperlukan oleh aplikasi.

Penting: Langkah-langkah berikut harus diselesaikan oleh admin Workspace. Admin akan memerlukan Client ID OAuth aplikasi dan daftar Cakupan OAuth yang diperlukan oleh aplikasi.

1. Login ke konsol Google Admin dan buka delegasi tingkat domain.
2. Di API clients, klik Add new.
3. Masukkan Client ID aplikasi yang akan diberi otorisasi (yaitu aplikasi yang menggunakan Data Studio API).
4. Masukkan semua cakupan OAuth yang diperlukan oleh aplikasi. Cakupan berikut biasanya diminta jika menggunakan Data Studio API untuk mengelola aset:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. Klik Authorize.

Catatan: Jika aplikasi Anda tidak perlu mengelola aset Data Studio, pertimbangkan untuk menggunakan cakupan https://www.googleapis.com/auth/datastudio.readonly yang lebih ketat bukan https://www.googleapis.com/auth/datastudio.

Setelah memberi otorisasi aplikasi, setiap pengguna Workspace yang tergabung dalam organisasi akan otomatis diberi otorisasi untuk menggunakan aplikasi dengan Data Studio API.

3. Mendapatkan token akses OAuth 2.0 dan memanggil API

Setelah mengembangkan dan memberi otorisasi aplikasi, Anda akan memiliki akses yang diperlukan untuk memanggil API bagi pengguna Workspace. Lihat Menggunakan OAuth 2.0 untuk Mengakses Google API guna mengetahui detail tentang cara menggunakan Google API menggunakan OAuth. Lihat referensi API untuk mengetahui operasi yang tersedia.

Pemecahan masalah

Dialog OAuth tidak ada

Jika organisasi pengguna telah memberi otorisasi aplikasi, pengguna organisasi tersebut tidak akan melihat dialog OAuth saat memberi otorisasi aplikasi. Satu-satunya pengecualian adalah jika aplikasi meminta otorisasi untuk cakupan Google API tambahan yang belum dikonfigurasi oleh Admin Workspace. Dalam hal ini, dialog OAuth akan ditampilkan kepada pengguna.

Error 400: invalid_scope

Jika pengguna menerima pesan Error 400: invalid_scope saat mencoba memberi otorisasi aplikasi, berarti organisasi pengguna belum atau salah memberi otorisasi aplikasi. Untuk mengatasi masalah ini, pengguna harus meminta organisasi mereka untuk memberi otorisasi aplikasi.