Membuat langganan Google Workspace

Apps Script

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

    gcloud init
    

• Project Google Cloud dengan penagihan diaktifkan. Untuk langganan ke Chat, Anda juga harus mengaktifkan Chat API di project Cloud dan mengonfigurasi kolom Nama aplikasi, URL avatar, dan Deskripsi. Untuk mengetahui detailnya, lihat Membangun 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 layar izin dan mengidentifikasi cakupan yang diperlukan, lihat Memilih cakupan.

• Project Apps Script:
  • Gunakan project Google Cloud Anda, bukan project default yang dibuat secara otomatis oleh Apps Script.
  • Untuk cakupan apa pun yang Anda tambahkan untuk mengonfigurasi layar izin OAuth, Anda juga harus menambahkan cakupan 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 mengupdate-nya, 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. Untuk menginisialisasi CLI gcloud, jalankan kode berikut:

    gcloud init
    

• Project Google Cloud dengan penagihan diaktifkan. Untuk langganan ke Chat, Anda juga harus mengaktifkan Chat API di project Cloud dan mengonfigurasi kolom Nama aplikasi, URL avatar, dan Deskripsi. Untuk mengetahui detailnya, lihat Membangun 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 layar izin dan mengidentifikasi cakupan yang diperlukan, lihat Memilih cakupan.

Konsol Google Cloud

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

Aktifkan API

gcloud

1. Di direktori kerja Anda, 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 aplikasi Anda.

3. Aktifkan 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 dipilih.

2. Klik add_box Buat topik dan lakukan tindakan berikut:

   1. Masukkan nama untuk topik Anda, seperti workspace-events-topic.
   2. Biarkan Tambahkan langganan default dipilih. Pub/Sub memberi nama langganan default ini mirip dengan nama topik Anda, seperti workspace-events-topic-sub.
   3. Opsional: Perbarui atau konfigurasi properti tambahan untuk topik Anda.

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

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

   1. Di halaman topik Anda, 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 Anda:
      1. Untuk acara Chat, chat-api-push@system.gserviceaccount.com.
      2. Pratinjau Developer:: Untuk peristiwa Drive, drive-api-event-push@system.gserviceaccount.com.
      3. Untuk acara Meet, meet-api-event-push@system.gserviceaccount.com.
   4. Di menu Tetapkan peran, pilih Pub/Sub Publisher.
   5. Klik Simpan. Diperlukan waktu beberapa menit untuk memperbarui izin topik Anda.

gcloud

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

   gcloud pubsub topics create TOPIC_ID

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

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

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.
     • Pratinjau Developer:: Untuk menerima peristiwa dari Drive, gunakan drive-api-event-push@system.gserviceaccount.com.
     • Untuk menerima peristiwa 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 Anda, buat file skrip baru bernama createSubscription, lalu 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: Resource Google Workspace yang Anda ikuti, diformat sebagai nama resource lengkapnya. Misalnya, untuk 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 Anda buat di project Cloud Anda. Diformat sebagai projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: Mencakup semua data resource. Untuk membatasi kolom yang disertakan, tambahkan kolom fieldMask dan tentukan setidaknya satu kolom untuk resource yang diubah. Hanya langganan ke resource Chat yang mendukung penyertaan 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 Anda, 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('credentials.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: Resource Google Workspace yang Anda ikuti, diformat sebagai nama resource lengkapnya. Misalnya, untuk 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 Anda buat di project Cloud Anda. Diformat sebagai projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: Mencakup semua data resource. Untuk membatasi kolom yang disertakan, tambahkan kolom fieldMask dan tentukan setidaknya satu kolom untuk resource yang diubah. Hanya langganan ke resource Chat yang mendukung penyertaan 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 langganan Google Workspace Anda. Misalnya, jika Anda telah berlangganan pesan baru di ruang Chat, posting pesan ke ruang tersebut.

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

   Buka Pub/Sub

   Pastikan project Cloud untuk aplikasi Anda dipilih.

3. Di menu Pub/Sub, klik Subscriptions.

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

5. Klik tab Pesan.

6. Klik Pull. Mungkin perlu waktu hingga beberapa menit bagi suatu peristiwa untuk menghasilkan pesan Pub/Sub.

gcloud

1. Memicu satu atau beberapa jenis peristiwa di resource target langganan Google Workspace Anda. Misalnya, jika Anda telah berlangganan pesan baru di ruang Chat, posting pesan di ruang tersebut.

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 Anda, yang diformat sebagai projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: Jumlah maksimum pesan Pub/Sub yang ingin Anda tarik.

   Mungkin perlu waktu hingga beberapa menit bagi suatu peristiwa untuk membuat pesan Pub/Sub.