อัปเดตหรือต่ออายุการสมัครใช้บริการ Google Workspace

หน้านี้อธิบายวิธีต่ออายุการสมัครใช้บริการ Google Workspace โดยใช้วิธีการ subscriptions.update() คุณสามารถใช้วิธีนี้เพื่ออัปเดตเวลาหมดอายุของการสมัครใช้บริการ รวมถึงต่ออายุการสมัครใช้บริการให้มีเวลาหมดอายุสูงสุดเท่าที่จะเป็นไปได้ หรือ เพื่ออัปเดตรายการประเภทเหตุการณ์ที่จะรับเกี่ยวกับทรัพยากรเป้าหมาย

Apps Script

  • โปรเจ็กต์ Apps Script
    • ใช้โปรเจ็กต์ Google Cloud แทนโปรเจ็กต์เริ่มต้นที่ Apps Script สร้างขึ้นโดยอัตโนมัติ
    • สำหรับขอบเขตทั้งหมดที่คุณเพิ่มเพื่อกำหนดค่าหน้าจอขอความยินยอม OAuth คุณต้องเพิ่มขอบเขตลงในไฟล์ appsscript.json ในโปรเจ็กต์ Apps Script ด้วย เช่น หากคุณระบุขอบเขต chat.messages ให้เพิ่มสิ่งต่อไปนี้ 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages"
]
    • เปิดใช้ Google Workspace Eventsบริการขั้นสูง

Python

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

ต่ออายุการสมัครใช้บริการ Google Workspace

ในส่วนนี้ คุณจะใช้subscriptions.update()เมธอดของ Google Workspace Events API เพื่อต่ออายุการสมัครใช้บริการจนถึงเวลาหมดอายุสูงสุด หากต้องการระบุเวลาหมดอายุสูงสุด ให้อัปเดตฟิลด์ ttl ของทรัพยากร Subscription เป็น 0

เวลาหมดอายุสูงสุดจะขึ้นอยู่กับข้อมูลทรัพยากรที่รวมอยู่ใน เพย์โหลดของเหตุการณ์ ดูข้อมูลเพิ่มเติมเกี่ยวกับเวลาหมดอายุได้ที่ข้อมูลเหตุการณ์สำหรับ เหตุการณ์ใน Google Workspace

วิธีต่ออายุการสมัครใช้บริการ Google Workspace

Apps Script

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

    function updateSubscription() {
  // The name of the subscription to update.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.patch({
    ttl: '0s',
  }, name);
  console.log(response);
}

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

    • SUBSCRIPTION_ID: รหัสของการสมัครใช้บริการ หากต้องการรับรหัส คุณสามารถใช้ตัวเลือกต่อไปนี้
      • ค่าของฟิลด์ uid
      • รหัสของชื่อทรัพยากรที่แสดงในฟิลด์ name เช่น หากชื่อทรัพยากรคือ subscriptions/subscription-123 ให้ใช้ subscription-123

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

Python

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

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

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

BODY = {
    'ttl': {'seconds': 0},
}
NAME = 'subscriptions/SUBSCRIPTION_ID'
response = (
    service.subscriptions()
    .patch(name=NAME, updateMask='ttl', body=BODY)
    .execute()
)
print(response)

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

    • SCOPES: ขอบเขต OAuth อย่างน้อย 1 รายการที่รองรับเหตุการณ์แต่ละประเภท สำหรับการสมัครใช้บริการ จัดรูปแบบเป็นอาร์เรย์ของสตริง หากต้องการแสดงขอบเขตหลายรายการ ให้คั่นด้วยคอมมา เช่น 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
    • SUBSCRIPTION_ID: รหัสของการสมัครใช้บริการ หากต้องการรับรหัส คุณสามารถใช้ตัวเลือกต่อไปนี้
      • ค่าของฟิลด์ uid
      • รหัสของชื่อทรัพยากรที่แสดงในฟิลด์ name เช่น หากชื่อทรัพยากรคือ subscriptions/subscription-123 ให้ใช้ subscription-123

  2. ตรวจสอบว่าคุณได้จัดเก็บข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และตั้งชื่อไฟล์เป็น credentials.json ในไดเรกทอรีการทำงาน ตัวอย่างโค้ดใช้ไฟล์ JSON นี้เพื่อตรวจสอบสิทธิ์กับ Google Workspace และรับข้อมูลเข้าสู่ระบบของผู้ใช้ โปรดดูวิธีการที่หัวข้อสร้างข้อมูลเข้าสู่ระบบ รหัสไคลเอ็นต์ OAuth

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

    python3 update_subscription.py
Google Workspace Events API จะแสดงการดำเนินการที่ใช้เวลานานซึ่งมีอินสแตนซ์ของทรัพยากร Subscription

