Package google.chat.v1

ดัชนี

ChatService

ช่วยให้นักพัฒนาแอปสร้างแอปใน Chat และการผสานรวมในแพลตฟอร์ม Google Chat ได้

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

ต้องใช้การตรวจสอบสิทธิ์ของแอปและการมอบสิทธิ์ทั่วทั้งโดเมน โปรดดูข้อมูลเพิ่มเติมที่หัวข้อให้สิทธิ์แอปใน Google Chat ในการนําเข้าข้อมูล

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.import

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

สร้างอีโมจิที่กำหนดเอง

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ดูตัวอย่างการใช้งานได้ที่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

สร้างข้อความในพื้นที่ใน Google Chat โปรดดูตัวอย่างที่หัวข้อส่งข้อความ

วิธีการ create() กำหนดให้ต้องตรวจสอบสิทธิ์ผู้ใช้หรือตรวจสอบสิทธิ์แอป Chat จะระบุแอตทริบิวต์ของผู้ส่งข้อความแตกต่างกันไปตามประเภทการตรวจสอบสิทธิ์ที่คุณใช้ในคำขอ

รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์ของแอป Chat จะแสดงแอป Chat เป็นผู้ส่งข้อความ เนื้อหาของข้อความอาจมีข้อความ (text), การ์ด (cardsV2) และสิ่งเสริมต่างๆ (accessoryWidgets)

ข้อความที่ส่งพร้อมการตรวจสอบสิทธิ์แอป

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

ข้อความที่ส่งด้วยการตรวจสอบสิทธิ์ผู้ใช้

ขนาดสูงสุดของข้อความรวมถึงเนื้อหาของข้อความคือ 32,000 ไบต์

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

สร้างรีแอ็กชันและเพิ่มลงในข้อความ รองรับเฉพาะอีโมจิ Unicode เท่านั้น ดูตัวอย่างได้ที่เพิ่มความรู้สึกที่มีต่อข้อความ

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

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

หากคุณเป็นสมาชิกโปรแกรมทดลองใช้สำหรับนักพัฒนาซอฟต์แวร์ คุณจะสร้างแชทเป็นกลุ่มในโหมดนำเข้าได้โดยใช้ spaceType.GROUP_CHAT

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

เมื่อมีการตรวจสอบสิทธิ์เป็นแอป ต้องตั้งค่าช่อง space.customer ในคำขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

ลบอีโมจิที่กำหนดเอง

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

ลบข้อความ โปรดดูตัวอย่างที่หัวข้อลบข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

ลบความรู้สึกที่มีต่อข้อความ ระบบรองรับเฉพาะอีโมจิแบบ Unicode เท่านั้น โปรดดูตัวอย่างที่หัวข้อลบความรู้สึก

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

แสดงข้อความส่วนตัวที่มีอยู่กับผู้ใช้ที่ระบุ หากไม่พบพื้นที่ข้อความส่วนตัว จะแสดงผลข้อผิดพลาด 404 NOT_FOUND ดูตัวอย่างได้ที่ค้นหาข้อความส่วนตัว

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

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

// รองรับ authentication ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

รับข้อมูลเมตาของไฟล์แนบของข้อความ ระบบจะดึงข้อมูลไฟล์แนบโดยใช้ media API โปรดดูตัวอย่างที่หัวข้อรับข้อมูลเมตาเกี่ยวกับไฟล์แนบของข้อความ ต้องใช้การตรวจสอบสิทธิ์แอป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

แสดงรายละเอียดเกี่ยวกับอีโมจิที่กำหนดเอง

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

แสดงรายละเอียดเกี่ยวกับการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Google Chat

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

แสดงรายละเอียดเกี่ยวกับข้อความ โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

หมายเหตุ: ฟิลด์ permissionSettings จะไม่แสดงผลในออบเจ็กต์ Space ของข้อมูลเหตุการณ์ Space สำหรับคำขอนี้

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

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

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.spacesettings

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

แสดงผลรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่ได้อ่าน โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับสถานะการอ่านชุดข้อความของผู้ใช้

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

แสดงรายการอีโมจิที่กำหนดเองที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์มองเห็นได้

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

แสดงรายการความรู้สึกที่มีต่อข้อความ ตัวอย่างเช่น ดูแสดงความรู้สึกต่อข้อความ

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ หากต้องการแสดงรายการกิจกรรม ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วต้องเป็นสมาชิกของสเปซ

โปรดดูตัวอย่างที่หัวข้อแสดงรายการเหตุการณ์จากพื้นที่ทำงานใน Google Chat

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

หากต้องการแสดงรายการพื้นที่ทำงานที่มีชื่อทั้งหมดตามองค์กร Google Workspace ให้ใช้เมธอด spaces.search() โดยใช้สิทธิ์ของผู้ดูแลระบบ Workspace แทน

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบ ในคำขอ ให้ตั้งค่า use_admin_access เป็น true

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

หากต้องการระบุสมาชิกที่เป็นบุคคลที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย membership.member.name ที่เหมาะสม หากต้องการเพิ่มผู้ใช้ที่เป็นมนุษย์ ให้ใช้ users/{user} โดย {user} สามารถเป็นอีเมลของผู้ใช้ได้ สำหรับผู้ใช้ในองค์กร Workspace เดียวกัน {user} สามารถเป็น id สำหรับบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ได้ด้วย ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลของ user@example.com ใน People API คือ 123456789 คุณจะเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยตั้งค่า membership.member.name เป็น users/user@example.com หรือ users/123456789

หากต้องการระบุกลุ่ม Google ที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย membership.group_member.name ที่เหมาะสม หากต้องการเพิ่มหรือเชิญกลุ่ม Google ให้ใช้ groups/{group} โดยที่ {group} เป็น id ของกลุ่มจาก Cloud Identity Groups API เช่น คุณสามารถใช้ Cloud Identity Groups lookup API เพื่อเรียกข้อมูลรหัส 123456789 สำหรับอีเมลกลุ่ม group@example.com จากนั้นเพิ่มกลุ่มลงในพื้นที่ทำงานได้โดยตั้งค่า membership.group_member.name เป็น groups/123456789 ไม่รองรับอีเมลกลุ่ม และเพิ่ม Google Groups เป็นสมาชิกได้เฉพาะในพื้นที่ทำงานที่ตั้งชื่อเท่านั้น

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

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

หากต้องการสร้าง DM ระหว่างผู้ใช้ที่โทรและแอปการโทร ให้ตั้งค่า Space.singleUserBotDm เป็น true และไม่ต้องระบุการเป็นสมาชิกใดๆ คุณสามารถใช้วิธีนี้เพื่อตั้งค่า DM ด้วยแอปการโทรเท่านั้น หากต้องการเพิ่มแอปการโทรเป็นสมาชิกของพื้นที่ทำงานหรือ DM ที่มีอยู่ระหว่างผู้ใช้ที่เป็นมนุษย์ 2 คน โปรดดูหัวข้อเชิญหรือเพิ่มผู้ใช้หรือแอปในพื้นที่ทำงาน

หากมี DM ระหว่างผู้ใช้ 2 คนอยู่แล้ว แม้ว่าผู้ใช้คนหนึ่งบล็อกอีกคนในขณะที่ส่งคำขอ ระบบจะส่ง DM เดิมกลับมา

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

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

อัปเดตการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้ออัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ทำงาน

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

อัปเดตข้อความ มีความแตกต่างระหว่างเมธอด patch และ update เมธอด patch ใช้คำขอ patch ขณะที่เมธอด update ใช้คำขอ put เราขอแนะนำให้ใช้วิธีการ patch ดูตัวอย่างได้ที่อัปเดตข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

อัปเดตพื้นที่ทำงาน โปรดดูตัวอย่างที่หัวข้ออัปเดตพื้นที่ทำงาน

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.spacesettings

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

AccessoryWidget

วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 1 รายการซึ่งปรากฏที่ด้านล่างของข้อความ โปรดดูรายละเอียดที่หัวข้อเพิ่มวิดเจ็ตแบบอินเทอร์แอกทีฟที่ด้านล่างของข้อความ

ช่อง
ช่องการรวม action ประเภทการดําเนินการ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
button_list

ButtonList

รายการปุ่ม

ActionResponse

พารามิเตอร์ที่แอปใน Chat ใช้ในการกำหนดค่าวิธีโพสต์คำตอบได้

ช่อง
type

ResponseType

อินพุตเท่านั้น ประเภทการตอบกลับของแอป Chat
url

string

อินพุตเท่านั้น URL สำหรับให้ผู้ใช้ตรวจสอบสิทธิ์หรือกําหนดค่า (สำหรับการตอบกลับ REQUEST_CONFIG ประเภทเท่านั้น)
dialog_action

DialogAction

อินพุตเท่านั้น การตอบกลับเหตุการณ์การโต้ตอบที่เกี่ยวข้องกับกล่องโต้ตอบ ต้องมาพร้อมกับ ResponseType.Dialog
updated_widget

UpdatedWidget

อินพุตเท่านั้น การตอบสนองของวิดเจ็ตที่อัปเดต

ResponseType

ประเภทการตอบกลับของแอป Chat

Enum
TYPE_UNSPECIFIED ประเภทเริ่มต้นที่จัดการเป็น NEW_MESSAGE
NEW_MESSAGE โพสต์เป็นข้อความใหม่ในหัวข้อ
UPDATE_MESSAGE อัปเดตข้อความของแอป Chat การตั้งค่านี้ใช้ได้เฉพาะในเหตุการณ์ CARD_CLICKED ซึ่งประเภทผู้ส่งข้อความคือ BOT
UPDATE_USER_MESSAGE_CARDS อัปเดตการ์ดในข้อความของผู้ใช้ การดำเนินการนี้จะใช้เป็นการตอบกลับกิจกรรม MESSAGE ที่มี URL ที่ตรงกัน หรือเหตุการณ์ CARD_CLICKED ที่มีประเภทผู้ส่งข้อความเป็น HUMAN เท่านั้น ระบบจะไม่สนใจข้อความ
REQUEST_CONFIG ขอการตรวจสอบสิทธิ์หรือการกำหนดค่าเพิ่มเติมจากผู้ใช้แบบส่วนตัว
DIALOG แสดงกล่องโต้ตอบ
UPDATE_WIDGET การค้นหาตัวเลือกการเติมข้อความอัตโนมัติของวิดเจ็ต

SelectionItems

รายการผลการเติมข้อความอัตโนมัติของวิดเจ็ต

ช่อง
items[]

SelectionItem

อาร์เรย์ของออบเจ็กต์ SelectionItem

UpdatedWidget

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

ช่อง
widget

string

รหัสของวิดเจ็ตที่อัปเดต รหัสต้องตรงกับรหัสของวิดเจ็ตที่เรียกใช้คำขออัปเดต
ช่องการรวม updated_widget วิดเจ็ตอัปเดตตามการดําเนินการของผู้ใช้ updated_widget ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
suggestions

SelectionItems

รายการผลการเติมข้อความอัตโนมัติของวิดเจ็ต

ActionStatus

แสดงสถานะของคำขอที่จะเรียกใช้หรือส่งกล่องโต้ตอบ

ช่อง
status_code

Code

รหัสสถานะ
user_facing_message

string

ข้อความที่จะส่งให้ผู้ใช้เกี่ยวกับสถานะคำขอ หากไม่ได้ตั้งค่า ระบบจะส่งข้อความทั่วไปตาม status_code

หมายเหตุ

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

ตัวอย่างเนื้อหาข้อความธรรมดา

Hello @FooBot how are you!"

ข้อมูลเมตาของคำอธิบายประกอบที่เกี่ยวข้องมีดังนี้

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
ช่อง
type

AnnotationType

ประเภทของคำอธิบายประกอบนี้
length

int32

ความยาวของสตริงย่อยในเนื้อหาข้อความข้อความธรรมดาที่สอดคล้องกับคำอธิบายประกอบนี้
start_index

int32

ดัชนีเริ่มต้น (แบบ 0 รวม) ในเนื้อหาข้อความข้อความธรรมดาที่สอดคล้องกับคำอธิบายประกอบนี้
ฟิลด์สหภาพ metadata ข้อมูลเมตาเพิ่มเติมเกี่ยวกับคำอธิบายประกอบ metadata ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
user_mention

UserMentionMetadata

ข้อมูลเมตาของการพูดถึงผู้ใช้
slash_command

SlashCommandMetadata

ข้อมูลเมตาสำหรับคำสั่งเครื่องหมายทับ

AnnotationType

ประเภทของคำอธิบายประกอบ

Enum
ANNOTATION_TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้
USER_MENTION มีการพูดถึงผู้ใช้
SLASH_COMMAND ระบบเรียกใช้คำสั่งเครื่องหมายทับ

AttachedGif

