Package google.chat.v1

ดัชนี

• ChatService (อินเทอร์เฟซ)
• AccessoryWidget (ข้อความ)
• ActionResponse (ข้อความ)
• ActionResponse.ResponseType (enum)
• ActionResponse.SelectionItems (ข้อความ)
• ActionResponse.UpdatedWidget (ข้อความ)
• ActionStatus (ข้อความ)
• Annotation (ข้อความ)
• AnnotationType (enum)
• AttachedGif (ข้อความ)
• Attachment (ข้อความ)
• Attachment.Source (enum)
• AttachmentDataRef (ข้อความ)
• CardWithId (ข้อความ)
• ChatSpaceLinkData (ข้อความ)
• CompleteImportSpaceRequest (ข้อความ)
• CompleteImportSpaceResponse (ข้อความ)
• ContextualAddOnMarkup (ข้อความ)
• ContextualAddOnMarkup.Card (ข้อความ)
• ContextualAddOnMarkup.Card.CardAction (ข้อความ)
• ContextualAddOnMarkup.Card.CardHeader (ข้อความ)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (enum)
• ContextualAddOnMarkup.Card.Section (ข้อความ)
• CreateMembershipRequest (ข้อความ)
• CreateMessageRequest (ข้อความ)
• CreateMessageRequest.MessageReplyOption (enum)
• CreateReactionRequest (ข้อความ)
• CreateSpaceRequest (ข้อความ)
• CustomEmoji (ข้อความ)
• DeleteMembershipRequest (ข้อความ)
• DeleteMessageRequest (ข้อความ)
• DeleteReactionRequest (ข้อความ)
• DeleteSpaceRequest (ข้อความ)
• DeletionMetadata (ข้อความ)
• DeletionMetadata.DeletionType (enum)
• Dialog (ข้อความ)
• DialogAction (ข้อความ)
• DriveDataRef (ข้อความ)
• DriveLinkData (ข้อความ)
• Emoji (ข้อความ)
• EmojiReactionSummary (ข้อความ)
• FindDirectMessageRequest (ข้อความ)
• GetAttachmentRequest (ข้อความ)
• GetMembershipRequest (ข้อความ)
• GetMessageRequest (ข้อความ)
• GetSpaceEventRequest (ข้อความ)
• GetSpaceReadStateRequest (ข้อความ)
• GetSpaceRequest (ข้อความ)
• GetThreadReadStateRequest (ข้อความ)
• Group (ข้อความ)
• HistoryState (enum)
• ListMembershipsRequest (ข้อความ)
• ListMembershipsResponse (ข้อความ)
• ListMessagesRequest (ข้อความ)
• ListMessagesResponse (ข้อความ)
• ListReactionsRequest (ข้อความ)
• ListReactionsResponse (ข้อความ)
• ListSpaceEventsRequest (ข้อความ)
• ListSpaceEventsResponse (ข้อความ)
• ListSpacesRequest (ข้อความ)
• ListSpacesResponse (ข้อความ)
• MatchedUrl (ข้อความ)
• Membership (ข้อความ)
• Membership.MembershipRole (enum)
• Membership.MembershipState (enum)
• MembershipBatchCreatedEventData (ข้อความ)
• MembershipBatchDeletedEventData (ข้อความ)
• MembershipBatchUpdatedEventData (ข้อความ)
• MembershipCreatedEventData (ข้อความ)
• MembershipDeletedEventData (ข้อความ)
• MembershipUpdatedEventData (ข้อความ)
• Message (ข้อความ)
• MessageBatchCreatedEventData (ข้อความ)
• MessageBatchDeletedEventData (ข้อความ)
• MessageBatchUpdatedEventData (ข้อความ)
• MessageCreatedEventData (ข้อความ)
• MessageDeletedEventData (ข้อความ)
• MessageUpdatedEventData (ข้อความ)
• QuotedMessageMetadata (ข้อความ)
• Reaction (ข้อความ)
• ReactionBatchCreatedEventData (ข้อความ)
• ReactionBatchDeletedEventData (ข้อความ)
• ReactionCreatedEventData (ข้อความ)
• ReactionDeletedEventData (ข้อความ)
• RichLinkMetadata (ข้อความ)
• RichLinkMetadata.RichLinkType (enum)
• SearchSpacesRequest (ข้อความ)
• SearchSpacesResponse (ข้อความ)
• SetUpSpaceRequest (ข้อความ)
• SlashCommand (ข้อความ)
• SlashCommandMetadata (ข้อความ)
• SlashCommandMetadata.Type (enum)
• Space (ข้อความ)
• Space.AccessSettings (ข้อความ)
• Space.AccessSettings.AccessState (enum)
• Space.MembershipCount (ข้อความ)
• Space.PermissionSetting (ข้อความ)
• Space.PermissionSettings (ข้อความ)
• Space.PredefinedPermissionSettings (enum)
• Space.SpaceDetails (ข้อความ)
• Space.SpaceThreadingState (enum)
• Space.SpaceType (enum)
• Space.Type (enum)
• SpaceBatchUpdatedEventData (ข้อความ)
• SpaceEvent (ข้อความ)
• SpaceReadState (ข้อความ)
• SpaceUpdatedEventData (ข้อความ)
• Thread (ข้อความ)
• ThreadReadState (ข้อความ)
• UpdateMembershipRequest (ข้อความ)
• UpdateMessageRequest (ข้อความ)
• UpdateSpaceReadStateRequest (ข้อความ)
• UpdateSpaceRequest (ข้อความ)
• User (ข้อความ)
• User.Type (enum)
• UserMentionMetadata (ข้อความ)
• UserMentionMetadata.Type (enum)
• WidgetMarkup (ข้อความ)
• WidgetMarkup.Button (ข้อความ)
• WidgetMarkup.FormAction (ข้อความ)
• WidgetMarkup.FormAction.ActionParameter (ข้อความ)
• WidgetMarkup.Icon (enum)
• WidgetMarkup.Image (ข้อความ)
• WidgetMarkup.ImageButton (ข้อความ)
• WidgetMarkup.KeyValue (ข้อความ)
• WidgetMarkup.OnClick (ข้อความ)
• WidgetMarkup.OpenLink (ข้อความ)
• WidgetMarkup.TextButton (ข้อความ)
• WidgetMarkup.TextParagraph (ข้อความ)

