Membuat langganan Google Workspace

Apps Script

• Untuk menggunakan perintah Google Cloud CLI dalam panduan ini:
  1. Instal Google Cloud CLI.
  2. Hingga lakukan inisialisasi CLI gcloud, jalankan kode berikut:

    gcloud init
    

• Project Google Cloud dengan penagihan diaktifkan. Untuk berlangganan Chat, Anda harus aktifkan Chat API di project Cloud Anda dan mengonfigurasi App name, Avatar URL, dan Description kolom. Untuk mengetahui detailnya, lihat Buat aplikasi Google Chat.
• Memerlukan autentikasi pengguna dengan layar izin OAuth yang dikonfigurasi untuk aplikasi. Saat mengonfigurasi layar izin, Anda harus menentukan cakupan untuk mendukung setiap jenis peristiwa untuk langganan. Untuk mengonfigurasi izin dan mengidentifikasi cakupan yang diperlukan, melihat Pilih cakupan.

• Project Apps Script:
  • Gunakan project Google Cloud Anda, bukan project default yang dibuat otomatis oleh Apps Script.
  • Untuk cakupan apa pun yang ditambahkan untuk mengonfigurasi layar izin OAuth, Anda juga harus menambahkan ke file appsscript.json di project Apps Script Anda. Contoh:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages.readonly"
  ]
      

  • Aktifkan layanan lanjutan Google Workspace Events.

Python

• Python 3.6 atau yang lebih baru
• Alat pengelolaan paket pip
• Library klien Google terbaru untuk Python. Untuk menginstal atau mengupdatenya, jalankan perintah berikut di antarmuka command line Anda:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• Untuk menggunakan perintah Google Cloud CLI dalam panduan ini:
  1. Instal Google Cloud CLI.
  2. Hingga lakukan inisialisasi CLI gcloud, jalankan kode berikut:

    gcloud init
    

• Project Google Cloud dengan penagihan diaktifkan. Untuk berlangganan Chat, Anda harus aktifkan Chat API di project Cloud Anda dan mengonfigurasi App name, Avatar URL, dan Description kolom. Untuk mengetahui detailnya, lihat Buat aplikasi Google Chat.
• Memerlukan autentikasi pengguna dengan layar izin OAuth yang dikonfigurasi untuk aplikasi. Saat mengonfigurasi layar izin, Anda harus menentukan cakupan untuk mendukung setiap jenis peristiwa untuk langganan. Untuk mengonfigurasi izin dan mengidentifikasi cakupan yang diperlukan, melihat Pilih cakupan.

Konsol Google Cloud

Di konsol Google Cloud, buka project Google Cloud untuk aplikasi Anda dan aktifkan Google Workspace Events API dan Pub/Sub API:

Aktifkan API

gcloud

1. Di direktori kerja, login ke Akun Google Anda:

   gcloud auth login
   

2. Tetapkan project Anda ke project Cloud untuk aplikasi Anda:

   gcloud config set project PROJECT_ID
   

   Ganti PROJECT_ID dengan project ID untuk project Cloud bagi aplikasi Anda.

3. Mengaktifkan Google Workspace Events API dan Google Cloud Pub/Sub API:

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
   

Konsol Google Cloud

1. Di Konsol Google Cloud, buka halaman Pub/Sub:

   Buka Google Cloud Pub/Sub

   Pastikan project Cloud untuk aplikasi Anda sudah dipilih.

2. Klik add_box Buat topik, lalu lakukan hal berikut:

   1. Masukkan nama untuk topik Anda, seperti workspace-events-topic.
   2. Biarkan Add a default subscription tetap dipilih. Pub/Sub menamai ini langganan default yang mirip dengan nama topik Anda, misalnya workspace-events-topic-sub.
   3. Opsional: Perbarui atau konfigurasi properti tambahan untuk topik Anda.

3. Klik Buat. Nama topik lengkap Anda diformat sebagai projects/PROJECT_ID/topics/TOPIC_ID. Anda akan menggunakan nama lengkap ini di langkah berikutnya.

4. Berikan akses untuk memublikasikan pesan Pub/Sub ke topik Anda:

   1. Di halaman topik, buka panel samping dan buka Tab Izin.
   2. Klik Add Principal.
   3. Di kolom Add principals, tambahkan akun layanan untuk Aplikasi Google Workspace yang mengirimkan peristiwa ke langganan:
      1. Untuk peristiwa Chat, chat-api-push@system.gserviceaccount.com.
      2. Untuk acara Meet, meet-api-event-push@system.gserviceaccount.com.
   4. Di menu Tetapkan peran, pilih Pub/Sub Publisher.
   5. Klik Simpan. Perlu waktu beberapa menit untuk memperbarui izin untuk topik Anda.

gcloud

1. Di project Cloud Anda, buat topik dengan menjalankan perintah berikut berikut:

   gcloud pubsub topics create TOPIC_ID
   

   Ganti TOPIC_ID dengan ID unik untuk topik Anda, seperti sebagai workspace-events-topic.

   Output menampilkan nama topik lengkap, yang diformat sebagai projects/PROJECT_ID/topics/TOPIC_ID. Catat namanya, dan pastikan nilai untuk PROJECT_ID adalah ID project Cloud untuk aplikasi Anda. Anda akan menggunakan nama topik pada langkah berikut, dan untuk membuat langganan Google Workspace.

