สร้างการสมัครใช้บริการ Google Workspace

Apps Script

• หากต้องการใช้คำสั่ง Google Cloud CLI ในคู่มือนี้ ให้ทำดังนี้
  1. ติดตั้ง Google Cloud CLI
  2. หากต้องการ เริ่มต้น CLI ของ gcloud ให้เรียกใช้โค้ดต่อไปนี้

    gcloud init
    

• โปรเจ็กต์ Apps Script
  • ใช้โปรเจ็กต์ Google Cloud แทนโปรเจ็กต์เริ่มต้นที่ Apps Script สร้างขึ้นโดยอัตโนมัติ
  • สำหรับขอบเขตทั้งหมดที่คุณเพิ่มเพื่อกำหนดค่าหน้าจอขอความยินยอม OAuth คุณต้องเพิ่มขอบเขตลงในไฟล์ appsscript.json ในโปรเจ็กต์ Apps Script ด้วย เช่น หากคุณระบุขอบเขต chat.messages ให้เพิ่มสิ่งต่อไปนี้

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

  • เปิดใช้ Google Workspace Eventsบริการขั้นสูง

• โปรเจ็กต์ Google Cloud ที่เปิดใช้การเรียกเก็บเงิน สำหรับการสมัครใช้บริการ Chat คุณต้อง เปิดใช้ Chat API ในโปรเจ็กต์ Cloud และ กำหนดค่าช่องชื่อแอป, URL รูปโปรไฟล์ และคำอธิบาย ด้วย โปรดดูรายละเอียดที่หัวข้อ สร้างแอป Google Chat
• ต้องมีการตรวจสอบสิทธิ์และขอบเขตการให้สิทธิ์ที่เหมาะสมสำหรับเหตุการณ์แต่ละประเภทในการสมัครใช้บริการ
  • โดยปกติแล้วต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยหน้าจอคำยินยอม OAuth ที่กำหนดค่าไว้สำหรับแอป เมื่อกำหนดค่าหน้าจอคำยินยอม คุณต้องระบุขอบเขตเพื่อรองรับเหตุการณ์แต่ละประเภทสำหรับการสมัครใช้บริการ หากต้องการกำหนดค่าหน้าจอความยินยอม และระบุขอบเขตที่จำเป็น โปรดดูเลือกขอบเขต
  • หากต้องการติดตามกิจกรรมใน Chat ในฐานะแอปใน Chat คุณต้องตรวจสอบสิทธิ์แอปด้วยการอนุมัติของผู้ดูแลระบบแบบครั้งเดียว การติดตามกิจกรรม Chat ในฐานะแอป Chat พร้อมใช้งานในเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์

Python

• Python 3.6 ขึ้นไป
• เครื่องมือจัดการแพ็กเกจ pip
• ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Python หากต้องการติดตั้งหรืออัปเดต ให้เรียกใช้คำสั่งต่อไปนี้ ในอินเทอร์เฟซบรรทัดคำสั่ง

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

• หากต้องการใช้คำสั่ง Google Cloud CLI ในคู่มือนี้ ให้ทำดังนี้
  1. ติดตั้ง Google Cloud CLI
  2. หากต้องการ เริ่มต้น CLI ของ gcloud ให้เรียกใช้โค้ดต่อไปนี้

    gcloud init
    

• โปรเจ็กต์ Google Cloud ที่เปิดใช้การเรียกเก็บเงิน สำหรับการสมัครใช้บริการ Chat คุณต้อง เปิดใช้ Chat API ในโปรเจ็กต์ Cloud และ กำหนดค่าช่องชื่อแอป, URL รูปโปรไฟล์ และคำอธิบาย ด้วย โปรดดูรายละเอียดที่หัวข้อ สร้างแอป Google Chat
• ต้องมีการตรวจสอบสิทธิ์และขอบเขตการให้สิทธิ์ที่เหมาะสมสำหรับเหตุการณ์แต่ละประเภทในการสมัครใช้บริการ
  • โดยปกติแล้วต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยหน้าจอคำยินยอม OAuth ที่กำหนดค่าไว้สำหรับแอป เมื่อกำหนดค่าหน้าจอคำยินยอม คุณต้องระบุขอบเขตเพื่อรองรับเหตุการณ์แต่ละประเภทสำหรับการสมัครใช้บริการ หากต้องการกำหนดค่าหน้าจอความยินยอม และระบุขอบเขตที่จำเป็น โปรดดูเลือกขอบเขต
  • หากต้องการติดตามกิจกรรมใน Chat ในฐานะแอปใน Chat คุณต้องตรวจสอบสิทธิ์แอปด้วยการอนุมัติของผู้ดูแลระบบแบบครั้งเดียว การติดตามกิจกรรม Chat ในฐานะแอป Chat พร้อมใช้งานในเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์

