คู่มือนี้จะอธิบายถึงวิธีใช้
patch()
ในทรัพยากร Space
ของ Google Chat API เพื่ออัปเดตพื้นที่ทำงาน อัปเดตพื้นที่ทำงานเพื่อเปลี่ยนแอตทริบิวต์เกี่ยวกับพื้นที่ทำงาน เช่น ชื่อที่แสดง คำอธิบาย และหลักเกณฑ์ที่ผู้ใช้มองเห็น
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเรียกใช้เมธอด patch()
เพื่ออัปเดตพื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace
Space
ทรัพยากรแสดงถึงสถานที่ที่ผู้ใช้และแอป Chat สามารถส่งข้อความ แชร์ไฟล์ และทำงานร่วมกันได้ พื้นที่ทำงานมีด้วยกันหลายประเภท ดังนี้
- ข้อความส่วนตัว (DM) คือการสนทนาระหว่างผู้ใช้ 2 คนหรือผู้ใช้ 1 ราย แอปใน Chat
- แชทกลุ่มเป็นการสนทนาระหว่างผู้ใช้ตั้งแต่ 3 คนขึ้นไปกับแอป Chat
- พื้นที่ทำงานที่มีชื่อเป็นพื้นที่ทำงานถาวรที่ผู้ใช้สามารถส่งข้อความ แชร์ไฟล์ และทำงานร่วมกันได้
ข้อกำหนดเบื้องต้น
Node.js
- ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API โดยใช้ชื่อ ไอคอนและคำอธิบายสำหรับแอป Chat ของคุณ
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Cloud สำหรับ Node.js
-
สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth สําหรับแอปพลิเคชันบนเดสก์ท็อป หากต้องการเรียกใช้ตัวอย่างใน
ให้บันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไฟล์ ไดเรกทอรีในเครื่อง
- เลือกขอบเขตการให้สิทธิ์ที่รองรับการตรวจสอบสิทธิ์ผู้ใช้
- พื้นที่ใน Google Chat หากต้องการสร้างโดยใช้ Google Chat API โปรดดูหัวข้อสร้างพื้นที่ทำงาน หากต้องการสร้างใน Chat ให้ไปที่เอกสารประกอบในศูนย์ช่วยเหลือ
Python
- ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- ติดตั้ง งูหลาม ไลบรารีของไคลเอ็นต์ระบบคลาวด์
-
สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth สําหรับแอปพลิเคชันบนเดสก์ท็อป หากต้องการเรียกใช้ตัวอย่างใน
ให้บันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไฟล์ ไดเรกทอรีในเครื่อง
- เลือกขอบเขตการให้สิทธิ์ที่รองรับการตรวจสอบสิทธิ์ผู้ใช้
- พื้นที่ใน Google Chat หากต้องการสร้างแชทโดยใช้ Google Chat API โปรดดู สร้างพื้นที่ทำงาน วิธีสร้างใน Chat โปรดไปที่ เอกสารในศูนย์ช่วยเหลือ
Java
- ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมของคุณ
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API โดยใช้ชื่อ ไอคอนและคำอธิบายสำหรับแอป Chat ของคุณ
- ติดตั้ง ชวา ไลบรารีของไคลเอ็นต์ระบบคลาวด์
-
สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth สำหรับแอปพลิเคชันบนเดสก์ท็อป หากต้องการเรียกใช้ตัวอย่างใน
ให้บันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไฟล์ ไดเรกทอรีในเครื่อง
- เลือกขอบเขตการให้สิทธิ์ที่รองรับการตรวจสอบสิทธิ์ผู้ใช้
- พื้นที่ใน Google Chat หากต้องการสร้างแชทโดยใช้ Google Chat API โปรดดู สร้างพื้นที่ทำงาน วิธีสร้างใน Chat โปรดไปที่ เอกสารในศูนย์ช่วยเหลือ
Apps Script
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API โดยใช้ชื่อ ไอคอนและคำอธิบายสำหรับแอป Chat ของคุณ
- สร้างโปรเจ็กต์ Apps Script แบบสแตนด์อโลน และเปิดบริการแชทขั้นสูง
- เลือกขอบเขตการให้สิทธิ์ที่รองรับการตรวจสอบสิทธิ์ผู้ใช้
- พื้นที่ใน Google Chat หากต้องการสร้างโดยใช้ Google Chat API โปรดดูหัวข้อสร้างพื้นที่ทำงาน หากต้องการสร้างใน Chat ให้ไปที่เอกสารประกอบในศูนย์ช่วยเหลือ
อัปเดตพื้นที่ทำงานในฐานะผู้ใช้
หากต้องการอัปเดตพื้นที่ทำงานที่มีอยู่ใน Google Chat ด้วยการตรวจสอบสิทธิ์ผู้ใช้ ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์
chat.spaces
- เรียกใช้
UpdateSpace()
ในคำขอ คุณต้องระบุฟิลด์name
ของพื้นที่ทำงาน ฟิลด์updateMask
ที่มีฟิลด์อย่างน้อย 1 ช่องที่จะอัปเดต และbody
ที่มีข้อมูลพื้นที่ทำงานที่อัปเดตแล้ว
คุณสามารถอัปเดตข้อมูลต่างๆ เช่น ชื่อที่แสดง ประเภทพื้นที่ทำงาน สถานะประวัติ และอื่นๆ หากต้องการดูฟิลด์ทั้งหมดที่คุณสามารถอัปเดตได้ โปรดดูที่ เอกสารอ้างอิง
วิธีอัปเดตช่อง displayName
ของพื้นที่ทำงานที่มีอยู่มีดังนี้
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ SPACE_NAME
ด้วยรหัสจากช่องname
ของพื้นที่ทำงาน คุณสามารถรับรหัสโดยโทรไปที่
ListSpaces()
หรือจาก URL ของพื้นที่ทำงาน
Google Chat API จะแสดงผลอินสแตนซ์ของ
Space
ซึ่งสะท้อนให้เห็นถึง
อัปเดต
อัปเดตพื้นที่ทำงานในฐานะผู้ดูแลระบบ Google Workspace
หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเรียกใช้เมธอด UpdateSpace()
เพื่ออัปเดตพื้นที่ทำงานในองค์กร Google Workspace
หากต้องการเรียกใช้เมธอดนี้ในฐานะผู้ดูแลระบบ Google Workspace ให้ทำดังนี้
- เรียกใช้เมธอดโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ และระบุ ขอบเขตการให้สิทธิ์ ที่สนับสนุนการเรียกใช้เมธอดโดยใช้ สิทธิ์ของผู้ดูแลระบบ
- ในคำขอ โปรดระบุพารามิเตอร์การค้นหา
useAdminAccess
เป็นtrue
สำหรับข้อมูลเพิ่มเติมและตัวอย่าง โปรดดูที่ จัดการพื้นที่ใน Google Chat ในฐานะผู้ดูแลระบบ Google Workspace
อัปเดตพื้นที่ทำงานเป็นแอป Chat
การตรวจสอบสิทธิ์แอปต้องการอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
หากต้องการอัปเดตพื้นที่ทำงานที่มีอยู่ใน Google Chat ด้วยการตรวจสอบสิทธิ์ของแอป ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุ
chat.app.spaces
ขอบเขตการให้สิทธิ์ เมื่อใช้การตรวจสอบสิทธิ์แอป คุณจะอัปเดตได้เฉพาะพื้นที่ทำงานที่สร้างขึ้นเท่านั้น ตามแอปใน Chat - เรียกใช้เมธอด
patch
ในทรัพยากรSpace
ใน คำขอของคุณ คุณสามารถระบุฟิลด์name
ฟิลด์updateMask
ซึ่งมีฟิลด์ให้อัปเดตอย่างน้อย 1 ฟิลด์ และbody
ด้วยข้อมูลพื้นที่ทำงานที่อัปเดตแล้ว
คุณสามารถอัปเดตข้อมูลต่างๆ เช่น ชื่อที่แสดง ประเภทพื้นที่ทำงาน สถานะประวัติ การตั้งค่าสิทธิ์ และอื่นๆ หากต้องการดูช่องทั้งหมดที่อัปเดตได้ โปรดดูเอกสารอ้างอิง
สร้างคีย์ API
หากต้องการเรียกใช้เมธอด Developer Preview API คุณต้องใช้เอกสารการค้นพบ API เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ที่ไม่ได้เผยแพร่แบบสาธารณะ หากต้องการตรวจสอบสิทธิ์คำขอ คุณต้องส่งคีย์ API
หากต้องการสร้างคีย์ API ให้เปิดโปรเจ็กต์ Google Cloud ของแอปแล้วทําดังนี้
- ในคอนโซล Google Cloud ให้ไปที่เมนู > API และ บริการ > ข้อมูลเข้าสู่ระบบ
- คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
- คีย์ API ใหม่จะปรากฏขึ้น
- คลิกคัดลอก เพื่อคัดลอกคีย์ API ไปใช้ในโค้ดของแอป นอกจากนี้ คุณยังดูคีย์ API ในส่วน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์ได้ด้วย
- คลิกจำกัดคีย์เพื่ออัปเดตการตั้งค่าขั้นสูงและจำกัดการใช้งาน ของคีย์ API ดูรายละเอียดเพิ่มเติมได้ที่การใช้ข้อจำกัดของคีย์ API
เขียนสคริปต์ที่เรียกใช้ Chat API
วิธีอัปเดตช่อง spaceDetails
ของพื้นที่ทำงานที่มีอยู่มีดังนี้
Python
- สร้างไฟล์ชื่อ
chat_space_update_app.py
ในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_space_update_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.spaces"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # 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().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()
ในโค้ด ให้แทนที่
API_KEY
: คีย์ API ที่คุณสร้างเพื่อสร้าง ปลายทางบริการสำหรับ Chat APISPACE
ที่มีชื่อพื้นที่ทำงาน ซึ่ง ที่คุณจะได้รับจากspaces.list
วิธี ใน Chat API หรือจาก URL ของพื้นที่ทำงาน
ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างด้วยคำสั่งต่อไปนี้
python3 chat_space_update_app.py
Google Chat API จะแสดงผลอินสแตนซ์ของ
แหล่งข้อมูล Space
รายการที่แสดง
อัปเดต
หัวข้อที่เกี่ยวข้อง
- ดูรายละเอียดเกี่ยวกับพื้นที่ทำงาน
- แสดงพื้นที่ทำงาน
- ลบพื้นที่ทำงาน
- ตั้งค่าพื้นที่ทำงาน
- ค้นหาพื้นที่ทำงานของข้อความส่วนตัว
- ทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้