คำแนะนำนี้จะอธิบายวิธีใช้เมธอด list
ในทรัพยากร membership
ของ Google Chat API เพื่อแสดงรายชื่อผู้ใช้และแอป Chat ในพื้นที่ทำงานเป็นรายการการเป็นสมาชิกที่มีการแบ่งหน้าและกรองได้ในพื้นที่ทำงาน การเป็นสมาชิกในรายการที่มีการตรวจสอบสิทธิ์แอปจะแสดงการเป็นสมาชิกในพื้นที่ทำงานที่แอป Chat เข้าถึงได้ แต่ไม่รวมการเป็นสมาชิกของแอป Chat ซึ่งรวมถึงการเป็นสมาชิกของตัวเองด้วย การเป็นสมาชิกในรายการที่มีการตรวจสอบสิทธิ์ของผู้ใช้จะแสดงการเป็นสมาชิกในพื้นที่ทำงานที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีสิทธิ์เข้าถึง
แหล่งข้อมูลของ Membership
แสดงให้เห็นว่าผู้ใช้ที่เป็นมนุษย์หรือแอป Google Chat ได้รับเชิญหรือไม่เข้าร่วม บ้าง หรือไม่ได้อยู่ในพื้นที่ทำงาน
ข้อกำหนดเบื้องต้น
Python
- Python 3.6 ขึ้นไป
- เครื่องมือการจัดการแพ็กเกจ pip
ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Python หากต้องการติดตั้งหรืออัปเดตคีย์ดังกล่าว ให้เรียกใช้คำสั่งต่อไปนี้ในอินเทอร์เฟซบรรทัดคำสั่ง
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- โปรเจ็กต์ Google Cloud ที่เปิดใช้และกำหนดค่า Google Chat API โปรดดูขั้นตอนที่หัวข้อสร้างแอป Google Chat
กำหนดค่าการให้สิทธิ์สำหรับแอป Chat แล้ว การเป็นสมาชิกของข้อมูลรองรับการตรวจสอบสิทธิ์ทั้ง 2 วิธีต่อไปนี้
- การตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์
chat.memberships.readonly
หรือchat.memberships
- การตรวจสอบสิทธิ์แอป
ด้วยขอบเขตการให้สิทธิ์
chat.bot
- การตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์
รายชื่อผู้ใช้และแอป Chat ในพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ผู้ใช้
หากต้องการแสดงรายการผู้ใช้และแอปใน Chat ในพื้นที่ทำงานที่ผู้ใช้ซึ่งผ่านการตรวจสอบสิทธิ์มีสิทธิ์เข้าถึง ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ให้ระบุขอบเขตการให้สิทธิ์
chat.memberships.readonly
หรือchat.memberships
- เรียกเมธอด
list
ในทรัพยากรmembership
ตัวอย่างต่อไปนี้แสดงสมาชิกในพื้นที่ทำงานของมนุษย์ (ไม่ใช่ผู้จัดการพื้นที่ทำงาน) ที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์เนื่องจากตั้งค่า filter
เป็น ROLE_Member
Python
- สร้างไฟล์ชื่อ
chat_member_list_user.py
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_member_list_user.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists human space members (but not space managers) in a specified space. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().list( # The space for which to list memberships. parent = 'spaces/SPACE', # An optional filter that returns only human space members. filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"' ).execute() # Prints the list of memberships. print(result) if __name__ == '__main__': main()
ในโค้ด ให้แทนที่
SPACE
ด้วยชื่อพื้นที่ทำงานซึ่งคุณดูได้จากเมธอดspaces.list
ใน Chat API หรือจาก URL ของพื้นที่ทำงานสร้างและเรียกใช้ตัวอย่างในไดเรกทอรีการทำงาน
python3 chat_member_list_user.py
Google Chat API จะแสดงผลรายชื่อสมาชิกพื้นที่ทำงานมนุษย์ (ไม่รวมผู้จัดการพื้นที่ทำงาน) และสมาชิกของแอปจากพื้นที่ทำงานที่ระบุ
แสดงรายการผู้ใช้และแอปใน Chat ในพื้นที่ทำงานด้วยการตรวจสอบสิทธิ์แอป
หากต้องการระบุผู้ใช้และแอปใน Chat ในพื้นที่ทำงานที่แอปที่ผ่านการตรวจสอบสิทธิ์มีสิทธิ์เข้าถึงแล้ว ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- เมื่อใช้การตรวจสอบสิทธิ์แอป ให้ระบุขอบเขตการให้สิทธิ์
chat.bot
- เรียกเมธอด
list
ในทรัพยากรmember
ตัวอย่างต่อไปนี้แสดงสมาชิกในพื้นที่ทำงานของมนุษย์ (ไม่ใช่ผู้จัดการพื้นที่ทำงาน) ที่แอป Chat มองเห็นได้
Python
- สร้างไฟล์ชื่อ
chat_member_list_app.py
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_member_list_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Use the service endpoint to call Chat API. result = chat.spaces().members().list( # The space for which to list memberships. parent = 'spaces/SPACE', # An optional filter that returns only human space members. filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"' ).execute() print(result)
ในโค้ด ให้แทนที่
SPACE
ด้วยชื่อพื้นที่ทำงานซึ่งคุณดูได้จากเมธอดspaces.list
ใน Chat API หรือจาก URL ของพื้นที่ทำงานสร้างและเรียกใช้ตัวอย่างในไดเรกทอรีการทำงาน
python3 chat_member_list_app.py
Google Chat API จะแสดงผลรายชื่อสมาชิกพื้นที่ทำงานมนุษย์ (ยกเว้นผู้จัดการพื้นที่ทำงาน) จากพื้นที่ทำงานที่ระบุ
ปรับแต่งการใส่เลขหน้าหรือกรองรายการ
หากต้องการแสดงการเป็นสมาชิก ให้ส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อปรับแต่งการใส่เลขหน้าหรือกรองการเป็นสมาชิกที่แสดงอยู่
pageSize
: จำนวนการเป็นสมาชิกสูงสุดที่จะคืน บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลเว้นวรรคไม่เกิน 100 รายการ ค่าสูงสุดคือ 1,000 และค่าที่มากกว่า 1,000 จะเปลี่ยนเป็น 1,000 โดยอัตโนมัติpageToken
: โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้พื้นที่รายการก่อนหน้า ระบุโทเค็นนี้เพื่อเรียกหน้าถัดไป เวลาใส่เลขหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นของหน้าเว็บ การส่งต่อค่าที่ต่างกันอาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิดfilter
: ตัวกรองการค้นหา ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ โปรดดูรายละเอียดการค้นหาที่รองรับในเมธอดspaces.members.list
หัวข้อที่เกี่ยวข้อง
- ดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Chat
- เชิญหรือเพิ่มผู้ใช้หรือแอป Chat ไปยังพื้นที่ทำงาน
- อัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ของ Google Chat
- นำผู้ใช้หรือแอป Chat ออกจากพื้นที่ทำงาน