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,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของพื้นที่ทำงาน

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

โดยที่ {space} แสดงถึงรหัสที่ระบบกำหนดให้กับพื้นที่ทำงาน คุณรับรหัสพื้นที่ทำงานได้โดยเรียกใช้เมธอด spaces.list() หรือจาก URL ของพื้นที่ทำงาน เช่น หาก URL ของพื้นที่ทำงานคือ https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA รหัสพื้นที่ทำงานจะเป็น AAAAAAAAA
type
(deprecated)

enum (Type)

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

enum (SpaceType)

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

boolean

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

boolean

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

string

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

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

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

boolean

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

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

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

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

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

boolean

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

การสร้างพื้นที่ทำงานใน Import Mode ต้องมีการการตรวจสอบสิทธิ์ผู้ใช้
createTime

string (Timestamp format)

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

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

ระบบจะป้อนข้อมูลในเอาต์พุตเมื่อ spaceType เป็น GROUP_CHAT หรือ SPACE เท่านั้น
lastActiveTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาของข้อความล่าสุดในพื้นที่ทำงาน
adminInstalled

boolean

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

แอป Chat ของคุณต้องมีการรับส่งข้อความส่วนตัวเพื่อรองรับการติดตั้งโดยผู้ดูแลระบบ
membershipCount

object (MembershipCount)

เอาต์พุตเท่านั้น จำนวนการเป็นสมาชิกที่เข้าร่วมซึ่งจัดกลุ่มตามประเภทสมาชิก สร้างขึ้นเมื่อ spaceType เป็น SPACE, DIRECT_MESSAGE หรือ GROUP_CHAT
accessSettings

object (AccessSettings)

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

string

เอาต์พุตเท่านั้น URI สำหรับผู้ใช้ในการเข้าถึงพื้นที่ทำงาน
customer

string

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

ในรูปแบบ customers/{customer} โดยที่ customer คือ id จาก [ทรัพยากรลูกค้า Admin SDK]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) นอกจากนี้ แอปส่วนตัวยังใช้อีเมลแทน customers/my_customer เพื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace เดียวกันกับแอปได้ด้วย

ระบบจะไม่ป้อนข้อมูลในช่องนี้สำหรับ DM

ฟิลด์สหภาพ space_permission_settings แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน ระบบจะป้อนข้อมูลเฉพาะเมื่อ space_type เป็น SPACE

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้ space_permission_settings ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

ไม่บังคับ อินพุตเท่านั้น การตั้งค่าสิทธิ์ของพื้นที่ทำงานที่กำหนดไว้ล่วงหน้า ให้ป้อนเฉพาะเมื่อสร้างพื้นที่ทำงานเท่านั้น หากไม่ได้ตั้งค่าช่อง ระบบจะสร้างพื้นที่ทำงานร่วมกัน หลังจากสร้างพื้นที่ทำงานแล้ว ระบบจะป้อนการตั้งค่าในช่อง PermissionSettings
permissionSettings

object (PermissionSettings)

ไม่บังคับ การตั้งค่าสิทธิ์ของพื้นที่ทำงานสำหรับพื้นที่ทำงานที่มีอยู่ อินพุตสำหรับการอัปเดตการตั้งค่าสิทธิ์ของพื้นที่ทำงานที่แน่นอน ซึ่งจะแทนที่การตั้งค่าสิทธิ์ที่มีอยู่ เอาต์พุตจะแสดงการตั้งค่าสิทธิ์ปัจจุบัน

ประเภท

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

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

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 ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาที่จะเก็บรักษาข้อความและชุดข้อความ

MembershipCount

แสดงจํานวนการเป็นสมาชิกของพื้นที่ทํางาน โดยแบ่งออกเป็นหมวดหมู่

การแสดง JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
ช่อง
joinedDirectHumanUserCount

integer

เอาต์พุตเท่านั้น จำนวนผู้ใช้ที่เข้าร่วมพื้นที่ทำงานโดยตรง โดยไม่นับรวมผู้ใช้ที่เข้าร่วมจากการเป็นสมาชิกในกลุ่มที่เข้าร่วม
joinedGroupCount

integer

เอาต์พุตเท่านั้น จำนวนกลุ่มทั้งหมดที่เข้าร่วมพื้นที่ทำงานโดยตรง

AccessSettings

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

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

enum (AccessState)

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

string

ไม่บังคับ ชื่อทรัพยากรของกลุ่มเป้าหมายที่ค้นพบพื้นที่ทำงาน เข้าร่วมพื้นที่ทำงาน และดูตัวอย่างข้อความในพื้นที่ทำงานได้ หากไม่ได้ตั้งค่าไว้ จะมีเพียงผู้ใช้หรือ Google Group ที่ได้รับเชิญหรือเพิ่มไปยังพื้นที่ทำงานทีละคนเท่านั้นที่เข้าถึงพื้นที่ทำงานได้ โปรดดูรายละเอียดที่หัวข้อทําให้พื้นที่ทํางานค้นพบได้ในกลุ่มเป้าหมาย