2. Memberikan akses untuk memublikasikan pesan ke topik Anda:

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
   

   Ganti kode berikut:

   • TOPIC_NAME: Nama topik lengkap, yang merupakan output dari langkah sebelumnya. Diformat sebagai projects/PROJECT_ID/topics/TOPIC_ID.

   • GOOGLE_WORKSPACE_APPLICATION: Aplikasi Google Workspace yang harus mengirimkan peristiwa ke langganan Anda:

     • Untuk menerima peristiwa dari Chat, gunakan chat-api-push@system.gserviceaccount.com.
     • Untuk menerima acara dari Meet, gunakan meet-api-event-push@system.gserviceaccount.com.

   Diperlukan waktu beberapa menit untuk memperbarui izin topik Anda.

3. Buat langganan Pub/Sub untuk topik:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   Ganti kode berikut:

   • SUBSCRIPTION_NAME: Nama untuk langganan Anda, seperti workspace-events-subscription.
   • TOPIC_NAME: Nama topik yang Anda buat di langkah sebelumnya.

Apps Script

1. Di project Apps Script, buat file skrip baru bernama createSubscription dan tambahkan kode berikut:

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   Ganti kode berikut:

   • TARGET_RESOURCE: Referensi Google Workspace langganan Anda, yang diformat sebagai nama resource lengkap. Sebagai misalnya, berlangganan ruang Google Chat dengan ID ruang AAAABBBB, gunakan //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Satu atau beberapa jenis peristiwa yang ingin Anda ikuti di resource target. Format sebagai array string, seperti 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Nama lengkap topik Pub/Sub yang yang Anda buat di project Cloud. Diformat sebagai projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Boolean yang menentukan apakah nilai langganan menyertakan data resource dalam payload:

     • True: Menyertakan semua data resource. Untuk membatasi {i>field<i} mana yang disertakan, tambahkan fieldMask dan menentukan setidaknya satu bidang untuk sumber daya yang diubah. Hanya langganan ke dukungan resource Chat, termasuk data resource.
     • False: Mengecualikan data resource.

2. Untuk membuat langganan Google Workspace, jalankan fungsi createSubscription di project Apps Script Anda.

Python

1. Di direktori kerja, buat file bernama create_subscription.py dan tambahkan kode berikut:

   """Create subscription."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = [SCOPES]
   
   # Authenticate with Google Workspace and get user authentication.
   flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   Ganti kode berikut:

   • SCOPES: Satu atau beberapa cakupan OAuth yang mendukung setiap jenis peristiwa untuk langganan. Diformat sebagai array string. Untuk mencantumkan beberapa cakupan, pisahkan dengan koma. Misalnya, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: Referensi Google Workspace langganan Anda, yang diformat sebagai nama resource lengkap. Sebagai misalnya, berlangganan ruang Google Chat dengan ID ruang AAAABBBB, gunakan //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Satu atau beberapa jenis peristiwa yang ingin Anda ikuti di resource target. Format sebagai array string, seperti 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Nama lengkap topik Pub/Sub yang yang Anda buat di project Cloud. Diformat sebagai projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Boolean yang menentukan apakah nilai langganan menyertakan data resource dalam payload:

     • True: Menyertakan semua data resource. Untuk membatasi {i>field<i} mana yang disertakan, tambahkan fieldMask dan menentukan setidaknya satu bidang untuk sumber daya yang diubah. Hanya langganan ke dukungan resource Chat, termasuk data resource.
     • False: Mengecualikan data resource.

2. Untuk membuat langganan Google Workspace, jalankan perintah berikut di terminal Anda:

   python3 create_subscription.py
   

Konsol Google Cloud

1. Memicu satu atau beberapa jenis peristiwa di resource target Google Workspace Anda. Misalnya, jika Anda sudah berlangganan pesan di ruang Chat, memposting pesan ke ruang.

2. Di Konsol Google Cloud, buka halaman Pub/Sub:

   Buka Pub/Sub

   Pastikan project Cloud untuk aplikasi Anda sudah dipilih.

3. Di menu Pub/Sub, klik Langganan.

4. Pada tabel, temukan langganan Pub/Sub untuk topik Anda, lalu klik nama langganan.

5. Klik tab Pesan.

6. Klik Pull. Diperlukan waktu hingga beberapa menit untuk membuat sebuah peristiwa pesan Pub/Sub.

gcloud

1. Memicu satu atau beberapa jenis peristiwa di resource target Google Workspace Anda. Misalnya, jika Anda sudah berlangganan dalam ruang Chat, memposting pesan dalam ruang.

2. Jalankan perintah berikut:

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
   

   Ganti kode berikut:

   • PUBSUB_SUBSCRIPTION_NAME: Nama lengkap Langganan Pub/Sub, yang diformat sebagai projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: Jumlah maksimum pesan Pub/Sub yang ingin Anda tarik.

   Diperlukan waktu hingga beberapa menit bagi peristiwa untuk membuat Pub/Sub untuk membuat pesan email baru.