ChatService

อนุญาตให้นักพัฒนาแอปสร้างแอปใน Chat และการผสานรวมในแพลตฟอร์ม Google Chat

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse) ทํากระบวนการนําเข้าสําหรับพื้นที่ทํางานที่ระบุให้เสร็จสมบูรณ์ และแสดงต่อผู้ใช้ ต้องมีการตรวจสอบสิทธิ์แอปและการมอบสิทธิ์ทั่วทั้งโดเมน โปรดดูข้อมูลเพิ่มเติมที่หัวข้อให้สิทธิ์แอปใน Google Chat ในการนําเข้าข้อมูล ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/chat.import สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership) สร้างการเป็นสมาชิกที่เป็นมนุษย์หรือการเป็นสมาชิกของแอปสำหรับแอปการโทร ระบบไม่รองรับการสร้างการเป็นสมาชิกสำหรับแอปอื่นๆ โปรดดูตัวอย่างที่หัวข้อเชิญหรือเพิ่มผู้ใช้หรือแอป Google Chat ไปยังพื้นที่ทำงาน เมื่อสร้างการเป็นสมาชิก หากสมาชิกที่ระบุปิดนโยบายการยอมรับอัตโนมัติไว้ สมาชิกก็จะได้รับเชิญและต้องยอมรับคำเชิญของพื้นที่ทำงานก่อนจึงจะเข้าร่วมได้ แต่หากสร้างการเป็นสมาชิก ระบบจะเพิ่มสมาชิกไปยังพื้นที่ทำงานที่ระบุโดยตรง ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ หากต้องการระบุสมาชิกที่จะเพิ่ม ให้ตั้งค่า membership.member.name สำหรับสมาชิกที่เป็นมนุษย์หรือแอป หรือตั้งค่า membership.group_member.name สำหรับสมาชิกกลุ่ม หากต้องการเพิ่มแอปการโทรไปยังพื้นที่ทำงานหรือข้อความส่วนตัวระหว่างผู้ใช้ที่เป็นมนุษย์ 2 คน ให้ใช้ users/app ไม่สามารถเพิ่มแอปอื่นๆ ไปยังพื้นที่ทำงานได้ หากต้องการเพิ่มผู้ใช้ที่เป็นมนุษย์ ให้ใช้ users/{user} โดย {user} สามารถเป็นอีเมลของผู้ใช้ได้ สำหรับผู้ใช้ในองค์กร Workspace เดียวกัน {user} สามารถเป็น id สำหรับบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ได้ด้วย ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลของ People API สำหรับ [e-mail] คือ 123456789 คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยตั้งค่า membership.member.name เป็น users/[e-mail] หรือ users/123456789 หากต้องการเพิ่มหรือเชิญกลุ่ม Google ในพื้นที่ทำงานที่ตั้งชื่อ ให้ใช้ groups/{group} โดยที่ {group} คือ id ของกลุ่มจาก Cloud Identity Groups API ตัวอย่างเช่น คุณสามารถใช้ API การค้นหากลุ่ม Cloud Identity เพื่อเรียกข้อมูลรหัส 123456789 สำหรับอีเมลกลุ่ม [e-mail] จากนั้นจึงเพิ่มหรือเชิญกลุ่มไปยังพื้นที่ทำงานที่ระบุชื่อ โดยตั้งค่า membership.group_member.name เป็น groups/123456789 ไม่รองรับอีเมลกลุ่ม และเพิ่ม Google Groups เป็นสมาชิกได้เฉพาะในพื้นที่ทำงานที่ตั้งชื่อเท่านั้น ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้ 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 ขนาดสูงสุดของข้อความรวมถึงข้อความและการ์ดคือ 32,000 ไบต์ โปรดดูตัวอย่างที่หัวข้อส่งข้อความ การเรียกใช้เมธอดนี้ต้องมีการตรวจสอบสิทธิ์ และรองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ สำหรับ SMS จะรองรับการตรวจสอบสิทธิ์ผู้ใช้หรือการตรวจสอบสิทธิ์แอป สำหรับข้อความการ์ด จะรองรับเฉพาะการตรวจสอบสิทธิ์แอปเท่านั้น (เฉพาะแอปใน Chat เท่านั้นที่สร้างข้อความในการ์ดได้) ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต 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 อาจใช้ชื่อที่แสดงนี้อยู่แล้ว ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้ https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership) ลบการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้อนําผู้ใช้หรือแอป Google Chat ออกจากพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้ 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.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 ที่เรียกใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้หรือการตรวจสอบสิทธิ์แอป ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต 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 สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

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 สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent) แสดงผลกิจกรรมจากพื้นที่ใน Google Chat เปย์โหลดเหตุการณ์มีทรัพยากรเวอร์ชันล่าสุดที่มีการเปลี่ยนแปลง ตัวอย่างเช่น หากคุณขอเหตุการณ์เกี่ยวกับข้อความใหม่ แต่ข้อความได้รับการอัปเดตในภายหลัง เซิร์ฟเวอร์จะส่งคืนทรัพยากร Message ที่อัปเดตแล้วในเพย์โหลดของเหตุการณ์ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ หากต้องการรับเหตุการณ์ ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วจะต้องเป็นสมาชิกของพื้นที่ทำงาน ตัวอย่างเช่น โปรดดูหัวข้อดูรายละเอียดเกี่ยวกับกิจกรรมจากพื้นที่ใน 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 สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

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 สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

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) แสดงข้อความในพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก รวมถึงข้อความจากสมาชิกที่ถูกบล็อกและพื้นที่ทำงาน เช่น โปรดดูแสดงข้อความ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต 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 จะไม่แสดงจนกว่าจะมีการส่งข้อความแรก ดูตัวอย่างได้ที่แสดงพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้ แสดงพื้นที่ทำงานที่ผู้โทรหรือผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมองเห็นได้ แชทเป็นกลุ่มและ 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 ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว แสดงผลรายการของพื้นที่ทำงานตามการค้นหาของผู้ใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ ผู้ใช้ต้องเป็นผู้ดูแลระบบขององค์กร 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 ได้ด้วย ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลของ People API สำหรับ [e-mail] คือ 123456789 คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยตั้งค่า membership.member.name เป็น users/[e-mail] หรือ users/123456789 หากต้องการระบุกลุ่ม Google ที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย membership.group_member.name ที่เหมาะสม หากต้องการเพิ่มหรือเชิญกลุ่ม Google ให้ใช้ groups/{group} โดยที่ {group} เป็น id ของกลุ่มจาก Cloud Identity Groups API ตัวอย่างเช่น คุณสามารถใช้ API การค้นหากลุ่ม Cloud Identity เพื่อเรียกข้อมูลรหัส 123456789 สำหรับอีเมลกลุ่ม [e-mail] จากนั้นจึงเพิ่มกลุ่มไปยังพื้นที่ทำงานโดยตั้งค่า 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.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.admin.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

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

