REST Resource: spaces

ทรัพยากร: พื้นที่ทำงาน

พื้นที่ทำงานใน Google Chat พื้นที่ทำงานคือการสนทนาระหว่างผู้ใช้ 2 คนขึ้นไปหรือข้อความแบบ 1:1 ระหว่างผู้ใช้กับแอป Chat

การแสดง JSON
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  }
}
ช่อง
name

string

ชื่อทรัพยากรของพื้นที่ทำงาน

รูปแบบ: spaces/{space}

type
(deprecated)

enum (Type)

เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ใช้ spaceType แทน ประเภทของพื้นที่ทำงาน

spaceType

enum (SpaceType)

ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานหรืออัปเดตประเภทพื้นที่ทำงานของพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นเท่านั้น

singleUserBotDm

boolean

ไม่บังคับ ระบุว่าพื้นที่ทำงานเป็น DM ระหว่างแอป Chat กับบุคคลคนเดียวหรือไม่

threaded
(deprecated)

boolean

เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ใช้ spaceThreadingState แทน ข้อความมีชุดข้อความในพื้นที่ทำงานนี้หรือไม่

displayName

string

ชื่อที่แสดงของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงาน หากคุณได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS เมื่อสร้างพื้นที่ทำงานหรืออัปเดต displayName ให้ลองใช้ displayName อื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว

สำหรับข้อความส่วนตัว ช่องนี้อาจว่างเปล่า

รองรับอักขระสูงสุด 128 ตัว

externalUserAllowed

boolean

เปลี่ยนแปลงไม่ได้ พื้นที่ทำงานนี้อนุญาตให้ผู้ใช้ Google Chat เป็นสมาชิกหรือไม่ ป้อนข้อมูลเมื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace เว้นช่องนี้ไว้เมื่อสร้างช่องว่างในเงื่อนไขต่อไปนี้

  • ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วจะใช้บัญชี Google โดยค่าเริ่มต้น พื้นที่ทำงานจะอนุญาตผู้ใช้ Google Chat ทุกคน

  • ระบบจะใช้พื้นที่ทำงานเพื่อนําเข้าข้อมูลไปยัง Google Chat พื้นที่ทำงานโหมดการนำเข้าต้องอนุญาตสมาชิกจากองค์กร Google Workspace เดียวกันเท่านั้น

สำหรับพื้นที่ทำงานที่มีอยู่ ช่องนี้จะแสดงเอาต์พุตเท่านั้น

spaceThreadingState

enum (SpaceThreadingState)

เอาต์พุตเท่านั้น สถานะชุดข้อความในพื้นที่ใน Chat

spaceDetails

object (SpaceDetails)

รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ

spaceHistoryState

enum (HistoryState)

สถานะประวัติข้อความสำหรับข้อความและชุดข้อความในพื้นที่ทำงานนี้

importMode

boolean

ไม่บังคับ พื้นที่ทำงานนี้สร้างขึ้นใน Import Mode เป็นส่วนหนึ่งของการย้ายข้อมูลไปยัง Google Workspace หรือไม่ ขณะที่นำเข้าพื้นที่ทำงานอยู่ ผู้ใช้จะไม่เห็นพื้นที่ทำงานดังกล่าวจนกว่าการนำเข้าจะเสร็จสมบูรณ์

createTime

string (Timestamp format)

ไม่บังคับ เปลี่ยนแปลงไม่ได้ สําหรับพื้นที่ทำงานที่สร้างใน Chat ระยะเวลาที่สร้างพื้นที่ทำงานนั้น ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ทำงานโหมดการนำเข้า

สำหรับพื้นที่ทำงานโหมดการนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาในอดีตที่มีการสร้างพื้นที่ทำงานในแหล่งที่มาเพื่อรักษาเวลาที่สร้างเดิมไว้

จะมีค่าในเอาต์พุตเมื่อ spaceType เป็น GROUP_CHAT หรือ SPACE เท่านั้น

adminInstalled

boolean

เอาต์พุตเท่านั้น ผู้ดูแลระบบ Google Workspace ติดตั้งแอปใน Chat หรือไม่ ผู้ดูแลระบบจะติดตั้งแอปใน Chat ให้กับโดเมน หน่วยขององค์กร หรือกลุ่มผู้ใช้ได้

ผู้ดูแลระบบติดตั้งได้เฉพาะแอปใน Chat สำหรับการรับส่งข้อความส่วนตัวระหว่างผู้ใช้และแอปดังกล่าวเท่านั้น แอปของคุณต้องมีฟีเจอร์ข้อความส่วนตัวเพื่อรองรับการติดตั้งโดยผู้ดูแลระบบ

accessSettings

object (AccessSettings)

ไม่บังคับ ระบุการตั้งค่าการเข้าถึงของพื้นที่ทำงาน ป้อนข้อมูลเมื่อ spaceType เป็น SPACE เท่านั้น

ประเภท

เลิกใช้งานแล้ว: ใช้ SpaceType แทน

Enum
TYPE_UNSPECIFIED
ROOM การสนทนาระหว่างคน 2 คนขึ้นไป
DM ข้อความส่วนตัวแบบ 1:1 ระหว่างผู้ใช้กับแอป Chat ซึ่งข้อความทั้งหมดจะแบนราบ โปรดทราบว่าการดำเนินการนี้ไม่รวมถึงข้อความส่วนตัวระหว่างบุคคล 2 คน