คอนโซล Google Cloud

ใน Google Cloud Console ให้เปิดโปรเจ็กต์ Google Cloud สำหรับแอป แล้วเปิดใช้ Google Workspace Events API และ Pub/Sub API โดยทำดังนี้

เปิดใช้ API

gcloud

1. ลงชื่อเข้าใช้บัญชี Google ในไดเรกทอรีการทำงานโดยทำดังนี้

   gcloud auth login

2. ตั้งค่าโปรเจ็กต์เป็นโปรเจ็กต์ Cloud สำหรับแอปของคุณ

   gcloud config set project PROJECT_ID

   แทนที่ PROJECT_ID ด้วย รหัสโปรเจ็กต์สำหรับโปรเจ็กต์ Cloud ของแอป

3. เปิดใช้ Google Workspace Events API และ Google Cloud Pub/Sub API โดยทำดังนี้

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

คอนโซล Google Cloud

1. ในคอนโซล Google Cloud ให้ไปที่หน้า Pub/Sub โดยทำดังนี้

   ไปที่ Google Cloud Pub/Sub

   ตรวจสอบว่าได้เลือกโปรเจ็กต์ Cloud สำหรับแอปแล้ว

2. คลิก add_box สร้างหัวข้อ แล้วทำดังนี้

   1. ป้อนชื่อหัวข้อ เช่น workspace-events-topic
   2. เลือกเพิ่มการสมัครใช้บริการเริ่มต้นไว้ Pub/Sub จะตั้งชื่อการสมัครใช้บริการเริ่มต้นนี้ คล้ายกับชื่อของหัวข้อ เช่น workspace-events-topic-sub
   3. ไม่บังคับ: อัปเดตหรือกําหนดค่าพร็อพเพอร์ตี้เพิ่มเติม สําหรับหัวข้อ

3. คลิกสร้าง ชื่อหัวข้อแบบเต็มจะจัดรูปแบบเป็น projects/PROJECT_ID/topics/TOPIC_ID คุณจะใช้ชื่อเต็มนี้ในขั้นตอนถัดไป

4. ให้สิทธิ์เข้าถึงเพื่อเผยแพร่ข้อความ Pub/Sub ไปยังหัวข้อของคุณ

   1. ในหน้าของหัวข้อ ให้ไปที่แผงด้านข้างแล้วเปิดแท็บสิทธิ์
   2. คลิกเพิ่มผู้รับมอบสิทธิ์
   3. ในช่องเพิ่มผู้ใช้หลัก ให้เพิ่มบัญชีบริการสำหรับ แอปพลิเคชัน Google Workspace ที่ส่งกิจกรรมไปยัง การสมัครใช้บริการของคุณ
      1. สำหรับกิจกรรมใน Chat chat-api-push@system.gserviceaccount.com
      2. รุ่นตัวอย่างสำหรับนักพัฒนาแอป: สำหรับเหตุการณ์ในไดรฟ์ drive-api-event-push@system.gserviceaccount.com
      3. สำหรับกิจกรรม Meet meet-api-event-push@system.gserviceaccount.com
   4. ในเมนูมอบหมายบทบาท ให้เลือก Pub/Sub Publisher
   5. คลิกบันทึก การอัปเดตสิทธิ์สำหรับหัวข้ออาจใช้เวลาสักครู่

gcloud

1. ในโปรเจ็กต์ Cloud ให้สร้างหัวข้อโดยเรียกใช้คำสั่งต่อไปนี้

   gcloud pubsub topics create TOPIC_ID

   แทนที่ TOPIC_ID ด้วยรหัสที่ไม่ซ้ำกันสำหรับหัวข้อ เช่น workspace-events-topic

   เอาต์พุตจะแสดงชื่อหัวข้อแบบเต็มในรูปแบบ projects/PROJECT_ID/topics/TOPIC_ID จดชื่อไว้ และตรวจสอบว่าค่าสำหรับ PROJECT_ID คือรหัสโปรเจ็กต์ Cloud สำหรับแอปของคุณ คุณจะใช้ชื่อหัวข้อในขั้นตอนต่อไป และเพื่อสร้าง การสมัครใช้บริการ Google Workspace ในภายหลัง

