คำแนะนำนี้จะอธิบายวิธีใช้เมธอด setup
ในทรัพยากร Space
ของ Google Chat API เพื่อตั้งค่าพื้นที่ใน Google Chat การตั้งค่าพื้นที่ทำงานจะสร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุลงในพื้นที่ทำงาน
แหล่งข้อมูล Space
เป็นพื้นที่ที่ผู้คนและแอป Chat ใช้ในการส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน พื้นที่ทำงานมีหลายประเภทดังนี้
- ข้อความส่วนตัว (DM) คือการสนทนาระหว่างผู้ใช้ 2 คนหรือผู้ใช้กับแอป Chat
- การแชทเป็นกลุ่มคือการสนทนาระหว่างผู้ใช้ 3 คนขึ้นไปกับแอป Chat
- พื้นที่ทำงานที่มีชื่อจะเป็นพื้นที่ทำงานถาวรที่ผู้คนส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน
เมื่อตั้งค่าพื้นที่ทำงาน ให้พิจารณาสิ่งต่อไปนี้
- ระบบจะเพิ่มผู้ใช้ที่โทรออก (ผ่านการตรวจสอบสิทธิ์) ไปยังพื้นที่ทำงานโดยอัตโนมัติแล้ว คุณจึงไม่จำเป็นต้องระบุการเป็นสมาชิกของผู้ใช้ในคำขอ
- เมื่อสร้างข้อความส่วนตัว (DM) หากมี DM ระหว่างผู้ใช้ 2 คน ระบบจะแสดงผล DM ไม่เช่นนั้น ระบบจะสร้าง DM ขึ้น
- เมื่อสร้างแชทเป็นกลุ่ม หากเพิ่มการเป็นสมาชิกที่ระบุในคำขอลงในแชทเป็นกลุ่มไม่สำเร็จ (เช่น ปัญหาด้านสิทธิ์) ระบบอาจสร้างแชทเป็นกลุ่มที่ว่างเปล่า (รวมถึงผู้ใช้ที่โทรเท่านั้น)
- คุณไม่สามารถตั้งค่าพื้นที่ทำงานที่มีการตอบกลับแบบแยกชุดข้อความหรือเพิ่มผู้คนนอก Google Workspace ได้
- การเป็นสมาชิกที่ซ้ำกัน (รวมถึงผู้ใช้ที่โทร) ที่ระบุไว้ในคำขอจะถูกกรองออกแทนที่จะทำให้เกิดข้อผิดพลาดเกี่ยวกับคำขอ
ข้อกำหนดเบื้องต้น
Python
- Python 3.6 ขึ้นไป
- เครื่องมือการจัดการแพ็กเกจ pip
ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Python หากต้องการติดตั้งหรืออัปเดต ให้เรียกใช้คำสั่งต่อไปนี้ในอินเทอร์เฟซบรรทัดคำสั่ง
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- โปรเจ็กต์ Google Cloud ที่เปิดใช้และกำหนดค่า Google Chat API โปรดดูขั้นตอนที่หัวข้อสร้างแอป Google Chat
กำหนดค่าการให้สิทธิ์สำหรับแอป Chat แล้ว การตั้งค่าพื้นที่ทำงานจะต้องมีการตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์
chat.spaces.create
หรือchat.spaces
Node.js
- Node.js และ npm
ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Node.js หากต้องการติดตั้ง ให้เรียกใช้คำสั่งต่อไปนี้ในอินเทอร์เฟซบรรทัดคำสั่ง
npm install @google-cloud/local-auth @googleapis/chat
- โปรเจ็กต์ Google Cloud ที่เปิดใช้และกำหนดค่า Google Chat API โปรดดูขั้นตอนที่หัวข้อสร้างแอป Google Chat
กำหนดค่าการให้สิทธิ์สำหรับแอป Chat แล้ว การสร้างพื้นที่ทำงานจำเป็นต้องมีการตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์
chat.spaces.create
หรือchat.spaces
ตั้งค่าพื้นที่ทำงาน
หากต้องการตั้งค่าพื้นที่ทำงาน ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์
chat.spaces.create
หรือchat.spaces
- เรียกเมธอด
setup
ในทรัพยากรSpace
- หากต้องการเพิ่มผู้ใช้ที่เป็นมนุษย์เป็นสมาชิกพื้นที่ทำงาน ให้ระบุ
users/{user}
โดยที่{user}
อาจเป็น{person_id}
สำหรับperson
จาก People API หรือรหัสของuser
ใน Directory API ตัวอย่างเช่น หากบุคคล APIresourceName
คือpeople/123456789
คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยระบุการเป็นสมาชิกที่มีusers/123456789
เป็นmember.name
- หากต้องการสร้าง DM ระหว่างผู้ใช้ที่โทรกับผู้ใช้ที่เป็นมนุษย์อีกคนหนึ่ง ให้ระบุการเป็นสมาชิกของผู้ใช้ที่เป็นมนุษย์ในคำขอ
- หากต้องการสร้าง DM ระหว่างผู้ใช้ที่โทรกับแอปโทร ให้ตั้งค่า
Space.singleUserBotDm
เป็นtrue
และไม่ระบุการเป็นสมาชิก คุณจะใช้วิธีนี้เพื่อตั้งค่า DM กับแอปการโทรได้เท่านั้น หากต้องการเพิ่มแอปการโทรเป็นสมาชิกของพื้นที่ทำงาน หรือ DM ที่มีอยู่ระหว่างผู้ใช้ที่เป็นมนุษย์ 2 คน โปรดดูสร้างการเป็นสมาชิก
ตัวอย่างต่อไปนี้สร้างพื้นที่ทำงานที่มีชื่อและสร้างการเป็นสมาชิกพื้นที่ทำงานสำหรับผู้ใช้ที่เป็นมนุษย์ 3 ราย ได้แก่ ผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว และผู้ใช้ที่ระบุอีก 2 ราย
Python
- สร้างไฟล์ชื่อ
chat_space_setup.py
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_space_setup.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.spaces.create"] def main(): ''' Authenticates with Chat API via user credentials, then sets up a Chat space by creating a space and adding members. ''' # 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().setup( # Details about the space to set up. body = { # Attributes of the space to set up, like space type and display name. 'space': { # To set up a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space 'displayName': 'API-setup' }, # The people and app to add to the space. # # The authenticated user is automatically added to the space, # and doesn't need to be specified in the memberships array. 'memberships': [ { 'member': { 'name':'users/123456789', 'type': 'HUMAN' } }, { 'member': { 'name':'users/987654321', 'type': 'HUMAN' } } ] } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
สร้างและเรียกใช้ตัวอย่างในไดเรกทอรีการทำงาน
python3 chat_space_setup.py
Node.js
- สร้างไฟล์ชื่อ
setup-space.js
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
setup-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Sets up a new Chat space with users. * @return {!Promise<!Object>} */ async function setupSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.create', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.setup({ requestBody: { space: { spaceType: 'SPACE', displayName: 'API-made', }, memberships: [ {member: {name: 'users/123456789', type: 'HUMAN'}}, {member: {name: 'users/987654321', type: 'HUMAN'}}, ] } }); } setupSpace().then(console.log);
เรียกใช้ตัวอย่างในไดเรกทอรีการทำงาน
node setup-space.js
ระบบตั้งค่าพื้นที่ใน Chat ที่มีชื่อซึ่งมีผู้ใช้เป็นมนุษย์ 3 คน รวมถึงผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
หากต้องการไปที่พื้นที่ทำงาน ให้ใช้รหัสทรัพยากรของพื้นที่ทำงานเพื่อสร้าง URL ของพื้นที่ทำงาน
คุณสามารถรับรหัสทรัพยากรได้จากพื้นที่ทำงาน name
ในเนื้อหาการตอบกลับของ Google Chat ตัวอย่างเช่น หาก name
ของพื้นที่ทำงานคือ spaces/1234567
คุณสามารถไปที่พื้นที่ทำงานโดยใช้ URL ต่อไปนี้ได้ https://mail.google.com/chat/u/0/#chat/space/1234567
หัวข้อที่เกี่ยวข้อง
- สร้างพื้นที่ทำงาน
- ดูรายละเอียดเกี่ยวกับพื้นที่ทำงาน
- แสดงรายการพื้นที่ทำงาน
- อัปเดตพื้นที่ทำงาน
- ลบพื้นที่ทำงาน
- ค้นหาพื้นที่ข้อความส่วนตัว