Google Workspace Admin SDK

Konektor Google Workspace Admin SDK memungkinkan Anda melakukan operasi yang didukung di Google Workspace Admin SDK.

Sebelum memulai

Sebelum menggunakan konektor Google Workspace Admin SDK, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
    • Berikan peran IAM roles/connectors.admin kepada pengguna mengonfigurasi konektor.
    • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Konektor dan akun layanan harus berada dalam project yang sama. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan.

    • Aktifkan layanan berikut:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

    Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

  • Jika Anda menggunakan autentikasi akun layanan, bukan autentikasi OAuth 2.0, pastikan bahwa izin yang sesuai diberikan ke akun layanan. Untuk mengetahui informasi selengkapnya, lihat Peran dan izin IAM.

Mengonfigurasi konektor

Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:

  1. Di konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

  2. Klik + Create new untuk membuka halaman Create Connection.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik Next.
  • Di bagian Connection Details, tetapkan kolom berikut:
    1. Konektor: Pilih Google Workspace Admin SDK dari menu drop-down konektor yang tersedia.
    2. Versi konektor: Pilih versi konektor dari menu drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan nama untuk instance koneksi.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
    4. Secara opsional, masukkan Description untuk instance koneksi.
    5. Secara opsional, pilih Enable cloud logging jika Anda ingin mencatat detail eksekusi konektor.
    6. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    7. Secara opsional, konfigurasikan Connection node settings:

      • Minimum number of nodes: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Diperlukan lebih banyak node untuk memproses lebih banyak transaksi untuk koneksi dan sebaliknya, diperlukan lebih sedikit node untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

    8. Secara opsional, klik + Add label untuk menambahkan label ke koneksi dalam bentuk pasangan nilai kunci.
    9. Klik Next.
    10. Di bagian Authentication, masukkan detail autentikasi.
      1. Pilih Authentication type , lalu masukkan detail yang relevan.

        Anda dapat memilih salah satu jenis autentikasi berikut:

        • OAuth 2.0 - Kode otorisasi
        • Akun layanan
      2. Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

      3. Klik Next.
    11. Review: Tinjau detail koneksi dan autentikasi Anda.
    12. Klik Create.

    Mengonfigurasi autentikasi

    Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

    • OAuth 2.0 - Kode otorisasi
      • Client ID: Client ID yang diperlukan untuk terhubung ke layanan Google backend Anda.
      • Cakupan: Pilih cakupan OAuth 2.0 yang diperlukan dari menu drop-down. Untuk melihat semua cakupan OAuth 2.0 yang didukung untuk layanan Google yang diperlukan, lihat bagian yang relevan di halaman Cakupan OAuth 2.0 untuk Google API.
      • Client Secret: Pilih secret Secret Manager yang berisi sandi yang terkait dengan client secret.
      • Versi secret: Pilih versi secret.
    • Akun layanan

      Pilih opsi ini untuk melakukan autentikasi menggunakan akun layanan yang Anda berikan pada langkah sebelumnya saat mengonfigurasi koneksi ini. Pastikan Anda telah memberikan akun layanan yang memiliki peran dan izin IAM yang relevan yang diperlukan untuk autentikasi.

      • Cakupan: Pilih cakupan OAuth 2.0 yang diperlukan dari menu drop-down. Untuk mengetahui informasi selengkapnya, lihat Cakupan akses.

    Tindakan

    Konektor ini menyediakan lapisan abstraksi untuk objek layanan backend yang terhubung. Anda hanya dapat mengakses objek backend melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai tindakan. An Action adalah fungsi kelas pertama yang disediakan untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda melakukan perubahan pada satu atau beberapa entity, dan berbeda-beda dari satu konektor ke konektor lainnya. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

    Menggunakan koneksi Google Workspace Admin SDK dalam integrasi

    Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

    Mendapatkan bantuan dari komunitas Google Cloud

    Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Forum Cloud.

    Langkah berikutnya