หมายเหตุ

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

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

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 ข้อมูลเมตาสำหรับคำสั่งเครื่องหมายทับ
rich_link_metadata	RichLinkMetadata ข้อมูลเมตาสำหรับลิงก์ที่มีการจัดรูปแบบ

AnnotationType

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

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

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 ชื่อทรัพยากรของข้อมูลไฟล์แนบ ช่องนี้ใช้กับ API สื่อเพื่อดาวน์โหลดข้อมูลไฟล์แนบ
attachment_upload_token	string โทเค็นทึบที่มีการอ้างอิงไฟล์แนบที่อัปโหลด ไคลเอ็นต์จะถือว่าเป็นสตริงที่คลุมเครือและใช้เพื่อสร้างหรืออัปเดตข้อความใน Chat ที่มีไฟล์แนบ

CardWithId

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

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

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

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

ช่อง
card_id	string ต้องระบุหากข้อความมีการ์ดหลายใบ ตัวระบุที่ไม่ซ้ำกันสำหรับการ์ดในข้อความ
card	Card การ์ด ขนาดสูงสุดคือ 32 KB

ChatSpaceLinkData

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

ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

ช่อง
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 รายการ

CreateMembershipRequest

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

ช่อง
parent	string ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก รูปแบบ: Spaces/{space}
membership	Membership ต้องระบุ ความสัมพันธ์กับการเป็นสมาชิกที่ต้องการสร้าง ช่อง memberType ต้องมีผู้ใช้พร้อมป้อนข้อมูลในช่อง user.name และ user.type เซิร์ฟเวอร์จะกำหนดชื่อทรัพยากรและเขียนทับข้อมูลที่ระบุ เมื่อแอปใน Chat สร้างความสัมพันธ์กับผู้ใช้ที่เป็นมนุษย์ แอปดังกล่าวต้องใช้ขอบเขต chat.memberships ตั้งค่า user.type เป็น HUMAN และตั้งค่า user.name ด้วยรูปแบบ users/{user} โดยที่ {user} เป็นอีเมลของผู้ใช้ได้ สำหรับผู้ใช้ในองค์กร Workspace เดียวกัน {user} สามารถเป็น id ของบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ได้ด้วย ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลของ People API สำหรับ [e-mail] คือ 123456789 คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยตั้งค่า membership.member.name เป็น users/[e-mail] หรือ users/123456789 เมื่อแอปใน Chat สร้างความสัมพันธ์กับการเป็นสมาชิก แอปดังกล่าวจะต้องใช้ขอบเขต chat.memberships.app ตั้งค่า user.type เป็น BOT และตั้งค่า user.name เป็น users/app
use_admin_access	bool ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ 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 อาจใช้ชื่อที่แสดงนี้อยู่แล้ว มีการกำหนดพื้นที่ name บนเซิร์ฟเวอร์ ดังนั้นสิ่งที่ระบุไว้ในช่องนี้จะถูกละเว้น
request_id	string ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับคำขอนี้ ขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอที่มีอยู่จะแสดงผลพื้นที่ทำงานที่สร้างด้วยรหัสนั้นแทนการสร้างพื้นที่ทำงานใหม่ การระบุรหัสคำขอที่มีอยู่จากแอป Chat เดียวกันโดยใช้ผู้ใช้รายอื่นที่ตรวจสอบสิทธิ์แล้วจะแสดงข้อผิดพลาด