รูปภาพ GIF ที่ระบุโดย URL

ช่อง
uri

string

เอาต์พุตเท่านั้น URL ที่โฮสต์รูปภาพ GIF

ไฟล์แนบ

ไฟล์แนบใน Google Chat

ช่อง
name

string

ชื่อทรัพยากรของไฟล์แนบในรูปแบบ spaces/{space}/messages/{message}/attachments/{attachment}
content_name

string

เอาต์พุตเท่านั้น ชื่อไฟล์ต้นฉบับของเนื้อหา ไม่ใช่เส้นทางแบบเต็ม
content_type

string

เอาต์พุตเท่านั้น ประเภทเนื้อหา (ประเภท MIME) ของไฟล์
thumbnail_uri

string

เอาต์พุตเท่านั้น URL ของภาพขนาดย่อซึ่งควรใช้ในการแสดงพรีวิวไฟล์แนบให้กับผู้ใช้ที่เป็นมนุษย์ แอปรับส่งข้อความไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ
download_uri

string

เอาต์พุตเท่านั้น URL การดาวน์โหลดที่ควรใช้เพื่อให้ผู้ใช้ดาวน์โหลดไฟล์แนบได้ แอปรับส่งข้อความไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ
source

Source

เอาต์พุตเท่านั้น แหล่งที่มาของไฟล์แนบ
ช่องการรวม data_ref การอ้างอิงข้อมูลไปยังไฟล์แนบ data_ref ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
attachment_data_ref

AttachmentDataRef

การอ้างอิงข้อมูลไฟล์แนบ ช่องนี้ใช้กับ API สื่อเพื่อดาวน์โหลดข้อมูลไฟล์แนบ
drive_data_ref

DriveDataRef

เอาต์พุตเท่านั้น การอ้างอิงไฟล์แนบ Google ไดรฟ์ ช่องนี้ใช้กับ Google Drive API

แหล่งที่มา

แหล่งที่มาของไฟล์แนบ

Enum
SOURCE_UNSPECIFIED สงวนไว้
DRIVE_FILE ไฟล์เป็นไฟล์ Google ไดรฟ์
UPLOADED_CONTENT ระบบจะอัปโหลดไฟล์ไปยัง Chat

AttachmentDataRef

การอ้างอิงข้อมูลไฟล์แนบ

ช่อง
resource_name

string

ชื่อทรัพยากรของข้อมูลไฟล์แนบ ฟิลด์นี้ใช้กับ Media API เพื่อดาวน์โหลดข้อมูลไฟล์แนบ
attachment_upload_token

string

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

CardWithId

การ์ดในข้อความ Google Chat

มีเพียงแอปใน Chat เท่านั้นที่สามารถสร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ ข้อความจะไม่มีการ์ด

ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด

เปิดเครื่องมือสร้างการ์ด

ช่อง
card_id

string

ต้องระบุหากข้อความมีการ์ดหลายใบ ตัวระบุที่ไม่ซ้ำกันสำหรับการ์ดในข้อความ
card

Card

การ์ด ขนาดสูงสุดคือ 32 KB

ChatSpaceLinkData

ข้อมูลสำหรับลิงก์พื้นที่ใน Chat

ช่อง
space

string

พื้นที่ของทรัพยากรพื้นที่ใน Chat ที่ลิงก์

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

string

ชุดข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์ไว้

รูปแบบ: spaces/{space}/threads/{thread}
message

string

ข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์

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

CompleteImportSpaceRequest

ข้อความคำขอสำหรับการนำเข้าพื้นที่ทำงานให้เสร็จสมบูรณ์

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานโหมดการนำเข้า

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

CompleteImportSpaceResponse

ข้อความตอบกลับสำหรับกระบวนการนำเข้าพื้นที่ทำงานที่เสร็จสมบูรณ์

ช่อง
space

Space

พื้นที่ทำงานโหมดการนำเข้า

ContextualAddOnMarkup

ประเภทนี้ไม่มีช่อง

มาร์กอัปสำหรับนักพัฒนาซอฟต์แวร์เพื่อระบุเนื้อหาของส่วนเสริมตามบริบท

การ์ด

การ์ดคือองค์ประกอบ UI ที่สามารถประกอบด้วยวิดเจ็ต UI เช่น ข้อความและรูปภาพ

ช่อง
header

CardHeader

ส่วนหัวของการ์ด โดยทั่วไปส่วนหัวจะมีชื่อและรูปภาพ
sections[]

Section

ส่วนต่างๆ จะคั่นด้วยเส้นแบ่ง
card_actions[]

CardAction

การดำเนินการของการ์ดนี้
name

string

ชื่อของการ์ด

CardAction

การดําเนินการของการ์ดคือการดําเนินการที่เกี่ยวข้องกับการ์ด สําหรับการ์ดใบแจ้งหนี้ การดําเนินการทั่วไป ได้แก่ ลบใบแจ้งหนี้ ส่งใบแจ้งหนี้ทางอีเมล หรือเปิดใบแจ้งหนี้ในเบราว์เซอร์

แอป Google Chat ไม่รองรับ

ช่อง
action_label

string

ป้ายกำกับที่ใช้ในรายการเมนูการทำงาน
on_click

OnClick

การดำเนินการ onclick สำหรับรายการการทำงานนี้

CardHeader

ช่อง
title

string

ต้องระบุชื่อ ส่วนหัวมีความสูงคงที่: หากระบุทั้งชื่อและคำบรรยาย แต่ละรายการจะใช้พื้นที่ 1 บรรทัด หากระบุเฉพาะชื่อ ชื่อนั้นจะกินพื้นที่ทั้ง 2 บรรทัด
subtitle

string

คำบรรยายของส่วนหัวของการ์ด
image_style

ImageStyle

ประเภทของรูปภาพ (เช่น เส้นขอบสี่เหลี่ยมจัตุรัสหรือเส้นขอบกลม)
image_url

string

URL ของรูปภาพในส่วนหัวของการ์ด

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE เส้นขอบสี่เหลี่ยมจัตุรัส
AVATAR เส้นขอบวงกลม

ส่วน

ส่วนจะประกอบด้วยคอลเลกชันของวิดเจ็ตที่แสดงผล (แนวตั้ง) ตามลำดับที่ระบุไว้ การ์ดในทุกแพลตฟอร์มมีความกว้างคงที่แคบ จึงไม่จำเป็นต้องใช้พร็อพเพอร์ตี้เลย์เอาต์ (เช่น ลอย) ในตอนนี้

ช่อง
header

string

ส่วนหัวของส่วน รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
widgets[]

WidgetMarkup

ส่วนต้องมีวิดเจ็ตอย่างน้อย 1 รายการ

CreateCustomEmojiRequest

คำขอสร้างอีโมจิที่กำหนดเอง

ช่อง
custom_emoji

CustomEmoji

ต้องระบุ อีโมจิที่กำหนดเองสำหรับสร้าง

CreateMembershipRequest

ข้อความขอสร้างการเป็นสมาชิก

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก

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

Membership

ต้องระบุ ความสัมพันธ์กับการเป็นสมาชิกที่ต้องการสร้าง

ช่อง memberType ต้องมีผู้ใช้ที่มีการป้อนข้อมูลในช่อง user.name และ user.type เซิร์ฟเวอร์จะกำหนดชื่อทรัพยากรและเขียนทับข้อมูลทั้งหมดที่ระบุ

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

  • เมื่อตรวจสอบสิทธิ์ในฐานะผู้ใช้ คุณต้องใช้ขอบเขตการให้สิทธิ์ chat.memberships

  • เมื่อตรวจสอบสิทธิ์เป็นแอป คุณต้องใช้ขอบเขตการให้สิทธิ์ chat.app.memberships การตรวจสอบสิทธิ์ในฐานะแอปพร้อมใช้งานใน

  • ตั้งค่า user.type เป็น HUMAN และตั้งค่า user.name ด้วยรูปแบบ users/{user} โดยที่ {user} จะเป็นอีเมลของผู้ใช้ สําหรับผู้ใช้ในองค์กร Workspace เดียวกัน {user} อาจเป็น id ของบุคคลจาก People API หรือ id ของผู้ใช้ใน Directory API ก็ได้ ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลของ People API สำหรับ user@example.com คือ 123456789 คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยตั้งค่า membership.member.name เป็น users/user@example.com หรือ users/123456789

เมื่อแอป Chat สร้างความสัมพันธ์การเป็นสมาชิกของตนเอง จะต้องตรวจสอบสิทธิ์ในฐานะผู้ใช้] และใช้ขอบเขต chat.memberships.app, ตั้งค่า user.type เป็น BOT และตั้งค่า user.name เป็น users/app
use_admin_access

bool

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 ของ chat.admin.memberships

ระบบไม่รองรับการสร้างการเป็นสมาชิกแอปหรือการสร้างการเป็นสมาชิกสำหรับผู้ใช้ภายนอกองค์กร Google Workspace ของผู้ดูแลระบบโดยใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ

CreateMessageRequest

สร้างข้อความ

ช่อง
parent

string

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

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

Message

ต้องระบุ เนื้อหาข้อความ
thread_key
(deprecated)

string

ไม่บังคับ เลิกใช้งานแล้ว: ให้ใช้ thread.thread_key แทน รหัสของชุดข้อความ รองรับอักขระได้สูงสุด 4,000 ตัว หากต้องการเริ่มหรือเพิ่มชุดข้อความ ให้สร้างข้อความและระบุ threadKey หรือ thread.name เช่น การใช้งานที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ
request_id

string

ไม่บังคับ รหัสคำขอที่ไม่ซ้ำกันสำหรับข้อความนี้ การระบุรหัสคำขอที่มีอยู่จะแสดงข้อความที่สร้างด้วยรหัสนั้นแทนการสร้างข้อความใหม่
message_reply_option

MessageReplyOption

ไม่บังคับ ระบุว่าข้อความเริ่มต้นชุดข้อความหรือตอบกลับ รองรับเฉพาะในพื้นที่ทํางานที่มีชื่อเท่านั้น
message_id

string

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

ค่าของช่องนี้ต้องเป็นไปตามข้อกำหนดต่อไปนี้

  • ขึ้นต้นด้วย client- ตัวอย่างเช่น client-custom-name เป็นรหัสที่กำหนดเองที่ถูกต้อง แต่ custom-name ไม่ใช่รหัสที่กำหนดเอง
  • มีอักขระได้สูงสุด 63 ตัว และประกอบด้วยตัวอักษรพิมพ์เล็ก ตัวเลข และขีดกลางเท่านั้น
  • ไม่ซ้ำกันภายในพื้นที่ทำงาน แอป Chat ไม่สามารถใช้รหัสที่กำหนดเองเดียวกันสำหรับข้อความที่แตกต่างกัน

โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ

MessageReplyOption

ระบุวิธีตอบกลับข้อความ อาจมีการเพิ่มรัฐอื่นๆ ในอนาคต

Enum
MESSAGE_REPLY_OPTION_UNSPECIFIED ค่าเริ่มต้น เริ่มชุดข้อความใหม่ การใช้ตัวเลือกนี้ไม่สนใจ thread ID หรือ thread_key ที่รวมไว้
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD สร้างข้อความเป็นการตอบกลับชุดข้อความที่ระบุโดย thread ID หรือ thread_key หากไม่สำเร็จ ข้อความจะเริ่มชุดข้อความใหม่แทน
REPLY_MESSAGE_OR_FAIL สร้างข้อความเป็นการตอบกลับชุดข้อความที่ระบุโดย thread ID หรือ thread_key หากใช้ thread_key ใหม่ ระบบจะสร้างชุดข้อความใหม่ หากสร้างข้อความไม่สำเร็จ ระบบจะแสดงข้อผิดพลาด NOT_FOUND แทน

CreateReactionRequest

สร้างรีแอ็กชันต่อข้อความ

ช่อง
parent

string

ต้องระบุ ข้อความที่สร้างความรู้สึก

รูปแบบ: spaces/{space}/messages/{message}
reaction

Reaction

ต้องระบุ รีแอ็กชันที่จะสร้าง

CreateSpaceRequest

คำขอสร้างพื้นที่ทำงานที่มีชื่อแต่ไม่มีสมาชิก

ช่อง
space

Space

ต้องระบุ ต้องป้อนข้อมูลในช่อง displayName และ spaceType รองรับเฉพาะ SpaceType.SPACE เท่านั้น

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

หากคุณเป็นสมาชิกโปรแกรมทดลองใช้สำหรับนักพัฒนาซอฟต์แวร์ คุณจะใช้ SpaceType.GROUP_CHAT ได้หากตั้งค่า importMode เป็น "จริง"

มีการกำหนดพื้นที่ name บนเซิร์ฟเวอร์ ดังนั้นสิ่งที่ระบุไว้ในช่องนี้จะถูกละเว้น
request_id

