คู่มือนี้อธิบายวิธีใช้เมธอด
update()
ในทรัพยากร Membership ของ Google Chat API เพื่อเปลี่ยนแอตทริบิวต์
เกี่ยวกับการเป็นสมาชิก เช่น การเปลี่ยนสมาชิกพื้นที่ทำงานเป็นผู้จัดการพื้นที่ทำงานหรือ
เจ้าของพื้นที่ทำงาน
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเรียกใช้เมธอด update()
เพื่ออัปเดตการเป็นสมาชิกของพื้นที่ใดก็ได้ในองค์กร Google Workspace
Membershipทรัพยากร
แสดงว่าผู้ใช้ที่เป็นมนุษย์หรือแอป Google Chat ได้รับเชิญให้เข้าร่วม
เป็นส่วนหนึ่งของ หรือไม่ได้อยู่ในพื้นที่ทำงาน
ข้อกำหนดเบื้องต้น
Node.js
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมของคุณ ดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Node.js Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.jsonในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
อัปเดตการเป็นสมาชิก
หากต้องการอัปเดตการเป็นสมาชิกพื้นที่ทำงาน ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์ ดังนี้
- เมื่อใช้การตรวจสอบสิทธิ์ของผู้ใช้ ให้
ระบุ
chat.membershipsขอบเขตการให้สิทธิ์ - เมื่อใช้การตรวจสอบสิทธิ์แอป ให้ระบุ
chat.app.membershipsขอบเขตการให้สิทธิ์ เมื่ออัปเดตการเป็นสมาชิกด้วยการตรวจสอบสิทธิ์แอป คุณจะอัปเดตการเป็นสมาชิกได้เฉพาะในพื้นที่ที่สร้างโดยแอป Chat เท่านั้น การตรวจสอบสิทธิ์แอปต้องได้รับ การอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
- เมื่อใช้การตรวจสอบสิทธิ์ของผู้ใช้ ให้
ระบุ
- เรียกใช้เมธอด
UpdateMembership() - ส่ง
membershipเป็นอินสแตนซ์ของMembershipพร้อมข้อมูลต่อไปนี้- ฟิลด์
nameตั้งค่าเป็นการเป็นสมาชิกที่จะอัปเดต ซึ่งรวมถึงรหัสพื้นที่ทำงาน และรหัสสมาชิก - ฟิลด์การเป็นสมาชิกที่จะอัปเดตตั้งค่าเป็นค่าใหม่
- ฟิลด์
- ส่ง
updateMaskเพื่อระบุลักษณะของการเป็นสมาชิกที่จะอัปเดต ซึ่งรวมถึงสิ่งต่อไปนี้role: บทบาทของผู้ใช้ภายในพื้นที่ใน Chat ซึ่งกำหนดการดำเนินการที่ได้รับอนุญาตในพื้นที่ โปรดดูคำอธิบายสิทธิ์โดยละเอียดที่MembershipRoleในเอกสารประกอบอ้างอิงของ Chat API ค่าที่เป็นไปได้มีดังนี้ROLE_MEMBER: สมาชิกของพื้นที่ทำงาน ใน UI ของ Chat บทบาทนี้เรียกว่าสมาชิกROLE_ASSISTANT_MANAGER: ผู้จัดการพื้นที่ทำงาน ใน UI ของ Chat บทบาทนี้เรียกว่าผู้จัดการROLE_MANAGER: เจ้าของพื้นที่ทำงาน ใน UI แชท บทบาทนี้ เรียกว่าเจ้าของ
เปลี่ยนสมาชิกเป็นเจ้าของ (การตรวจสอบสิทธิ์ผู้ใช้)
ตัวอย่างต่อไปนี้เรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์ผู้ใช้
เพื่อทำให้สมาชิกพื้นที่ทำงานปกติเป็นเจ้าของพื้นที่ทำงานโดยการระบุ role เป็น
ROLE_MANAGER
Node.js
หากต้องการเรียกใช้ตัวอย่าง ให้แทนที่ค่าต่อไปนี้
SPACE_NAME: รหัสจากnameของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอดListSpaces()หรือจาก URL ของพื้นที่ทำงานMEMBER_NAME: รหัสจากการเป็นสมาชิกของnameคุณขอรับรหัสได้โดยการเรียกใช้เมธอดListMemberships()หรือจากเนื้อหาการตอบสนองที่ส่งกลับมาหลังจากสร้างการเป็นสมาชิก แบบไม่พร้อมกันด้วย Chat APIROLE_NAME: บทบาทที่อัปเดตROLE_MANAGERคุณตั้งค่านี้เป็นค่าใดก็ได้ของMembershipRoleเช่น หากต้องการเปลี่ยนสมาชิกทั่วไปเป็นผู้จัดการพื้นที่ทำงาน ให้เปลี่ยนROLE_NAMEเป็นROLE_ASSISTANT_MANAGERแทน
Google Chat API จะอัปเดตการเป็นสมาชิกที่ระบุให้เป็นเจ้าของพื้นที่ทำงานและแสดงผลอินสแตนซ์ของ Membership
เปลี่ยนเจ้าของเป็นสมาชิก (การตรวจสอบสิทธิ์ผู้ใช้)
ตัวอย่างต่อไปนี้เรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์ผู้ใช้
เพื่อให้เจ้าของพื้นที่ทำงานเป็นสมาชิกพื้นที่ทำงานทั่วไปโดยระบุ role เป็น
ROLE_MEMBER
Node.js
หากต้องการเรียกใช้ตัวอย่าง ให้แทนที่ค่าต่อไปนี้
SPACE_NAME: รหัสจากnameของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอดListSpaces()หรือจาก URL ของพื้นที่ทำงานMEMBER_NAME: รหัสจากการเป็นสมาชิกของnameคุณขอรับรหัสได้โดยการเรียกใช้เมธอดListMemberships()หรือจากเนื้อหาการตอบสนองที่ส่งกลับมาหลังจากสร้างการเป็นสมาชิก แบบไม่พร้อมกันด้วย Chat APIROLE_NAME: บทบาทที่อัปเดตROLE_MEMBER
Google Chat API จะอัปเดตการเป็นสมาชิกที่ระบุให้เป็นเจ้าของพื้นที่ทำงานและแสดงผลอินสแตนซ์ของ Membership
เปลี่ยนสมาชิกเป็นเจ้าของ (การตรวจสอบสิทธิ์แอป Chat)
การตรวจสอบสิทธิ์แอปต้องได้รับ การอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
เขียนสคริปต์ที่เรียกใช้ Chat API
ตัวอย่างต่อไปนี้เรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์แอป
เพื่อเปลี่ยนสมาชิกพื้นที่ทำงานปกติให้เป็นเจ้าของพื้นที่ทำงานโดยระบุ role เป็น
ROLE_MANAGER ใน body ที่ระบุแอตทริบิวต์การเป็นสมาชิกที่อัปเดตแล้ว
Python
- สร้างไฟล์ชื่อ
chat_membership_update_to_owner_app.pyในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_membership_update_to_owner_app.pyfrom google.oauth2 import service_account from apiclient.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.app.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then updates a specified space member to change it from a regular member to a space owner. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # 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().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', # Replace ROLE with a MembershipRole value. # Obtain the MembershipRole values from the membership of Chat API. body={'role': 'ROLE'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()ในโค้ด ให้แทนที่ค่าต่อไปนี้
SPACE: ชื่อพื้นที่ ซึ่งคุณรับได้จากเมธอดspaces.listใน Chat API หรือจาก URL ของพื้นที่MEMBERSHIP: ชื่อการเป็นสมาชิก ซึ่งคุณรับได้จากspaces.members.listเมธอด ใน Chat APIROLE: บทบาทที่อัปเดตROLE_MANAGERคุณตั้งค่านี้เป็นค่าใดก็ได้ของMembershipRoleเช่น หากต้องการเปลี่ยนสมาชิกทั่วไปเป็นผู้จัดการพื้นที่ทำงาน ให้เปลี่ยนROLEเป็นROLE_ASSISTANT_MANAGERแทน
ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างโดยทำดังนี้
python3 chat_membership_update_to_owner_app.py
เปลี่ยนเจ้าของเป็นสมาชิก (การตรวจสอบสิทธิ์แอป Chat)
การตรวจสอบสิทธิ์แอปต้องได้รับ การอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
เขียนสคริปต์ที่เรียกใช้ Chat API
ตัวอย่างต่อไปนี้เรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์แอป
เพื่อทำให้เจ้าของพื้นที่ทำงานเป็นสมาชิกพื้นที่ทำงานปกติโดยระบุ role เป็น
ROLE_MEMBER ใน body ที่ระบุแอตทริบิวต์การเป็นสมาชิกที่อัปเดตแล้ว
Python
- สร้างไฟล์ชื่อ
chat_membership_update_to_member_app.pyในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_membership_update_to_member_app.pyfrom google.oauth2 import service_account from apiclient.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.app.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space owner to change it to a regular member. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # 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().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MEMBER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()ในโค้ด ให้แทนที่ค่าต่อไปนี้
SPACE: ชื่อพื้นที่ ซึ่งคุณรับได้จากเมธอดspaces.listใน Chat API หรือจาก URL ของพื้นที่MEMBERSHIP: ชื่อการเป็นสมาชิก ซึ่งคุณรับได้จากspaces.members.listเมธอด ใน Chat API
ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างโดยทำดังนี้
python3 chat_membership_update_to_member_app.py
อัปเดตการเป็นสมาชิกในฐานะผู้ดูแลระบบ Google Workspace
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเรียกใช้เมธอด update()
เพื่ออัปเดตการเป็นสมาชิกของพื้นที่ทำงานในองค์กร Google Workspace
ได้
หากต้องการเรียกใช้เมธอดนี้ในฐานะผู้ดูแลระบบ Google Workspace ให้ทำดังนี้
- เรียกใช้เมธอดโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ และระบุขอบเขตการให้สิทธิ์ ที่รองรับการเรียกใช้เมธอดโดยใช้สิทธิ์ของผู้ดูแลระบบ
- ในคำขอ ให้ระบุพารามิเตอร์การค้นหา
useAdminAccessเป็นtrue
ดูข้อมูลเพิ่มเติมและตัวอย่างได้ที่ จัดการพื้นที่ใน Google Chat ในฐานะผู้ดูแลระบบ Google Workspace
หัวข้อที่เกี่ยวข้อง
- เชิญหรือเพิ่มผู้ใช้หรือแอป Google Chat ลงในพื้นที่ทำงาน
- ดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Chat
- แสดงรายชื่อสมาชิกในพื้นที่ทำงาน
- นำผู้ใช้หรือแอป Chat ออกจากพื้นที่ทำงาน