CustomEmoji

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

ช่อง
uid	string เอาต์พุตเท่านั้น คีย์ที่ไม่ซ้ำกันสำหรับทรัพยากรอีโมจิที่กำหนดเอง

DeleteMembershipRequest

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

ช่อง
name	string ต้องระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่จะลบ แอปแชทสามารถลบผู้ใช้ที่เป็นมนุษย์ได้ หรือการเป็นสมาชิกของตนเอง แอป Chat จะลบแอปอื่นๆ ไม่ได้ การเป็นสมาชิก เมื่อลบการเป็นสมาชิกที่เป็นมนุษย์ จะต้องมีขอบเขต chat.memberships และรูปแบบ spaces/{space}/members/{member} คุณสามารถใช้อีเมลนี้เป็นอีเมลแทนสำหรับ {member} ได้ เช่น spaces/{space}/members/[e-mail] โดยที่ [e-mail] คืออีเมลของผู้ใช้ Google Chat เมื่อลบการเป็นสมาชิกแอป จะต้องมีขอบเขต chat.memberships.app และรูปแบบ spaces/{space}/members/app รูปแบบ: spaces/{space}/members/{member} หรือ spaces/{space}/members/app
use_admin_access	bool ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ 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 ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ chat.admin.delete

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

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

ช่อง
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/[e-mail] โดยที่ [e-mail] คืออีเมลของผู้ใช้ Google Chat