string

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

CustomEmoji

แสดงอีโมจิที่กำหนดเอง

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของอีโมจิที่กำหนดเองซึ่งเซิร์ฟเวอร์กำหนด

รูปแบบ: customEmojis/{customEmoji}

uid

string

เอาต์พุตเท่านั้น คีย์ที่ไม่ซ้ำกันสำหรับแหล่งข้อมูลอีโมจิที่กำหนดเอง
emoji_name

string

เปลี่ยนแปลงไม่ได้ ชื่อที่ผู้ใช้ระบุสำหรับอีโมจิที่กำหนดเอง ซึ่งต้องไม่ซ้ำกันภายในองค์กร

ต้องระบุเมื่อสร้างอีโมจิที่กำหนดเอง ไม่เช่นนั้นให้แสดงผลเท่านั้น

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

ตัวอย่าง: :valid-emoji-name:

temporary_image_uri

string

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

payload

CustomEmojiPayload

อินพุตเท่านั้น ข้อมูลเพย์โหลด

CustomEmojiPayload

ข้อมูลเพย์โหลดสำหรับอีโมจิที่กำหนดเอง

ช่อง
file_content

bytes

ต้องระบุ อินพุตเท่านั้น รูปภาพที่ใช้สำหรับอีโมจิที่กำหนดเอง

เพย์โหลดต้องมีขนาดไม่เกิน 256 KB และต้องมีขนาดของรูปภาพอยู่ระหว่าง 64 ถึง 500 พิกเซล ข้อจำกัดเหล่านี้อาจมีการเปลี่ยนแปลง
filename

string

ต้องระบุ อินพุตเท่านั้น ชื่อไฟล์ภาพ

นามสกุลไฟล์ที่รองรับ: .png, .jpg, .gif

DeleteCustomEmojiRequest

คำขอลบอีโมจิที่กำหนดเอง

ช่อง
name

string

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

รูปแบบ: customEmojis/{customEmoji}

คุณสามารถใช้ชื่ออีโมจิเป็นชื่อแทนสำหรับ {customEmoji} ได้ เช่น customEmojis/:example-emoji: โดยที่ :example-emoji: คือชื่ออีโมจิสำหรับอีโมจิที่กำหนดเอง

DeleteMembershipRequest

คำขอลบการเป็นสมาชิกในพื้นที่ทำงาน

ช่อง
name

string

ต้องระบุ ชื่อแหล่งข้อมูลของการเป็นสมาชิกที่จะลบ แอปแชทสามารถลบผู้ใช้ที่เป็นมนุษย์หรือการเป็นสมาชิกของตนเอง แอป Chat จะลบการเป็นสมาชิกของแอปอื่นๆ ไม่ได้

เมื่อลบการเป็นสมาชิกที่เป็นมนุษย์ จะต้องมีขอบเขต chat.memberships และรูปแบบ spaces/{space}/members/{member} คุณสามารถใช้อีเมลดังกล่าวเป็นอีเมลแทนของ {member} ได้ เช่น spaces/{space}/members/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat

เมื่อลบการเป็นสมาชิกแอป จะต้องมีขอบเขต chat.memberships.app และรูปแบบ spaces/{space}/members/app

รูปแบบ: spaces/{space}/members/{member} หรือ spaces/{space}/members/app
use_admin_access

bool

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 ของ chat.admin.memberships

ระบบไม่รองรับการลบการเป็นสมาชิกแอปในพื้นที่ทำงานโดยใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ

DeleteMessageRequest

ขอให้ลบข้อความ

ช่อง
name

string

ต้องระบุ ชื่อแหล่งข้อมูลของข้อความ

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

หากตั้งค่ารหัสที่กำหนดเองสำหรับข้อความไว้ คุณจะใช้ค่าจากฟิลด์ clientAssignedMessageId สำหรับ {message} ได้ โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
force

bool

เมื่อ true การลบข้อความจะลบการตอบกลับแบบแยกชุดข้อความของข้อความนั้นด้วย เมื่อ false ถ้าข้อความมีการตอบกลับแบบแยกชุดข้อความ การลบจะไม่สำเร็จ

ใช้ได้เมื่อตรวจสอบสิทธิ์ในฐานะผู้ใช้เท่านั้น จะไม่มีผลเมื่อตรวจสอบสิทธิ์เป็นแอป Chat

DeleteReactionRequest

ลบรีแอ็กชันต่อข้อความ

ช่อง
name

string

ต้องระบุ ชื่อของรีแอ็กชันที่จะลบ

รูปแบบ: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

คำขอลบพื้นที่ทำงาน

ช่อง
name

string

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

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

bool

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้chat.admin.deleteขอบเขต OAuth 2.0

DeletionMetadata

ข้อมูลเกี่ยวกับข้อความที่ถูกลบ ระบบจะลบข้อความเมื่อตั้งค่าเป็น delete_time

ช่อง
deletion_type

DeletionType

บ่งบอกว่าใครลบข้อความ

DeletionType

ใครเป็นผู้ลบข้อความและวิธีการลบ อาจมีการเพิ่มค่าอื่นๆ ในอนาคต

Enum
DELETION_TYPE_UNSPECIFIED ค่านี้ไม่ได้ใช้งาน
CREATOR ผู้ใช้ลบข้อความของตนเองแล้ว
SPACE_OWNER เจ้าของพื้นที่ทำงานลบข้อความแล้ว
ADMIN ผู้ดูแลระบบ Google Workspace ได้ลบข้อความดังกล่าวแล้ว
APP_MESSAGE_EXPIRY แอป Chat ลบข้อความของตัวเองเมื่อข้อความหมดอายุ
CREATOR_VIA_APP แอป Chat ลบข้อความในนามของผู้ใช้
SPACE_OWNER_VIA_APP แอป Chat ลบข้อความในนามของเจ้าของพื้นที่ทำงาน

Dialog

Wrapper ของเนื้อหาการ์ดของกล่องโต้ตอบ

ช่อง
body

Card

อินพุตเท่านั้น เนื้อความของกล่องโต้ตอบซึ่งแสดงผลในโมดอล แอป Google Chat ไม่รองรับเอนทิตีการ์ดต่อไปนี้ DateTimePicker, OnChangeAction

DialogAction

มีกล่องโต้ตอบและรหัสสถานะคำขอ

ช่อง
action_status

ActionStatus

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

Dialog

อินพุตเท่านั้น กล่องโต้ตอบสําหรับคําขอ

DriveDataRef

การอ้างอิงข้อมูลของไฟล์แนบในไดรฟ์

ช่อง
drive_file_id

string

รหัสสำหรับไฟล์ในไดรฟ์ ใช้กับ Drive API

DriveLinkData

ข้อมูลสำหรับลิงก์ Google ไดรฟ์

ช่อง
drive_data_ref

DriveDataRef

DriveDataRef ที่อ้างอิงไฟล์ Google ไดรฟ์
mime_type

string

ประเภท MIME ของทรัพยากร Google ไดรฟ์ที่ลิงก์

อีโมจิ

อีโมจิที่ใช้แสดงความรู้สึกต่อข้อความ

ช่อง
ฟิลด์สหภาพ content เนื้อหาของอีโมจิ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
unicode

string

อีโมจิพื้นฐานที่แสดงด้วยสตริง Unicode
custom_emoji

CustomEmoji

เอาต์พุตเท่านั้น อีโมจิที่กำหนดเอง

EmojiReactionSummary

จำนวนผู้ที่แสดงความรู้สึกต่อข้อความด้วยอีโมจิที่เจาะจง

ช่อง
emoji

Emoji

อีโมจิที่เกี่ยวข้องกับรีแอ็กชัน
reaction_count

int32

จำนวนรีแอ็กชันทั้งหมดที่ใช้อีโมจิที่เกี่ยวข้อง

FindDirectMessageRequest

คำขอรับพื้นที่ทำงานของข้อความส่วนตัวตามทรัพยากรของผู้ใช้

ช่อง
name

string

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

รูปแบบ: users/{user} โดยที่ {user} เป็น id สำหรับบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ตัวอย่างเช่น หากรหัสโปรไฟล์ของ People API คือ 123456789 คุณจะค้นหาข้อความส่วนตัวกับบุคคลดังกล่าวได้โดยใช้ users/123456789 เป็น name เมื่อตรวจสอบสิทธิ์เป็นผู้ใช้แล้ว คุณจะใช้อีเมลดังกล่าวเป็นอีเมลแทนสำหรับ {user} ได้ เช่น users/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat

GetAttachmentRequest

ส่งคำขอรับไฟล์แนบ

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของไฟล์แนบในรูปแบบ spaces/{space}/messages/{message}/attachments/{attachment}

GetCustomEmojiRequest

คำขอแสดงอีโมจิที่กำหนดเองรายการเดียว

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของอีโมจิที่กำหนดเอง

รูปแบบ: customEmojis/{customEmoji}

คุณสามารถใช้ชื่ออีโมจิเป็นชื่อแทนสำหรับ {customEmoji} ได้ เช่น customEmojis/:example-emoji: โดยที่ :example-emoji: เป็นชื่ออีโมจิสำหรับอีโมจิที่กำหนดเอง

GetMembershipRequest

ขอเป็นสมาชิกของพื้นที่ทำงาน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่จะดึงข้อมูล

หากต้องการสมัครสมาชิกของแอปเองโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะเลือกใช้ spaces/{space}/members/app ก็ได้

รูปแบบ: spaces/{space}/members/{member} หรือ spaces/{space}/members/app

คุณสามารถใช้อีเมลของผู้ใช้เป็นอีเมลแทนสำหรับ {member} ได้ เช่น spaces/{space}/members/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat
use_admin_access

bool

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships หรือ chat.admin.memberships.readonly

ไม่รองรับการเป็นสมาชิกแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ

GetMessageRequest

ส่งคำขอรับข้อความ

ช่อง
name

string

ต้องระบุ ชื่อแหล่งข้อมูลของข้อความ

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

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

GetSpaceEventRequest

ข้อความขอรับกิจกรรมในพื้นที่ทำงาน

ช่อง
name

string

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

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

GetSpaceNotificationSettingRequest

ส่งคำขอข้อความเพื่อรับการตั้งค่าการแจ้งเตือนในพื้นที่ทำงาน รองรับเฉพาะการตั้งค่าการแจ้งเตือนสำหรับผู้ใช้ที่โทร

ช่อง
name

string

ต้องระบุ รูปแบบ: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting หรือ
  • users/user@example.com/spaces/{space}/spaceNotificationSetting หรือ
  • users/123456789/spaces/{space}/spaceNotificationSetting หมายเหตุ: ระบบอนุญาตเฉพาะรหัสผู้ใช้หรืออีเมลของผู้ใช้เท่านั้นในเส้นทาง

GetSpaceReadStateRequest

ข้อความคําขอสําหรับ GetSpaceReadState API

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านพื้นที่ทำงานที่จะดึงข้อมูล

รองรับเฉพาะการดูสถานะการอ่านสำหรับผู้ใช้ที่โทรเท่านั้น

หากต้องการอ้างอิงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้

  • ชื่อแทน me เช่น users/me/spaces/{space}/spaceReadState

  • อีเมล Workspace ของผู้ใช้ เช่น users/user@example.com/spaces/{space}/spaceReadState

  • รหัสผู้ใช้ เช่น users/123456789/spaces/{space}/spaceReadState

รูปแบบ: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

คำขอแสดงผลพื้นที่ทำงานเดียว

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานในรูปแบบ spaces/{space}

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

bool

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.spaces หรือ chat.admin.spaces.readonly

GetThreadReadStateRequest

ข้อความคําขอสําหรับ GetThreadReadStateRequest API

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านชุดข้อความที่จะดึงข้อมูล

รองรับเฉพาะการรับสถานะการอ่านสำหรับผู้ใช้ที่โทร

หากต้องการอ้างอิงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้

  • ชื่อแทน me เช่น users/me/spaces/{space}/threads/{thread}/threadReadState

  • อีเมล Workspace ของผู้ใช้ เช่น users/user@example.com/spaces/{space}/threads/{thread}/threadReadState

  • รหัสผู้ใช้ เช่น users/123456789/spaces/{space}/threads/{thread}/threadReadState

รูปแบบ: users/{user}/spaces/{space}/threads/{thread}/threadReadState

กลุ่ม

กลุ่ม Google ใน Google Chat

ช่อง
name

string

ชื่อแหล่งข้อมูลของ Google Group

แสดงกลุ่มใน Cloud Identity Groups API

รูปแบบ: groups/{group}

HistoryState

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

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

ListCustomEmojisRequest

คำขอแสดงรายการอีโมจิที่กำหนดเอง

ช่อง
page_size

int32