SpaceType

ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างหรืออัปเดตพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นเท่านั้น

Enum
SPACE_TYPE_UNSPECIFIED จองแล้ว
SPACE สถานที่ที่ผู้คนส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน SPACE มีแอปใน Chat ได้
GROUP_CHAT การสนทนากลุ่มที่มี 3 คนขึ้นไป GROUP_CHAT มีแอปใน Chat ได้
DIRECT_MESSAGE ข้อความแบบ 1:1 ระหว่างคน 2 คนหรือคนกับแอป Chat

SpaceThreadingState

ระบุประเภทของสถานะชุดข้อความในพื้นที่ใน Chat

Enum
SPACE_THREADING_STATE_UNSPECIFIED จองแล้ว
THREADED_MESSAGES พื้นที่ทำงานที่มีชื่อซึ่งรองรับชุดข้อความ เมื่อผู้ใช้ตอบกลับข้อความ ก็จะตอบกลับในชุดข้อความได้ ซึ่งจะคงการตอบกลับไว้ในบริบทของข้อความต้นฉบับ
GROUPED_MESSAGES พื้นที่ทำงานที่มีชื่อซึ่งจัดระเบียบการสนทนาตามหัวข้อ ระบบจะจัดกลุ่มหัวข้อและการตอบกลับไว้ด้วยกัน
UNTHREADED_MESSAGES ข้อความส่วนตัว (DM) ระหว่าง 2 คนกับการสนทนากลุ่มระหว่าง 3 คนขึ้นไป

SpaceDetails

รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ

การแสดง JSON
{
  "description": string,
  "guidelines": string
}
ช่อง
description

string

ไม่บังคับ คำอธิบายของพื้นที่ทำงาน ตัวอย่างเช่น อธิบายหัวข้อการสนทนาของพื้นที่ทำงาน วัตถุประสงค์ด้านฟังก์ชัน หรือผู้เข้าร่วม

รองรับอักขระสูงสุด 150 ตัว

guidelines

string

ไม่บังคับ กฎเกณฑ์ ความคาดหวัง และมารยาทของพื้นที่ทำงาน

รองรับอักขระสูงสุด 5,000 ตัว

HistoryState

สถานะประวัติสำหรับข้อความและพื้นที่ทำงาน ระบุระยะเวลาในการเก็บข้อความและชุดข้อความการสนทนาหลังจากสร้าง

Enum
HISTORY_STATE_UNSPECIFIED ค่าเริ่มต้น โปรดอย่าใช้
HISTORY_OFF ประวัติปิดอยู่ ข้อความและชุดข้อความจะเก็บไว้เป็นเวลา 24 ชั่วโมง
HISTORY_ON ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาที่จะเก็บรักษาข้อความและชุดข้อความ

AccessSettings

แสดงการตั้งค่าการเข้าถึงของพื้นที่ทำงาน

การแสดง JSON
{
  "accessState": enum (AccessState),
  "audience": string
}
ช่อง
accessState

enum (AccessState)

เอาต์พุตเท่านั้น ระบุสถานะการเข้าถึงพื้นที่ทำงาน

audience

string

ไม่บังคับ ชื่อทรัพยากรของกลุ่มเป้าหมายที่เข้าถึงพื้นที่ทำงานได้ ตั้งค่าช่องนี้เป็นรหัสกลุ่มเป้าหมายที่ถูกต้องเพื่อให้ค้นพบพื้นที่ทำงานได้ หรือใช้ชื่อแทน audiences/default เพื่อตั้งค่าพื้นที่ทำงานด้วยการตั้งค่าการเข้าถึงเริ่มต้นในคอนโซลผู้ดูแลระบบ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อทำให้กลุ่มเป้าหมายค้นพบพื้นที่ทำงานได้ ยกเลิกการตั้งค่าช่องนี้เพื่อจำกัดพื้นที่ทำงาน ระบบจะแสดงข้อมูลเมื่อค้นพบพื้นที่ทำงานได้เท่านั้น รูปแบบ: audiences/{audience} และ audiences/default จะใช้เป็นชื่อแทนของการตั้งค่าการแชร์เริ่มต้นของ Chat ได้

AccessState

แสดงสถานะการเข้าถึงของพื้นที่ทำงาน

Enum
ACCESS_STATE_UNSPECIFIED ระบบไม่รู้จักสถานะการเข้าถึงหรือไม่รองรับใน API นี้
PRIVATE สมาชิกหรือกลุ่มที่เพิ่มหรือที่ได้รับเชิญจะค้นพบพื้นที่ทำงานได้
DISCOVERABLE กลุ่มเป้าหมายที่เลือกค้นพบพื้นที่ทำงานได้ รวมถึงสมาชิกหรือกลุ่มที่เพิ่มหรือเชิญแล้ว

วิธีการ

completeImport

ดำเนินขั้นตอนการนำเข้าสำหรับพื้นที่ทำงานที่ระบุ และแสดงต่อผู้ใช้

create

สร้างพื้นที่ทำงานที่มีชื่อ

delete

ลบพื้นที่ทำงานที่ตั้งชื่อแล้ว

findDirectMessage

แสดงผลข้อความส่วนตัวที่มีอยู่กับผู้ใช้ที่ระบุ

get

แสดงผลรายละเอียดเกี่ยวกับพื้นที่ทำงาน

list

แสดงรายการพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก

patch

อัปเดตพื้นที่ทำงาน

setup

สร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุไปยังพื้นที่ทำงาน