GetAttachmentRequest

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

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

GetMembershipRequest

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

ช่อง
name	string ต้องระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่จะดึงข้อมูล หากต้องการสมัครสมาชิกของแอปเองโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะเลือกใช้ spaces/{space}/members/app ก็ได้ รูปแบบ: spaces/{space}/members/{member} หรือ spaces/{space}/members/app เมื่อตรวจสอบสิทธิ์ว่าเป็นผู้ใช้แล้ว คุณจะใช้อีเมลของผู้ใช้เป็นชื่อแทนสำหรับ {member} ได้ เช่น spaces/{space}/members/[e-mail] โดยที่ [e-mail] คืออีเมลของผู้ใช้ Google Chat
use_admin_access	bool ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ 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}

GetSpaceReadStateRequest

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

ช่อง

name

string ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านพื้นที่ทำงานที่จะดึงข้อมูล รองรับเฉพาะการรับสถานะการอ่านสำหรับผู้ใช้ที่โทร หากต้องการอ้างอิงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้ ชื่อแทน me เช่น users/me/spaces/{space}/spaceReadState อีเมล Workspace ของผู้ใช้ เช่น users/[e-mail]/spaces/{space}/spaceReadState รหัสผู้ใช้ เช่น users/123456789/spaces/{space}/spaceReadState รูปแบบ: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

คำขอส่งคืนพื้นที่ทำงาน 1 รายการ

ช่อง
name	string ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานในรูปแบบ spaces/{space} รูปแบบ: spaces/{space}
use_admin_access	bool ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ 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/[e-mail]/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	ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาการเก็บข้อความและชุดข้อความ

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 ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ 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 ผลลัพธ์จะแสดงตามลำดับเวลา (เหตุการณ์ที่เก่าสุดก่อน)
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 รายการพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก)
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 ที่เป็นสมาชิก

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 หรือทุกคนในพื้นที่ทำงานได้อีกด้วย หากต้องการเรียนรู้เกี่ยวกับการสร้างข้อความ โปรดดูที่ส่งข้อความ
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 เท่านั้นที่ส่งข้อความส่วนตัวได้ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้เพื่อส่งข้อความ ข้อความจะไม่เป็นแบบส่วนตัวและต้องไม่มีช่องนี้ โปรดดูรายละเอียดที่หัวข้อส่งข้อความส่วนตัวไปยังผู้ใช้ Google Chat
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 ของลิงก์นี้
rich_link_type	RichLinkType ประเภทลิงก์ริชมีเดีย
ช่องการรวม data ข้อมูลสำหรับทรัพยากรที่ลิงก์ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
drive_link_data	DriveLinkData ข้อมูลสำหรับลิงก์ไดรฟ์
chat_space_link_data	ChatSpaceLinkData ข้อมูลสำหรับลิงก์พื้นที่ใน Chat ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