2. ให้สิทธิ์เข้าถึงเพื่อเผยแพร่ข้อความไปยังหัวข้อของคุณ

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

   แทนที่ค่าต่อไปนี้

   • TOPIC_NAME: ชื่อหัวข้อแบบเต็ม ซึ่งเป็น เอาต์พุตจากขั้นตอนก่อนหน้า โดยมีรูปแบบเป็น projects/PROJECT_ID/topics/TOPIC_ID

   • GOOGLE_WORKSPACE_APPLICATION: แอปพลิเคชัน Google Workspace ที่ต้องส่งเหตุการณ์ไปยังการสมัครใช้บริการของคุณ

     • หากต้องการรับเหตุการณ์จาก Chat ให้ใช้ chat-api-push@system.gserviceaccount.com
     • เวอร์ชันตัวอย่างสำหรับนักพัฒนาแอป: หากต้องการรับเหตุการณ์จากไดรฟ์ ให้ใช้ drive-api-event-push@system.gserviceaccount.com
     • หากต้องการรับเหตุการณ์จาก Meet ให้ใช้ meet-api-event-push@system.gserviceaccount.com

   การอัปเดตสิทธิ์สำหรับหัวข้ออาจใช้เวลาสักครู่

3. สร้างการสมัครใช้บริการ Pub/Sub สำหรับหัวข้อ

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME

   แทนที่ค่าต่อไปนี้

   • SUBSCRIPTION_NAME: ชื่อสำหรับการสมัครใช้บริการ เช่น workspace-events-subscription
   • TOPIC_NAME: ชื่อหัวข้อที่คุณสร้าง ในขั้นตอนก่อนหน้า

Apps Script

1. ในโปรเจ็กต์ Apps Script ให้สร้างไฟล์สคริปต์ใหม่ ชื่อ createSubscription แล้วเพิ่มโค้ดต่อไปนี้

   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);
   }
   

   แทนที่ค่าต่อไปนี้

   • TARGET_RESOURCE: ทรัพยากร Google Workspace ที่คุณสมัครใช้บริการ ซึ่งจัดรูปแบบเป็นชื่อทรัพยากรแบบเต็ม เช่น หากต้องการติดตามพื้นที่ใน Google Chat ที่มีรหัสพื้นที่ AAAABBBB ให้ใช้ //chat.googleapis.com/spaces/AAAABBBB
   • EVENT_TYPES: ประเภทเหตุการณ์อย่างน้อย 1 รายการ ที่คุณต้องการสมัครรับข้อมูลในแหล่งข้อมูลเป้าหมาย จัดรูปแบบเป็น อาร์เรย์ของสตริง เช่น 'google.workspace.chat.message.v1.created'
   • TOPIC_NAME: ชื่อเต็มของหัวข้อ Pub/Sub ที่คุณสร้างในโปรเจ็กต์ Cloud โดยมีรูปแบบเป็น projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: บูลีนที่ระบุว่าการสมัครใช้บริการมีข้อมูลทรัพยากรในเพย์โหลดหรือไม่

     • True: รวมข้อมูลทรัพยากรทั้งหมด หากต้องการจำกัดช่องที่จะรวม ให้เพิ่มฟิลด์ fieldMask และระบุอย่างน้อย 1 ฟิลด์สำหรับทรัพยากรที่เปลี่ยนแปลง เฉพาะการสมัครใช้บริการทรัพยากรของ Chat เท่านั้นที่รองรับการรวมข้อมูลทรัพยากร
     • False: ไม่รวมข้อมูลทรัพยากร

2. หากต้องการสร้างการสมัครใช้บริการ Google Workspace ให้เรียกใช้ฟังก์ชัน createSubscription ในโปรเจ็กต์ Apps Script

Python