ไม่บังคับ จำนวนอีโมจิที่กำหนดเองที่ส่งคืนได้สูงสุด บริการอาจแสดงอีโมจิที่กำหนดเองน้อยกว่าค่านี้ หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น 25 ค่าสูงสุดคือ 200 ระบบจะเปลี่ยนค่าที่มากกว่า 200 เป็น 200
page_token

string

ไม่บังคับ (หากทำต่อจากคำค้นหาก่อนหน้า)

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

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

string

ไม่บังคับ ตัวกรองการค้นหา

รองรับการกรองตามครีเอเตอร์

หากต้องการกรองตามครีเอเตอร์ คุณต้องระบุค่าที่ถูกต้อง ปัจจุบันระบบยอมรับเฉพาะ creator("users/me") และ NOT creator("users/me") เพื่อกรองอีโมจิที่กำหนดเองตามว่าผู้ใช้ที่โทรสร้างขึ้นหรือไม่

ตัวอย่างเช่น คำค้นหาต่อไปนี้จะแสดงอีโมจิที่กำหนดเองซึ่งผู้โทรสร้างขึ้น

creator("users/me")

เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด INVALID_ARGUMENT

ListCustomEmojisResponse

การตอบสนองต่อรายการอีโมจิที่กำหนดเอง

ช่อง
custom_emojis[]

CustomEmoji

รายการที่ไม่เรียงลำดับ รายการอีโมจิที่กำหนดเองในหน้าที่ขอ (หรือหน้าแรก)
next_page_token

string

โทเค็นที่คุณสามารถส่งในชื่อ pageToken เพื่อเรียกผลลัพธ์หน้าถัดไป หากเว้นว่างไว้ แสดงว่าไม่มีหน้าถัดไป

ListMembershipsRequest

ข้อความขอแสดงข้อมูลการเป็นสมาชิก

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะดึงข้อมูลรายการสมาชิก

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

int32

ไม่บังคับ จำนวนการเป็นสมาชิกสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงข้อมูลการเป็นสมาชิกไม่เกิน 100 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ

ค่าลบแสดงผลข้อผิดพลาด INVALID_ARGUMENT
page_token

string

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

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

string

ไม่บังคับ ตัวกรองการค้นหา

คุณสามารถกรองการเป็นสมาชิกตามบทบาทของสมาชิก (role) และประเภท (member.type)

หากต้องการกรองตามบทบาท ให้ตั้งค่า role เป็น ROLE_MEMBER หรือ ROLE_MANAGER

หากต้องการกรองตามประเภท ให้ตั้งค่า member.type เป็น HUMAN หรือ BOT คุณยังกรองหา member.type โดยใช้โอเปอเรเตอร์ != ได้ด้วย

หากต้องการกรองตามบทบาทและประเภท ให้ใช้โอเปอเรเตอร์ AND หากต้องการกรองตามบทบาทหรือประเภท ให้ใช้โอเปอเรเตอร์ OR

ต้องระบุ member.type = "HUMAN" หรือ member.type != "BOT" เมื่อตั้งค่า use_admin_access เป็น "จริง" ระบบจะปฏิเสธตัวกรองประเภทสมาชิกอื่นๆ

ตัวอย่างเช่น การค้นหาต่อไปนี้ถูกต้อง

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

การค้นหาต่อไปนี้ไม่ถูกต้อง

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

เซิร์ฟเวอร์ที่มีข้อผิดพลาด INVALID_ARGUMENT จะปฏิเสธการค้นหาที่ไม่ถูกต้อง
show_groups

bool

ไม่บังคับ เมื่อ true ระบบจะแสดงการเป็นสมาชิกที่เชื่อมโยงกับ Google Group นอกเหนือจากการเป็นสมาชิกประเภทอื่นๆ ด้วย หากตั้งค่า filter ระบบจะไม่แสดงการเป็นสมาชิก Google Group ที่ไม่ตรงกับเกณฑ์ตัวกรอง
show_invited

bool

ไม่บังคับ เมื่อ true จะแสดงการเป็นสมาชิกที่เชื่อมโยงกับสมาชิก invited ด้วย นอกเหนือจากการเป็นสมาชิกประเภทอื่นๆ หากตั้งค่าตัวกรองไว้ ระบบจะไม่แสดงการเป็นสมาชิก invited ที่ไม่ตรงกับเกณฑ์ตัวกรอง

ปัจจุบันต้องมีการตรวจสอบสิทธิ์ผู้ใช้
use_admin_access

bool

เมื่อ true วิธีการจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships.readonly หรือ chat.admin.memberships

ระบบไม่รองรับการแสดงการเป็นสมาชิกของแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ

ListMembershipsResponse

การตอบกลับรายการการเป็นสมาชิกของพื้นที่ทำงาน

ช่อง
memberships[]

Membership

รายการที่ไม่เรียงลำดับ รายการการเป็นสมาชิกในหน้าที่ขอ (หรือหน้าแรก)
next_page_token

string

โทเค็นที่คุณส่งเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไปของผลการค้นหาได้ หากเป็นค่าว่าง จะไม่มีหน้าถัดไป

ListMessagesRequest

แสดงข้อความในพื้นที่ทำงานที่ระบุที่ผู้ใช้เป็นสมาชิก

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะแสดงข้อความ

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

int32

จำนวนข้อความสูงสุดที่แสดง บริการอาจแสดงผลข้อความน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลสูงสุด 25 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ

ค่าลบจะแสดงผลข้อผิดพลาด INVALID_ARGUMENT
page_token

string

ไม่บังคับ หากกลับมาใช้งานต่อจากคำค้นหาก่อนหน้า

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

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

string

ตัวกรองข้อความค้นหา

คุณสามารถกรองข้อความตามวันที่ (create_time) และชุดข้อความ (thread.name)

หากต้องการกรองข้อความตามวันที่สร้าง ให้ระบุ create_time พร้อมการประทับเวลาในรูปแบบ RFC-3339 และเครื่องหมายคำพูดแบบปิด เช่น "2023-04-21T11:30:00-04:00" คุณสามารถใช้โอเปอเรเตอร์มากกว่า > เพื่อแสดงข้อความที่สร้างขึ้นหลังการประทับเวลา หรือใช้โอเปอเรเตอร์น้อยกว่า < เพื่อแสดงข้อความที่สร้างขึ้นก่อนการประทับเวลา หากต้องการกรองข้อความภายในช่วงเวลา ให้ใช้โอเปอเรเตอร์ AND ระหว่างการประทับเวลา 2 รายการ

หากต้องการกรองตามชุดข้อความ ให้ระบุ thread.name ที่มีการจัดรูปแบบเป็น spaces/{space}/threads/{thread} คุณระบุ thread.name ได้แค่ 1 รายการต่อคำค้นหา

หากต้องการกรองตามทั้งชุดข้อความและวันที่ ให้ใช้โอเปอเรเตอร์ AND ในการค้นหา

ตัวอย่างเช่น การค้นหาต่อไปนี้ถูกต้อง

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

เซิร์ฟเวอร์ที่มีข้อผิดพลาด INVALID_ARGUMENT จะปฏิเสธการค้นหาที่ไม่ถูกต้อง
order_by

string

ไม่บังคับ หากกลับมาใช้งานต่อจากคำค้นหาก่อนหน้า

วิธีเรียงลำดับรายการข้อความ ระบุมูลค่าที่จะสั่งซื้อตามการดำเนินการสั่งซื้อ ค่าการดำเนินการเรียงลำดับที่ถูกต้องมีดังนี้

  • ASC สำหรับจากน้อยไปมาก

  • DESC สำหรับจากมากไปน้อย

การเรียงลำดับเริ่มต้นคือ create_time ASC
show_deleted

bool

เลือกว่าจะรวมข้อความที่ลบไปแล้วหรือไม่ ข้อความที่ถูกลบจะมีเวลาที่ถูกลบและข้อมูลเมตาเกี่ยวกับการลบ แต่เนื้อหาข้อความจะใช้งานไม่ได้

ListMessagesResponse

ข้อความตอบกลับสำหรับการแสดงข้อความ

ช่อง
messages[]

Message

รายการข้อความ
next_page_token

string

คุณสามารถส่งโทเค็นในฐานะ pageToken เพื่อเรียกผลลัพธ์หน้าถัดไป หากเว้นว่างไว้ แสดงว่าไม่มีหน้าถัดไป

ListReactionsRequest

แสดงรายการความรู้สึกที่มีต่อข้อความ

ช่อง
parent

string

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

รูปแบบ: spaces/{space}/messages/{message}
page_size

int32

ไม่บังคับ จำนวนรีแอ็กชันสูงสุดที่แสดงผล บริการอาจแสดงรีแอ็กชันน้อยกว่าค่านี้ หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น 25 ค่าสูงสุดคือ 200 ระบบจะเปลี่ยนค่าที่มากกว่า 200 เป็น 200
page_token

string

ไม่บังคับ (หากกลับมาดำเนินการต่อจากการค้นหาก่อนหน้า)

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

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

string

ไม่บังคับ ตัวกรองข้อความค้นหา

คุณสามารถกรองรีแอ็กชันตามอีโมจิ (emoji.unicode หรือ emoji.custom_emoji.uid) และผู้ใช้ (user.name)

หากต้องการกรองรีแอ็กชันสำหรับอีโมจิหรือผู้ใช้หลายรายการ ให้ผนวกช่องที่คล้ายกันด้วยโอเปอเรเตอร์ OR เช่น emoji.unicode = "🙂" OR emoji.unicode = "👍" และ user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"

หากต้องการกรองรีแอ็กชันตามอีโมจิและผู้ใช้ ให้ใช้โอเปอเรเตอร์ AND เช่น emoji.unicode = "🙂" AND user.name = "users/AAAAAA"

หากคําค้นหาใช้ทั้ง AND และ OR ให้จัดกลุ่มด้วยวงเล็บ

ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

การค้นหาต่อไปนี้ไม่ถูกต้อง

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

เซิร์ฟเวอร์ที่มีข้อผิดพลาด INVALID_ARGUMENT จะปฏิเสธการค้นหาที่ไม่ถูกต้อง

ListReactionsResponse

การตอบสนองต่อคำขอรีแอ็กชันรายการ

ช่อง
reactions[]

Reaction

รายการรีแอ็กชันในหน้าที่ขอ (หรือหน้าแรก)
next_page_token

string

โทเค็นต่อเนื่องเพื่อเรียกข้อมูลหน้าถัดไป หน้าสุดท้ายของผลการค้นหาจะว่างเปล่า

ListSpaceEventsRequest

ข้อความคำขอสำหรับข้อมูลกิจกรรมในพื้นที่ทํางาน

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ใน Google Chat ที่เกิดเหตุการณ์

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

int32

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

ค่าลบจะแสดงผลข้อผิดพลาด INVALID_ARGUMENT
page_token

string

โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้เหตุการณ์พื้นที่รายการก่อนหน้านี้ โปรดระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป

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

string

ต้องระบุ ตัวกรองข้อความค้นหา

คุณต้องระบุประเภทเหตุการณ์อย่างน้อย 1 ประเภท (event_type) โดยใช้โอเปอเรเตอร์มี : หากต้องการกรองตามเหตุการณ์หลายประเภท ให้ใช้โอเปอเรเตอร์ OR ละเว้นประเภทเหตุการณ์แบบเป็นกลุ่มในตัวกรอง คำขอจะแสดงเหตุการณ์แบบกลุ่มที่เกี่ยวข้องโดยอัตโนมัติ เช่น หากคุณกรองตามความรู้สึกใหม่ (google.workspace.chat.reaction.v1.created) เซิร์ฟเวอร์จะแสดงผลเหตุการณ์ความรู้สึกใหม่แบบเป็นกลุ่ม (google.workspace.chat.reaction.v1.batchCreated) ด้วย ดูรายการประเภทเหตุการณ์ที่รองรับได้ที่SpaceEventsเอกสารอ้างอิง

นอกจากนี้ คุณยังกรองตามเวลาเริ่มต้น (start_time) และเวลาสิ้นสุด (end_time) ได้ด้วย โดยทำดังนี้

  • start_time: การประทับเวลาที่ไม่ซ้ำกันซึ่งจะเริ่มแสดงเหตุการณ์ในพื้นที่ คุณระบุเหตุการณ์ที่เกิดขึ้นในช่วง 28 วันที่ผ่านมาได้ หากไม่ระบุ จะแสดงเหตุการณ์ที่เกิดขึ้นในพื้นที่ทำงานในช่วง 28 วันที่ผ่านมา
  • end_time: การประทับเวลาที่รวมจนถึงเวลาที่แสดงเหตุการณ์ในพื้นที่ทำงาน หากไม่ระบุ จะแสดงเหตุการณ์จนถึงเวลาที่ขอ

