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,
  "importModeExpireTime": 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

ไม่บังคับ ไม่ว่าจะเป็นข้อความส่วนตัวระหว่างแอป 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 สำหรับผู้ใช้ในการเข้าถึงพื้นที่ทำงาน
importModeExpireTime

string (Timestamp format)

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

พื้นที่ทำงานแต่ละรายการที่สร้างในโหมดการนำเข้าจะต้องออกจากโหมดนี้ก่อนเวลาหมดอายุโดยใช้ spaces.completeImport

ระบบจะป้อนข้อมูลในช่องนี้เฉพาะสำหรับพื้นที่ทำงานที่สร้างขึ้นด้วยโหมดการนำเข้าเท่านั้น
customer

string

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

ในรูปแบบ customers/{customer} โดยที่ customer คือ id จากแหล่งข้อมูลลูกค้าของ Admin SDK แอปส่วนตัวยังใช้customers/my_customerแทนชื่อจริงเพื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace เดียวกันกับแอปได้ด้วย

สำหรับ DM ระบบจะไม่ป้อนข้อมูลในช่องนี้
ฟิลด์ Union 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 ซึ่งข้อความทั้งหมดเป็นแบบเรียบ โปรดทราบว่าการดำเนินการนี้ไม่รวมถึงข้อความส่วนตัวระหว่างบุคคล 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 ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาที่จะเก็บรักษาข้อความและเธรด

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)

ไม่บังคับ การตั้งค่าสำหรับการใช้ @ทั้งหมด ในพื้นที่ทำงาน
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

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