RichLinkType

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

Enum
RICH_LINK_TYPE_UNSPECIFIED	ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้
DRIVE_FILE	ประเภทลิงก์ริชมีเดียของ Google ไดรฟ์
CHAT_SPACE	ประเภทลิงก์ริชมีเดียของพื้นที่ใน Chat เช่น ชิปอัจฉริยะในพื้นที่ทำงาน ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

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 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ
page_token	string โทเค็นที่ได้รับจากการเรียกใช้ Search Space ก่อนหน้า ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้าเว็บ การส่งต่อค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด
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/[e-mail] หากต้องการเชิญผู้ใช้ 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 รหัสของคำสั่งเครื่องหมายทับ

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}
type (deprecated)	Type รายการนี้เลิกใช้งานแล้ว เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ใช้ space_type แทน ประเภทของพื้นที่ทำงาน
space_type	SpaceType ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานหรืออัปเดตประเภทพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นเท่านั้น
single_user_bot_dm	bool ไม่บังคับ พื้นที่ทำงานเป็น DM ระหว่างแอป Chat กับบุคคลเพียงคนเดียวหรือไม่
threaded (deprecated)	bool รายการนี้เลิกใช้งานแล้ว เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ใช้ spaceThreadingState แทน ระบุว่าข้อความเป็นชุดข้อความในพื้นที่ทำงานนี้หรือไม่
display_name	string ชื่อที่แสดงของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงาน หากได้รับข้อความแสดงข้อผิดพลาด 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 หรือไม่ ขณะที่นําเข้าพื้นที่ทำงาน ผู้ใช้จะไม่เห็นพื้นที่ทำงานดังกล่าวจนกว่าการนําเข้าจะเสร็จสมบูรณ์
create_time	Timestamp ไม่บังคับ เปลี่ยนแปลงไม่ได้ สําหรับพื้นที่ทำงานที่สร้างใน Chat เวลาที่สร้างพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ทำงานโหมดการนำเข้า สำหรับพื้นที่ทำงานโหมดการนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาในอดีตที่มีการสร้างพื้นที่ทำงานในแหล่งที่มาเพื่อรักษาเวลาที่สร้างเดิมไว้ ระบบจะป้อนข้อมูลในเอาต์พุตเมื่อ spaceType คือ GROUP_CHAT หรือ SPACE เท่านั้น
last_active_time	Timestamp เอาต์พุตเท่านั้น การประทับเวลาของข้อความสุดท้ายในพื้นที่ทำงาน ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว
admin_installed	bool เอาต์พุตเท่านั้น สําหรับพื้นที่ทำงานในข้อความส่วนตัว (DM) ที่มีแอป Chat ไม่ว่าพื้นที่ทำงานนั้นสร้างขึ้นโดยผู้ดูแลระบบ Google Workspace หรือไม่ ผู้ดูแลระบบสามารถติดตั้งและตั้งค่าข้อความส่วนตัวกับแอป Chat ในนามของผู้ใช้ในองค์กรได้ แอป Chat ของคุณต้องมีการรับส่งข้อความส่วนตัวจึงจะรองรับการติดตั้งโดยผู้ดูแลระบบ
membership_count	MembershipCount เอาต์พุตเท่านั้น จำนวนการเป็นสมาชิกที่เข้าร่วมซึ่งจัดกลุ่มตามประเภทสมาชิก ป้อนข้อมูลเมื่อ space_type คือ SPACE, DIRECT_MESSAGE หรือ GROUP_CHAT ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว
access_settings	AccessSettings ไม่บังคับ ระบุการตั้งค่าการเข้าถึงของพื้นที่ทำงาน ระบบจะป้อนข้อมูลเมื่อ space_type คือ SPACE เท่านั้น
space_uri	string เอาต์พุตเท่านั้น URI สำหรับผู้ใช้ในการเข้าถึงพื้นที่ทำงาน
ช่องการรวม space_permission_settings แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน ระบบจะป้อนข้อมูลเมื่อ space_type คือ SPACE เท่านั้น ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว space_permission_settings ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
predefined_permission_settings	PredefinedPermissionSettings ไม่บังคับ อินพุตเท่านั้น การตั้งค่าสิทธิ์ของพื้นที่ทำงาน อินพุตสำหรับการสร้างพื้นที่ทำงาน ระบบจะสร้างพื้นที่การทำงานร่วมกันหากไม่ได้ตั้งค่าช่องนี้ หลังจากสร้างพื้นที่ทำงานแล้ว ระบบจะป้อนข้อมูลการตั้งค่าในช่อง PermissionSettings ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว
permission_settings	PermissionSettings ไม่บังคับ การตั้งค่าสิทธิ์ที่แน่นอนซึ่งกำหนดให้อัปเดตพื้นที่ทำงานได้ อินพุตสำหรับการอัปเดตพื้นที่ทำงาน หากไม่เป็นเช่นนั้น ให้แสดงเฉพาะเอาต์พุต หากต้องการสร้างพื้นที่ทำงาน โปรดใช้ predefined_permission_settings แทน ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

