Kredensial digunakan untuk mendapatkan token akses dari server otorisasi Google sehingga aplikasi Anda dapat memanggil Google Workspace API. Dokumen ini menjelaskan cara memilih dan menyiapkan kredensial yang dibutuhkan aplikasi Anda.
Pilih kredensial akses yang tepat untuk Anda
Kredensial yang diperlukan bergantung pada jenis data, platform, dan metodologi akses aplikasi Anda. Ada tiga jenis kredensial yang tersedia:
| Kasus penggunaan | Metode autentikasi | Tentang metode autentikasi ini |
|---|---|---|
| Mengakses data yang tersedia secara publik secara anonim di aplikasi Anda. | Kunci API | Pastikan API yang ingin Anda gunakan mendukung kunci API sebelum menggunakan metode autentikasi ini. |
| Mengakses data pengguna seperti alamat email atau usia mereka. | ID klien OAuth | Mewajibkan aplikasi Anda untuk meminta dan menerima izin dari pengguna. |
| Mengakses data yang dimiliki oleh aplikasi Anda, dokumen bersama tertentu (seperti Google Spreadsheet), atau mengakses resource Google Workspace atas nama pengguna melalui delegasi tingkat domain. | Service account | Saat melakukan autentikasi sebagai akun layanan, aplikasi memiliki akses ke semua resource yang boleh diakses oleh akun layanan. |
Untuk definisi istilah yang ada di halaman ini, lihat Ringkasan autentikasi dan otorisasi.
Kredensial kunci API
Kunci API adalah string panjang yang berisi huruf besar dan kecil, angka, garis bawah, dan tanda hubung, seperti AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe.
Metode autentikasi ini digunakan untuk mengakses data yang tersedia secara publik secara anonim, seperti file Google Workspace yang dibagikan menggunakan setelan berbagi "Siapa saja di Internet yang memiliki link ini". Untuk mengetahui detail selengkapnya, lihat Mengelola kunci API.
Untuk membuat kunci API:
- Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create credentials > API key.
- Kunci API baru Anda akan ditampilkan.
- Klik Salin untuk menyalin kunci API Anda agar dapat digunakan dalam kode aplikasi Anda. Kunci API juga dapat ditemukan di bagian "API Keys" pada kredensial project Anda.
- Untuk mencegah penggunaan tanpa izin, sebaiknya batasi tempat dan API yang dapat menggunakan kunci API. Untuk mengetahui detail selengkapnya, lihat Menambahkan pembatasan API.
Kredensial ID klien OAuth
Untuk mengautentikasi pengguna akhir dan mengakses data pengguna di aplikasi Anda, Anda perlu membuat satu atau beberapa ID Klien OAuth 2.0. Client ID digunakan untuk mengidentifikasi satu aplikasi ke server OAuth Google. Jika aplikasi Anda berjalan di beberapa platform, Anda harus membuat ID klien terpisah untuk setiap platform.Pilih jenis aplikasi untuk mengetahui petunjuk khusus tentang cara membuat klien OAuth:
Aplikasi web
- Di Konsol Google Cloud, buka Menu > Google Auth platform > Clients.
- Klik Buat Klien.
- Klik Application type > aplikasi web.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
- Tambahkan URI resmi yang terkait dengan aplikasi Anda:
- Aplikasi sisi klien (JavaScript)–Di bagian Authorized JavaScript origins, klik Add URI. Kemudian, masukkan URI yang akan digunakan untuk permintaan browser. Parameter ini mengidentifikasi domain tempat aplikasi Anda dapat mengirim permintaan API ke server OAuth 2.0.
- Aplikasi sisi server (Java, Python, dan lainnya)–Di bagian Authorized redirect URIs, klik Add URI. Kemudian, masukkan URI endpoint yang dapat digunakan server OAuth 2.0 untuk mengirim respons.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian Client ID OAuth 2.0.
Perhatikan bahwa rahasia klien tidak digunakan untuk Aplikasi web.
Android
- Di Konsol Google Cloud, buka Menu > Google Auth platform > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > Android.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
- Di kolom Package name, masukkan nama paket dari file
AndroidManifest.xmlAnda. - Di kolom SHA-1 certificate fingerprint, masukkan sidik jari sertifikat SHA-1 yang dihasilkan.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
iOS
- Di Konsol Google Cloud, buka Menu > Google Auth platform > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > iOS.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
- Di kolom Bundle ID, masukkan ID paket yang tercantum dalam file
Info.plistaplikasi. - Opsional: Jika aplikasi Anda muncul di Apple App Store, masukkan ID App Store.
- Opsional: Di kolom Team ID, masukkan string unik yang terdiri atas 10 karakter yang dibuat oleh Apple dan ditetapkan bagi tim Anda.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Ekstensi Chrome
- Di Konsol Google Cloud, buka Menu > Google Auth platform > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > Ekstensi Chrome.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
- Di kolom ID Item, masukkan string ID 32 karakter unik aplikasi Anda. Anda dapat menemukan nilai ID ini di URL Chrome Web Store aplikasi Anda dan di Dasbor Developer Chrome Web Store.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Aplikasi desktop
- Di Konsol Google Cloud, buka Menu > Google Auth platform > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > Aplikasi desktop.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
TV dan Perangkat Input Terbatas
- Di Konsol Google Cloud, buka Menu > Google Auth platform > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > TV dan perangkat Input Terbatas.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Kredensial akun layanan
Akun layanan adalah jenis akun khusus yang digunakan oleh aplikasi, bukan oleh pengguna. Anda dapat menggunakan akun layanan untuk mengakses data atau melakukan tindakan oleh akun robot, atau untuk mengakses data atas nama pengguna Google Workspace atau Cloud Identity. Untuk mengetahui informasi selengkapnya, lihat Ringkasan akun layanan.Perhatikan bahwa peran Identity and Access Management (IAM) yang dikonfigurasi di Konsol Google Cloud tidak memberikan akses ke aset Google Workspace (seperti Spreadsheet atau Gmail). Untuk memberikan akses akun layanan ke resource Google Workspace, Anda dapat menggunakan hal berikut:
| Jika aplikasi Anda perlu... | Tempat mengonfigurasinya... |
|---|---|
| Mengakses file tertentu (seperti Spreadsheet Google) | Berbagi dokumen langsung dari file atau folder dengan alamat email akun layanan |
| Melakukan administrasi domain (seperti membuat pengguna Google Workspace) | Menetapkan peran administratif langsung ke akun layanan |
| Mengakses data pengguna di seluruh domain (seperti membaca acara Gmail atau Google Kalender pengguna mana pun) | Beri otorisasi akun layanan untuk menggunakan delegasi tingkat domain |
Membuat akun layanan
Anda dapat membuat akun layanan menggunakan Konsol Google Cloud atau alat command line gcloud.
Konsol Google Cloud
-
Di Konsol Google Cloud, buka Menu
> IAM & Admin
> Service Accounts.
Langkah-langkah yang tersisa akan muncul di Konsol Google Cloud.
- Pilih project Google Cloud.
- Klik Create service account.
- Masukkan nama akun layanan untuk ditampilkan di Konsol Google Cloud.
- Jika tidak ingin menetapkan kontrol akses sekarang, klik Selesai untuk menyelesaikan pembuatan akun layanan. Untuk menetapkan kontrol akses sekarang, klik Buat dan lanjutkan, lalu lanjutkan ke langkah berikutnya.
- Opsional: Tetapkan peran ke akun layanan Anda untuk memberikan akses ke resource project Google Cloud Anda selain resource Google Workspace. Untuk mengetahui detail selengkapnya, lihat Mengelola akses ke project, folder, dan organisasi.
- Klik Lanjutkan.
- Opsional: Masukkan pengguna atau grup yang dapat mengelola dan melakukan tindakan dengan akun layanan ini. Untuk mengetahui detail selengkapnya, lihat Peniruan akun layanan.
- Klik Selesai untuk menyelesaikan pembuatan akun layanan.
Catat alamat email untuk akun layanan.
gcloud CLI
- Buat akun layanan:
gcloud iam service-accounts createSERVICE_ACCOUNT_NAME\ --display-name="SERVICE_ACCOUNT_NAME" - Opsional: Tetapkan peran ke akun layanan Anda untuk memberikan akses ke resource project Google Cloud Anda selain resource Google Workspace. Untuk mengetahui detail selengkapnya, lihat Mengelola akses ke project, folder, dan organisasi.
Mengakses file Google Workspace secara langsung dengan akun layanan
Jika aplikasi Anda hanya perlu membaca atau menulis file tertentu (seperti Spreadsheet Google atau folder Google Drive), Anda tidak perlu menetapkan peran administratif atau mengonfigurasi delegasi di seluruh domain. Sebagai gantinya, Anda dapat membagikan setiap file secara langsung ke alamat email akun layanan menggunakan UI standar. Anda dapat memperlakukan alamat email akun layanan sebagai akun pengguna di setelan berbagi dokumen tanpa memerlukan hak istimewa administrator.
Untuk memberikan akses:
- Salin alamat email akun layanan Anda. Misalnya,
my-service-account@my-project.iam.gserviceaccount.com. - Buka dokumen Spreadsheet atau folder Drive yang ingin Anda akses.
- Klik Bagikan.
- Tambahkan alamat email akun layanan dan tetapkan tingkat akses yang sesuai (seperti Editor atau Pelihat).
- Hapus pilihan Beri tahu orang (karena akun layanan tidak memiliki kotak masuk, akun tersebut tidak akan menerima email undangan, tetapi izin tetap diberikan).
- Klik Bagikan.
Membuat kunci akun layanan
Anda harus mendapatkan kredensial dalam bentuk pasangan kunci publik/pribadi. Kredensial ini digunakan oleh kode Anda untuk mengizinkan tindakan akun layanan dalam aplikasi Anda.Untuk membuat kunci akun layanan:
-
Di Konsol Google Cloud, buka Menu
> IAM & Admin
> Service Accounts.
Langkah-langkah yang tersisa akan muncul di Konsol Google Cloud.
- Pilih project Google Cloud.
- Klik alamat email akun layanan yang ingin Anda buatkan kunci.
- Klik tab Kunci.
- Klik menu drop-down Kunci, lalu pilih Buat kunci baru.
- Pilih JSON sebagai jenis kunci dan klik Create.
Pasangan kunci umum/pribadi baru Anda dibuat dan didownload ke komputer Anda sebagai file kunci akun layanan. Simpan file JSON yang didownload sebagai
credentials.jsondi direktori kerja Anda. File ini adalah satu-satunya salinan kunci ini. Setelah Anda mendownload file kunci, Anda tidak dapat mendownloadnya lagi. Untuk mengetahui informasi tentang cara menyimpan kunci Anda dengan aman, lihat Praktik terbaik untuk mengelola kunci akun layanan.
Menetapkan peran administrator Google Workspace ke akun layanan
Anda dapat menetapkan peran Google Workspace standar atau khusus ke akun layanan, kecuali peran Admin Super.
Di konsol Google Admin, buka Menu > Akun > Peran admin.
Anda harus login sebagai Admin Super untuk melakukan tugas ini.
Langkah-langkah selanjutnya akan muncul di konsol Google Admin.
Arahkan kursor ke peran yang ingin Anda tetapkan, klik menu drop-down
Actions, lalu pilih Tetapkan admin.Klik Tetapkan akun layanan.
Masukkan alamat email akun layanan.
Klik Tambahkan > Tetapkan peran.
Opsional: Menyiapkan delegasi tingkat domain untuk akun layanan
Gunakan delegasi tingkat domain saat aplikasi Anda perlu mengakses data Google Workspace atas nama beberapa pengguna perorangan di organisasi Anda (seperti mengirim email menggunakan Gmail API) tanpa memerlukan izin pengguna perorangan. Untuk memanggil API atas nama pengguna di organisasi Google Workspace, berikan akun layanan Anda delegasi otoritas tingkat domain di konsol Google Admin menggunakan akun Admin Super. Untuk mengetahui informasi selengkapnya, lihat Mendelegasikan otoritas tingkat domain ke akun layanan.Untuk menyiapkan pendelegasian kewenangan tingkat domain untuk akun layanan:
- Di Konsol Google Cloud, buka Menu > IAM & Admin > Service Accounts.
- Pilih project Google Cloud.
- Klik alamat email akun layanan yang ingin Anda siapkan delegasi tingkat domainnya.
- Klik Tampilkan setelan lanjutan.
- Di bagian "Delegasi di seluruh domain", temukan "ID Klien" akun layanan Anda.
- Klik Salin untuk menyalin nilai ID klien ke papan klip Anda.
Jika Anda memiliki akses Admin Super ke akun Google Workspace yang relevan, klik Lihat Konsol Admin Google Workspace, login dengan akun pengguna administrator super Anda, lalu lanjutkan mengikuti langkah-langkah ini.
Jika Anda tidak memiliki akses administrator super ke akun Google Workspace yang relevan, hubungi administrator super untuk akun tersebut. Kirimkan ID klien akun layanan Anda dan daftar Cakupan OAuth yang diperlukan oleh aplikasi Anda agar mereka dapat menyelesaikan langkah-langkah berikut di konsol Google Admin.
- Di konsol Google Admin, buka Menu > Keamanan > Kontrol data dan akses > Kontrol API.
- Klik Kelola Delegasi Tingkat Domain.
- Klik Tambahkan baru.
- Di kolom Client ID, tempelkan ID klien yang Anda salin sebelumnya.
- Di kolom OAuth Scopes, masukkan daftar cakupan yang dibatasi koma yang diperlukan oleh aplikasi Anda. Ini adalah kumpulan cakupan yang sama yang Anda tentukan saat mengonfigurasi layar izin OAuth.
- Klik Otorisasi.
Perubahan dapat membutuhkan waktu hingga 24 jam, tetapi biasanya berlangsung lebih cepat. Untuk mengetahui informasi selengkapnya, lihat Mengontrol akses API dengan delegasi tingkat domain.
Langkah berikutnya
Anda siap mengembangkan aplikasi di Google Workspace. Tinjau daftar produk developer Google Workspace dan cara menemukan bantuan.