หากต้องการระบุเวลาเริ่มต้นหรือสิ้นสุด ให้ใช้โอเปอเรเตอร์เท่ากับ = และรูปแบบใน RFC-3339 หากต้องการกรองตามทั้ง start_time และ end_time ให้ใช้โอเปอเรเตอร์ AND

ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

การค้นหาต่อไปนี้ไม่ถูกต้อง

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

เซิร์ฟเวอร์ที่มีข้อผิดพลาด INVALID_ARGUMENT จะปฏิเสธการค้นหาที่ไม่ถูกต้อง

ListSpaceEventsResponse

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

ช่อง
space_events[]

SpaceEvent

ผลลัพธ์จะแสดงตามลำดับเวลา (เหตุการณ์ที่เก่าสุดก่อน) หมายเหตุ: ช่อง permissionSettings จะไม่แสดงผลในออบเจ็กต์พื้นที่ทำงานสำหรับคำขอรายการ
next_page_token

string

ใช้โทเค็นต่อเนื่องเพื่อดึงข้อมูลเหตุการณ์เพิ่มเติม หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป

ListSpacesRequest

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

ช่อง
page_size

int32

ไม่บังคับ จำนวนพื้นที่ทำงานสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลเว้นวรรคมากที่สุด 100 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ

ค่าลบแสดงผลข้อผิดพลาด INVALID_ARGUMENT
page_token

string

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

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับคอลที่ระบุโทเค็นหน้า การส่งค่าอื่นอาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองการค้นหา

คุณสามารถกรองพื้นที่ทำงานตามประเภทพื้นที่ทำงาน (space_type)

หากต้องการกรองตามประเภทพื้นที่ทำงาน คุณต้องระบุค่า Enum ที่ถูกต้อง เช่น SPACE หรือ GROUP_CHAT (space_type ต้องไม่ใช่ SPACE_TYPE_UNSPECIFIED) หากต้องการค้นหาพื้นที่ทำงานหลายประเภท ให้ใช้โอเปอเรเตอร์ OR

ตัวอย่างเช่น การค้นหาต่อไปนี้ถูกต้อง

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด INVALID_ARGUMENT

ListSpacesResponse

การตอบกลับของคำขอพื้นที่ทำงานรายการ

ช่อง
spaces[]

Space

รายการพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก) หมายเหตุ: ช่อง permissionSettings จะไม่แสดงผลในออบเจ็กต์พื้นที่ทำงานสำหรับคำขอรายการ
next_page_token

string

คุณสามารถส่งโทเค็นเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไป หากเป็นค่าว่าง จะไม่มีหน้าถัดไป

MatchedUrl

URL ที่ตรงกันในข้อความ Chat แอปแชทจะดูตัวอย่าง URL ที่ตรงกันได้ ดูข้อมูลเพิ่มเติมได้ที่ดูตัวอย่างลิงก์

ช่อง
url

string

เอาต์พุตเท่านั้น URL ที่ตรงกัน

การเป็นสมาชิก

แสดงถึงความสัมพันธ์กับการเป็นสมาชิกใน Google Chat เช่น ผู้ใช้หรือแอป Chat ได้รับเชิญเข้าร่วม เข้าร่วม หรือไม่ได้เข้าร่วมในพื้นที่ทำงาน

ช่อง
name

string

ชื่อทรัพยากรของการเป็นสมาชิกที่เซิร์ฟเวอร์กำหนด

รูปแบบ: spaces/{space}/members/{member}
state

MembershipState

เอาต์พุตเท่านั้น สถานะการเป็นสมาชิก
role

MembershipRole

ไม่บังคับ บทบาทของผู้ใช้ภายในพื้นที่ใน Chat ซึ่งกำหนดการดำเนินการที่ผู้ใช้ได้รับอนุญาตในพื้นที่

ช่องนี้สามารถใช้เป็นอินพุตใน UpdateMembership เท่านั้น
create_time

Timestamp

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

Timestamp

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

User

ผู้ใช้หรือแอป Google Chat ที่เชื่อมโยงกับการเป็นสมาชิก หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะสร้างผู้ใช้ name และ type
group_member

Group

Google Group ที่เป็นสมาชิก

การอ่านหรือแก้ไขการเป็นสมาชิกของ Google Groups ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้

MembershipRole

แสดงการดำเนินการที่ผู้ใช้ได้รับอนุญาตในพื้นที่ใน Chat อาจมีการเพิ่มค่า enum อื่นๆ ในอนาคต

Enum
MEMBERSHIP_ROLE_UNSPECIFIED ค่าเริ่มต้น สำหรับ users: ผู้ใช้ไม่ใช่สมาชิกของพื้นที่ทำงาน แต่สามารถได้รับเชิญได้ สำหรับ Google Groups: ระบบจะกำหนดบทบาทนี้เสมอ (อาจมีการใช้ค่า enum อื่นๆ ในอนาคต)
ROLE_MEMBER สมาชิกของพื้นที่ทำงาน ผู้ใช้มีสิทธิ์พื้นฐาน เช่น ส่งข้อความไปยังพื้นที่ทำงาน ทุกคนมีบทบาทนี้ในการสนทนาแบบ 1:1 และแบบกลุ่มที่ไม่มีชื่อ
ROLE_MANAGER ผู้จัดการพื้นที่ทำงาน ผู้ใช้จะมีสิทธิ์พื้นฐานทั้งหมดรวมถึงสิทธิ์ระดับผู้ดูแลระบบที่อนุญาตให้จัดการพื้นที่ทำงานได้ เช่น การเพิ่มหรือนำสมาชิกออก รองรับเฉพาะใน SpaceType.SPACE

MembershipState

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

Enum
MEMBERSHIP_STATE_UNSPECIFIED ค่าเริ่มต้น โปรดอย่าใช้
JOINED เพิ่มผู้ใช้ไปยังพื้นที่ทำงานแล้ว และจะเข้าร่วมพื้นที่ทำงานได้
INVITED ผู้ใช้ได้รับเชิญให้เข้าร่วมพื้นที่ทำงาน แต่ยังไม่ได้เข้าร่วม
NOT_A_MEMBER ผู้ใช้ไม่ได้อยู่ในพื้นที่ทำงานและไม่มีคำเชิญที่รอดำเนินการให้เข้าร่วมพื้นที่ทำงาน

MembershipBatchCreatedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchCreated

ช่อง
memberships[]

MembershipCreatedEventData

รายการสมาชิกใหม่

MembershipBatchDeletedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchDeleted

ช่อง
memberships[]

MembershipDeletedEventData

รายการการเป็นสมาชิกที่ถูกลบ

MembershipBatchUpdatedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchUpdated

ช่อง
memberships[]

MembershipUpdatedEventData

รายการการเป็นสมาชิกที่อัปเดตแล้ว

MembershipCreatedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกใหม่

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.created

ช่อง
membership

Membership

การเป็นสมาชิกใหม่

MembershipDeletedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.deleted

ช่อง
membership

Membership

การเป็นสมาชิกที่ถูกลบ ระบบจะป้อนข้อมูลในช่อง name และ state เท่านั้น

MembershipUpdatedEventData

เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกที่อัปเดตแล้ว

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.updated

ช่อง
membership

Membership

การเป็นสมาชิกที่อัปเดตแล้ว

ข้อความ

ข้อความในพื้นที่ใน Google Chat

ช่อง
name

string

ชื่อทรัพยากรของข้อความ

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

โดยที่ {space} คือรหัสของพื้นที่ทำงานที่มีการโพสต์ข้อความ และ {message} คือรหัสที่ระบบกำหนดให้สำหรับข้อความ เช่น spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

หากตั้งรหัสที่กำหนดเองเมื่อสร้างข้อความ คุณจะใช้รหัสนี้เพื่อระบุข้อความในคำขอได้ โดยแทนที่ {message} ด้วยค่าจากช่อง clientAssignedMessageId เช่น spaces/AAAAAAAAAAA/messages/client-custom-name โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
sender

User

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างข้อความ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะสร้างผู้ใช้ name และ type
create_time

Timestamp

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

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

Timestamp

เอาต์พุตเท่านั้น เวลาล่าสุดที่ผู้ใช้แก้ไขข้อความ หากไม่เคยมีการแก้ไขข้อความ ช่องนี้จะว่างเปล่า
delete_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่ข้อความถูกลบใน Google Chat หากข้อความไม่เคยถูกลบ ช่องนี้จะว่างเปล่า
text

string

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

ดูข้อมูลเกี่ยวกับการสร้าง SMS ได้ที่ส่งข้อความ
formatted_text

string

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

  • ไวยากรณ์มาร์กอัปสำหรับตัวหนา ตัวเอียง ขีดทับ แบบโมโนสเปซ บล็อกแบบโมโนสเปซ และรายการสัญลักษณ์หัวข้อย่อย

  • ผู้ใช้พูดถึงโดยใช้รูปแบบ <users/{user}>

  • ไฮเปอร์ลิงก์ที่กำหนดเองโดยใช้รูปแบบ <{url}|{rendered_text}> โดยที่สตริงแรกเป็น URL และสตริงที่ 2 เป็นข้อความที่แสดงผล เช่น <http://example.com|custom text>

  • อีโมจิที่กำหนดเองโดยใช้รูปแบบ :{emoji_name}: เช่น :smile: ข้อมูลนี้ไม่มีผลกับอีโมจิแบบ Unicode เช่น U+1F600 สำหรับอีโมจิหน้ายิ้ม

ดูข้อมูลเพิ่มเติมได้ที่ดูการจัดรูปแบบข้อความที่ส่งในข้อความ
cards[]
(deprecated)

Card

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

การ์ดแบบริชมีเดียที่จัดรูปแบบและเป็นแบบอินเทอร์แอกทีฟ ซึ่งคุณใช้แสดงองค์ประกอบ UI ได้ เช่น ข้อความที่จัดรูปแบบ ปุ่ม และรูปภาพที่คลิกได้ โดยปกติแล้วการ์ดจะแสดงใต้เนื้อหาข้อความธรรมดา cards และ cards_v2 มีขนาดได้สูงสุด 32 KB
cards_v2[]

CardWithId

อาร์เรย์ของการ์ด

เฉพาะแอป Chat เท่านั้นที่สร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ ข้อความจะไม่มีการ์ด

โปรดดูวิธีสร้างข้อความที่มีการ์ดที่หัวข้อส่งข้อความ

ออกแบบและแสดงตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด

เปิดเครื่องมือสร้างการ์ด
annotations[]

Annotation

เอาต์พุตเท่านั้น หมายเหตุที่เกี่ยวข้องกับ text ในข้อความนี้
thread

Thread

ชุดข้อความที่ข้อความเป็นสมาชิก ดูตัวอย่างการใช้งานได้ที่เริ่มหรือตอบกลับชุดข้อความ
space

Space

หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ เอาต์พุตจะเติมพื้นที่ทำงาน name
fallback_text

string

คำอธิบายข้อความธรรมดาของการ์ดข้อความ ซึ่งใช้เมื่อไม่สามารถแสดงการ์ดจริง เช่น การแจ้งเตือนในอุปกรณ์เคลื่อนที่
action_response

ActionResponse

อินพุตเท่านั้น พารามิเตอร์ที่แอปใน Chat ใช้ในการกำหนดค่าวิธีโพสต์คำตอบได้
argument_text

string

เอาต์พุตเท่านั้น เนื้อหาที่เป็นข้อความธรรมดาที่มีการพูดถึงแอป Chat ทั้งหมด
slash_command

SlashCommand

เอาต์พุตเท่านั้น ข้อมูลคำสั่งเครื่องหมายทับ (หากมี)
attachment[]

Attachment

ไฟล์แนบที่ผู้ใช้อัปโหลด
matched_url

MatchedUrl

เอาต์พุตเท่านั้น URL ใน spaces.messages.text ที่ตรงกับรูปแบบตัวอย่างลิงก์ ดูข้อมูลเพิ่มเติมได้ที่ลิงก์แสดงตัวอย่าง
thread_reply

bool

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

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

string

ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ คุณสามารถใช้ฟิลด์เพื่อระบุข้อความ หรือเพื่อรับ ลบ หรืออัปเดตข้อความ หากต้องการตั้งค่ารหัสที่กำหนดเอง ให้ระบุช่อง messageId เมื่อสร้างข้อความ โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
emoji_reaction_summaries[]

EmojiReactionSummary

เอาต์พุตเท่านั้น รายการสรุปรีแอ็กชันด้วยอีโมจิในข้อความ
private_message_viewer

User

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

โปรดดูรายละเอียดที่หัวข้อส่งข้อความแบบส่วนตัว
deletion_metadata

DeletionMetadata

เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ลบ ระบบจะลบข้อความเมื่อตั้งค่า delete_time
quoted_message_metadata