AccessSettings

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

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

AccessState

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

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

MembershipCount

ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

แสดงจำนวนสมาชิกของพื้นที่ทำงานที่จัดกลุ่มเป็นหมวดหมู่ต่างๆ

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

PermissionSetting

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

ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

ช่อง
managers_allowed	bool ผู้จัดการพื้นที่ทำงานมีสิทธิ์นี้หรือไม่
members_allowed	bool สมาชิกที่ไม่ใช่ผู้จัดการจะมีสิทธิ์นี้หรือไม่

PermissionSettings

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

ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

ช่อง
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

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

ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว

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

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 ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ chat.admin.memberships

UpdateMessageRequest

ขออัปเดตข้อความ

ช่อง
message	Message ต้องระบุ ข้อความที่อัปเดตช่องแล้ว
update_mask	FieldMask ต้องระบุ เส้นทางช่องที่จะอัปเดต คั่นค่าหลายค่าด้วยเครื่องหมายจุลภาคหรือใช้ * เพื่ออัปเดตเส้นทางช่องทั้งหมด เส้นทางช่องที่รองรับในปัจจุบันมีดังนี้ text attachment cards (ต้องมีการตรวจสอบสิทธิ์แอป) cards_v2 (ต้องมีการตรวจสอบสิทธิ์แอป) accessory_widgets (ต้องมีการตรวจสอบสิทธิ์แอป)
allow_missing	bool ไม่บังคับ หาก true และไม่พบข้อความ ระบบจะสร้างข้อความใหม่และระบบจะไม่สนใจ updateMask รหัสข้อความที่ระบุต้องได้รับการกำหนดโดยลูกค้า มิฉะนั้นคำขอจะล้มเหลว

UpdateSpaceReadStateRequest

ข้อความคำขอสำหรับ UpdateSpaceReadState API

