คำแนะนำนี้จะอธิบายวิธีใช้เมธอด list
ในทรัพยากร membership
ของ Google Chat API เพื่อแสดงสมาชิกในพื้นที่ทำงานเป็นรายการการเป็นสมาชิกที่มีการแบ่งหน้าและกรองได้ในพื้นที่ทำงาน ข้อมูลการเป็นสมาชิกที่มีการตรวจสอบสิทธิ์แอปจะแสดงการเป็นสมาชิกในพื้นที่ทำงานที่แอป 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
- การตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์
แสดงรายการสมาชิกในพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ผู้ใช้
หากต้องการแสดงรายการผู้ใช้, Google Groups และแอป Chat ในพื้นที่ทำงานที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีสิทธิ์เข้าถึง ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ให้ระบุขอบเขตการให้สิทธิ์
chat.memberships.readonly
หรือchat.memberships
- เรียกใช้เมธอด
list
ในทรัพยากรmembership
- หากต้องการแสดงรายการ Google Groups ให้ตั้งพารามิเตอร์การค้นหา
showGroups
เป็นtrue
ตัวอย่างต่อไปนี้แสดงรายชื่อสมาชิกของ Google Group, บุคคล และสมาชิกแอปที่แสดงต่อผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์แล้ว
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 Google Group, human, and app members 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', # Set this parameter to list Google Groups. showGroups = 'true' ).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 จะแสดงรายการสมาชิก Google Group, บุคคล และสมาชิกของแอปจากพื้นที่ทำงานที่ระบุ
แสดงรายการสมาชิกในพื้นที่ทำงานด้วยการตรวจสอบสิทธิ์แอป
หากต้องการแสดงรายการผู้ใช้และแอปใน Chat ในพื้นที่ทำงานที่แอปที่ตรวจสอบสิทธิ์แล้วมีสิทธิ์เข้าถึง ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- เมื่อใช้การตรวจสอบสิทธิ์แอป ให้ระบุขอบเขตการให้สิทธิ์
chat.bot
- เรียกใช้เมธอด
list
ในทรัพยากรmember
- หากต้องการแสดงรายการ Google Groups ให้ตั้งพารามิเตอร์การค้นหา
showGroups
เป็นtrue
ตัวอย่างต่อไปนี้แสดงรายชื่อสมาชิกในพื้นที่ทำงานของผู้ใช้ (ไม่ใช่ผู้จัดการพื้นที่ทำงาน) ที่แอป 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 ออกจากพื้นที่ทำงาน