รูปแบบ: audiences/{audience}

หากต้องการใช้กลุ่มเป้าหมายเริ่มต้นสําหรับองค์กร Google Workspace ให้ตั้งค่าเป็น audiences/default

การอ่านกลุ่มเป้าหมายรองรับการดำเนินการต่อไปนี้

ช่องนี้จะไม่มีข้อมูลเมื่อใช้ขอบเขต chat.bot กับการตรวจสอบสิทธิ์ของแอป

การตั้งค่ากลุ่มเป้าหมายต้องใช้การตรวจสอบสิทธิ์ของผู้ใช้

AccessState

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

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

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

การสร้างพื้นที่ทำงานที่ค้นพบได้ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้

PredefinedPermissionSettings

การตั้งค่าสิทธิ์ที่กำหนดไว้ล่วงหน้าซึ่งคุณจะระบุได้เมื่อสร้างพื้นที่ทำงานที่มีชื่อเท่านั้น ทั้งนี้อาจมีการเพิ่มการตั้งค่าอื่นๆ ในอนาคต ดูรายละเอียดเกี่ยวกับการตั้งค่าสิทธิ์สำหรับพื้นที่ทำงานที่มีชื่อได้ที่หัวข้อดูข้อมูลเกี่ยวกับพื้นที่ทำงาน

Enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED ไม่ระบุ อย่าใช้
COLLABORATION_SPACE การตั้งค่าเพื่อทําให้พื้นที่ทํางานเป็นพื้นที่ทํางานร่วมกันที่สมาชิกทุกคนสามารถโพสต์ข้อความได้
ANNOUNCEMENT_SPACE การตั้งค่าให้พื้นที่ทำงานเป็นพื้นที่ประกาศที่มีเพียงผู้จัดการพื้นที่ทำงานเท่านั้นที่โพสต์ข้อความได้

PermissionSettings

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

หากต้องการตั้งค่าสิทธิ์เมื่อสร้างพื้นที่ทำงาน ให้ระบุช่อง PredefinedPermissionSettings ในคำขอ

การแสดง JSON 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
ช่อง
manageMembersAndGroups

object (PermissionSetting)

ไม่บังคับ การตั้งค่าสำหรับจัดการสมาชิกและกลุ่มในพื้นที่ทำงาน
modifySpaceDetails

object (PermissionSetting)

ไม่บังคับ การตั้งค่าสำหรับการอัปเดตชื่อ รูปโปรไฟล์ คำอธิบาย และหลักเกณฑ์ของพื้นที่ทำงาน
toggleHistory

object (PermissionSetting)

ไม่บังคับ การตั้งค่าสำหรับเปิดและปิดประวัติพื้นที่ทำงาน
useAtMentionAll

object (PermissionSetting)

ไม่บังคับ การตั้งค่าสำหรับการใช้ @all ในพื้นที่ทำงาน
manageApps

object (PermissionSetting)

ไม่บังคับ การตั้งค่าสำหรับการจัดการแอปในพื้นที่ทำงาน
manageWebhooks

object (PermissionSetting)

ไม่บังคับ การตั้งค่าสำหรับการจัดการเว็บฮุคในพื้นที่ทำงาน
postMessages

object (PermissionSetting)

เอาต์พุตเท่านั้น การตั้งค่าสำหรับการโพสต์ข้อความในพื้นที่ทำงาน
replyMessages

object (PermissionSetting)

ไม่บังคับ การตั้งค่าสำหรับการตอบกลับข้อความในพื้นที่ทำงาน

PermissionSetting

แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน

การแสดง JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
ช่อง
managersAllowed

boolean

ไม่บังคับ ผู้จัดการพื้นที่ทำงานมีสิทธิ์นี้หรือไม่
membersAllowed

boolean

ไม่บังคับ สมาชิกที่ไม่ใช่ผู้จัดการมีสิทธิ์นี้หรือไม่

เมธอด

completeImport

 ดำเนินการกระบวนการนําเข้าสําหรับพื้นที่ทำงานที่ระบุให้เสร็จสมบูรณ์และทําให้ผู้ใช้เห็นพื้นที่ทำงานดังกล่าว

create

 สร้างพื้นที่ทำงานที่ไม่มีสมาชิก

delete

 ลบพื้นที่ทำงานที่มีชื่อ

findDirectMessage

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

get

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

list

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

patch

 อัปเดตพื้นที่ทำงาน
แสดงรายการพื้นที่ทำงานในองค์กร Google Workspace ตามการค้นหาของผู้ดูแลระบบ

setup

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