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)
  },
  "spaceUri": string
}
ช่อง
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 Chat ทุกคน

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

สำหรับการเว้นวรรคที่มีอยู่ ช่องนี้เป็นเอาต์พุตเท่านั้น
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 เท่านั้น

spaceUri

string

เอาต์พุตเท่านั้น URI ของพื้นที่ทำงาน

ประเภท

เลิกใช้งานแล้ว: ใช้ 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

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