- ทรัพยากร: พื้นที่ทำงาน
- เมธอด
ทรัพยากร: พื้นที่ทำงาน
พื้นที่ทำงานใน Google Chat พื้นที่ทำงานคือการสนทนาระหว่างผู้ใช้ตั้งแต่ 2 คนขึ้นไป หรือข้อความแบบ 1:1 ระหว่างผู้ใช้กับแอปใน Chat
| การแสดง JSON |
|---|
{ "name": string, "type": enum ( |
| ช่อง | |
|---|---|
name |
ตัวระบุ ชื่อทรัพยากรของพื้นที่ทำงาน รูปแบบ: โดย |
type |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: โปรดใช้ |
spaceType |
ไม่บังคับ ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานหรืออัปเดตประเภทพื้นที่ทำงานของพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นๆ เท่านั้น |
singleUserBotDm |
ไม่บังคับ พื้นที่ทำงานเป็น DM ระหว่างแอปใน Chat กับบุคคลเดียวหรือไม่ |
threaded |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: โปรดใช้ |
displayName |
ไม่บังคับ ชื่อที่แสดงของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานที่มี สำหรับข้อความส่วนตัว ช่องนี้อาจว่างเปล่า รองรับอักขระได้สูงสุด 128 ตัว |
externalUserAllowed |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ พื้นที่ทำงานนี้อนุญาตให้ผู้ใช้ Google Chat เป็นสมาชิกหรือไม่ ข้อมูลที่ป้อนเมื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace ละเว้นช่องนี้เมื่อสร้างพื้นที่ทำงานในเงื่อนไขต่อไปนี้
สำหรับพื้นที่ทำงานที่มีอยู่ ช่องนี้จะเป็นเอาต์พุตเท่านั้น |
spaceThreadingState |
เอาต์พุตเท่านั้น สถานะชุดข้อความในพื้นที่ทำงานใน Chat |
spaceDetails |
ไม่บังคับ รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ |
spaceHistoryState |
ไม่บังคับ สถานะประวัติข้อความสำหรับข้อความและชุดข้อความในพื้นที่ทำงานนี้ |
importMode |
ไม่บังคับ พื้นที่ทำงานนี้สร้างขึ้นใน การสร้างพื้นที่ทำงานใน |
createTime |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ สำหรับพื้นที่ทำงานที่สร้างใน Chat จะเป็นเวลาที่สร้างพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ทำงานโหมดการนำเข้า สำหรับพื้นที่ทำงานในโหมดนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาที่ผ่านมาซึ่งมีการสร้างพื้นที่ทำงานในแหล่งที่มาเพื่อรักษาเวลาที่สร้างเดิมไว้ จะป้อนข้อมูลในเอาต์พุตเมื่อ |
lastActiveTime |
เอาต์พุตเท่านั้น การประทับเวลาของข้อความสุดท้ายในพื้นที่ทำงาน |
adminInstalled |
เอาต์พุตเท่านั้น สำหรับพื้นที่ทำงานของข้อความส่วนตัว (DM) ที่มีแอปใน Chat ให้ดูว่าผู้ดูแลระบบ Google Workspace เป็นผู้สร้างพื้นที่ทำงานหรือไม่ ผู้ดูแลระบบสามารถติดตั้งและตั้งค่าข้อความส่วนตัวด้วยแอปใน Chat ในนามของผู้ใช้ในองค์กรได้ แอปใน Chat ต้องมีฟีเจอร์การรับส่งข้อความส่วนตัวเพื่อรองรับการติดตั้งโดยผู้ดูแลระบบ |
membershipCount |
เอาต์พุตเท่านั้น จำนวนการเป็นสมาชิกที่เข้าร่วมซึ่งจัดกลุ่มตามประเภทสมาชิก ระบบจะป้อนข้อมูลเมื่อ |
accessSettings |
ไม่บังคับ ระบุการตั้งค่าการเข้าถึงของพื้นที่ทำงาน จะป้อนข้อมูลเมื่อ |
spaceUri |
เอาต์พุตเท่านั้น URI สำหรับให้ผู้ใช้เข้าถึงพื้นที่ทำงาน |
sessionState |
เอาต์พุตเท่านั้น สถานะเซสชันของพื้นที่ทำงาน |
sessionEnableTime |
เอาต์พุตเท่านั้น การประทับเวลาที่สถานะการรองรับเซสชันของพื้นที่ทำงานเปลี่ยนเป็นรองรับ ไม่ได้ตั้งค่าหากพื้นที่ทำงานไม่ได้เปิดใช้การรองรับเซสชัน |
importModeExpireTime |
เอาต์พุตเท่านั้น เวลาที่ระบบจะลบพื้นที่ทำงานโดยอัตโนมัติหากยังคงอยู่ในโหมดการนำเข้า พื้นที่ทำงานแต่ละรายการที่สร้างในโหมดการนำเข้าต้องออกจากโหมดนี้ก่อนเวลาหมดอายุโดยใช้ ระบบจะป้อนข้อมูลในช่องนี้สำหรับพื้นที่ทำงานที่สร้างด้วยโหมดการนำเข้าเท่านั้น |
customer |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ รหัสลูกค้าของโดเมนของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานด้วยการตรวจสอบสิทธิ์แอปและ ในรูปแบบ ระบบจะไม่ป้อนข้อมูลในช่องนี้สำหรับข้อความส่วนตัว (DM) หรือเมื่อผู้ใช้ที่ไม่ได้ใช้ Google Workspace เป็นผู้สร้างพื้นที่ทำงาน |
แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน จะป้อนข้อมูลเมื่อ space_type เป็น SPACE เท่านั้น รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ |
|
predefinedPermissionSettings |
ไม่บังคับ อินพุตเท่านั้น การตั้งค่ากลุ่มสิทธิ์ของพื้นที่ทำงานที่กำหนดไว้ล่วงหน้า ให้ป้อนข้อมูลเมื่อสร้างพื้นที่ทำงานเท่านั้น หากไม่ได้ตั้งค่าฟิลด์นี้ ระบบจะสร้างพื้นที่ทำงานร่วมกัน หลังจากสร้างพื้นที่ทำงานแล้ว การตั้งค่าจะปรากฏในช่อง การตั้งค่ากลุ่มสิทธิ์ที่กำหนดไว้ล่วงหน้าจะรองรับสิ่งต่อไปนี้
|
permissionSettings |
ไม่บังคับ การตั้งค่าสิทธิ์ของพื้นที่ทำงานสำหรับพื้นที่ทำงานที่มีอยู่ ข้อมูลสำหรับการอัปเดตการตั้งค่าสิทธิ์ของพื้นที่ทำงานที่แน่นอน ซึ่งจะแทนที่การตั้งค่าสิทธิ์ที่มีอยู่ เอาต์พุตจะแสดงการตั้งค่าสิทธิ์ปัจจุบัน การอ่านและอัปเดตการตั้งค่าสิทธิ์รองรับสิ่งต่อไปนี้
|
| สิ้นสุดฟิลด์ที่แยกกัน | |
ประเภท
เลิกใช้งานแล้ว: โปรดใช้ SpaceType แทน
| Enum | |
|---|---|
TYPE_UNSPECIFIED |
Reserved. |
ROOM |
การสนทนาระหว่างมนุษย์ 2 คนขึ้นไป |
DM |
ข้อความส่วนตัวแบบ 1:1 ระหว่างบุคคลกับแอปใน Chat ซึ่งข้อความทั้งหมดจะไม่มีการแยกชุดข้อความ โปรดทราบว่าการดำเนินการนี้ไม่รวมข้อความส่วนตัวระหว่างบุคคล 2 คน |
SpaceType
ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างหรืออัปเดตพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นๆ เท่านั้น
| Enum | |
|---|---|
SPACE_TYPE_UNSPECIFIED |
Reserved. |
SPACE |
พื้นที่ที่ผู้คนส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน SPACE สามารถมีแอปใน Chat ได้ |
GROUP_CHAT |
การสนทนากลุ่มระหว่างผู้คนตั้งแต่ 3 คนขึ้นไป GROUP_CHAT สามารถมีแอปใน Chat ได้ |
DIRECT_MESSAGE |
ข้อความแบบ 1:1 ระหว่างมนุษย์ 2 คนหรือมนุษย์กับแอปใน Chat |
SpaceThreadingState
ระบุประเภทสถานะชุดข้อความในพื้นที่ทำงานใน Chat
| Enum | |
|---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Reserved. |
THREADED_MESSAGES |
พื้นที่ทำงานที่รองรับชุดข้อความ เมื่อผู้ใช้ตอบกลับข้อความ ผู้ใช้สามารถตอบกลับในชุดข้อความได้ ซึ่งจะทำให้คำตอบอยู่ในบริบทของข้อความต้นฉบับ |
GROUPED_MESSAGES |
พื้นที่ทำงานที่มีชื่อซึ่งจัดระเบียบการสนทนาตามหัวข้อ ระบบจะจัดกลุ่มหัวข้อและการตอบกลับไว้ด้วยกัน |
UNTHREADED_MESSAGES |
พื้นที่ทำงานที่ไม่รองรับชุดข้อความ สถานะชุดข้อความของพื้นที่ทำงานนี้ใช้สำหรับกรณีพิเศษเท่านั้น ซึ่งรวมถึงกรณีต่อไปนี้
|
SpaceDetails
รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ
| การแสดง JSON |
|---|
{ "description": string, "guidelines": string } |
| ฟิลด์ | |
|---|---|
description |
ไม่บังคับ คำอธิบายพื้นที่ทำงาน เช่น อธิบายหัวข้อการสนทนา วัตถุประสงค์การใช้งาน หรือผู้เข้าร่วมของพื้นที่ทำงาน รองรับอักขระสูงสุด 4,096 ตัว |
guidelines |
ไม่บังคับ กฎ ความคาดหวัง และมารยาทของพื้นที่ทำงาน รองรับอักขระได้สูงสุด 5,000 ตัว |
HistoryState
สถานะประวัติสำหรับข้อความและพื้นที่ทำงาน ระบุระยะเวลาที่จะเก็บข้อความและชุดข้อความการสนทนาหลังจากสร้าง
| Enum | |
|---|---|
HISTORY_STATE_UNSPECIFIED |
ค่าเริ่มต้น โปรดอย่าใช้ |
HISTORY_OFF |
ประวัติปิดอยู่ ระบบจะเก็บข้อความและชุดข้อความไว้เป็นเวลา 24 ชั่วโมง |
HISTORY_ON |
ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาที่จะเก็บข้อความและชุดข้อความไว้ |
MembershipCount
แสดงจำนวนการเป็นสมาชิกของพื้นที่ทำงาน โดยแบ่งออกเป็นหมวดหมู่ต่างๆ
| การแสดง JSON |
|---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
| ช่อง | |
|---|---|
joinedDirectHumanUserCount |
เอาต์พุตเท่านั้น จำนวนผู้ใช้ที่เป็นมนุษย์ซึ่งเข้าร่วมพื้นที่ทำงานโดยตรง โดยไม่นับรวมผู้ใช้ที่เข้าร่วมโดยการเป็นสมาชิกในกลุ่มที่เข้าร่วม |
joinedGroupCount |
เอาต์พุตเท่านั้น จำนวนกลุ่มทั้งหมดที่เข้าร่วมพื้นที่ทำงานโดยตรง |
AccessSettings
แสดงการตั้งค่าการเข้าถึงของพื้นที่ทำงาน
| การแสดง JSON |
|---|
{ "accessState": enum ( |
| ช่อง | |
|---|---|
accessState |
เอาต์พุตเท่านั้น ระบุสถานะการเข้าถึงของพื้นที่ทำงาน |
audience |
ไม่บังคับ ชื่อทรัพยากรของกลุ่มเป้าหมายที่สามารถค้นพบพื้นที่ทำงาน เข้าร่วมพื้นที่ทำงาน และดูตัวอย่างข้อความในพื้นที่ทำงานได้ หากไม่ได้ตั้งค่าไว้ เฉพาะผู้ใช้หรือ Google Groups ที่ได้รับเชิญหรือเพิ่มไปยังพื้นที่ทำงานเป็นรายบุคคลเท่านั้นที่จะเข้าถึงพื้นที่ทำงานได้ โปรดดูรายละเอียดที่หัวข้อทำให้กลุ่มเป้าหมายค้นพบพื้นที่ทำงานได้ รูปแบบ: หากต้องการใช้กลุ่มเป้าหมายเริ่มต้นสำหรับองค์กร Google Workspace ให้ตั้งค่าเป็น การอ่านกลุ่มเป้าหมายรองรับสิ่งต่อไปนี้
ระบบจะไม่ป้อนข้อมูลในช่องนี้เมื่อใช้ขอบเขต การตั้งค่ากลุ่มเป้าหมายต้องมีการตรวจสอบสิทธิ์ของผู้ใช้ |
accessPermissionSettings |
ไม่บังคับ การตั้งค่าสิทธิ์เข้าถึงสำหรับพื้นที่ทำงาน หากต้องการตั้งค่ากลุ่มเป้าหมายเมื่อสร้างพื้นที่ทำงาน ให้ระบุช่อง |
AccessState
แสดงสถานะการเข้าถึงของพื้นที่ทำงาน
| Enum | |
|---|---|
ACCESS_STATE_UNSPECIFIED |
ไม่ทราบสถานะการเข้าถึงหรือไม่รองรับใน API นี้ |
PRIVATE |
เฉพาะผู้ใช้หรือ Google Groups ที่ได้รับการเพิ่มหรือเชิญโดยผู้ใช้รายอื่นหรือผู้ดูแลระบบ Google Workspace เป็นรายบุคคลเท่านั้นที่จะค้นพบและเข้าถึงพื้นที่ทำงานได้ |
DISCOVERABLE |
ผู้จัดการพื้นที่ทำงานได้ให้สิทธิ์เข้าถึงพื้นที่ทำงานแก่กลุ่มเป้าหมาย ผู้ใช้หรือ Google Groups ที่ได้รับการเพิ่มหรือได้รับเชิญให้เข้าร่วมพื้นที่ทำงานเป็นรายบุคคลจะค้นพบและเข้าถึงพื้นที่ทำงานได้ด้วย ดูข้อมูลเพิ่มเติมได้ที่หัวข้อทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้ การสร้างพื้นที่ทำงานที่ค้นพบได้ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ |
AccessPermissionSettings
การตั้งค่าสิทธิ์เข้าถึงสำหรับพื้นที่ทำงาน
| การแสดง JSON |
|---|
{ "discoverSpaceSetting": { object ( |
| ฟิลด์ | |
|---|---|
discoverSpaceSetting |
ไม่บังคับ การตั้งค่าสิทธิ์เข้าถึงสำหรับการค้นพบพื้นที่ทำงาน |
joinSpaceSetting |
ไม่บังคับ การตั้งค่าสิทธิ์เข้าถึงสำหรับการเข้าร่วมพื้นที่ทำงาน |
viewSpaceMembershipSetting |
ไม่บังคับ การตั้งค่าสิทธิ์เข้าถึงสำหรับการดูการเป็นสมาชิกของพื้นที่ทำงาน ต้องระบุร่วมกับ |
AccessPermissionSetting
การตั้งค่าสิทธิ์การเข้าถึง
| การแสดง JSON |
|---|
{
"principals": [
{
object ( |
| ฟิลด์ | |
|---|---|
principals[] |
ไม่บังคับ รายการที่ไม่เรียงลำดับ ผู้ใช้หลักที่ได้รับอนุญาตสำหรับสิทธิ์นี้ |
ผู้ใช้หลัก
ผู้ใช้หลักที่แสดงถึงเอนทิตีที่ได้รับสิทธิ์เข้าถึง
| การแสดง JSON |
|---|
{
"audience": {
object ( |
| ช่อง | |
|---|---|
| ประเภทของ Principal รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
audience |
กลุ่มเป้าหมาย |
| สิ้นสุดฟิลด์ที่แยกกัน | |
กลุ่มเป้าหมาย
กลุ่มเป้าหมายใน Google Chat กลุ่มเป้าหมายหมายถึงกลุ่มผู้ใช้ภายในองค์กร Google Workspace ซึ่งกำหนดโดยผู้ดูแลระบบ กลุ่มเป้าหมายใช้เพื่อกำหนดค่าการเข้าถึงและการตั้งค่าระดับการเข้าถึงสำหรับทรัพยากร เช่น การทำให้พื้นที่ทำงานค้นพบได้สำหรับกลุ่มผู้ใช้ที่เฉพาะเจาะจง
ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อกลุ่มเป้าหมายและทำให้พื้นที่ทำงานค้นพบได้สำหรับกลุ่มเป้าหมาย
| การแสดง JSON |
|---|
{ "name": string } |
| ช่อง | |
|---|---|
name |
ชื่อทรัพยากรของกลุ่มเป้าหมายที่สามารถค้นพบหรือเข้าร่วมพื้นที่ทำงานได้ โปรดดูรายละเอียดที่หัวข้อทำให้กลุ่มเป้าหมายค้นพบพื้นที่ทำงานได้ รูปแบบ: หากต้องการใช้กลุ่มเป้าหมายเริ่มต้นสำหรับองค์กร Google Workspace ให้ตั้งค่าเป็น |
PredefinedPermissionSettings
การตั้งค่าสิทธิ์ที่กำหนดไว้ล่วงหน้าซึ่งคุณระบุได้เฉพาะเมื่อสร้างพื้นที่ทำงานที่มีชื่อเท่านั้น ทั้งนี้อาจมีการเพิ่มการตั้งค่าอื่นๆ ในอนาคต โปรดดูรายละเอียดเกี่ยวกับการตั้งค่าสิทธิ์สำหรับพื้นที่ทำงานที่มีชื่อที่หัวข้อดูข้อมูลเกี่ยวกับพื้นที่ทำงาน
| Enum | |
|---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
ไม่ระบุ ไม่ใช้ |
COLLABORATION_SPACE |
การตั้งค่าเพื่อทำให้พื้นที่ทำงานเป็นพื้นที่สำหรับการทำงานร่วมกันซึ่งสมาชิกทุกคนสามารถโพสต์ข้อความได้ |
ANNOUNCEMENT_SPACE |
การตั้งค่าเพื่อทำให้พื้นที่ทำงานเป็นพื้นที่ประกาศซึ่งมีเพียงผู้จัดการพื้นที่ทำงานเท่านั้นที่โพสต์ข้อความได้ |
PermissionSettings
การตั้งค่าสิทธิ์ที่คุณระบุได้เมื่ออัปเดตพื้นที่ทำงานที่มีชื่ออยู่แล้ว
หากต้องการตั้งค่าสิทธิ์เมื่อสร้างพื้นที่ทำงาน ให้ระบุช่อง PredefinedPermissionSettings ในคำขอ
| การแสดง JSON |
|---|
{ "manageMembersAndGroups": { object ( |
| ฟิลด์ | |
|---|---|
manageMembersAndGroups |
ไม่บังคับ การตั้งค่าสำหรับการจัดการสมาชิกและกลุ่มในพื้นที่ทำงาน |
modifySpaceDetails |
ไม่บังคับ การตั้งค่าสำหรับการอัปเดตชื่อ รูปโปรไฟล์ คำอธิบาย และหลักเกณฑ์ของพื้นที่ทำงาน |
toggleHistory |
ไม่บังคับ การตั้งค่าสำหรับการเปิดและปิดประวัติพื้นที่ทำงาน |
useAtMentionAll |
ไม่บังคับ การตั้งค่าสำหรับการใช้ @ทั้งหมด ในพื้นที่ทำงาน |
manageApps |
ไม่บังคับ การตั้งค่าสำหรับการจัดการแอปในพื้นที่ทำงาน |
manageWebhooks |
ไม่บังคับ การตั้งค่าสำหรับการจัดการเว็บฮุคในพื้นที่ทำงาน |
postMessages |
เอาต์พุตเท่านั้น การตั้งค่าสำหรับการโพสต์ข้อความในพื้นที่ทำงาน |
replyMessages |
ไม่บังคับ การตั้งค่าสำหรับการตอบกลับข้อความในพื้นที่ทำงาน |
viewSpaceMembership |
ไม่บังคับ การตั้งค่าสำหรับการดูการเป็นสมาชิกของพื้นที่ทำงาน ต้องระบุร่วมกับ |
PermissionSetting
แสดงการตั้งค่ากลุ่มสิทธิ์ของพื้นที่ทำงาน
| การแสดง JSON |
|---|
{ "managersAllowed": boolean, "membersAllowed": boolean, "assistantManagersAllowed": boolean } |
| ฟิลด์ | |
|---|---|
managersAllowed |
ไม่บังคับ เจ้าของพื้นที่ทำงาน ( |
membersAllowed |
ไม่บังคับ สมาชิกพื้นที่ทำงานขั้นพื้นฐาน ( |
assistantManagersAllowed |
ไม่บังคับ ผู้จัดการพื้นที่ทำงาน |
SpaceSessionState
สถานะเซสชันของพื้นที่ทำงาน
| Enum | |
|---|---|
SPACE_SESSION_STATE_UNSPECIFIED |
ไม่ระบุ ไม่ใช้ |
NOT_SUPPORTED |
พื้นที่ทำงานไม่รองรับเซสชัน |
THREAD |
พื้นที่ทำงานรองรับเซสชันตามชุดข้อความ |
เมธอด |
|
|---|---|
|
ดำเนินการกระบวนการนำเข้าสำหรับพื้นที่ทำงานที่ระบุให้เสร็จสมบูรณ์และทำให้ผู้ใช้มองเห็นได้ |
|
สร้างพื้นที่ทำงาน |
|
ลบพื้นที่ทำงานที่มีชื่อ |
|
แสดงผลข้อความส่วนตัวที่มีอยู่กับผู้ใช้ที่ระบุ |
|
แสดงผลพื้นที่ทำงานทั้งหมดที่มี spaceType == GROUP_CHAT ซึ่งการเป็นสมาชิกของบุคคลมีผู้ใช้ที่โทรและผู้ใช้ที่ระบุใน FindGroupChatsRequest.users เท่านั้น |
|
แสดงรายละเอียดเกี่ยวกับพื้นที่ทำงาน |
|
แสดงรายการพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก |
|
อัปเดตพื้นที่ทำงาน |
|
แสดงรายการพื้นที่ทำงานในองค์กร Google Workspace |
|
สร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุลงในพื้นที่ทำงาน |