หน้านี้อธิบายวิธีแสดงการสมัครใช้บริการ Google Workspace โดยใช้เมธอด
subscriptions.list()
เมื่อเรียกใช้เมธอดนี้ด้วยการตรวจสอบสิทธิ์ผู้ใช้ เมธอดจะแสดง รายการการสมัครใช้บริการที่ผู้ใช้ให้สิทธิ์ เมื่อใช้การตรวจสอบสิทธิ์แอป เมธอดจะแสดงรายการที่มีการสมัครใช้บริการสำหรับแอป
ข้อกำหนดเบื้องต้น
Apps Script
- การสมัครใช้บริการ Google Workspace หากต้องการสร้าง ให้ดูสร้างการสมัครใช้บริการ
- โปรเจ็กต์ Apps Script
- ใช้โปรเจ็กต์ Google Cloud แทนโปรเจ็กต์เริ่มต้นที่ Apps Script สร้างขึ้นโดยอัตโนมัติ
- สำหรับขอบเขตทั้งหมดที่คุณเพิ่มเพื่อกำหนดค่าหน้าจอขอความยินยอม OAuth คุณต้องเพิ่มขอบเขตลงในไฟล์
appsscript.jsonในโปรเจ็กต์ Apps Script ด้วย เช่น หากคุณระบุขอบเขตchat.messagesให้เพิ่มสิ่งต่อไปนี้ - เปิดใช้
Google Workspace Eventsบริการขั้นสูง
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages" ]
ต้องมีการตรวจสอบสิทธิ์และขอบเขตการให้สิทธิ์ที่เหมาะสมสำหรับเหตุการณ์แต่ละประเภทในการสมัครใช้บริการ
- สำหรับการตรวจสอบสิทธิ์ผู้ใช้ ต้องมี ขอบเขตที่รองรับประเภทเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ ดูวิธีระบุขอบเขตได้ที่ขอบเขตตามประเภทเหตุการณ์
- สำหรับการตรวจสอบสิทธิ์แอป ต้องใช้ขอบเขต
chat.bot(แอป Google Chat เท่านั้น)
Python
- Python 3.6 ขึ้นไป
- เครื่องมือจัดการแพ็กเกจ pip
- ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Python หากต้องการติดตั้งหรืออัปเดต ให้เรียกใช้คำสั่งต่อไปนี้
ในอินเทอร์เฟซบรรทัดคำสั่ง
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- การสมัครใช้บริการ Google Workspace หากต้องการสร้าง ให้ดูสร้างการสมัครใช้บริการ
ต้องมีการตรวจสอบสิทธิ์และขอบเขตการให้สิทธิ์ที่เหมาะสมสำหรับเหตุการณ์แต่ละประเภทในการสมัครใช้บริการ
- สำหรับการตรวจสอบสิทธิ์ผู้ใช้ ต้องมี ขอบเขตที่รองรับประเภทเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ ดูวิธีระบุขอบเขตได้ที่ขอบเขตตามประเภทเหตุการณ์
- สำหรับการตรวจสอบสิทธิ์แอป ต้องใช้ขอบเขต
chat.bot(แอป Google Chat เท่านั้น)
แสดงรายการการสมัครใช้บริการที่ผู้ใช้ให้สิทธิ์
หากต้องการแสดงการสมัครใช้บริการ คุณต้องกรองตามประเภทเหตุการณ์อย่างน้อย 1 ประเภท นอกจากนี้ คุณยัง
กรองคำค้นหาตามแหล่งข้อมูลเป้าหมายอย่างน้อย 1 รายการได้ด้วย ดูข้อมูลเกี่ยวกับตัวกรองการค้นหาที่รองรับได้ที่เอกสารประกอบของเมธอด list()
ตัวอย่างโค้ดต่อไปนี้จะแสดงอาร์เรย์ของออบเจ็กต์ Subscription
ที่กรองตามประเภทเหตุการณ์และทรัพยากรเป้าหมาย เมื่อได้รับการตรวจสอบสิทธิ์ในฐานะผู้ใช้ เมธอดจะแสดงเฉพาะรายการการติดตามที่ผู้ใช้ให้สิทธิ์แอปในการสร้าง
วิธีแสดงรายการการติดตามสำหรับประเภทเหตุการณ์และทรัพยากรเป้าหมายที่ระบุ
Apps Script
ในโปรเจ็กต์ Apps Script ให้สร้างไฟล์สคริปต์ใหม่ ชื่อ
listSubscriptionsแล้วเพิ่มโค้ดต่อไปนี้function listSubscriptions() { // Filter for event type (required). const eventType = 'EVENT_TYPE'; // Filter for target resource (optional). const targetResource = 'TARGET_RESOURCE'; const filter = `event_types:"${eventType}" AND target_resource="${targetResource}"` // Call the Workspace Events API using the advanced service. const response = WorkspaceEvents.Subscriptions.list({ filter }); console.log(response); }แทนที่ค่าต่อไปนี้
EVENT_TYPE: ประเภทเหตุการณ์ ที่จัดรูปแบบตามข้อกําหนดของ CloudEvents เช่น หากต้องการกรองการสมัครใช้บริการที่รับเหตุการณ์เกี่ยวกับการเป็นสมาชิกใหม่ในพื้นที่ Google Chat ให้ใช้google.workspace.chat.message.v1.createdTARGET_RESOURCE: ทรัพยากรเป้าหมาย ที่จัดรูปแบบเป็นชื่อทรัพยากรแบบเต็ม เช่น หากต้องการกรองตาม การติดตามสำหรับพื้นที่ใน Google Chat ให้ใช้//chat.googleapis.com/spaces/SPACE_IDโดยที่spaces/SPACE_IDแสดงถึงฟิลด์nameสำหรับทรัพยากรSpace
หากต้องการแสดงรายการการสมัครใช้บริการ ให้เรียกใช้ฟังก์ชัน
listSubscriptionsในโปรเจ็กต์ Apps Script
Python
สร้างไฟล์ชื่อ
list_subscriptions.pyในไดเรกทอรีการทำงาน แล้วเพิ่มโค้ดต่อไปนี้"""List subscriptions.""" from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Specify required scopes. SCOPES = ['SCOPE'] # 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, ) # Filter for event type (required). EVENT_TYPE = 'EVENT_TYPE' # Filter for target resource (optional). TARGET_RESOURCE = 'TARGET_RESOURCE' FILTER = f'event_types:"{EVENT_TYPE}" AND target_resource="{TARGET_RESOURCE}"' response = service.subscriptions().list(filter=FILTER).execute() print(response)แทนที่ค่าต่อไปนี้
SCOPE: ขอบเขต OAuth ที่รองรับเหตุการณ์อย่างน้อย 1 ประเภทจากการสมัครใช้บริการ เช่น หากการสมัครใช้บริการของคุณได้รับกิจกรรม พื้นที่ใน Chat ที่อัปเดตแล้วhttps://www.googleapis.com/auth/chat.spaces.readonlyEVENT_TYPE: ประเภทเหตุการณ์ ที่จัดรูปแบบตามข้อกําหนดของ CloudEvents เช่น หากต้องการกรองการสมัครใช้บริการที่รับเหตุการณ์เกี่ยวกับการเป็นสมาชิกใหม่ในพื้นที่ Google Chat ให้ใช้google.workspace.chat.message.v1.createdTARGET_RESOURCE: ทรัพยากรเป้าหมาย ที่จัดรูปแบบเป็นชื่อทรัพยากรแบบเต็ม เช่น หากต้องการกรองตาม การติดตามสำหรับพื้นที่ใน Google Chat ให้ใช้//chat.googleapis.com/spaces/SPACE_IDโดยที่spaces/SPACE_IDแสดงถึงฟิลด์nameสำหรับทรัพยากรSpace
ตรวจสอบว่าคุณได้จัดเก็บข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และตั้งชื่อไฟล์เป็น
credentials.jsonในไดเรกทอรีการทำงาน ตัวอย่างโค้ดใช้ไฟล์ JSON นี้เพื่อตรวจสอบสิทธิ์กับ Google Workspace และรับข้อมูลเข้าสู่ระบบของผู้ใช้ โปรดดูวิธีการที่หัวข้อสร้างข้อมูลเข้าสู่ระบบ รหัสไคลเอ็นต์ OAuthหากต้องการแสดงรายการการสมัครใช้บริการ ให้เรียกใช้คำสั่งต่อไปนี้ในเทอร์มินัล
python3 list_subscriptions.py
Google Workspace Events API จะแสดงอาร์เรย์แบบแบ่งหน้าของSubscription
ออบเจ็กต์
ที่ตรงกับตัวกรองสำหรับคำค้นหาของคุณ