QuotedMessageMetadata

เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ผู้ใช้ Google Chat ยกมาในพื้นที่ทำงาน ผู้ใช้ Google Chat จะยกข้อความมาตอบกลับได้
attached_gifs[]

AttachedGif

เอาต์พุตเท่านั้น รูปภาพ GIF ที่แนบมากับข้อความ
accessory_widgets[]

AccessoryWidget

วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 1 รายการซึ่งปรากฏที่ด้านล่างของข้อความ คุณเพิ่มวิดเจ็ตอุปกรณ์เสริมในข้อความที่มีข้อความ การ์ด หรือทั้งข้อความและการ์ดได้ ไม่รองรับข้อความที่มีกล่องโต้ตอบ โปรดดูรายละเอียดที่หัวข้อเพิ่มวิดเจ็ตแบบอินเทอร์แอกทีฟที่ด้านล่างของข้อความ

การสร้างข้อความด้วยวิดเจ็ตเสริมต้องมีการการตรวจสอบสิทธิ์แอป

MessageBatchCreatedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchCreated

ช่อง
messages[]

MessageCreatedEventData

รายการข้อความใหม่

MessageBatchDeletedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความที่ลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchDeleted

ช่อง
messages[]

MessageDeletedEventData

รายการข้อความที่ถูกลบ

MessageBatchUpdatedEventData

เปย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchUpdated

ช่อง
messages[]

MessageUpdatedEventData

รายการข้อความที่อัปเดต

MessageCreatedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความใหม่

ประเภทเหตุการณ์: google.workspace.chat.message.v1.created

ช่อง
message

Message

ข้อความใหม่

MessageDeletedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความที่ลบ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.deleted

ช่อง
message

Message

ข้อความที่ถูกลบ ป้อนข้อมูลในช่อง name, createTime, deleteTime และ deletionMetadata เท่านั้น

MessageUpdatedEventData

เปย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดต

ประเภทเหตุการณ์: google.workspace.chat.message.v1.updated

ช่อง
message

Message

ข้อความที่อัปเดตแล้ว

QuotedMessageMetadata

ข้อมูลเกี่ยวกับข้อความที่ยกมา

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อแหล่งข้อมูลของข้อความที่ยกมา

รูปแบบ: spaces/{space}/messages/{message}
last_update_time

Timestamp

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

รีแอ็กชัน

รีแอ็กชันต่อข้อความ

ช่อง
name

string

ชื่อทรัพยากรของรีแอ็กชัน

รูปแบบ: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างความรู้สึก
emoji

Emoji

อีโมจิที่ใช้ในรีแอ็กชัน

ReactionBatchCreatedEventData

เปย์โหลดของเหตุการณ์สำหรับความรู้สึกใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchCreated

ช่อง
reactions[]

ReactionCreatedEventData

รายการรีแอ็กชันใหม่

ReactionBatchDeletedEventData

เปย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้วหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchDeleted

ช่อง
reactions[]

ReactionDeletedEventData

รายการความรู้สึกที่ถูกลบ

ReactionCreatedEventData

เพย์โหลดเหตุการณ์สำหรับรีแอ็กชันใหม่

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.created

ช่อง
reaction

Reaction

รีแอ็กชันใหม่

ReactionDeletedEventData

เปย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้ว

ประเภท: google.workspace.chat.reaction.v1.deleted

ช่อง
reaction

Reaction

รีแอ็กชันที่ถูกลบ

RichLinkMetadata

ลิงก์แบบสมบูรณ์ไปยังทรัพยากร

ช่อง
uri

string

URI ของลิงก์นี้
ช่องการรวม data ข้อมูลของทรัพยากรที่ลิงก์ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

RichLinkType

ประเภทลิงก์ริชมีเดีย ในอนาคตอาจมีการเพิ่มประเภทอื่นๆ เข้ามา

Enum
DRIVE_FILE ประเภทลิงก์ริชมีเดียของ Google ไดรฟ์
CHAT_SPACE ประเภทลิงก์ริชมีเดียของพื้นที่ใน Chat เช่น ชิปอัจฉริยะในพื้นที่ทำงาน

SearchSpacesRequest

คำขอค้นหารายการพื้นที่ทำงานตามคำค้นหา

ช่อง
use_admin_access

bool

เมื่อ true วิธีการจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.spaces.readonly หรือ chat.admin.spaces

ขณะนี้วิธีการนี้รองรับเฉพาะการเข้าถึงระดับผู้ดูแลระบบเท่านั้น จึงยอมรับเฉพาะ true สําหรับช่องนี้
page_size

int32

จำนวนพื้นที่ทำงานสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลการเว้นวรรคไม่เกิน 100 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ
page_token

string

โทเค็นที่ได้รับจากการเรียกใช้พื้นที่การค้นหาก่อนหน้า ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป

เมื่อแบ่งหน้าเว็บ พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด
query

string

ต้องระบุ คำค้นหา

คุณค้นหาได้โดยใช้พารามิเตอร์ต่อไปนี้

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time และ last_active_time ยอมรับการประทับเวลาในรูปแบบ RFC-3339 และโอเปอเรเตอร์การเปรียบเทียบที่รองรับ ได้แก่ =, <, >, <=, >=

ต้องใช้ customer และใช้เพื่อระบุว่าจะดึงข้อมูลพื้นที่ทำงานจากลูกค้ารายใด customers/my_customer เป็นค่าเดียวที่รองรับ

display_name ยอมรับเฉพาะโอเปอเรเตอร์ HAS (:) ระบบจะแบ่งข้อความที่จะจับคู่ออกเป็นโทเค็นก่อน จากนั้นจะจับคู่แต่ละโทเค็นกับคำนำหน้าแบบไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ และจับคู่แบบอิสระเป็นสตริงย่อยที่ใดก็ได้ใน display_name ของพื้นที่โฆษณา เช่น Fun Eve ตรงกับ Fun event หรือ The evening was fun แต่ไม่ตรงกับ notFun event หรือ even

external_user_allowed ยอมรับ true หรือ false

space_history_state ยอมรับเฉพาะค่าจากช่อง historyState ของทรัพยากร space

space_type ต้องมีค่าที่ถูกต้องเพียงค่าเดียวคือ SPACE

ช่องต่างๆ รองรับเฉพาะโอเปอเรเตอร์ AND เท่านั้น ตัวอย่างที่ถูกต้องคือ space_type = "SPACE" AND display_name:"Hello" และตัวอย่างที่ไม่ถูกต้องคือ space_type = "SPACE" OR display_name:"Hello"

ในช่องเดียวกัน space_type ไม่รองรับโอเปอเรเตอร์ AND หรือ OR display_name, "space_history_state" และ "external_user_allowed" รองรับเฉพาะโอเปอเรเตอร์ OR last_active_time และ create_time รองรับทั้งโอเปอเรเตอร์ AND และ OR AND ใช้ได้เพื่อแสดงช่วงเวลาเท่านั้น เช่น last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"

ตัวอย่างคำค้นหาที่ถูกต้องมีดังนี้

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

ไม่บังคับ วิธีเรียงลำดับรายการพื้นที่ทำงาน

แอตทริบิวต์ที่รองรับการเรียงลำดับมีดังนี้

  • membership_count.joined_direct_human_user_count — หมายถึงจำนวนผู้ใช้ที่เป็นมนุษย์ที่เข้าร่วมพื้นที่ทำงานโดยตรง
  • last_active_time — แสดงเวลาที่เพิ่มรายการที่มีสิทธิ์ล่าสุดลงในหัวข้อใดก็ได้ของพื้นที่ทำงานนี้
  • create_time — หมายถึงเวลาที่สร้างพื้นที่ทำงาน

ค่าการดำเนินการเรียงลำดับที่ถูกต้องมีดังนี้

  • ASC สำหรับจากน้อยไปมาก ค่าเริ่มต้น

  • DESC สำหรับจากมากไปน้อย

ไวยากรณ์ที่รองรับมีดังนี้

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

ตอบกลับพร้อมรายการพื้นที่ทำงานที่เกี่ยวข้องกับคำขอ Search Space

ช่อง
spaces[]

Space

หน้าของพื้นที่ทำงานที่ขอ
next_page_token

string

โทเค็นที่ใช้เพื่อเรียกข้อมูลหน้าถัดไปได้ หากช่องนี้ว่างเปล่า จะไม่มีหน้าถัดไป
total_size

int32

จํานวนพื้นที่โฆษณาทั้งหมดที่ตรงกับคําค้นหาในทุกหน้า หากผลลัพธ์มีการเว้นวรรคเกิน 10,000 ครั้ง ค่านี้จะเป็นค่าประมาณ

SetUpSpaceRequest

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

ช่อง
space

Space

ต้องระบุ ต้องกรอกข้อมูลในช่อง Space.spaceType

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

หากต้องการสร้างแชทเป็นกลุ่ม ให้ตั้งค่า Space.spaceType เป็น GROUP_CHAT อย่าตั้งค่าSpace.displayName

หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างบุคคล ให้ตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE และตั้งค่า Space.singleUserBotDm เป็น false อย่าตั้งค่าเป็น Space.displayName หรือ Space.spaceDetails

หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างบุคคลกับแอป Chat ที่ใช้โทร ให้ตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE และ Space.singleUserBotDm เป็น true อย่าตั้งค่าเป็น Space.displayName หรือ Space.spaceDetails

หากมีDIRECT_MESSAGEพื้นที่ทำงานอยู่แล้ว ระบบจะแสดงพื้นที่ทำงานนั้นแทนการสร้างพื้นที่ทำงานใหม่
request_id

string

ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับคำขอนี้ ขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอที่มีอยู่จะแสดงพื้นที่ทำงานที่สร้างด้วยรหัสนั้นแทนการสร้างพื้นที่ทำงานใหม่ การระบุรหัสคำขอที่มีอยู่จากแอป Chat เดียวกันที่มีผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์คนละรายจะแสดงข้อผิดพลาด
memberships[]

Membership

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

ปัจจุบันชุดนี้มีสิทธิ์สมาชิกได้สูงสุด 20 คน (นอกเหนือจากผู้โทร)

สำหรับการเป็นสมาชิกของบุคคลธรรมดา ช่อง Membership.member ต้องมี user ที่มี name ป้อนไว้ (รูปแบบ: users/{user}) และตั้งค่า type เป็น User.Type.HUMAN คุณจะเพิ่มได้เฉพาะผู้ใช้ที่เป็นบุคคลธรรมดาเมื่อตั้งค่าพื้นที่ทำงาน (ระบบรองรับการเพิ่มแอปใน Chat สำหรับการตั้งค่าข้อความส่วนตัวกับแอปการโทรเท่านั้น) นอกจากนี้ คุณยังเพิ่มสมาชิกโดยใช้อีเมลของผู้ใช้เป็นชื่อแทนสำหรับ {user} ได้ด้วย เช่น user.name อาจเป็น users/example@gmail.com หากต้องการเชิญผู้ใช้ Gmail หรือผู้ใช้จากโดเมน Google Workspace ภายนอก คุณต้องใช้อีเมลของผู้ใช้สำหรับ {user}

สําหรับการเป็นสมาชิกกลุ่ม Google ฟิลด์ Membership.group_member ต้องมี group ที่มี name แสดงอยู่ (รูปแบบ groups/{group}) คุณจะเพิ่มกลุ่ม Google ได้ก็ต่อเมื่อตั้งค่า Space.spaceType เป็น SPACE

ไม่บังคับเมื่อตั้งค่า Space.spaceType เป็น SPACE

ต้องระบุเมื่อตั้งค่า Space.spaceType เป็น GROUP_CHAT พร้อมกับการเป็นสมาชิกอย่างน้อย 2 รายการ

ต้องระบุเมื่อตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE สำหรับผู้ใช้ที่เป็นมนุษย์ พร้อมกับการเป็นสมาชิกเพียง 1 รายการ

ต้องเว้นว่างไว้เมื่อสร้างการสนทนาแบบ 1:1 ระหว่างบุคคลกับแอป Chat ที่โทรออก (เมื่อตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE และ Space.singleUserBotDm เป็น true)

SlashCommand

คําสั่งเครื่องหมายทับใน Google Chat

ช่อง
command_id

int64

รหัสของคำสั่ง Slash ที่เรียกใช้

SlashCommandMetadata

ข้อมูลเมตาคำอธิบายประกอบสำหรับคำสั่งเครื่องหมายทับ (/)

ช่อง
bot

User

แอป Chat ที่เรียกใช้คําสั่ง
type

Type

ประเภทของคำสั่งเครื่องหมายทับ
command_name

string

ชื่อของคำสั่งขีดกลางที่เรียกใช้
command_id

int64

รหัสคำสั่งของคำสั่งเครื่องหมายทับ
triggers_dialog

bool