1. สร้างไฟล์ชื่อ create_subscription.py ในไดเรกทอรีการทำงาน แล้วเพิ่มโค้ดต่อไปนี้

   """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)
   

   แทนที่ค่าต่อไปนี้

   • SCOPES: ขอบเขต OAuth อย่างน้อย 1 รายการที่รองรับเหตุการณ์แต่ละประเภท สำหรับการสมัครใช้บริการ จัดรูปแบบเป็นอาร์เรย์ของสตริง หากต้องการแสดงขอบเขตหลายรายการ ให้คั่นด้วยคอมมา เช่น 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
   • TARGET_RESOURCE: ทรัพยากร Google Workspace ที่คุณสมัครใช้บริการ ซึ่งจัดรูปแบบเป็นชื่อทรัพยากรแบบเต็ม เช่น หากต้องการติดตามพื้นที่ใน Google Chat ที่มีรหัสพื้นที่ AAAABBBB ให้ใช้ //chat.googleapis.com/spaces/AAAABBBB
   • EVENT_TYPES: ประเภทเหตุการณ์อย่างน้อย 1 รายการ ที่คุณต้องการสมัครรับข้อมูลในแหล่งข้อมูลเป้าหมาย จัดรูปแบบเป็น อาร์เรย์ของสตริง เช่น 'google.workspace.chat.message.v1.created'
   • TOPIC_NAME: ชื่อเต็มของหัวข้อ Pub/Sub ที่คุณสร้างในโปรเจ็กต์ Cloud โดยมีรูปแบบเป็น projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: บูลีนที่ระบุว่าการสมัครใช้บริการมีข้อมูลทรัพยากรในเพย์โหลดหรือไม่

     • True: รวมข้อมูลทรัพยากรทั้งหมด หากต้องการจำกัดช่องที่จะรวม ให้เพิ่มฟิลด์ fieldMask และระบุอย่างน้อย 1 ฟิลด์สำหรับทรัพยากรที่เปลี่ยนแปลง เฉพาะการสมัครใช้บริการทรัพยากรของ Chat เท่านั้นที่รองรับการรวมข้อมูลทรัพยากร
     • False: ไม่รวมข้อมูลทรัพยากร

2. หากต้องการสร้างการสมัครใช้บริการ Google Workspace ให้เรียกใช้คำสั่งต่อไปนี้ในเทอร์มินัล

   python3 create_subscription.py

คอนโซล Google Cloud

1. ทริกเกอร์เหตุการณ์อย่างน้อย 1 ประเภทในทรัพยากรเป้าหมายของการสมัครใช้บริการ Google Workspace เช่น หากคุณสมัครรับข้อมูลข้อความใหม่ในพื้นที่ใน Chat ให้โพสต์ข้อความในพื้นที่นั้น

2. ในคอนโซล Google Cloud ให้ไปที่หน้า Pub/Sub โดยทำดังนี้

   ไปที่ Pub/Sub

   ตรวจสอบว่าได้เลือกโปรเจ็กต์ Cloud สำหรับแอปแล้ว

3. คลิกการสมัครใช้บริการในเมนู Pub/Sub

4. ในตาราง ให้ค้นหาการสมัครใช้บริการ Pub/Sub สำหรับหัวข้อของคุณ แล้วคลิก ชื่อการสมัครใช้บริการ

5. คลิกแท็บข้อความ

6. คลิกดึง เหตุการณ์อาจใช้เวลา 2-3 นาทีในการสร้างข้อความ Pub/Sub

gcloud

1. ทริกเกอร์เหตุการณ์อย่างน้อย 1 ประเภทในทรัพยากรเป้าหมายของการสมัครใช้บริการ Google Workspace เช่น หากคุณสมัครรับข้อมูลข้อความใหม่ในพื้นที่ใน Chat ให้โพสต์ข้อความในพื้นที่นั้น

2. เรียกใช้คำสั่งต่อไปนี้

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

   แทนที่ค่าต่อไปนี้

   • PUBSUB_SUBSCRIPTION_NAME: ชื่อเต็มของการสมัครใช้บริการ Pub/Sub ในรูปแบบ projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID
   • MESSAGE_COUNT: จำนวนข้อความ Pub/Sub สูงสุดที่คุณต้องการดึง

   เหตุการณ์อาจใช้เวลา 2-3 นาทีในการสร้างข้อความ Pub/Sub

Python

  """Create subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = ['https://www.googleapis.com/auth/chat.app.messages.readonly']

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # The Google Workspace resource to monitor for events.
  TARGET_RESOURCE = '//chat.googleapis.com/spaces/SPACE_ID'

  # The types of events to receive.
  EVENT_TYPES = [
                  'google.workspace.chat.message.v1.created',
                  'google.workspace.chat.message.v1.updated',
                  'google.workspace.chat.message.v1.deleted',
                ]

  # 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',
      'v1beta',
      credentials=CREDENTIALS,
      discoveryServiceUrl='https://workspaceevents.googleapis.com/$discovery/rest?version=v1beta&labels=DEVELOPER_PREVIEW&key=API_KEY',
  )

  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)