คู่มือนี้จะอธิบายวิธีใช้วิธี create()
ในทรัพยากร Membership
ของ Google Chat API เพื่อเชิญหรือเพิ่มผู้ใช้ กลุ่ม Google หรือแอป Chat ไปยังพื้นที่ทำงาน หรือที่เรียกว่าการสร้างการเป็นสมาชิก เมื่อสร้างการเป็นสมาชิก หากสมาชิกที่ระบุปิดนโยบายการยอมรับโดยอัตโนมัติไว้ ระบบจะส่งคำเชิญให้สมาชิกดังกล่าว และสมาชิกจะต้องยอมรับคำเชิญให้เข้าร่วมพื้นที่ทำงานก่อนจึงจะเข้าร่วมได้ หรือการสร้างการเป็นสมาชิกจะเพิ่มสมาชิกไปยังพื้นที่ทำงานที่ระบุโดยตรง
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเพิ่มผู้ใช้, แอป Google Groups หรือ Chat ไปยังพื้นที่ทำงานใดก็ได้ในองค์กร Google Workspace
Membership
ทรัพยากรแสดงว่าผู้ใช้หรือแอป Google Chat ได้รับเชิญให้เข้าร่วม เป็นส่วนหนึ่งของ หรือไม่ได้อยู่ในพื้นที่ทำงาน
ข้อกำหนดเบื้องต้น
Node.js
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง 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
Python
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Cloud สำหรับ Python
- สร้างข้อมูลเข้าสู่ระบบตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ที่มีชื่อว่า
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
Java
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Cloud สำหรับ Java
- สร้างข้อมูลเข้าสู่ระบบตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ที่มีชื่อว่า
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
Apps Script
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- สร้างโปรเจ็กต์ Apps Script แบบสแตนด์อโลน และเปิดบริการแชทขั้นสูง
- ในคู่มือนี้ คุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้หรือแอป หากต้องการตรวจสอบสิทธิ์เป็นแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ ดูขั้นตอนได้ที่หัวข้อตรวจสอบสิทธิ์และให้สิทธิ์ในฐานะแอป Google Chat
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
เชิญหรือเพิ่มผู้ใช้ไปยังพื้นที่ทำงานในฐานะผู้ใช้
หากต้องการเชิญหรือเพิ่มผู้ใช้ไปยังพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ผู้ใช้ ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุ
chat.memberships
ขอบเขตการให้สิทธิ์ - เรียกใช้เมธอด
CreateMembership()
- ส่ง
parent
เป็นชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก - ส่ง
membership
เป็นอินสแตนซ์ของMembership
โดยตั้งค่าช่องmember
ดังนี้- ช่อง
type
ตั้งค่าเป็นHUMAN
- ช่อง
name
ตั้งค่าเป็นusers/{user}
โดยที่{user}
คือบุคคลที่คุณต้องการเพิ่มในพื้นที่ทำงาน หากต้องการระบุผู้ใช้ Chat ให้แทนที่{user}
ด้วยรายการต่อไปนี้- รหัสสำหรับบุคคลใน People API เช่น หาก People API
person
resourceName
คือpeople/123456789
ให้ใช้ค่าusers/123456789
- รหัสสำหรับผู้ใช้ใน Directory API
- อีเมลของผู้ใช้ เช่น
users/222larabrown@gmail.com
หรือusers/larabrown@cymbalgroup.com
หากผู้ใช้ใช้บัญชี Google หรืออยู่ในองค์กร Google Workspace อื่น คุณต้องใช้อีเมลของผู้ใช้
- รหัสสำหรับบุคคลใน People API เช่น หาก People API
person
- ช่อง
ตัวอย่างต่อไปนี้จะเพิ่มผู้ใช้ไปยังพื้นที่ทำงานด้วยการตรวจสอบสิทธิ์ผู้ใช้
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่าง ให้แทนที่ข้อมูลต่อไปนี้
SPACE_NAME
: รหัสจากname
ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอดListSpaces()
หรือจาก URL ของพื้นที่ทำงานUSER_NAME
: รหัสผู้ใช้
Chat API จะแสดงผลอินสแตนซ์ของ Membership
ที่แสดงรายละเอียดการเป็นสมาชิกของผู้ใช้ที่สร้างไว้
เชิญหรือเพิ่ม Google Group ในพื้นที่ทำงาน
หากต้องการเชิญหรือเพิ่ม Google Group ไปยังพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ผู้ใช้ (การตรวจสอบสิทธิ์ของแอปไม่รองรับการเชิญหรือเพิ่ม Google Group ไปยังพื้นที่ทำงาน) ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุ
chat.memberships
ขอบเขตการให้สิทธิ์ - เรียกใช้เมธอด
CreateMembership()
- ส่ง
parent
เป็นชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก - ส่ง
membership
เป็นอินสแตนซ์ของMembership
โดยตั้งค่าช่องname
ของgroupMember
เป็นgroups/{group}
โดยที่{group}
คือรหัสกลุ่มที่คุณต้องการสร้างการเป็นสมาชิก คุณสามารถเรียกข้อมูลรหัสของกลุ่มได้โดยใช้ Cloud Identity API
คุณจะเพิ่ม Google Groups ลงในแชทกลุ่มหรือข้อความส่วนตัวไม่ได้ แต่จะเพิ่มได้เฉพาะในพื้นที่ทำงานที่มีชื่อเท่านั้น
ตัวอย่างต่อไปนี้จะเพิ่มกลุ่มในพื้นที่ทำงานที่มีชื่อด้วยการตรวจสอบสิทธิ์ของผู้ใช้
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่าง ให้แทนที่ข้อมูลต่อไปนี้
SPACE_NAME
: รหัสจากname
ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอดListSpaces()
หรือจาก URL ของพื้นที่ทำงานGROUP_NAME
: รหัสกลุ่ม
Chat API จะแสดงผลอินสแตนซ์ของ Membership
ที่แสดงรายละเอียดการเป็นสมาชิกของผู้ใช้ที่สร้างไว้
เพิ่มแอป Chat ไปยังพื้นที่ทำงาน
แอป Chat ไม่สามารถเพิ่มแอปอื่นเป็นสมาชิกของพื้นที่ทำงานได้ หากต้องการเพิ่มแอป Chat ไปยังพื้นที่ทำงานหรือข้อความส่วนตัวระหว่างผู้ใช้ 2 คน ให้ส่งข้อมูลต่อไปนี้ในคำขอด้วยการตรวจสอบสิทธิ์ผู้ใช้ (การตรวจสอบสิทธิ์แอปไม่รองรับการเชิญหรือเพิ่มแอป Chat ไปยังพื้นที่ทำงาน)
- ระบุ
chat.memberships.app
ขอบเขตการให้สิทธิ์ - เรียกใช้เมธอด
CreateMembership()
- ส่ง
parent
เป็นชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก - ส่ง
membership
เป็นอินสแตนซ์ของMembership
โดยตั้งค่าช่องmember
ดังนี้- ช่อง
type
ตั้งค่าเป็นBOT
- ช่อง
name
ตั้งค่าเป็นusers/app
ซึ่งเป็นชื่อแทนที่แสดงถึงแอปที่เรียกใช้ Chat API
- ช่อง
ตัวอย่างต่อไปนี้จะเพิ่มแอป Chat ไปยังพื้นที่ทำงาน
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่าง ให้แทนที่ SPACE_NAME
ด้วยรหัสจากname
ของพื้นที่ทำงาน
คุณรับรหัสได้โดยเรียกใช้เมธอด ListSpaces()
หรือจาก URL ของพื้นที่ทำงาน
Chat API จะแสดงผลอินสแตนซ์ของ Membership
ที่แสดงรายละเอียดการเป็นสมาชิกของผู้ใช้ที่สร้างไว้
เชิญหรือเพิ่มผู้ใช้ไปยังพื้นที่ทำงานในฐานะแอป Chat
การตรวจสอบสิทธิ์แอปต้องการอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
หากต้องการเชิญหรือเพิ่มผู้ใช้ไปยังพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ของแอป ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุ
chat.app.memberships
ขอบเขตการให้สิทธิ์ - เรียกใช้เมธอด
create
ในแหล่งข้อมูลmembership
- ตั้งค่า
parent
เป็นชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก - ตั้งค่า
member
เป็นusers/{user}
โดยที่{user}
คือบุคคลที่คุณต้องการสร้างการเป็นสมาชิกให้ และมีลักษณะดังนี้- รหัสสำหรับบุคคลใน People API เช่น หาก People API
person
resourceName
คือpeople/123456789
ให้ตั้งค่าmembership.member.name
เป็นusers/123456789
- รหัสสำหรับผู้ใช้ใน Directory API
- อีเมลของผู้ใช้ เช่น
users/222larabrown@gmail.com
หรือusers/larabrown@cymbalgroup.com
หากผู้ใช้ใช้บัญชี Google หรืออยู่ในองค์กร Google Workspace อื่น คุณต้องใช้อีเมลของผู้ใช้
- รหัสสำหรับบุคคลใน People API เช่น หาก People API
person
สร้างคีย์ API
หากต้องการเรียกใช้เมธอด API ของเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ คุณต้องใช้เอกสารการค้นพบ API เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์แบบไม่สาธารณะ คุณต้องส่งคีย์ API เพื่อตรวจสอบสิทธิ์คําขอ
หากต้องการสร้างคีย์ API ให้เปิดโปรเจ็กต์ Google Cloud ของแอปแล้วทําดังนี้
- ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > ข้อมูลเข้าสู่ระบบ
- คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
- คีย์ API ใหม่จะปรากฏขึ้น
- คลิกคัดลอก เพื่อคัดลอกคีย์ API ไปใช้ในโค้ดของแอป หรือจะดูคีย์ API ในส่วน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์ก็ได้
- คลิกจํากัดคีย์เพื่ออัปเดตการตั้งค่าขั้นสูงและจํากัดการใช้คีย์ API ดูรายละเอียดเพิ่มเติมได้ที่การใช้ข้อจำกัดของคีย์ API
เขียนสคริปต์ที่เรียกใช้ Chat API
ตัวอย่างต่อไปนี้จะเพิ่มผู้ใช้ไปยังพื้นที่ทำงานด้วยการตรวจสอบสิทธิ์ของแอป
Python
- ในไดเรกทอรีทํางาน ให้สร้างไฟล์ชื่อ
chat_membership_app_create.py
ใส่รหัสต่อไปนี้ใน
chat_membership_app_create.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 adds a user to a Chat space by creating a membership. ''' # 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().create( # The space in which to create a membership. parent = 'spaces/SPACE', # Specify which user the membership is for. body = { 'member': { 'name':'users/USER', 'type': 'HUMAN' } } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
แทนที่ข้อมูลต่อไปนี้ในโค้ด
API_KEY
: คีย์ API ที่คุณสร้างเพื่อสร้างอุปกรณ์ปลายทางบริการสำหรับ Chat APISPACE
: ชื่อพื้นที่ทำงาน ซึ่งคุณรับได้จากเมธอดspaces.list
ใน Chat API หรือจาก URL ของพื้นที่ทำงานUSER
: รหัสผู้ใช้
ในไดเรกทอรีทํางาน ให้สร้างและเรียกใช้ตัวอย่าง ดังนี้
python3 chat_membership_app_create.py
เพิ่มผู้ใช้หรือ Google Group ในพื้นที่ทำงานในฐานะผู้ดูแลระบบ Google Workspace
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเรียกใช้create()
วิธีนี้เพื่อเพิ่มผู้ใช้, Google Groups หรือแอป Chat ไปยังพื้นที่ทำงานใดก็ได้ในองค์กร Google Workspace
หากต้องการเรียกใช้เมธอดนี้ในฐานะผู้ดูแลระบบ Google Workspace ให้ทำดังนี้
- เรียกใช้เมธอดโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ และระบุขอบเขตการให้สิทธิ์ที่รองรับการเรียกใช้เมธอดโดยใช้สิทธิ์ของผู้ดูแลระบบ
- ในคําขอ ให้ระบุพารามิเตอร์การค้นหา
useAdminAccess
ถึงtrue
โปรดดูข้อมูลเพิ่มเติมและตัวอย่างที่หัวข้อจัดการพื้นที่ทำงานของ Google Chat ในฐานะผู้ดูแลระบบ Google Workspace
ข้อจำกัดและข้อควรพิจารณา
- เมื่อใช้การตรวจสอบสิทธิ์แอป แอป Chat จะเชิญหรือเพิ่มผู้ใช้ได้ แต่จะเชิญหรือเพิ่มผู้ใช้ใน Google Groups หรือแอป Chat ไม่ได้ หากต้องการเพิ่มตัวเอง แอป Chat ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์
chat.memberships
หัวข้อที่เกี่ยวข้อง
- ดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Chat
- แสดงรายชื่อสมาชิกในพื้นที่ทำงาน
- อัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ใน Google Chat
- นำผู้ใช้หรือแอป Chat ออกจากพื้นที่ทำงาน