คู่มือนี้จะอธิบายวิธีใช้เมธอด 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 ของคุณ
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Cloud สำหรับ Node.js
- สร้างข้อมูลเข้าสู่ระบบโดยอิงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ใน Google Chat API
คำขอ:
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไดเรกทอรีในเครื่อง - วิธีตรวจสอบสิทธิ์ว่าเป็นแอป Chat
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์เป็นผู้ใช้หรือ แอป Chat
อัปเดตการเป็นสมาชิก
หากต้องการอัปเดตการเป็นสมาชิกของพื้นที่ทำงาน ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์:
- เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้
ระบุขอบเขตการให้สิทธิ์
chat.memberships
- เมื่อใช้การตรวจสอบสิทธิ์ของแอป (มีให้ใช้งานในตัวอย่างสำหรับนักพัฒนาแอป) ให้ระบุขอบเขตการให้สิทธิ์
chat.app.memberships
เมื่ออัปเดตการเป็นสมาชิกด้วยการรับรองแอป คุณจะอัปเดตการเป็นสมาชิกได้ในเฉพาะพื้นที่ทำงานที่สร้างโดยแอป Chat การตรวจสอบสิทธิ์แอปต้องการอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
- เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้
ระบุขอบเขตการให้สิทธิ์
- เรียกใช้
UpdateMembership()
- ส่ง
membership
เป็นอินสแตนซ์ของMembership
พร้อมข้อมูลต่อไปนี้- ช่อง
name
ที่กำหนดให้เป็นสมาชิกที่จะอัปเดต ซึ่งมีรหัสพื้นที่ทำงาน และรหัสสมาชิก - ตั้งค่าช่องการเป็นสมาชิกที่จะอัปเดตเป็นค่าใหม่
- ช่อง
- ส่ง
updateMask
เพื่อระบุแง่มุมของการเป็นสมาชิกที่จะอัปเดต ซึ่งรวมถึงข้อมูลต่อไปนี้role
: บทบาทของผู้ใช้ในพื้นที่ใน Chat ซึ่งกำหนดการดำเนินการที่ผู้ใช้ทำได้ในพื้นที่ทำงาน ค่าที่เป็นไปได้มีดังนี้ROLE_MEMBER
: สมาชิกของพื้นที่ทำงาน ผู้ใช้มีสิทธิ์พื้นฐาน เช่น ส่งข้อความไปยังพื้นที่ทำงาน ทุกคนมีบทบาทนี้ในการสนทนาแบบ 1:1 และการสนทนากลุ่มที่ไม่มีชื่อROLE_MANAGER
: ผู้จัดการพื้นที่ทำงาน ผู้ใช้จะมีสิทธิ์พื้นฐานทั้งหมด รวมถึงสิทธิ์ระดับผู้ดูแลระบบที่ช่วยในการจัดการพื้นที่ทำงาน เช่น การเพิ่มหรือนำสมาชิกออก ใช้ได้เฉพาะในพื้นที่ทำงานที่spaceType
เป็นSPACE
(พื้นที่ทำงานที่มีชื่อ)
ตั้งให้สมาชิกพื้นที่ทำงานทั่วไปเป็นผู้จัดการพื้นที่ทำงานในฐานะผู้ใช้
ตัวอย่างต่อไปนี้เรียกใช้ Chat API โดยใช้
การตรวจสอบสิทธิ์ผู้ใช้
เพื่อกำหนดให้สมาชิกพื้นที่ทำงานปกติเป็นผู้จัดการพื้นที่ทำงานโดยระบุ role
เป็น
ROLE_MANAGER
:
Node.js
หากต้องการเรียกใช้ตัวอย่าง ให้แทนที่รายการต่อไปนี้
SPACE_NAME
: รหัสจากพื้นที่ทำงานname
คุณรับรหัสได้โดยเรียกใช้เมธอดListSpaces()
หรือจาก URL ของพื้นที่ทำงานMEMBER_NAME
: รหัสจากname
ของโปรแกรมการเป็นสมาชิก คุณสามารถรับรหัสโดยโทรไปที่ListMemberships()
หรือจากเนื้อหาการตอบกลับที่แสดงหลังจากสร้างการเป็นสมาชิก แบบไม่พร้อมกันกับ Chat APIROLE_NAME
: บทบาทROLE_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
การตรวจสอบสิทธิ์แอปต้องใช้ครั้งเดียว การอนุมัติจากผู้ดูแลระบบ
สร้างคีย์ API
หากต้องการเรียกใช้เมธอด Developer Preview API คุณต้องใช้เอกสารการค้นพบ API เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ที่ไม่ได้เผยแพร่แบบสาธารณะ คุณต้องส่งคีย์ API เพื่อตรวจสอบสิทธิ์คําขอ
หากต้องการสร้างคีย์ API ให้เปิดโปรเจ็กต์ Google Cloud ของแอปแล้วทำดังนี้
- ในคอนโซล Google Cloud ให้ไปที่เมนู > API และ บริการ > ข้อมูลเข้าสู่ระบบ
- คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
- คีย์ API ใหม่จะปรากฏขึ้น
- คลิกคัดลอก เพื่อคัดลอกคีย์ API ไปใช้ในโค้ดของแอป คีย์ API ยังทำหน้าที่เป็น ที่พบใน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์
- คลิกจำกัดคีย์เพื่ออัปเดตการตั้งค่าขั้นสูงและจำกัดการใช้งาน ของคีย์ API ดูรายละเอียดเพิ่มเติมได้ที่การใช้ข้อจำกัดของคีย์ API
เขียนสคริปต์ที่เรียกใช้ Chat API
ตัวอย่างต่อไปนี้เรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์ของแอปเพื่อทำให้สมาชิกพื้นที่ทำงานทั่วไปเป็นผู้จัดการพื้นที่ทำงานโดยระบุ role
เป็น ROLE_MANAGER
ใน body
ที่ระบุแอตทริบิวต์การเป็นสมาชิกที่อัปเดตแล้ว
Python
- สร้างไฟล์ชื่อ
chat_membership_update_to_manager_app.py
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_membership_update_to_manager_app.py
from 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 manager. ''' # 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # 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_MANAGER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
ในโค้ด ให้แทนที่ข้อมูลต่อไปนี้
API_KEY
: คีย์ API ที่คุณสร้างเพื่อสร้างอุปกรณ์ปลายทางบริการสำหรับ Chat APISPACE
: ชื่อพื้นที่ทำงาน ที่คุณจะได้รับจากspaces.list
วิธี ใน Chat API หรือจาก URL ของพื้นที่ทำงานMEMBERSHIP
: ชื่อการเป็นสมาชิก ที่คุณจะได้รับจากspaces.members.list
วิธี ใน Chat API
ในไดเรกทอรีทํางาน ให้สร้างและเรียกใช้ตัวอย่าง ดังนี้
python3 chat_membership_update_to_manager_app.py
ตั้งค่าผู้จัดการพื้นที่ทำงานเป็นสมาชิกทั่วไปในแอป Chat
การตรวจสอบสิทธิ์แอปต้องการอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
สร้างคีย์ API
หากต้องการเรียกใช้เมธอด Developer Preview API คุณต้องใช้เอกสารการค้นพบ API เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ที่ไม่ได้เผยแพร่แบบสาธารณะ คุณต้องส่งคีย์ API เพื่อตรวจสอบสิทธิ์คําขอ
หากต้องการสร้างคีย์ API ให้เปิดโปรเจ็กต์ Google Cloud ของแอปแล้วทำดังนี้
- ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > ข้อมูลเข้าสู่ระบบ
- คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
- คีย์ API ใหม่จะปรากฏขึ้น
- คลิกคัดลอก เพื่อคัดลอกคีย์ API ไปใช้ในโค้ดของแอป คีย์ API ยังทำหน้าที่เป็น ที่พบใน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์
- คลิกจำกัดคีย์เพื่ออัปเดตการตั้งค่าขั้นสูงและจำกัดการใช้งาน ของคีย์ API ดูรายละเอียดเพิ่มเติมได้ที่การใช้ข้อจำกัดของคีย์ API
เขียนสคริปต์ที่เรียกใช้ Chat API
ตัวอย่างต่อไปนี้เรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์ของแอปเพื่อทําให้ผู้จัดการพื้นที่ทํางานเป็นสมาชิกพื้นที่ทำงานปกติโดยระบุ role
เป็น ROLE_MEMBER
ใน body
ที่ระบุแอตทริบิวต์การเป็นสมาชิกที่อัปเดตแล้ว
Python
- สร้างไฟล์ชื่อ
chat_membership_update_to_member_app.py
ในไดเรกทอรีทํางาน ใส่รหัสต่อไปนี้ใน
chat_membership_update_to_member_app.py
from 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 member to change it from a regular member to a space manager. ''' # 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # 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()
ในโค้ด ให้แทนที่
API_KEY
: คีย์ API ที่คุณสร้างเพื่อสร้างอุปกรณ์ปลายทางบริการสำหรับ Chat APISPACE
: ชื่อพื้นที่ทำงาน ซึ่งคุณรับได้จากเมธอด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 ออกจากพื้นที่ทำงาน