ระบุว่าใช้คําสั่งเครื่องหมายทับสำหรับกล่องโต้ตอบหรือไม่

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum อย่าใช้
ADD เพิ่มแอป Chat ไปยังพื้นที่ทำงาน
INVOKE เรียกใช้คำสั่งเครื่องหมายทับในพื้นที่ทำงาน

Space

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

ช่อง
name

string

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

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

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

Type

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

SpaceType

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

bool

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

bool

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

string

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

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

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

bool

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

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

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

SpaceThreadingState

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

SpaceDetails

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

HistoryState

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

bool

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

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

Timestamp

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

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

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

Timestamp

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

admin_installed

bool

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

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

MembershipCount

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

access_settings

AccessSettings

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

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 ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
predefined_permission_settings

PredefinedPermissionSettings

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

PermissionSettings

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

AccessSettings

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

ช่อง
access_state

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

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

MembershipCount

แสดงจำนวนสมาชิกของพื้นที่ทำงานที่จัดกลุ่มเป็นหมวดหมู่ต่างๆ

ช่อง
joined_direct_human_user_count

int32

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

int32

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

PermissionSetting

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

ช่อง
managers_allowed

bool

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

bool

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

PermissionSettings

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

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

ช่อง
manage_members_and_groups

PermissionSetting

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

PermissionSetting

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

PermissionSetting

การตั้งค่าเพื่อเปิด/ปิดประวัติพื้นที่ทำงาน
use_at_mention_all

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PredefinedPermissionSettings

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

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

SpaceDetails

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

ช่อง
description

string

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

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

string

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

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

SpaceThreadingState

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

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

SpaceType

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

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

ประเภท

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

Enum
TYPE_UNSPECIFIED จองแล้ว
ROOM การสนทนาระหว่างมนุษย์ 2 คนขึ้นไป
DM ข้อความส่วนตัวแบบ 1:1 ระหว่างบุคคลกับแอป Chat โดยข้อความทั้งหมดจะแบน ทั้งนี้ไม่รวมถึงข้อความส่วนตัวระหว่างบุคคล 2 คน

SpaceBatchUpdatedEventData

เปย์โหลดเหตุการณ์สำหรับการอัปเดตหลายรายการในพื้นที่ทำงาน

ประเภทเหตุการณ์: google.workspace.chat.space.v1.batchUpdated

ช่อง
spaces[]

SpaceUpdatedEventData

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

SpaceEvent

เหตุการณ์ที่แสดงการเปลี่ยนแปลงหรือกิจกรรมในพื้นที่ใน Google Chat โปรดดูข้อมูลเพิ่มเติมที่หัวข้อใช้งานกิจกรรมจาก Google Chat

ช่อง
name

string

ชื่อทรัพยากรของเหตุการณ์พื้นที่ทำงาน

รูปแบบ: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

เวลาที่เกิดเหตุการณ์
event_type

string

ประเภทเหตุการณ์ในพื้นที่ทำงาน เหตุการณ์แต่ละประเภทจะมีเวอร์ชันกลุ่ม ซึ่งแสดงถึงอินสแตนซ์หลายรายการของประเภทเหตุการณ์ที่เกิดขึ้นในช่วงเวลาสั้นๆ สําหรับคําขอ spaceEvents.list() ให้ละเว้นประเภทเหตุการณ์กลุ่มในตัวกรองข้อความค้นหา โดยค่าเริ่มต้น เซิร์ฟเวอร์จะแสดงผลทั้งประเภทเหตุการณ์และเวอร์ชันการประมวลผลเป็นกลุ่ม

ประเภทเหตุการณ์ที่รองรับข้อความมีดังนี้

  • ข้อความใหม่: google.workspace.chat.message.v1.created
  • ข้อความที่อัปเดต: google.workspace.chat.message.v1.updated
  • ข้อความที่ลบ: google.workspace.chat.message.v1.deleted
  • ข้อความใหม่หลายรายการ: google.workspace.chat.message.v1.batchCreated
  • ข้อความที่อัปเดตหลายรายการ: google.workspace.chat.message.v1.batchUpdated
  • ข้อความที่ลบหลายรายการ: google.workspace.chat.message.v1.batchDeleted

ประเภทเหตุการณ์ที่รองรับสำหรับการเป็นสมาชิก

  • การเป็นสมาชิกใหม่: google.workspace.chat.membership.v1.created
  • การเป็นสมาชิกที่อัปเดตแล้ว: google.workspace.chat.membership.v1.updated
  • การเป็นสมาชิกที่ถูกลบ: google.workspace.chat.membership.v1.deleted
  • มีการเป็นสมาชิกใหม่หลายรายการ: google.workspace.chat.membership.v1.batchCreated
  • การเป็นสมาชิกที่อัปเดตหลายรายการ: google.workspace.chat.membership.v1.batchUpdated
  • การเป็นสมาชิกหลายรายการที่ลบแล้ว: google.workspace.chat.membership.v1.batchDeleted

ประเภทเหตุการณ์ที่รองรับสำหรับรีแอ็กชัน

  • รีแอ็กชันใหม่: google.workspace.chat.reaction.v1.created
  • รีแอ็กชันที่ถูกลบ: google.workspace.chat.reaction.v1.deleted
  • ความรู้สึกใหม่หลายรายการ: google.workspace.chat.reaction.v1.batchCreated
  • รีแอ็กชันที่ถูกลบหลายรายการ: google.workspace.chat.reaction.v1.batchDeleted

ประเภทเหตุการณ์ที่รองรับเกี่ยวกับพื้นที่ทำงานมีดังนี้

  • พื้นที่ทำงานที่อัปเดต: google.workspace.chat.space.v1.updated
  • การอัปเดตพื้นที่ทำงานหลายรายการ: google.workspace.chat.space.v1.batchUpdated

ช่องการรวม payload

payload ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
message_created_event_data

MessageCreatedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความใหม่

ประเภทเหตุการณ์: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความที่อัปเดต

ประเภทเหตุการณ์: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความที่ลบ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

เปย์โหลดของเหตุการณ์สำหรับข้อความใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

เพย์โหลดเหตุการณ์สําหรับข้อความที่ลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

เพย์โหลดเหตุการณ์สำหรับการอัปเดตพื้นที่ทำงาน

ประเภทเหตุการณ์: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

เพย์โหลดเหตุการณ์สำหรับการอัปเดตพื้นที่ทำงานหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกใหม่

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตแล้ว

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่ลบแล้ว

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

เปย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

เปย์โหลดเหตุการณ์สำหรับรีแอ็กชันใหม่

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

เปย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้ว

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

เปย์โหลดของเหตุการณ์สำหรับความรู้สึกใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

เพย์โหลดเหตุการณ์สําหรับรีแอ็กชันที่ลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

การตั้งค่าการแจ้งเตือนของผู้ใช้ในพื้นที่ทำงาน

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน รูปแบบ: users/{user}/spaces/{space}/spaceNotificationSetting
notification_setting

NotificationSetting

การตั้งค่าการแจ้งเตือน
mute_setting

MuteSetting

การตั้งค่าปิดการแจ้งเตือนพื้นที่ทำงาน

MuteSetting

ประเภทการตั้งค่าการปิดเสียงการแจ้งเตือนของพื้นที่ทำงาน

Enum
MUTE_SETTING_UNSPECIFIED จองแล้ว
UNMUTED ผู้ใช้จะได้รับการแจ้งเตือนสำหรับพื้นที่ทำงานตามการตั้งค่าการแจ้งเตือน
MUTED ผู้ใช้จะไม่ได้รับการแจ้งเตือนใดๆ สำหรับพื้นที่ทำงาน ไม่ว่าจะตั้งค่าการแจ้งเตือนไว้อย่างไรก็ตาม

NotificationSetting

ประเภทของการตั้งค่าการแจ้งเตือน

Enum
NOTIFICATION_SETTING_UNSPECIFIED จองแล้ว
ALL การแจ้งเตือนจะทริกเกอร์โดย @การพูดถึง ชุดข้อความที่ติดตาม ข้อความแรกของชุดข้อความใหม่ ระบบจะติดตามชุดข้อความใหม่ทั้งหมดโดยอัตโนมัติ เว้นแต่ผู้ใช้จะเลิกติดตามด้วยตนเอง
MAIN_CONVERSATIONS ระบบจะทริกเกอร์การแจ้งเตือนด้วยการ @พูดถึง ชุดข้อความที่ติดตาม ข้อความแรกของชุดข้อความใหม่ ใช้งานกับข้อความส่วนตัวแบบ 1:1 ไม่ได้
FOR_YOU การแจ้งเตือนจะทริกเกอร์เมื่อมีการ @พูดถึง ชุดข้อความที่ติดตาม ใช้งานกับข้อความส่วนตัวแบบ 1:1 ไม่ได้
OFF การแจ้งเตือนปิดอยู่

SpaceReadState

สถานะการอ่านของผู้ใช้ในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน

ช่อง
name

string

ชื่อทรัพยากรและสถานะการอ่านของพื้นที่ทำงาน

รูปแบบ: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

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

SpaceUpdatedEventData

เพย์โหลดเหตุการณ์สำหรับพื้นที่ทำงานที่อัปเดตแล้ว

ประเภทเหตุการณ์: google.workspace.chat.space.v1.updated

ช่อง
space

Space

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

ชุดข้อความ

ชุดข้อความในพื้นที่ใน Google Chat เช่น การใช้งานที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ

หากระบุชุดข้อความเมื่อสร้างข้อความ คุณจะตั้งค่าช่อง messageReplyOption เพื่อกำหนดสิ่งที่จะเกิดขึ้นหากไม่พบชุดข้อความที่ตรงกัน

ช่อง
name

string

ชื่อทรัพยากรของเธรด

ตัวอย่าง: spaces/{space}/threads/{thread}
thread_key

string

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

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

ThreadReadState

สถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน

ช่อง
name

string

ชื่อทรัพยากรของสถานะอ่านชุดข้อความ

รูปแบบ: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

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

UpdateMembershipRequest

ข้อความคำขออัปเดตการเป็นสมาชิก

ช่อง
membership

Membership

ต้องระบุ การเป็นสมาชิกที่จะอัปเดต เฉพาะฟิลด์ที่ update_mask ระบุเท่านั้นที่อัปเดต
update_mask

FieldMask

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

เส้นทางช่องที่รองรับในปัจจุบันมีดังนี้

  • role
use_admin_access

bool

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้chat.admin.membershipsขอบเขต OAuth 2.0

UpdateMessageRequest

ขออัปเดตข้อความ

ช่อง
message

Message

ต้องระบุ ข้อความที่มีช่องที่อัปเดตแล้ว
update_mask

FieldMask

ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต คั่นหลายค่าด้วยคอมมา หรือใช้ * เพื่ออัปเดตเส้นทางของช่องทั้งหมด

เส้นทางช่องที่รองรับในปัจจุบันมีดังนี้
allow_missing

bool

ไม่บังคับ หาก true และไม่พบข้อความ ระบบจะสร้างข้อความใหม่และระบบจะไม่สนใจ updateMask รหัสข้อความที่ระบุต้องได้รับการclient-assigned มิฉะนั้นคำขอจะล้มเหลว

UpdateSpaceNotificationSettingRequest

คำขออัปเดตการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน รองรับเฉพาะการอัปเดตการตั้งค่าการแจ้งเตือนสำหรับผู้ใช้ที่โทร

ช่อง
space_notification_setting

SpaceNotificationSetting

ต้องระบุ ชื่อทรัพยากรสำหรับการตั้งค่าการแจ้งเตือนของพื้นที่ทำงานต้องป้อนข้อมูลในรูปแบบ users/{user}/spaces/{space}/spaceNotificationSetting ระบบจะอัปเดตเฉพาะช่องที่ระบุด้วย update_mask
update_mask

FieldMask

ต้องระบุ เส้นทางช่องที่รองรับ: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

ข้อความคำขอสำหรับ UpdateSpaceReadState API

ช่อง
space_read_state

SpaceReadState

ต้องระบุ สถานะการอ่านพื้นที่ทำงานและฟิลด์ที่จะอัปเดต

รองรับเฉพาะการอัปเดตสถานะการอ่านสำหรับผู้ใช้ที่โทรเข้ามาเท่านั้น

หากต้องการอ้างอิงถึงผู้ใช้ที่โทรเข้ามา ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้

  • ชื่อแทน me เช่น users/me/spaces/{space}/spaceReadState

  • อีเมล Workspace ของผู้ใช้ เช่น users/user@example.com/spaces/{space}/spaceReadState

  • รหัสผู้ใช้ เช่น users/123456789/spaces/{space}/spaceReadState

รูปแบบ: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต เส้นทางช่องที่รองรับในปัจจุบันมีดังนี้

  • last_read_time

