คู่มือนี้อธิบายวิธีใช้เมธอด
create()
ในทรัพยากร Membership
ของ Google Chat API เพื่อเชิญหรือเพิ่มผู้ใช้
Google Group หรือแอป Chat ไปยังพื้นที่ทำงาน หรือที่เรียกว่า
การสร้างการเป็นสมาชิก เมื่อสร้างการเป็นสมาชิก หากสมาชิกที่ระบุปิดนโยบายยอมรับอัตโนมัติไว้ ระบบจะเชิญสมาชิกรายนั้น และสมาชิกจะต้องยอมรับคำเชิญเข้าร่วมพื้นที่ก่อนจึงจะเข้าร่วมได้ ไม่เช่นนั้น การสร้างการเป็นสมาชิกจะเพิ่ม
สมาชิกไปยังพื้นที่ทำงานที่ระบุโดยตรง
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเพิ่มผู้ใช้ Google Groups หรือแอป Chat ลงในพื้นที่ใดก็ได้ในองค์กร 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
Python
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อม โดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Python Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
ในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
Java
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อม โดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Java Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
ในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
Apps Script
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อม โดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- สร้างโปรเจ็กต์ Apps Script แบบสแตนด์อโลน และเปิดบริการ Chat ขั้นสูง
- ในคู่มือนี้ คุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ หรือแอป หากต้องการตรวจสอบสิทธิ์ในฐานะแอป 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.memberships
หัวข้อที่เกี่ยวข้อง
- ดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Chat
- แสดงรายชื่อสมาชิกในพื้นที่ทำงาน
- อัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ทำงานใน Google Chat
- นำผู้ใช้หรือแอป Chat ออกจากพื้นที่ทำงาน