ช่อง
space_read_state	SpaceReadState ต้องระบุ สถานะการอ่านของพื้นที่ทำงานและฟิลด์ที่จะอัปเดต รองรับเฉพาะการอัปเดตสถานะการอ่านสำหรับผู้ใช้ที่โทร หากต้องการอ้างอิงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้ ชื่อแทน me เช่น users/me/spaces/{space}/spaceReadState อีเมล Workspace ของผู้ใช้ เช่น users/[e-mail]/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 display_name: รองรับเฉพาะการอัปเดตชื่อที่แสดงสำหรับพื้นที่ทำงานที่ช่อง spaceType เป็น SPACE หากได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS ให้ลองใช้ค่าอื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว space_type: รองรับเฉพาะการเปลี่ยนประเภทพื้นที่ทำงาน GROUP_CHAT เป็น SPACE รวม display_name พร้อมกับ space_type ในมาสก์การอัปเดตและตรวจสอบว่าพื้นที่ทำงานที่ระบุมีชื่อที่แสดงและไม่ว่างเปล่าและประเภทพื้นที่ทำงาน SPACE คุณจะใส่มาสก์ space_type และประเภท SPACE ในพื้นที่ทำงานที่ระบุหรือไม่ก็ได้เมื่ออัปเดตชื่อที่แสดง หากพื้นที่ทำงานที่มีอยู่มีประเภท SPACE อยู่แล้ว การพยายามอัปเดตประเภทพื้นที่ทำงานด้วยวิธีอื่นๆ จะส่งผลให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ไม่ถูกต้อง space_type ไม่รองรับสิทธิ์เข้าถึงระดับผู้ดูแลระบบ space_history_state: อัปเดตการตั้งค่าประวัติพื้นที่ทำงานโดยการเปิดหรือปิดประวัติสำหรับพื้นที่ทำงาน รองรับเฉพาะเมื่อเปิดการตั้งค่าประวัติสำหรับองค์กร Google Workspace หากต้องการอัปเดตสถานะประวัติพื้นที่ทำงาน คุณต้องเว้นฟิลด์มาสก์อื่นๆ ทั้งหมดในคำขอ space_history_state ไม่รองรับสิทธิ์เข้าถึงระดับผู้ดูแลระบบ access_settings.audience: อัปเดตการตั้งค่าการเข้าถึงว่าใครสามารถค้นพบพื้นที่ทำงาน เข้าร่วมพื้นที่ทำงาน และดูตัวอย่างข้อความในพื้นที่ทำงานที่ตั้งชื่อโดยที่ช่อง spaceType คือ SPACE หากพื้นที่ทำงานที่มีอยู่มีกลุ่มเป้าหมาย คุณจะนำกลุ่มเป้าหมายออกและจำกัดการเข้าถึงพื้นที่ทำงานได้โดยละเว้นค่าสำหรับมาสก์ช่องนี้ หากต้องการอัปเดตการตั้งค่าการเข้าถึงสำหรับพื้นที่ทำงาน ผู้ใช้ที่ตรวจสอบสิทธิ์จะต้องเป็นผู้จัดการพื้นที่ทำงาน และยกเว้นฟิลด์มาสก์อื่นๆ ทั้งหมดในคำขอ คุณจะอัปเดตช่องนี้ไม่ได้หากพื้นที่ทำงานอยู่ในโหมดการนำเข้า โปรดดูข้อมูลเพิ่มเติมที่หัวข้อทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้ access_settings.audience ไม่รองรับสิทธิ์เข้าถึงระดับผู้ดูแลระบบ ตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: รองรับการเปลี่ยนการตั้งค่าสิทธิ์ของพื้นที่ทำงาน เส้นทางช่องที่รองรับ ได้แก่ permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (คำเตือน: จำกัดเฉพาะเส้นทางในช่องการตั้งค่าที่ไม่ใช่สิทธิ์อื่นๆ ทั้งหมด) permission_settings ไม่รองรับสิทธิ์เข้าถึงระดับผู้ดูแลระบบ
use_admin_access	bool ตัวอย่างสำหรับนักพัฒนาแอป: มีให้ใช้งานโดยเป็นส่วนหนึ่งของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป Google Workspace ซึ่งจะให้สิทธิ์ทดลองใช้บางฟีเจอร์ก่อนเปิดตัว เมื่อใช้ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ chat.admin.spaces ค่า FieldMask บางค่าไม่ได้รับการสนับสนุนโดยใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ โปรดดูรายละเอียดในคำอธิบาย update_mask

ผู้ใช้

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

ช่อง
name	string ชื่อทรัพยากรสำหรับ Google Chat user รูปแบบ: 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 ได้ ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลของ People API สำหรับ [e-mail] คือ 123456789 คุณสามารถใช้ users/[e-mail] เป็นชื่อแทนเพื่ออ้างอิง 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 จะมีรายการดังต่อไปนี้ได้เพียง 1 รายการเท่านั้น คุณสามารถใช้ช่อง 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 นี้ หากระบุ
open_link	OpenLink การดำเนินการ onclick นี้จะทริกเกอร์การดำเนินการแบบเปิดของลิงก์ (หากระบุไว้)

OpenLink

ลิงก์ที่เปิดหน้าต่างใหม่

ช่อง
url	string URL ที่จะเปิด

TextButton

ปุ่มที่มีข้อความและการทำงาน onclick

ช่อง
text	string ข้อความของปุ่ม
on_click	OnClick การทำงาน onclick ของปุ่ม

TextParagraph

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

ช่อง
text	string