เมื่อ last_read_time อยู่ก่อนเวลาสร้างข้อความล่าสุด พื้นที่ทำงานจะปรากฏว่ายังไม่อ่านใน UI

หากต้องการทำเครื่องหมายพื้นที่ทำงานว่าอ่านแล้ว ให้ตั้งค่า last_read_time เป็นค่าใดก็ได้ในภายหลัง (ใหญ่กว่า) เวลาที่สร้างข้อความล่าสุด ระบบจะบังคับให้ last_read_time ตรงกับเวลาที่สร้างข้อความล่าสุด โปรดทราบว่าสถานะอ่านของพื้นที่ทำงานจะมีผลกับสถานะอ่านของข้อความที่ปรากฏในการสนทนาระดับบนสุดของพื้นที่ทำงานเท่านั้น การตอบกลับในชุดข้อความจะไม่ได้รับผลกระทบจากการประทับเวลานี้ และจะอาศัยสถานะการอ่านชุดข้อความแทน

UpdateSpaceRequest

คำขออัปเดตพื้นที่ทำงาน 1 รายการ

ช่อง
space

Space

ต้องระบุ พื้นที่ทำงานที่มีช่องที่จะอัปเดต Space.name ต้องป้อนในรูปแบบ spaces/{space} เฉพาะฟิลด์ที่ update_mask ระบุเท่านั้นที่อัปเดต
update_mask

FieldMask

ต้องระบุ เส้นทางฟิลด์ที่อัปเดตแล้ว โดยคั่นด้วยคอมมาหากมีหลายรายการ

คุณสามารถอัปเดตพื้นที่ทำงานในช่องต่อไปนี้

space_details: อัปเดตคำอธิบายของพื้นที่ทำงาน รองรับสูงสุด 150 อักขระ

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

space_type: รองรับเฉพาะการเปลี่ยนประเภทพื้นที่ทำงาน GROUP_CHAT เป็น SPACE รวม display_name ไว้กับ space_type ในมาสก์การอัปเดต และตรวจสอบว่าพื้นที่ทำงานที่ระบุมีชื่อที่แสดงที่ไม่ใช่ค่าว่างและประเภทพื้นที่ทำงาน SPACE การรวมมาสก์ space_type และประเภท SPACE ในพื้นที่ทำงานที่ระบุเมื่ออัปเดตชื่อที่แสดงนั้นไม่บังคับหากพื้นที่ทำงานที่มีอยู่มีประเภท SPACE อยู่แล้ว การพยายามอัปเดตประเภทพื้นที่ทำงานด้วยวิธีอื่นๆ จะส่งผลให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ไม่ถูกต้อง space_type ไม่รองรับ useAdminAccess

space_history_state: อัปเดตการตั้งค่าประวัติพื้นที่ทำงานโดยการเปิดหรือปิดประวัติสำหรับพื้นที่ทำงาน ใช้ได้เฉพาะในกรณีที่เปิดใช้การตั้งค่าประวัติสำหรับองค์กร Google Workspace เท่านั้น หากต้องการอัปเดตสถานะประวัติพื้นที่ทำงาน คุณต้องละเว้นมาสก์ฟิลด์อื่นๆ ทั้งหมดในคำขอ useAdminAccess ไม่รองรับ space_history_state

access_settings.audience: อัปเดตการตั้งค่าการเข้าถึงว่าใครสามารถค้นพบพื้นที่ทำงาน เข้าร่วมพื้นที่ทำงาน และดูตัวอย่างข้อความในพื้นที่ทำงานที่ตั้งชื่อโดยที่ช่อง spaceType คือ SPACE หากพื้นที่ทำงานที่มีอยู่มีกลุ่มเป้าหมาย คุณจะนำกลุ่มเป้าหมายออกและจำกัดการเข้าถึงพื้นที่ทำงานได้โดยละเว้นค่าสำหรับมาสก์ช่องนี้ หากต้องการอัปเดตการตั้งค่าการเข้าถึงสำหรับพื้นที่ทำงาน ผู้ใช้ที่ตรวจสอบสิทธิ์ต้องเป็นผู้จัดการพื้นที่ทำงานและไม่ต้องใส่มาสก์ช่องอื่นๆ ทั้งหมดในคำขอ คุณจะอัปเดตช่องนี้ไม่ได้หากพื้นที่ทำงานอยู่ในโหมดการนำเข้า โปรดดูข้อมูลเพิ่มเติมที่หัวข้อทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้ useAdminAccess ไม่รองรับ access_settings.audience

permission_settings: รองรับการเปลี่ยนแปลงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน เมื่ออัปเดตการตั้งค่าสิทธิ์ คุณจะระบุมาสก์ช่องได้เพียง permissionSettings รายการเท่านั้น คุณจะอัปเดตมาสก์ของช่องอื่นๆ พร้อมกันไม่ได้ permissionSettings ไม่รองรับ useAdminAccess ฟิลด์มาสก์ที่รองรับมีดังนี้

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 ของ chat.admin.spaces

ค่า FieldMask บางค่าไม่ได้รับการสนับสนุนโดยใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ โปรดดูรายละเอียดที่คำอธิบายของ update_mask

ผู้ใช้

ผู้ใช้ใน Google Chat เมื่อแสดงผลเป็นเอาต์พุตจากคำขอ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตสำหรับทรัพยากร User จะแสดงเฉพาะ name และ type ของผู้ใช้

ช่อง
name

string

ชื่อทรัพยากรสำหรับ user ของ Google Chat

รูปแบบ: users/{user} users/app สามารถใช้เป็นอีเมลแทนสำหรับผู้ใช้ bot ของแอปการโทร

สำหรับ human users {user} จะเป็นตัวระบุผู้ใช้เดียวกันกับ

  • id สำหรับ Person ใน People API ตัวอย่างเช่น users/123456789 ใน Chat API แสดงแทนบุคคลเดียวกันกับรหัสโปรไฟล์บุคคลของ 123456789 ใน People API

  • id สำหรับผู้ใช้ใน Admin SDK Directory API

  • สามารถใช้อีเมลของผู้ใช้เป็นอีเมลแทนสำหรับ {user} ในคำขอ API เช่น หากรหัสโปรไฟล์บุคคลของ user@example.com ใน People API คือ 123456789 คุณจะใช้ users/user@example.com เป็นชื่อแทนเพื่ออ้างอิง users/123456789 ได้ ระบบจะแสดงผลเฉพาะชื่อแหล่งข้อมูล Canonical (เช่น users/123456789) จาก API
display_name

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของผู้ใช้
domain_id

string

ตัวระบุที่ไม่ซ้ำกันของโดเมน Google Workspace ของผู้ใช้
type

Type

ประเภทผู้ใช้
is_anonymous

bool

เอาต์พุตเท่านั้น เมื่อเป็น true แสดงว่าระบบลบผู้ใช้หรือโปรไฟล์ของผู้ใช้นั้นไม่แสดง

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้
HUMAN ผู้ใช้ที่เป็นบุคคล
BOT ผู้ใช้แอป Chat

UserMentionMetadata

ข้อมูลเมตาของคำอธิบายประกอบสำหรับการพูดถึงผู้ใช้ (@)

ช่อง
user

User

ผู้ใช้พูดถึง
type

Type

ประเภทของการพูดถึงผู้ใช้

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้
ADD เพิ่มผู้ใช้ไปยังพื้นที่ทำงาน
MENTION พูดถึงผู้ใช้ในพื้นที่ทำงาน

WidgetMarkup

วิดเจ็ตเป็นองค์ประกอบ UI ที่แสดงข้อความและรูปภาพ

ช่อง
buttons[]

Button

รายการปุ่ม ปุ่มต่างๆ ยังเป็นแบบ oneof data ด้วย และควรตั้งค่าเพียงฟิลด์เดียวเท่านั้น
ฟิลด์สหภาพ data WidgetMarkup อาจมีรายการใดรายการหนึ่งต่อไปนี้เท่านั้น คุณสามารถใช้ช่อง WidgetMarkup หลายช่องเพื่อแสดงรายการเพิ่มเติมได้ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
text_paragraph

TextParagraph

แสดงย่อหน้าข้อความในวิดเจ็ตนี้
image

Image

แสดงรูปภาพในวิดเจ็ตนี้
key_value

KeyValue

แสดงรายการคีย์-ค่าในวิดเจ็ตนี้

ปุ่ม

ปุ่ม อาจเป็นปุ่มข้อความหรือปุ่มรูปภาพ

ช่อง

ช่องการรวม type

type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text_button

TextButton

ปุ่มที่มีข้อความและการดำเนินการ onclick
image_button

ImageButton

ปุ่มที่มีรูปภาพและการดําเนินการ onclick

FormAction

การดําเนินการของแบบฟอร์มจะอธิบายลักษณะการทํางานเมื่อมีการส่งแบบฟอร์ม เช่น คุณสามารถเรียกใช้ Apps Script เพื่อจัดการแบบฟอร์ม

ช่อง
action_method_name

string

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

ActionParameter

รายการพารามิเตอร์การดำเนินการ

ActionParameter

รายการพารามิเตอร์สตริงที่ต้องระบุเมื่อมีการเรียกใช้เมธอดการดำเนินการ ตัวอย่างเช่น ลองพิจารณาปุ่มปิดเสียงเตือนชั่วคราว 3 ปุ่ม ได้แก่ ปิดเสียงเตือนชั่วคราวเดี๋ยวนี้ ปิดเสียงเตือนชั่วคราว 1 วัน ปิดเสียงเตือนชั่วคราวสัปดาห์หน้า คุณอาจใช้ action method = snooze() โดยส่งประเภทการเลื่อนการปลุกและเวลาเลื่อนการปลุกในรายการพารามิเตอร์สตริง

ช่อง
key

string

ชื่อพารามิเตอร์สําหรับสคริปต์การดำเนินการ
value

string

ค่าของพารามิเตอร์

Icon

ชุดไอคอนที่รองรับ

Enum
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

รูปภาพ

รูปภาพที่ระบุโดย URL และมีการดำเนินการ onclick ได้

ช่อง
image_url

string

URL ของรูปภาพ
on_click

OnClick

การดำเนินการ onclick
aspect_ratio

double

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

ImageButton

ปุ่มรูปภาพที่มีการดำเนินการ onclick

ช่อง
on_click

OnClick

การดำเนินการ onclick
name

string

ชื่อของ image_button นี้ซึ่งใช้สำหรับการช่วยเหลือพิเศษ ระบบจะระบุค่าเริ่มต้นหากไม่ได้ระบุชื่อนี้
ฟิลด์สหภาพ icons ระบุไอคอนได้โดยใช้ Icon enum หรือ URL icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
icon

Icon

ไอคอนที่ระบุโดย enum ซึ่งระบุดัชนีไปยังไอคอนที่ Chat API ระบุ
icon_url

string

ไอคอนที่ระบุโดย URL

KeyValue

องค์ประกอบ UI มีคีย์ (ป้ายกำกับ) และค่า (เนื้อหา) องค์ประกอบนี้ยังมีการดำเนินการบางอย่าง เช่น ปุ่ม onclick ด้วย

ช่อง
top_label

string

ข้อความของป้ายกำกับด้านบน รองรับข้อความที่มีการจัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
content

string

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

bool

ในกรณีที่เนื้อหาควรเป็นหลายบรรทัด
bottom_label

string

ข้อความของป้ายกำกับด้านล่าง รองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
on_click

OnClick

การดำเนินการ onclick เฉพาะป้ายกำกับด้านบน ป้ายกำกับด้านล่าง และขอบเขตของเนื้อหาเท่านั้นที่คลิกได้
ช่องการรวม icons ต้องกำหนดไอคอนอย่างน้อย 1 รายการ top_label และ bottom_label icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
icon

Icon

ค่า enum ที่ Chat API แทนที่ด้วยรูปภาพไอคอนที่เกี่ยวข้อง
icon_url

string

ไอคอนที่ระบุโดย URL
ฟิลด์สหภาพ control วิดเจ็ตการควบคุม คุณตั้งค่า button หรือ switch_widget ได้ แต่ตั้งค่าทั้ง 2 อย่างไม่ได้ control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
button

Button

ปุ่มที่คลิกได้เพื่อเรียกให้แสดงการดำเนินการ

OnClick

การดำเนินการ onclick (เช่น เปิดลิงก์)

ช่อง

ฟิลด์สหภาพ data

data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
action

FormAction

การทำงานของแบบฟอร์มจะทริกเกอร์โดยการดำเนินการ onclick นี้ หากระบุ

TextButton

ปุ่มที่มีข้อความและการทำงาน onclick

ช่อง
text

string

ข้อความของปุ่ม
on_click

OnClick

การทำงาน onclick ของปุ่ม

TextParagraph

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

ช่อง
text

string