หากต้องการดูรายละเอียดเกี่ยวกับทรัพยากร Subscription ที่อัปเดต ให้ใช้วิธี operations.get() และระบุทรัพยากร Operation ที่แสดงผลจากคำขอ subscriptions.update() หรือหากคุณระบุทรัพยากร Operation จากการสมัครใช้บริการเวอร์ชันก่อนหน้า การตอบกลับจะว่างเปล่า

อัปเดตหรือต่ออายุการสมัครใช้บริการในฐานะแอป Google Chat

คุณสามารถอัปเดตหรือต่ออายุการสมัครใช้บริการเหตุการณ์ใน Chat ในฐานะแอป Chat แทนที่จะเป็นผู้ใช้ กระบวนการจะคล้ายกัน ยกเว้น

  1. แทนที่จะตรวจสอบสิทธิ์ผู้ใช้ ให้ตรวจสอบสิทธิ์ในฐานะแอป Chat ด้วยการอนุมัติของผู้ดูแลระบบแบบครั้งเดียว

  2. ระบุขอบเขตการให้สิทธิ์ที่อนุญาตให้แอปใน Chat สมัครรับข้อมูลเหตุการณ์ใน Chat ขอบเขตการให้สิทธิ์เหล่านี้จะเริ่มต้นด้วย chat.app เสมอ และ รวมถึงรายการต่อไปนี้

    • https://www.googleapis.com/auth/chat.app.memberships: ติดตามกิจกรรมของสมาชิกในพื้นที่ใน Chat
    • https://www.googleapis.com/auth/chat.app.messages.readonly: ติดตามกิจกรรมข้อความในพื้นที่ Chat
    • https://www.googleapis.com/auth/chat.app.spaces: ติดตามกิจกรรมในพื้นที่ Chat

สร้างคีย์ API

หากต้องการเรียกเมธอด API ของรุ่นตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ คุณต้องใช้เอกสารการค้นพบ API เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ที่ไม่ใช่แบบสาธารณะ หากต้องการตรวจสอบสิทธิ์คำขอ คุณต้องส่งคีย์ API

หากต้องการสร้างคีย์ API ให้เปิดโปรเจ็กต์ Google Cloud ของแอป แล้วทำดังนี้

  1. ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > ข้อมูลเข้าสู่ระบบ

    ไปที่ข้อมูลเข้าสู่ระบบ

  2. คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
  3. ระบบจะแสดงคีย์ API ใหม่
    • คลิกคัดลอก เพื่อคัดลอกคีย์ API สำหรับใช้ ในโค้ดของแอป คุณยังดูคีย์ API ได้ในส่วน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์ ด้วย
    • เราขอแนะนำให้จำกัดตำแหน่งและ API ที่ใช้คีย์ API ได้เพื่อป้องกันการใช้งานที่ไม่ได้รับอนุญาต ดูรายละเอียดเพิ่มเติมได้ที่ เพิ่มการจำกัด API

เขียนสคริปต์ที่เรียก Google Workspace Events API

ตัวอย่างโค้ดต่อไปนี้จะอัปเดตการสมัครใช้บริการ Google Workspace ของแอป Chat

Python 

  """Update subscription."""

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

  # Specify required scopes.
  SCOPES = [SCOPES]

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

  # 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 = {
      'ttl': {'seconds': 0},
  }
  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = (
      service.subscriptions()
      .patch(name=NAME, updateMask='ttl', body=BODY)
      .execute()
  )
  print(response)

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

  • SCOPES: ระบุขอบเขตการให้สิทธิ์ที่อนุญาตให้แอป ใน Chat ติดตามกิจกรรมใน Chat ขอบเขตการให้สิทธิ์เหล่านี้จะเริ่มต้นด้วย chat.app เสมอ และ รวมถึงรายการต่อไปนี้

    • https://www.googleapis.com/auth/chat.app.memberships: ติดตามกิจกรรมของสมาชิกในพื้นที่ใน Chat
    • https://www.googleapis.com/auth/chat.app.messages.readonly: ติดตามข้อความในพื้นที่ทำงานของ Chat และกิจกรรมรีแอ็กชัน
    • https://www.googleapis.com/auth/chat.app.spaces: ติดตามกิจกรรมในพื้นที่ Chat

  • API_KEY: คีย์ API ที่คุณสร้างขึ้นเพื่อสร้าง ปลายทางของบริการสำหรับ Google Workspace Events API

  • SUBSCRIPTION_ID: รหัสของการสมัครใช้บริการ หากต้องการรับรหัส คุณสามารถใช้สิ่งต่อไปนี้

    • ค่าของฟิลด์ uid
    • รหัสของชื่อทรัพยากรที่แสดงในฟิลด์ name เช่น หากชื่อทรัพยากรคือ subscriptions/subscription-123 ให้ใช้ subscription-123