ดัชนี
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 |
---|
ดำเนินการกระบวนการนําเข้าสําหรับพื้นที่ทำงานที่ระบุให้เสร็จสมบูรณ์และทําให้ผู้ใช้เห็นพื้นที่ทำงานดังกล่าว ต้องมีการตรวจสอบสิทธิ์แอปและการมอบสิทธิ์ทั่วทั้งโดเมน โปรดดูข้อมูลเพิ่มเติมที่หัวข้อให้สิทธิ์แอปใน Google Chat ในการนําเข้าข้อมูล
|
CreateMembership |
---|
สร้างการเป็นสมาชิกสำหรับแอป Chat, ผู้ใช้ หรือ Google Group ระบบไม่รองรับการสร้างการเป็นสมาชิกสำหรับแอป Chat อื่นๆ เมื่อสร้างการเป็นสมาชิก หากสมาชิกที่ระบุปิดนโยบายการยอมรับอัตโนมัติไว้ สมาชิกก็จะได้รับเชิญและต้องยอมรับคำเชิญของพื้นที่ทำงานก่อนจึงจะเข้าร่วมได้ แต่หากสร้างการเป็นสมาชิก ระบบจะเพิ่มสมาชิกไปยังพื้นที่ทำงานที่ระบุโดยตรง ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ ดูตัวอย่างการใช้งานได้ที่
|
CreateMessage |
---|
สร้างข้อความในพื้นที่ใน Google Chat โปรดดูตัวอย่างที่หัวข้อส่งข้อความ เมธอด รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์แอป Chat จะแสดงแอป Chat เป็นผู้ส่งข้อความ เนื้อหาของข้อความอาจมีข้อความ ( รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์ผู้ใช้ Chat จะแสดงผู้ใช้เป็นผู้ส่งข้อความและระบุแหล่งที่มาของแอป Chat เป็นข้อความด้วยการแสดงชื่อแอป เนื้อหาข้อความมีได้เฉพาะข้อความ ( ขนาดสูงสุดของข้อความรวมถึงเนื้อหาของข้อความคือ 32,000 ไบต์
|
CreateReaction |
---|
สร้างรีแอ็กชันและเพิ่มลงในข้อความ รองรับเฉพาะอีโมจิ Unicode เท่านั้น โปรดดูตัวอย่างที่หัวข้อเพิ่มรีแอ็กชันในข้อความ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
CreateSpace |
---|
สร้างพื้นที่ทำงานที่ไม่มีสมาชิก สามารถใช้เพื่อสร้างพื้นที่ทำงานที่มีชื่อ ไม่รองรับพื้นที่ทำงานที่จัดกลุ่มตามหัวข้อ โปรดดูตัวอย่างที่หัวข้อสร้างพื้นที่ทำงาน หากได้รับข้อความแสดงข้อผิดพลาด หากคุณเป็นสมาชิกโปรแกรมทดลองใช้สำหรับนักพัฒนาซอฟต์แวร์ คุณจะสร้างแชทเป็นกลุ่มในโหมดนำเข้าได้โดยใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
DeleteMembership |
---|
ลบการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้อนําผู้ใช้หรือแอป Google Chat ออกจากพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
DeleteMessage |
---|
ลบข้อความ โปรดดูตัวอย่างที่หัวข้อลบข้อความ ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้ เมื่อใช้การตรวจสอบสิทธิ์แอป คำขอจะลบได้เฉพาะข้อความที่สร้างโดยแอป Chat ที่เรียกใช้เท่านั้น
|
DeleteReaction |
---|
ลบรีแอ็กชันต่อข้อความ รองรับเฉพาะอีโมจิ Unicode เท่านั้น ดูตัวอย่างได้ที่ลบรีแอ็กชัน ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
DeleteSpace |
---|
ลบพื้นที่ทำงานที่มีชื่อ ดำเนินการลบแบบต่อเรียงเสมอ ซึ่งหมายความว่าทรัพยากรย่อยของพื้นที่ทำงาน เช่น ข้อความที่โพสต์ในพื้นที่ทำงานและการเป็นสมาชิกในพื้นที่ทำงาน จะถูกลบไปด้วย โปรดดูตัวอย่างที่หัวข้อลบพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์ผู้ใช้จากผู้ใช้ที่มีสิทธิ์ลบพื้นที่ทำงาน
|
FindDirectMessage |
---|
แสดงผลข้อความส่วนตัวที่มีอยู่กับผู้ใช้ที่ระบุ หากไม่พบพื้นที่ข้อความส่วนตัว จะแสดงผลข้อผิดพลาด เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ จะแสดงผลพื้นที่ข้อความส่วนตัวระหว่างผู้ใช้ที่ระบุและผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ เมื่อใช้การตรวจสอบสิทธิ์แอป ระบบจะแสดงพื้นที่ข้อความส่วนตัวระหว่างผู้ใช้ที่ระบุกับแอป Chat ที่เรียกใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้หรือการตรวจสอบสิทธิ์แอป
|
GetAttachment |
---|
รับข้อมูลเมตาของไฟล์แนบของข้อความ ระบบจะดึงข้อมูลไฟล์แนบโดยใช้ media API โปรดดูตัวอย่างที่หัวข้อรับข้อมูลเมตาเกี่ยวกับไฟล์แนบของข้อความ ต้องมีการตรวจสอบสิทธิ์แอป
|
GetMembership |
---|
แสดงรายละเอียดเกี่ยวกับการเป็นสมาชิก ตัวอย่างเช่น โปรดดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Google Chat ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้
|
GetMessage |
---|
แสดงรายละเอียดเกี่ยวกับข้อความ ตัวอย่างเช่น โปรดดูดูรายละเอียดเกี่ยวกับข้อความ ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้ หมายเหตุ: อาจแสดงข้อความจากสมาชิกที่ถูกบล็อกหรือพื้นที่ทำงาน
|
GetSpace |
---|
แสดงรายละเอียดเกี่ยวกับพื้นที่ทำงาน ตัวอย่างเช่น โปรดดูดูรายละเอียดเกี่ยวกับพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้
|
GetSpaceEvent |
---|
แสดงผลกิจกรรมจากพื้นที่ใน Google Chat เปย์โหลดเหตุการณ์มีทรัพยากรเวอร์ชันล่าสุดที่มีการเปลี่ยนแปลง ตัวอย่างเช่น หากคุณขอเหตุการณ์เกี่ยวกับข้อความใหม่ แต่ข้อความได้รับการอัปเดตในภายหลัง เซิร์ฟเวอร์จะส่งคืนทรัพยากร ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ หากต้องการรับเหตุการณ์ ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วจะต้องเป็นสมาชิกของพื้นที่ทำงาน ตัวอย่างเช่น โปรดดูหัวข้อดูรายละเอียดเกี่ยวกับกิจกรรมจากพื้นที่ใน Google Chat
|
GetSpaceReadState |
---|
แสดงผลรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับสถานะการอ่านพื้นที่ทำงานของผู้ใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
GetThreadReadState |
---|
แสดงผลรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน ตัวอย่างเช่น โปรดดูรายละเอียดเกี่ยวกับสถานะการอ่านชุดข้อความของผู้ใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
ListMemberships |
---|
แสดงการเป็นสมาชิกในพื้นที่ทำงาน โปรดดูตัวอย่างที่หัวข้อแสดงรายการผู้ใช้และแอป Google Chat ในพื้นที่ทำงาน ข้อมูลการเป็นสมาชิกด้วยการตรวจสอบสิทธิ์แอปจะแสดงการเป็นสมาชิกในพื้นที่ทำงานที่แอป Chat เข้าถึงได้ แต่ไม่รวมการเป็นสมาชิกของแอป Chat ซึ่งรวมถึงการเป็นสมาชิกของตนเองด้วย การแสดงการเป็นสมาชิกที่มีการตรวจสอบสิทธิ์ผู้ใช้จะแสดงการเป็นสมาชิกในพื้นที่ทำงานที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีสิทธิ์เข้าถึง ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้
|
ListMessages |
---|
แสดงข้อความในพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก รวมถึงข้อความจากสมาชิกที่ถูกบล็อกและพื้นที่ทำงาน หากคุณแสดงข้อความจากพื้นที่ทำงานที่ไม่มีข้อความ การตอบกลับจะเป็นออบเจ็กต์ที่ว่างเปล่า เมื่อใช้อินเทอร์เฟซ REST/HTTP การตอบกลับจะมีออบเจ็กต์ JSON ที่ว่างเปล่า
|
ListReactions |
---|
แสดงความรู้สึกที่มีต่อข้อความ ตัวอย่างเช่น ดูแสดงความรู้สึกต่อข้อความ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
ListSpaceEvents |
---|
แสดงรายการเหตุการณ์จากพื้นที่ทำงานใน Google Chat เพย์โหลดจะมีทรัพยากร Chat เวอร์ชันล่าสุดสำหรับแต่ละเหตุการณ์ ตัวอย่างเช่น หากคุณแสดงรายการเหตุการณ์เกี่ยวกับสมาชิกใหม่ในพื้นที่ทำงาน เซิร์ฟเวอร์จะแสดงผลทรัพยากร ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ หากต้องการแสดงรายการเหตุการณ์ ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์จะต้องเป็นสมาชิกของพื้นที่ทำงาน ดูตัวอย่างได้ที่แสดงรายการกิจกรรมจากพื้นที่ใน Google Chat
|
ListSpaces |
---|
แสดงพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก แชทเป็นกลุ่มและ DM จะไม่แสดงจนกว่าจะมีการส่งข้อความแรก ดูตัวอย่างได้ที่แสดงพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้ แสดงพื้นที่ทำงานที่ผู้โทรหรือผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมองเห็นได้ แชทเป็นกลุ่มและ DM จะไม่แสดงจนกว่าจะมีการส่งข้อความแรก หากต้องการแสดงรายการพื้นที่ทำงานที่มีชื่อทั้งหมดตามองค์กร Google Workspace ให้ใช้เมธอด
|
SearchSpaces |
---|
use_admin_access เป็น true
|
SetUpSpace |
---|
สร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุไปยังพื้นที่ทำงานนั้น ระบบจะเพิ่มผู้ใช้ที่โทรไปยังพื้นที่ทำงานโดยอัตโนมัติ และไม่ควรระบุว่าเป็นสมาชิกในคำขอ โปรดดูตัวอย่างที่หัวข้อตั้งค่าพื้นที่ทำงานที่มีสมาชิกเริ่มต้น หากต้องการระบุสมาชิกที่เป็นมนุษย์ที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย หากต้องการระบุกลุ่ม Google ที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย สำหรับพื้นที่ทำงานที่มีชื่อหรือแชทเป็นกลุ่ม หากผู้โทรบล็อกหรือถูกบล็อกโดยสมาชิกบางราย หรือไม่มีสิทธิ์เพิ่มสมาชิกบางราย ระบบจะไม่เพิ่มสมาชิกเหล่านั้นไปยังพื้นที่ทำงานที่สร้างขึ้น หากต้องการสร้างข้อความส่วนตัว (DM) ระหว่างผู้ใช้ที่โทรและผู้ใช้ที่เป็นมนุษย์รายอื่น ให้ระบุการเป็นสมาชิก 1 รายการเพื่อเป็นตัวแทนผู้ใช้ที่เป็นมนุษย์ หากผู้ใช้คนหนึ่งบล็อกอีกคน คำขอจะล้มเหลวและไม่สร้าง DM หากต้องการสร้าง DM ระหว่างผู้ใช้ที่โทรและแอปการโทร ให้ตั้งค่า หากมี DM ระหว่างผู้ใช้ 2 คนอยู่แล้ว แม้ว่าผู้ใช้คนหนึ่งบล็อกอีกคนในขณะที่ส่งคำขอ ระบบจะส่ง DM เดิมกลับมา ไม่รองรับพื้นที่ทำงานที่มีการตอบกลับแบบแยกชุดข้อความ หากได้รับข้อความแสดงข้อผิดพลาด ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
UpdateMembership |
---|
อัปเดตการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้ออัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ทำงาน ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
UpdateMessage |
---|
อัปเดตข้อความ มีความแตกต่างระหว่างเมธอด ต้องมีการตรวจสอบสิทธิ์ รองรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้ เมื่อใช้การตรวจสอบสิทธิ์แอป คำขอจะอัปเดตได้เฉพาะข้อความที่สร้างโดยแอป Chat ที่เรียกใช้เท่านั้น
|
UpdateSpace |
---|
อัปเดตพื้นที่ทำงาน โปรดดูตัวอย่างที่หัวข้ออัปเดตพื้นที่ทำงาน หากคุณกำลังอัปเดตช่อง ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
UpdateSpaceReadState |
---|
อัปเดตสถานะการอ่านของผู้ใช้ในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน ดูตัวอย่างได้ที่อัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
|
AccessoryWidget
วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 1 รายการซึ่งปรากฏที่ด้านล่างของข้อความ โปรดดูรายละเอียดที่หัวข้อเพิ่มวิดเจ็ตแบบอินเทอร์แอกทีฟที่ด้านล่างของข้อความ
ช่อง | |
---|---|
ช่องการรวม action ประเภทการทำงาน action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
button_list |
รายการปุ่ม |
ActionResponse
พารามิเตอร์ที่แอปใน Chat ใช้ในการกำหนดค่าวิธีโพสต์คำตอบได้
ช่อง | |
---|---|
type |
อินพุตเท่านั้น ประเภทการตอบกลับของแอป Chat |
url |
อินพุตเท่านั้น URL สำหรับให้ผู้ใช้ตรวจสอบสิทธิ์หรือกำหนดค่า (สำหรับการตอบกลับ |
dialog_action |
อินพุตเท่านั้น การตอบกลับเหตุการณ์การโต้ตอบที่เกี่ยวข้องกับกล่องโต้ตอบ ต้องมี |
updated_widget |
อินพุตเท่านั้น การตอบกลับของวิดเจ็ตที่อัปเดต |
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 |
UpdatedWidget
การตอบกลับของวิดเจ็ตที่อัปเดต ใช้เพื่อแสดงตัวเลือกการเติมข้อความอัตโนมัติสำหรับวิดเจ็ต
ช่อง | |
---|---|
widget |
รหัสของวิดเจ็ตที่อัปเดต รหัสต้องตรงกับรหัสของวิดเจ็ตที่เรียกใช้คำขออัปเดต |
ช่องการรวม updated_widget วิดเจ็ตอัปเดตตามการดำเนินการของผู้ใช้ updated_widget ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
suggestions |
รายการผลลัพธ์การเติมข้อความอัตโนมัติในวิดเจ็ต |
ActionStatus
แสดงสถานะของคำขอที่จะเรียกใช้หรือส่งกล่องโต้ตอบ
ช่อง | |
---|---|
status_code |
รหัสสถานะ |
user_facing_message |
ข้อความที่จะส่งให้ผู้ใช้เกี่ยวกับสถานะคำขอ หากไม่ได้ตั้งค่า ระบบจะส่งข้อความทั่วไปตาม |
หมายเหตุ
เอาต์พุตเท่านั้น คำอธิบายประกอบที่เกี่ยวข้องกับเนื้อหาข้อความธรรมดา หากต้องการเพิ่มการจัดรูปแบบพื้นฐานให้กับข้อความ โปรดดูที่จัดรูปแบบข้อความ
ตัวอย่างเนื้อหาข้อความธรรมดา
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 |
ประเภทของคำอธิบายประกอบนี้ |
length |
ความยาวของสตริงย่อยในเนื้อหาข้อความข้อความธรรมดาที่สอดคล้องกับคำอธิบายประกอบนี้ |
start_index |
ดัชนีเริ่มต้น (แบบ 0 รวม) ในเนื้อหาข้อความข้อความธรรมดาที่สอดคล้องกับคำอธิบายประกอบนี้ |
ช่องการรวม metadata ข้อมูลเมตาเพิ่มเติมเกี่ยวกับคำอธิบายประกอบ metadata ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
user_mention |
ข้อมูลเมตาการพูดถึงของผู้ใช้ |
slash_command |
ข้อมูลเมตาสำหรับคำสั่งเครื่องหมายทับ |
rich_link_metadata |
ข้อมูลเมตาสำหรับลิงก์แบบสมบูรณ์ |
AnnotationType
ประเภทของคำอธิบายประกอบ
Enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum อย่าใช้ |
USER_MENTION |
มีการกล่าวถึงผู้ใช้ |
SLASH_COMMAND |
ระบบเรียกใช้คำสั่งเครื่องหมายทับ |
RICH_LINK |
คำอธิบายประกอบแบบ Rich Link |
AttachedGif
รูปภาพ GIF ที่ระบุโดย URL
ช่อง | |
---|---|
uri |
เอาต์พุตเท่านั้น URL ที่โฮสต์รูปภาพ GIF |
ไฟล์แนบ
ไฟล์แนบใน Google Chat
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของไฟล์แนบในรูปแบบ |
content_name |
เอาต์พุตเท่านั้น ชื่อไฟล์ต้นฉบับของเนื้อหา ไม่ใช่เส้นทางแบบเต็ม |
content_type |
เอาต์พุตเท่านั้น ประเภทเนื้อหา (ประเภท MIME) ของไฟล์ |
thumbnail_uri |
เอาต์พุตเท่านั้น URL ของภาพขนาดย่อซึ่งควรใช้ในการแสดงพรีวิวไฟล์แนบให้กับผู้ใช้ที่เป็นมนุษย์ แอปแชทไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ |
download_uri |
เอาต์พุตเท่านั้น URL สำหรับดาวน์โหลดซึ่งควรใช้เพื่อให้ผู้ใช้ที่เป็นมนุษย์ดาวน์โหลดไฟล์แนบได้ แอปแชทไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ |
source |
เอาต์พุตเท่านั้น แหล่งที่มาของไฟล์แนบ |
ช่องการรวม data_ref ข้อมูลที่อ้างอิงไปยังไฟล์แนบ data_ref ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
attachment_data_ref |
การอ้างอิงข้อมูลไฟล์แนบ ช่องนี้ใช้กับ API สื่อเพื่อดาวน์โหลดข้อมูลไฟล์แนบ |
drive_data_ref |
เอาต์พุตเท่านั้น การอ้างอิงไฟล์แนบ Google ไดรฟ์ ช่องนี้ใช้กับ Google Drive API |
แหล่งที่มา
แหล่งที่มาของไฟล์แนบ
Enum | |
---|---|
SOURCE_UNSPECIFIED |
จองแล้ว |
DRIVE_FILE |
ไฟล์นี้เป็นไฟล์ Google ไดรฟ์ |
UPLOADED_CONTENT |
ระบบจะอัปโหลดไฟล์ไปยัง Chat |
AttachmentDataRef
การอ้างอิงข้อมูลไฟล์แนบ
ช่อง | |
---|---|
resource_name |
ชื่อทรัพยากรของข้อมูลไฟล์แนบ ช่องนี้ใช้กับ API สื่อเพื่อดาวน์โหลดข้อมูลไฟล์แนบ |
attachment_upload_token |
โทเค็นทึบที่มีการอ้างอิงไฟล์แนบที่อัปโหลด ไคลเอ็นต์จะถือว่าเป็นสตริงที่คลุมเครือและใช้เพื่อสร้างหรืออัปเดตข้อความใน Chat ที่มีไฟล์แนบ |
CardWithId
การ์ดในข้อความ Google Chat
มีเพียงแอปใน Chat เท่านั้นที่สามารถสร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์ว่าเป็นผู้ใช้ ข้อความนั้นจะไม่มีการ์ด
ออกแบบและแสดงตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด
เปิดเครื่องมือสร้างการ์ดช่อง | |
---|---|
card_id |
ต้องระบุหากข้อความมีการ์ดหลายใบ ตัวระบุที่ไม่ซ้ำกันสำหรับการ์ดในข้อความ |
card |
การ์ด ขนาดสูงสุดคือ 32 KB |
ChatSpaceLinkData
ข้อมูลสำหรับลิงก์พื้นที่ใน Chat
ช่อง | |
---|---|
space |
พื้นที่ทำงานของทรัพยากรพื้นที่ใน Chat ที่ลิงก์ไว้ รูปแบบ: |
thread |
ชุดข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์ไว้ รูปแบบ: |
message |
ข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์ไว้ รูปแบบ: |
CompleteImportSpaceRequest
ข้อความขอให้ดำเนินการนำเข้าพื้นที่ทำงานให้เสร็จสมบูรณ์
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานโหมดการนำเข้า รูปแบบ: |
CompleteImportSpaceResponse
ข้อความตอบกลับสำหรับขั้นตอนการนำเข้าพื้นที่ทำงานให้เสร็จสมบูรณ์
ช่อง | |
---|---|
space |
พื้นที่ทำงานโหมดการนำเข้า |
ContextualAddOnMarkup
ประเภทนี้ไม่มีช่อง
มาร์กอัปสำหรับนักพัฒนาซอฟต์แวร์เพื่อระบุเนื้อหาของส่วนเสริมตามบริบท
การ์ด
การ์ดคือองค์ประกอบ UI ที่อาจมีวิดเจ็ต UI เช่น ข้อความและรูปภาพ
ช่อง | |
---|---|
header |
ส่วนหัวของการ์ด โดยทั่วไปส่วนหัวจะมีชื่อและรูปภาพ |
sections[] |
ส่วนต่างๆ จะคั่นด้วยเส้นแบ่ง |
card_actions[] |
การดำเนินการของการ์ดนี้ |
name |
ชื่อการ์ด |
CardAction
การทำงานของการ์ดคือการดำเนินการที่เชื่อมโยงกับการ์ด สำหรับการ์ดใบแจ้งหนี้ การดำเนินการทั่วไปคือ ลบใบแจ้งหนี้ อีเมลใบแจ้งหนี้ หรือเปิดใบแจ้งหนี้ในเบราว์เซอร์
แอป Google Chat ไม่รองรับ
ช่อง | |
---|---|
action_label |
ป้ายกำกับที่ใช้ในรายการเมนูการทำงาน |
on_click |
การดำเนินการ onclick สำหรับรายการการทำงานนี้ |
CardHeader
ช่อง | |
---|---|
title |
ต้องระบุชื่อ ส่วนหัวมีความสูงคงที่: หากมีการระบุทั้งชื่อและชื่อรอง แต่ละรายการจะใช้ 1 บรรทัด หากระบุไว้เพียงชื่อ ก็จะใช้ทั้ง 2 บรรทัด |
subtitle |
คำบรรยายของส่วนหัวของการ์ด |
image_style |
ประเภทของรูปภาพ (เช่น เส้นขอบสี่เหลี่ยมจัตุรัสหรือเส้นขอบวงกลม) |
image_url |
URL ของรูปภาพในส่วนหัวของการ์ด |
ImageStyle
Enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
เส้นขอบสี่เหลี่ยมจัตุรัส |
AVATAR |
เส้นขอบวงกลม |
ส่วน
ส่วนจะประกอบด้วยคอลเล็กชันของวิดเจ็ตที่แสดงผล (แนวตั้ง) ตามลำดับที่ระบุไว้ การ์ดจะมีความกว้างคงที่แบบแคบในทุกแพลตฟอร์ม ตอนนี้จึงไม่จำเป็นต้องใช้คุณสมบัติเลย์เอาต์ (เช่น ทศนิยม)
ช่อง | |
---|---|
header |
ส่วนหัวของส่วน รองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
widgets[] |
ส่วนต้องมีวิดเจ็ตอย่างน้อย 1 รายการ |
CreateMembershipRequest
ข้อความคำขอสร้างการเป็นสมาชิก
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก รูปแบบ: Spaces/{space} |
membership |
ต้องระบุ ความสัมพันธ์กับการเป็นสมาชิกที่ต้องการสร้าง ช่อง |
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ ระบบไม่รองรับการสร้างการเป็นสมาชิกของแอปหรือสร้างการเป็นสมาชิกสำหรับผู้ใช้ภายนอกองค์กร Google Workspace ของผู้ดูแลระบบโดยใช้สิทธิ์การเข้าถึงระดับผู้ดูแลระบบ |
CreateMessageRequest
สร้างข้อความ
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างข้อความ รูปแบบ: |
message |
ต้องระบุ เนื้อหาข้อความ |
thread_key |
ไม่บังคับ เลิกใช้งานแล้ว: ใช้ |
request_id |
ไม่บังคับ รหัสคำขอที่ไม่ซ้ำกันสำหรับข้อความนี้ การระบุรหัสคำขอที่มีอยู่จะแสดงข้อความที่สร้างด้วยรหัสนั้นแทนที่จะต้องสร้างข้อความใหม่ |
message_reply_option |
ไม่บังคับ ระบุว่าข้อความเริ่มต้นชุดข้อความหรือตอบกลับ รองรับเฉพาะในพื้นที่ทำงานที่มีชื่อ |
message_id |
ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ อนุญาตให้แอปใน Chat อัปเดต หรือลบข้อความโดยไม่ต้องจัดเก็บรหัสที่ระบบกำหนดไว้ในชื่อทรัพยากรของข้อความ (แสดงในช่อง ค่าสำหรับช่องนี้ต้องเป็นไปตามข้อกำหนดต่อไปนี้
โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ |
MessageReplyOption
ระบุวิธีตอบกลับข้อความ อาจมีการเพิ่มรัฐอื่นๆ ในอนาคต
Enum | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
ค่าเริ่มต้น เริ่มชุดข้อความใหม่ การใช้ตัวเลือกนี้ไม่สนใจ thread ID หรือ ที่รวมไว้ |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
สร้างข้อความเป็นการตอบกลับชุดข้อความที่ระบุโดย thread ID หรือ หากไม่สำเร็จ ข้อความจะเริ่มชุดข้อความใหม่แทน |
REPLY_MESSAGE_OR_FAIL |
สร้างข้อความเป็นการตอบกลับชุดข้อความที่ระบุโดย thread ID หรือ หากใช้ thread_key ใหม่ ระบบจะสร้างชุดข้อความใหม่ หากสร้างข้อความไม่สำเร็จ ระบบจะแสดงข้อผิดพลาด NOT_FOUND แทน |
CreateReactionRequest
สร้างรีแอ็กชันต่อข้อความ
ช่อง | |
---|---|
parent |
ต้องระบุ ข้อความที่สร้างความรู้สึก รูปแบบ: |
reaction |
ต้องระบุ รีแอ็กชันที่จะสร้าง |
CreateSpaceRequest
คำขอสร้างพื้นที่ทำงานที่ไม่มีสมาชิก
ช่อง | |
---|---|
space |
ต้องระบุ ต้องป้อนข้อมูล หากคุณได้รับข้อความแสดงข้อผิดพลาด หากคุณเป็นสมาชิกของโปรแกรมทดลองใช้สำหรับนักพัฒนาแอป คุณจะใช้ มีการกำหนดพื้นที่ |
request_id |
ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับคำขอนี้ ขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอที่มีอยู่จะแสดงผลพื้นที่ทำงานที่สร้างด้วยรหัสนั้นแทนการสร้างพื้นที่ทำงานใหม่ การระบุรหัสคำขอที่มีอยู่จากแอป Chat เดียวกันโดยใช้ผู้ใช้รายอื่นที่ตรวจสอบสิทธิ์แล้วจะแสดงข้อผิดพลาด |
CustomEmoji
แสดงอีโมจิที่กำหนดเอง
ช่อง | |
---|---|
uid |
เอาต์พุตเท่านั้น คีย์ที่ไม่ซ้ำกันสำหรับทรัพยากรอีโมจิที่กำหนดเอง |
DeleteMembershipRequest
คำขอลบการเป็นสมาชิกในพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่จะลบ แอปแชทสามารถลบผู้ใช้ที่เป็นมนุษย์ได้ หรือการเป็นสมาชิกของตนเอง แอป Chat จะลบแอปอื่นๆ ไม่ได้ การเป็นสมาชิก เมื่อลบการเป็นสมาชิกที่เป็นมนุษย์ จะต้องมีขอบเขต เมื่อลบการเป็นสมาชิกแอป จะต้องมีขอบเขต รูปแบบ: |
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ ไม่รองรับการลบการเป็นสมาชิกของแอปในพื้นที่ทำงานโดยใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ |
DeleteMessageRequest
ขอให้ลบข้อความ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อแหล่งข้อมูลของข้อความ รูปแบบ: หากตั้งรหัสที่กำหนดเองให้กับข้อความแล้ว คุณจะใช้ค่าจากช่อง |
force |
เมื่อ มีผลเฉพาะเมื่อตรวจสอบสิทธิ์เป็นผู้ใช้เท่านั้น จะไม่มีผลเมื่อตรวจสอบสิทธิ์เป็นแอป Chat |
DeleteReactionRequest
ลบรีแอ็กชันต่อข้อความ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของรีแอ็กชันที่จะลบ รูปแบบ: |
DeleteSpaceRequest
คำขอลบพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะลบ รูปแบบ: |
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ |
DeletionMetadata
ข้อมูลเกี่ยวกับข้อความที่ถูกลบ ระบบจะลบข้อความเมื่อตั้งค่า delete_time
ช่อง | |
---|---|
deletion_type |
ระบุผู้ที่ลบข้อความ |
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 |
อินพุตเท่านั้น เนื้อหาของกล่องโต้ตอบ ซึ่งแสดงผลในรูปแบบ แอป Google Chat ไม่รองรับเอนทิตีการ์ดต่อไปนี้ |
DialogAction
มีกล่องโต้ตอบและรหัสสถานะคำขอ
ช่อง | |
---|---|
action_status |
อินพุตเท่านั้น สถานะคำขอที่จะเรียกใช้หรือส่งกล่องโต้ตอบ แสดงสถานะและข้อความแก่ผู้ใช้ หากจำเป็น เช่น ในกรณีที่เกิดข้อผิดพลาดหรือสำเร็จ |
ช่องการรวม action การดำเนินการ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
dialog |
อินพุตเท่านั้น กล่องโต้ตอบสำหรับคำขอ |
DriveDataRef
การอ้างอิงข้อมูลของไฟล์แนบไดรฟ์
ช่อง | |
---|---|
drive_file_id |
รหัสสำหรับไฟล์ในไดรฟ์ ใช้กับ Drive API |
DriveLinkData
ข้อมูลสำหรับลิงก์ Google ไดรฟ์
ช่อง | |
---|---|
drive_data_ref |
DriveDataRef ที่อ้างอิงไฟล์ใน Google ไดรฟ์ |
mime_type |
ประเภท MIME ของทรัพยากร Google ไดรฟ์ที่ลิงก์ไว้ |
อีโมจิ
อีโมจิที่ใช้เป็นรีแอ็กชันต่อข้อความ
ช่อง | |
---|---|
ช่องการรวม content เนื้อหาของอีโมจิ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
unicode |
อีโมจิพื้นฐานที่แสดงด้วยสตริง Unicode |
custom_emoji |
เอาต์พุตเท่านั้น อีโมจิที่กำหนดเอง |
EmojiReactionSummary
จำนวนผู้ที่แสดงความรู้สึกต่อข้อความด้วยอีโมจิที่เจาะจง
ช่อง | |
---|---|
emoji |
อีโมจิที่เกี่ยวข้องกับรีแอ็กชัน |
reaction_count |
จำนวนรีแอ็กชันทั้งหมดที่ใช้อีโมจิที่เกี่ยวข้อง |
FindDirectMessageRequest
คำขอเพื่อรับพื้นที่ข้อความส่วนตัวตามทรัพยากรของผู้ใช้
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของผู้ใช้ที่จะใช้ค้นหาข้อความส่วนตัว รูปแบบ: |
GetAttachmentRequest
ส่งคำขอรับไฟล์แนบ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของไฟล์แนบในรูปแบบ |
GetMembershipRequest
คำขอสมัครสมาชิกพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่จะดึงข้อมูล หากต้องการสมัครสมาชิกของแอปเองโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะเลือกใช้ รูปแบบ: เมื่อตรวจสอบสิทธิ์ว่าเป็นผู้ใช้แล้ว คุณจะใช้อีเมลของผู้ใช้เป็นชื่อแทนสำหรับ |
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ไม่รองรับการเป็นสมาชิกแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ |
GetMessageRequest
ส่งคำขอรับข้อความ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อแหล่งข้อมูลของข้อความ รูปแบบ: หากตั้งรหัสที่กำหนดเองให้กับข้อความแล้ว คุณจะใช้ค่าจากช่อง |
GetSpaceEventRequest
ข้อความขอให้รับเหตุการณ์ในพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของเหตุการณ์พื้นที่ทำงาน รูปแบบ: |
GetSpaceReadStateRequest
ข้อความคำขอสำหรับ GetSpaceReadState API
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านพื้นที่ทำงานที่จะดึงข้อมูล รองรับเฉพาะการรับสถานะการอ่านสำหรับผู้ใช้ที่โทร หากต้องการอ้างอิงถึงผู้ใช้ที่โทรเข้ามา ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้
รูปแบบ: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
คำขอแสดงผลพื้นที่ทำงาน 1 รายการ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานในรูปแบบ รูปแบบ: |
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 |
GetThreadReadStateRequest
ข้อความคำขอสำหรับ GetThreadReadStateRequest API
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านชุดข้อความที่จะดึงข้อมูล รองรับเฉพาะการรับสถานะการอ่านสำหรับผู้ใช้ที่โทร หากต้องการอ้างอิงถึงผู้ใช้ที่โทรเข้ามา ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้
รูปแบบ: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
กลุ่ม
กลุ่ม Google ใน Google Chat
ช่อง | |
---|---|
name |
ชื่อทรัพยากรสำหรับ Google Group แสดงกลุ่มใน Cloud Identity Groups API รูปแบบ: groups/{group} |
HistoryState
สถานะประวัติสำหรับข้อความและพื้นที่ทำงาน ระบุระยะเวลาที่จะเก็บข้อความและชุดข้อความการสนทนาหลังจากการสร้าง
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
ค่าเริ่มต้น โปรดอย่าใช้ |
HISTORY_OFF |
ประวัติปิดอยู่ ข้อความและชุดข้อความจะเก็บไว้เป็นเวลา 24 ชั่วโมง |
HISTORY_ON |
ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาการเก็บข้อความและชุดข้อความ |
ListMembershipsRequest
ข้อความคำขอสำหรับข้อมูลการเป็นสมาชิก
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะดึงข้อมูลรายการสมาชิก รูปแบบ: Spaces/{space} |
page_size |
ไม่บังคับ จำนวนการเป็นสมาชิกสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลการเป็นสมาชิกสูงสุด 100 รายการ ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ ค่าลบแสดงผลข้อผิดพลาด |
page_token |
ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้รายการก่อนหน้านี้เพื่อแสดงการเป็นสมาชิก ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้าเว็บ การส่งต่อค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองการค้นหา คุณสามารถกรองการเป็นสมาชิกตามบทบาทของสมาชิก ( หากต้องการกรองตามบทบาท ให้ตั้งค่า หากต้องการกรองตามประเภท ให้ตั้งค่า หากต้องการกรองตามบทบาทและประเภท ให้ใช้โอเปอเรเตอร์ ต้องระบุ ตัวอย่างเช่น การค้นหาต่อไปนี้ถูกต้อง
การค้นหาต่อไปนี้ไม่ถูกต้อง
เซิร์ฟเวอร์ที่มีข้อผิดพลาด |
show_groups |
ไม่บังคับ เมื่อ |
show_invited |
ไม่บังคับ เมื่อ ปัจจุบันต้องมีการตรวจสอบสิทธิ์ผู้ใช้ |
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ระบบไม่รองรับการแสดงการเป็นสมาชิกของแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ |
ListMembershipsResponse
การตอบกลับรายการการเป็นสมาชิกของพื้นที่ทำงาน
ช่อง | |
---|---|
memberships[] |
รายการที่ไม่เรียงลำดับ รายการการเป็นสมาชิกในหน้าที่ขอ (หรือหน้าแรก) |
next_page_token |
โทเค็นที่คุณสามารถส่งในชื่อ |
ListMessagesRequest
แสดงข้อความในพื้นที่ทำงานที่ระบุที่ผู้ใช้เป็นสมาชิก
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะแสดงข้อความ รูปแบบ: |
page_size |
จำนวนข้อความสูงสุดที่ส่งกลับ บริการอาจแสดงผลข้อความน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลสูงสุด 25 รายการ ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ ค่าลบแสดงผลข้อผิดพลาด |
page_token |
ไม่บังคับ หากกลับมาใช้งานต่อจากคำค้นหาก่อนหน้า โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ข้อความรายการก่อนหน้า ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้าเว็บ การส่งต่อค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด |
filter |
ตัวกรองการค้นหา คุณกรองข้อความตามวันที่ ( หากต้องการกรองข้อความตามวันที่สร้าง ให้ระบุ หากต้องการกรองตามชุดข้อความ ให้ระบุ หากต้องการกรองตามทั้งชุดข้อความและวันที่ ให้ใช้โอเปอเรเตอร์ ตัวอย่างเช่น การค้นหาต่อไปนี้ถูกต้อง
เซิร์ฟเวอร์ที่มีข้อผิดพลาด |
order_by |
ไม่บังคับ หากกลับมาใช้งานต่อจากคำค้นหาก่อนหน้า วิธีเรียงลำดับรายการข้อความ ระบุมูลค่าที่จะสั่งซื้อตามการดำเนินการสั่งซื้อ ค่าการดำเนินการเรียงลำดับที่ถูกต้องมีดังนี้
การเรียงลำดับเริ่มต้นคือ |
show_deleted |
รวมข้อความที่ถูกลบหรือไม่ ข้อความที่ถูกลบจะมีเวลาที่ลบและข้อมูลเมตาเกี่ยวกับการลบ แต่เนื้อหาของข้อความจะไม่พร้อมใช้งาน |
ListMessagesResponse
ข้อความตอบกลับสำหรับการแสดงข้อความ
ช่อง | |
---|---|
messages[] |
รายการข้อความ |
next_page_token |
คุณสามารถส่งโทเค็นในฐานะ |
ListReactionsRequest
แสดงความรู้สึกที่มีต่อข้อความ
ช่อง | |
---|---|
parent |
ต้องระบุ ข้อความที่ผู้ใช้แสดงความรู้สึก รูปแบบ: |
page_size |
ไม่บังคับ จำนวนรีแอ็กชันสูงสุดที่แสดงผล บริการอาจแสดงรีแอ็กชันน้อยกว่าค่านี้ หากไม่ระบุ ค่าเริ่มต้นจะเป็น 25 ค่าสูงสุดคือ 200 ค่าที่มากกว่า 200 จะเปลี่ยนเป็น 200 |
page_token |
ไม่บังคับ (หากทำต่อจากคำค้นหาก่อนหน้า) โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้รีแอ็กชันรายการก่อนหน้า โปรดระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า ค่าตัวกรองควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้า การส่งผ่านค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองการค้นหา คุณกรองรีแอ็กชันได้โดยใช้อีโมจิ ( หากต้องการกรองรีแอ็กชันสำหรับอีโมจิหรือผู้ใช้หลายรายการ ให้ผนวกช่องที่คล้ายกันด้วยโอเปอเรเตอร์ หากต้องการกรองรีแอ็กชันตามอีโมจิและผู้ใช้ ให้ใช้โอเปอเรเตอร์ หากการค้นหาของคุณใช้ทั้ง ตัวอย่างเช่น การค้นหาต่อไปนี้ถูกต้อง
การค้นหาต่อไปนี้ไม่ถูกต้อง
เซิร์ฟเวอร์ที่มีข้อผิดพลาด |
ListReactionsResponse
ตอบกลับคำขอรีแอ็กชันรายการ
ช่อง | |
---|---|
reactions[] |
รายการรีแอ็กชันในหน้าที่ขอ (หรือหน้าแรก) |
next_page_token |
โทเค็นต่อเนื่องเพื่อเรียกผลลัพธ์หน้าถัดไป ผลการค้นหาหน้าสุดท้ายจะว่างเปล่า |
ListSpaceEventsRequest
ข้อความคำขอสำหรับข้อมูลกิจกรรมในพื้นที่ทํางาน
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ใน Google Chat ที่เกิดเหตุการณ์ รูปแบบ: |
page_size |
ไม่บังคับ จำนวนเหตุการณ์ในพื้นที่ทำงานสูงสุดที่แสดงผล บริการอาจแสดงผลน้อยกว่าค่านี้ ค่าลบแสดงผลข้อผิดพลาด |
page_token |
โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้กิจกรรมรายการพื้นที่ทำงานก่อนหน้า โปรดระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุเพื่อแสดงเหตุการณ์ของพื้นที่ทำงานต้องตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งต่อค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด |
filter |
ต้องระบุ ตัวกรองการค้นหา คุณต้องระบุประเภทเหตุการณ์อย่างน้อย 1 ประเภท ( นอกจากนี้ คุณยังกรองตามเวลาเริ่มต้น (
หากต้องการระบุเวลาเริ่มต้นหรือสิ้นสุด ให้ใช้โอเปอเรเตอร์เท่ากับ ตัวอย่างเช่น การค้นหาต่อไปนี้ถูกต้อง
การค้นหาต่อไปนี้ไม่ถูกต้อง
เซิร์ฟเวอร์ที่มีข้อผิดพลาด |
ListSpaceEventsResponse
ข้อความตอบกลับสำหรับการแสดงกิจกรรมในพื้นที่ทำงาน
ช่อง | |
---|---|
space_events[] |
ผลลัพธ์จะแสดงตามลำดับเวลา (เหตุการณ์ที่เก่าสุดก่อน) |
next_page_token |
ใช้โทเค็นต่อเนื่องเพื่อดึงข้อมูลเหตุการณ์เพิ่มเติม หากเว้นช่องนี้ไว้ จะไม่มีหน้าลำดับต่อมา |
ListSpacesRequest
คําขอแสดงพื้นที่ทำงานที่ผู้โทรเป็นสมาชิกอยู่
ช่อง | |
---|---|
page_size |
ไม่บังคับ จำนวนช่องว่างสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลเว้นวรรคมากที่สุด 100 รายการ ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ ค่าลบแสดงผลข้อผิดพลาด |
page_token |
ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้รายการพื้นที่ทำงานก่อนหน้า ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า ค่าตัวกรองควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้า การส่งผ่านค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองการค้นหา คุณสามารถกรองพื้นที่ทำงานตามประเภทพื้นที่ทำงาน ( หากต้องการกรองตามประเภทพื้นที่ทำงาน คุณต้องระบุค่า enum ที่ถูกต้อง เช่น ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง
เซิร์ฟเวอร์ที่มีข้อผิดพลาด |
ListSpacesResponse
การตอบกลับของคำขอพื้นที่ทำงานรายการ
ช่อง | |
---|---|
spaces[] |
รายการพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก) |
next_page_token |
คุณสามารถส่งโทเค็นในฐานะ |
MatchedUrl
URL ที่ตรงกันในข้อความ Chat แอปแชทสามารถแสดงตัวอย่าง URL ที่ตรงกันได้ ดูข้อมูลเพิ่มเติมได้ที่ลิงก์แสดงตัวอย่าง
ช่อง | |
---|---|
url |
เอาต์พุตเท่านั้น URL ที่ตรงกัน |
การเป็นสมาชิก
แสดงความสัมพันธ์การเป็นสมาชิกใน Google Chat เช่น ผู้ใช้หรือแอป Chat ได้รับเชิญให้เข้าร่วม เป็นส่วนหนึ่งของ หรือไม่ได้อยู่ในพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของการเป็นสมาชิกที่เซิร์ฟเวอร์กำหนด รูปแบบ: |
state |
เอาต์พุตเท่านั้น สถานะของการเป็นสมาชิก |
role |
ไม่บังคับ บทบาทของผู้ใช้ภายในพื้นที่ใน Chat ซึ่งจะกำหนดการดำเนินการที่ได้รับอนุญาตในพื้นที่ทำงาน ช่องนี้สามารถใช้เป็นอินพุตใน |
create_time |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ เวลาที่สร้างการเป็นสมาชิก เช่น เมื่อสมาชิกเข้าร่วมหรือได้รับเชิญให้เข้าร่วมพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้เพื่อนำเข้าการเป็นสมาชิกที่ผ่านมาในพื้นที่ทำงานโหมดการนำเข้า |
delete_time |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ เวลาที่ลบการเป็นสมาชิก เช่น เมื่อสมาชิกออกจากพื้นที่ทำงานหรือถูกนำออกจากพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้เพื่อนำเข้าการเป็นสมาชิกที่ผ่านมาในพื้นที่ทำงานโหมดการนำเข้า |
ช่องการรวม memberType สมาชิกที่เชื่อมโยงกับการเป็นสมาชิกนี้ ทั้งนี้ ระบบอาจรองรับสมาชิกประเภทอื่นๆ ในอนาคต memberType ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
member |
ผู้ใช้หรือแอป Google Chat ที่สอดคล้องกับการเป็นสมาชิก หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ เอาต์พุตจะป้อนข้อมูลเป็นผู้ใช้ |
group_member |
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[] |
รายการสมาชิกใหม่ |
MembershipBatchDeletedEventData
เปย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบหลายรายการ
ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchDeleted
ช่อง | |
---|---|
memberships[] |
รายการการเป็นสมาชิกที่ถูกลบ |
MembershipBatchUpdatedEventData
เปย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตหลายรายการ
ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchUpdated
ช่อง | |
---|---|
memberships[] |
รายการการเป็นสมาชิกที่อัปเดตแล้ว |
MembershipCreatedEventData
เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกใหม่
ประเภทเหตุการณ์: google.workspace.chat.membership.v1.created
ช่อง | |
---|---|
membership |
การเป็นสมาชิกใหม่ |
MembershipDeletedEventData
เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกที่ถูกลบ
ประเภทเหตุการณ์: google.workspace.chat.membership.v1.deleted
ช่อง | |
---|---|
membership |
การเป็นสมาชิกที่ถูกลบ ระบบจะป้อนข้อมูลในช่อง |
MembershipUpdatedEventData
เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกที่อัปเดตแล้ว
ประเภทเหตุการณ์: google.workspace.chat.membership.v1.updated
ช่อง | |
---|---|
membership |
การเป็นสมาชิกที่อัปเดตแล้ว |
ข้อความ
ข้อความในพื้นที่ใน Google Chat
ช่อง | |
---|---|
name |
ชื่อแหล่งข้อมูลของข้อความ รูปแบบ: โดยที่ หากตั้งรหัสที่กำหนดเองเมื่อสร้างข้อความ คุณจะใช้รหัสนี้เพื่อระบุข้อความในคำขอได้ โดยแทนที่ |
sender |
เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างข้อความ หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ เอาต์พุตจะป้อนข้อมูลเป็นผู้ใช้ |
create_time |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ สําหรับพื้นที่ทำงานที่สร้างใน Chat ซึ่งเป็นเวลาที่สร้างข้อความ ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ทำงานโหมดการนำเข้า สำหรับพื้นที่ทำงานโหมดการนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาในอดีตที่มีการสร้างข้อความในแหล่งที่มาเพื่อเก็บรักษาเวลาที่สร้างเดิม |
last_update_time |
เอาต์พุตเท่านั้น เวลาที่ผู้ใช้แก้ไขข้อความครั้งล่าสุด หากข้อความไม่เคยได้รับการแก้ไข ช่องนี้จะว่างเปล่า |
delete_time |
เอาต์พุตเท่านั้น เวลาที่ข้อความถูกลบใน Google Chat หากข้อความไม่เคยถูกลบ ช่องนี้จะว่างเปล่า |
text |
เนื้อหาข้อความธรรมดาของข้อความ ลิงก์แรกที่ไปยังรูปภาพ วิดีโอ หรือหน้าเว็บจะสร้างชิปแสดงตัวอย่าง นอกจากนี้คุณยัง@พูดถึงผู้ใช้ Google Chat หรือทุกคนในพื้นที่ทำงานได้อีกด้วย หากต้องการเรียนรู้เกี่ยวกับการสร้างข้อความ โปรดดูที่ส่งข้อความ |
formatted_text |
เอาต์พุตเท่านั้น ประกอบด้วยข้อความ
โปรดดูข้อมูลเพิ่มเติมที่หัวข้อดูการจัดรูปแบบข้อความที่ส่งในข้อความ |
cards[] |
เลิกใช้งานแล้ว: ใช้ การ์ดแบบอินเทอร์แอกทีฟที่มีการจัดรูปแบบและสมบูรณ์ที่คุณสามารถใช้เพื่อแสดงองค์ประกอบ UI เช่น ข้อความที่มีการจัดรูปแบบ ปุ่ม และรูปภาพที่คลิกได้ โดยปกติแล้ว การ์ดจะแสดงอยู่ใต้เนื้อหาข้อความธรรมดา |
cards_v2[] |
อาร์เรย์ของการ์ด มีเพียงแอปใน Chat เท่านั้นที่สามารถสร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ ข้อความจะไม่มีการ์ด โปรดดูวิธีสร้างข้อความที่มีการ์ดที่หัวข้อส่งข้อความ ออกแบบและแสดงตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด เปิดเครื่องมือสร้างการ์ด |
annotations[] |
เอาต์พุตเท่านั้น หมายเหตุที่เกี่ยวข้องกับ |
thread |
ชุดข้อความที่มีข้อความนั้น เช่น การใช้งานที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ |
space |
หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ เอาต์พุตจะเติมพื้นที่ทำงาน |
fallback_text |
คำอธิบายแบบข้อความธรรมดาของการ์ดข้อความ ซึ่งใช้เมื่อไม่สามารถแสดงการ์ดจริง เช่น การแจ้งเตือนในอุปกรณ์เคลื่อนที่ |
action_response |
อินพุตเท่านั้น พารามิเตอร์ที่แอปใน Chat ใช้ในการกำหนดค่าวิธีโพสต์คำตอบได้ |
argument_text |
เอาต์พุตเท่านั้น เนื้อหาที่เป็นข้อความธรรมดาที่มีการพูดถึงแอป Chat ทั้งหมด |
slash_command |
เอาต์พุตเท่านั้น ข้อมูลคำสั่งเครื่องหมายทับ (หากมี) |
attachment[] |
ไฟล์แนบที่อัปโหลดโดยผู้ใช้ |
matched_url |
เอาต์พุตเท่านั้น URL ใน |
thread_reply |
เอาต์พุตเท่านั้น เมื่อ หากพื้นที่ทำงานไม่รองรับการตอบกลับในชุดข้อความ ช่องนี้จะเป็น |
client_assigned_message_id |
ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ คุณสามารถใช้ช่องเพื่อระบุข้อความ หรือเพื่อรับ ลบ หรืออัปเดตข้อความ หากต้องการตั้งรหัสที่กำหนดเอง ให้ระบุช่อง |
emoji_reaction_summaries[] |
เอาต์พุตเท่านั้น รายการสรุปรีแอ็กชันด้วยอีโมจิในข้อความ |
private_message_viewer |
เปลี่ยนแปลงไม่ได้ อินพุตสําหรับการสร้างข้อความ หรือเอาต์พุตเท่านั้น ผู้ใช้ที่ดูข้อความได้ เมื่อตั้งค่าแล้ว ข้อความจะเป็นแบบส่วนตัวและจะปรากฏต่อผู้ใช้ที่ระบุและแอป Chat เท่านั้น หากต้องการรวมช่องนี้ไว้ในคำขอ คุณต้องเรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์แอป และละเว้นข้อมูลต่อไปนี้ โปรดดูรายละเอียดที่หัวข้อส่งข้อความแบบส่วนตัว |
deletion_metadata |
เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ถูกลบ ระบบจะลบข้อความเมื่อตั้งค่า |
quoted_message_metadata |
เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ยกมาจากผู้ใช้ Google Chat ในพื้นที่ทำงาน ผู้ใช้ Google Chat จะยกข้อความมาตอบกลับได้ |
attached_gifs[] |
เอาต์พุตเท่านั้น รูปภาพ GIF ที่แนบมากับข้อความ |
accessory_widgets[] |
วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 1 รายการซึ่งปรากฏที่ด้านล่างของข้อความ คุณเพิ่มวิดเจ็ตอุปกรณ์เสริมในข้อความที่มีข้อความ การ์ด หรือทั้งข้อความและการ์ดได้ ไม่รองรับข้อความที่มีกล่องโต้ตอบ โปรดดูรายละเอียดที่หัวข้อเพิ่มวิดเจ็ตแบบอินเทอร์แอกทีฟที่ด้านล่างของข้อความ การสร้างข้อความด้วยวิดเจ็ตอุปกรณ์เสริมต้องมีการตรวจสอบสิทธิ์แอป |
MessageBatchCreatedEventData
เปย์โหลดของเหตุการณ์สำหรับข้อความใหม่หลายรายการ
ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchCreated
ช่อง | |
---|---|
messages[] |
รายการข้อความใหม่ |
MessageBatchDeletedEventData
เปย์โหลดของเหตุการณ์สำหรับข้อความที่ถูกลบหลายรายการ
ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchDeleted
ช่อง | |
---|---|
messages[] |
รายการข้อความที่ถูกลบ |
MessageBatchUpdatedEventData
เปย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดตหลายรายการ
ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchUpdated
ช่อง | |
---|---|
messages[] |
รายการข้อความที่อัปเดต |
MessageCreatedEventData
เปย์โหลดของเหตุการณ์สำหรับข้อความใหม่
ประเภทเหตุการณ์: google.workspace.chat.message.v1.created
ช่อง | |
---|---|
message |
ข้อความใหม่ |
MessageDeletedEventData
เพย์โหลดเหตุการณ์สําหรับข้อความที่ลบ
ประเภทเหตุการณ์: google.workspace.chat.message.v1.deleted
ช่อง | |
---|---|
message |
ข้อความที่ถูกลบ ป้อนข้อมูลในช่อง |
MessageUpdatedEventData
เปย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดต
ประเภทเหตุการณ์: google.workspace.chat.message.v1.updated
ช่อง | |
---|---|
message |
ข้อความที่อัปเดต |
QuotedMessageMetadata
ข้อมูลเกี่ยวกับข้อความที่ยกมา
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อแหล่งข้อมูลของข้อความที่ยกมา รูปแบบ: |
last_update_time |
เอาต์พุตเท่านั้น การประทับเวลาเมื่อมีการสร้างข้อความที่ยกมาหรือเมื่อมีการอัปเดตข้อความที่ยกมาครั้งล่าสุด |
รีแอ็กชัน
รีแอ็กชันต่อข้อความ
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของรีแอ็กชัน รูปแบบ: |
user |
เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างความรู้สึก |
emoji |
อีโมจิที่ใช้ในการแสดงความรู้สึก |
ReactionBatchCreatedEventData
เปย์โหลดของเหตุการณ์สำหรับความรู้สึกใหม่หลายรายการ
ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchCreated
ช่อง | |
---|---|
reactions[] |
รายการความรู้สึกใหม่ |
ReactionBatchDeletedEventData
เปย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้วหลายรายการ
ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchDeleted
ช่อง | |
---|---|
reactions[] |
รายการความรู้สึกที่ถูกลบ |
ReactionCreatedEventData
เปย์โหลดเหตุการณ์สำหรับรีแอ็กชันใหม่
ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.created
ช่อง | |
---|---|
reaction |
รีแอ็กชันใหม่ |
ReactionDeletedEventData
เปย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้ว
ประเภท: google.workspace.chat.reaction.v1.deleted
ช่อง | |
---|---|
reaction |
ลบรีแอ็กชันแล้ว |
RichLinkMetadata
ลิงก์แบบสมบูรณ์ไปยังทรัพยากร
ช่อง | |
---|---|
uri |
URI ของลิงก์นี้ |
rich_link_type |
ประเภทลิงก์ริชมีเดีย |
ช่องการรวม data ข้อมูลสำหรับทรัพยากรที่ลิงก์ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
drive_link_data |
ข้อมูลสำหรับลิงก์ไดรฟ์ |
chat_space_link_data |
ข้อมูลสำหรับลิงก์พื้นที่ใน Chat |
RichLinkType
ประเภทลิงก์ริชมีเดีย เราอาจเพิ่มประเภทอื่นๆ ในอนาคต
Enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้ |
DRIVE_FILE |
ประเภทลิงก์ริชมีเดียของ Google ไดรฟ์ |
CHAT_SPACE |
ประเภทลิงก์ที่มีริชมีเดียของพื้นที่ใน Chat เช่น ชิปอัจฉริยะในพื้นที่ทำงาน |
SearchSpacesRequest
คำขอค้นหารายการพื้นที่ทำงานตามคำค้นหา
ช่อง | |
---|---|
use_admin_access |
เมื่อใช้ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ขณะนี้วิธีการนี้รองรับเฉพาะการเข้าถึงระดับผู้ดูแลระบบเท่านั้น จึงยอมรับเฉพาะ |
page_size |
จำนวนช่องว่างสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลเว้นวรรคมากที่สุด 100 รายการ ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1, 000 ระบบจะเปลี่ยนค่าเป็น 1000 โดยอัตโนมัติ |
page_token |
โทเค็นที่ได้รับจากการเรียกใช้ Search Space ก่อนหน้า ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกใช้ที่ระบุโทเค็นหน้าเว็บ การส่งต่อค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด |
query |
ต้องระบุ คำค้นหา คุณสามารถค้นหาโดยใช้พารามิเตอร์ต่อไปนี้
ต้องใช้
ในช่องต่างๆ ระบบรองรับโอเปอเรเตอร์ ในช่องเดียวกัน ตัวอย่างการค้นหาที่ถูกต้องมีดังนี้
|
order_by |
ไม่บังคับ วิธีเรียงลำดับรายการพื้นที่ทำงาน แอตทริบิวต์ที่รองรับการเรียงลำดับมีดังนี้
ค่าการดำเนินการเรียงลำดับที่ถูกต้องมีดังนี้
ไวยากรณ์ที่รองรับมีดังนี้
|
SearchSpacesResponse
ตอบกลับพร้อมรายการพื้นที่ทำงานที่เกี่ยวข้องกับคำขอ Search Space
ช่อง | |
---|---|
spaces[] |
หน้าของพื้นที่ทำงานที่ขอ |
next_page_token |
โทเค็นที่ใช้เพื่อเรียกข้อมูลหน้าถัดไปได้ หากช่องนี้ว่างเปล่า หมายความว่าไม่มีหน้าถัดไป |
total_size |
จำนวนรวมของพื้นที่ทำงานที่ตรงกับคำค้นหาในทุกหน้า หากผลลัพธ์มีการเว้นวรรคเกิน 10,000 ครั้ง ค่านี้จะเป็นค่าประมาณ |
SetUpSpaceRequest
ส่งคำขอสร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุไปยังพื้นที่ทำงานนั้น
ช่อง | |
---|---|
space |
ต้องระบุ ต้องระบุข้อมูลในช่อง หากต้องการสร้างพื้นที่ทำงาน ให้ตั้งค่า หากต้องการสร้างแชทเป็นกลุ่ม ให้ตั้งค่า หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างบุคคล ให้ตั้งค่า หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างบุคคลกับแอป Chat ที่โทรออก ให้ตั้งค่า หากมีพื้นที่ทำงาน |
request_id |
ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับคำขอนี้ ขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอที่มีอยู่จะแสดงผลพื้นที่ทำงานที่สร้างด้วยรหัสนั้นแทนการสร้างพื้นที่ทำงานใหม่ การระบุรหัสคำขอที่มีอยู่จากแอป Chat เดียวกันโดยใช้ผู้ใช้รายอื่นที่ตรวจสอบสิทธิ์แล้วจะแสดงข้อผิดพลาด |
memberships[] |
ไม่บังคับ ผู้ใช้หรือกลุ่ม Google Chat ที่จะเชิญให้เข้าร่วมพื้นที่ทำงาน ไม่รับสาย เนื่องจากระบบจะเพิ่มผู้ใช้ให้โดยอัตโนมัติ ขณะนี้การตั้งค่าอนุญาตให้มีการเป็นสมาชิกได้สูงสุด 20 รายการ (นอกเหนือจากผู้โทร) สำหรับการเป็นสมาชิกที่เป็นมนุษย์ ช่อง สำหรับการเป็นสมาชิกกลุ่มของ Google ช่อง ไม่บังคับเมื่อตั้งค่า ต้องระบุเมื่อตั้งค่า ต้องระบุเมื่อตั้งค่า ต้องเว้นว่างไว้เมื่อสร้างการสนทนาแบบ 1:1 ระหว่างบุคคลกับแอป Chat ที่โทรออก (เมื่อตั้งค่า |
SlashCommand
คําสั่งเครื่องหมายทับใน Google Chat
ช่อง | |
---|---|
command_id |
รหัสของคำสั่งเครื่องหมายทับ |
SlashCommandMetadata
ข้อมูลเมตาคำอธิบายประกอบสำหรับคำสั่งเครื่องหมายทับ (/)
ช่อง | |
---|---|
bot |
แอป Chat ที่มีการเรียกใช้คำสั่ง |
type |
ประเภทของคำสั่งเครื่องหมายทับ |
command_name |
ชื่อของคำสั่งเครื่องหมายทับ |
command_id |
รหัสคำสั่งของคำสั่งเครื่องหมายทับ |
triggers_dialog |
ระบุว่าใช้คําสั่งเครื่องหมายทับสำหรับกล่องโต้ตอบหรือไม่ |
ประเภท
Enum | |
---|---|
TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้ |
ADD |
เพิ่มแอป Chat ไปยังพื้นที่ทำงาน |
INVOKE |
เรียกใช้คำสั่งเครื่องหมายทับในพื้นที่ทำงาน |
Space
พื้นที่ทำงานใน Google Chat พื้นที่ทำงานคือการสนทนาระหว่างผู้ใช้ 2 คนขึ้นไปหรือข้อความแบบ 1:1 ระหว่างผู้ใช้กับแอป Chat
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของพื้นที่ทำงาน รูปแบบ: โดย |
type |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ใช้ |
space_type |
ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานหรืออัปเดตประเภทพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นเท่านั้น |
single_user_bot_dm |
ไม่บังคับ พื้นที่ทำงานเป็น DM ระหว่างแอป Chat กับบุคคลเพียงคนเดียวหรือไม่ |
threaded |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ใช้ |
display_name |
ชื่อที่แสดงของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานด้วย สำหรับข้อความส่วนตัว ช่องนี้อาจว่างเปล่า รองรับสูงสุด 128 อักขระ |
external_user_allowed |
เปลี่ยนแปลงไม่ได้ พื้นที่ทำงานนี้อนุญาตให้ผู้ใช้ Google Chat เป็นสมาชิกหรือไม่ ป้อนข้อมูลเมื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace ข้ามช่องนี้เมื่อสร้างพื้นที่ทำงานในเงื่อนไขต่อไปนี้
สําหรับพื้นที่ทำงานที่มีอยู่ ช่องนี้จะเป็นเอาต์พุตเท่านั้น |
space_threading_state |
เอาต์พุตเท่านั้น สถานะการแยกชุดข้อความในพื้นที่ใน Chat |
space_details |
รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ |
space_history_state |
สถานะประวัติข้อความสำหรับข้อความและชุดข้อความในพื้นที่ทำงานนี้ |
import_mode |
ไม่บังคับ พื้นที่ทำงานนี้สร้างขึ้นใน |
create_time |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ สําหรับพื้นที่ทำงานที่สร้างใน Chat เวลาที่สร้างพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ทำงานโหมดการนำเข้า สำหรับพื้นที่ทำงานโหมดการนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาในอดีตที่มีการสร้างพื้นที่ทำงานในแหล่งที่มาเพื่อรักษาเวลาที่สร้างเดิมไว้ ระบบจะป้อนข้อมูลในเอาต์พุตเมื่อ |
last_active_time |
เอาต์พุตเท่านั้น การประทับเวลาของข้อความสุดท้ายในพื้นที่ทำงาน |
admin_installed |
เอาต์พุตเท่านั้น สําหรับพื้นที่ทำงานในข้อความส่วนตัว (DM) ที่มีแอป Chat ไม่ว่าพื้นที่ทำงานนั้นสร้างขึ้นโดยผู้ดูแลระบบ Google Workspace หรือไม่ ผู้ดูแลระบบสามารถติดตั้งและตั้งค่าข้อความส่วนตัวกับแอป Chat ในนามของผู้ใช้ในองค์กรได้ แอป Chat ของคุณต้องมีการรับส่งข้อความส่วนตัวจึงจะรองรับการติดตั้งโดยผู้ดูแลระบบ |
membership_count |
เอาต์พุตเท่านั้น จำนวนการเป็นสมาชิกที่เข้าร่วมซึ่งจัดกลุ่มตามประเภทสมาชิก ป้อนข้อมูลเมื่อ |
access_settings |
ไม่บังคับ ระบุการตั้งค่าการเข้าถึงของพื้นที่ทำงาน ระบบจะป้อนข้อมูลเมื่อ |
space_uri |
เอาต์พุตเท่านั้น URI สำหรับผู้ใช้ในการเข้าถึงพื้นที่ทำงาน |
ช่องการรวม space_permission_settings แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน ระบบจะป้อนข้อมูลเมื่อ space_type คือ SPACE เท่านั้น space_permission_settings ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
predefined_permission_settings |
ไม่บังคับ อินพุตเท่านั้น การตั้งค่าสิทธิ์ของพื้นที่ทำงาน อินพุตสําหรับการสร้างพื้นที่ทำงาน ระบบจะสร้างพื้นที่สําหรับการทํางานร่วมกันหากไม่ได้ตั้งค่าช่องนี้ หลังจากสร้างพื้นที่ทำงานแล้ว ระบบจะป้อนข้อมูลการตั้งค่าในช่อง |
permission_settings |
ไม่บังคับ การตั้งค่าสิทธิ์ที่แน่นอนซึ่งกำหนดให้อัปเดตพื้นที่ทำงานได้ อินพุตสำหรับการอัปเดตพื้นที่ทำงาน หากไม่เป็นเช่นนั้น ให้แสดงเฉพาะเอาต์พุต หากต้องการสร้างพื้นที่ทำงาน โปรดใช้ |
AccessSettings
แสดงการตั้งค่าการเข้าถึงของพื้นที่ทำงาน
ช่อง | |
---|---|
access_state |
เอาต์พุตเท่านั้น ระบุสถานะการเข้าถึงของพื้นที่ทำงาน |
audience |
ไม่บังคับ ชื่อทรัพยากรของกลุ่มเป้าหมายที่สำรวจพื้นที่ทำงาน เข้าร่วมพื้นที่ทำงาน และดูตัวอย่างข้อความในพื้นที่ทำงานได้ หากไม่ได้ตั้งค่า จะมีเพียงผู้ใช้หรือ Google Groups ที่ได้รับเชิญเป็นรายบุคคลหรือได้รับการเพิ่มไปยังพื้นที่ทำงานเท่านั้นที่สามารถเข้าถึงพื้นที่ทำงานได้ โปรดดูรายละเอียดที่หัวข้อทำให้กลุ่มเป้าหมายค้นพบพื้นที่ทำงานได้ รูปแบบ: หากต้องการใช้กลุ่มเป้าหมายเริ่มต้นสำหรับองค์กร Google Workspace ให้ตั้งค่าเป็น |
AccessState
แสดงสถานะการเข้าถึงของพื้นที่ทำงาน
Enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
ไม่ทราบสถานะการเข้าถึงหรือไม่รองรับใน API นี้ |
PRIVATE |
มีเพียงผู้ใช้หรือ Google Groups ที่ผู้ใช้รายอื่นๆ หรือผู้ดูแลระบบ Google Workspace เพิ่มหรือเชิญเป็นรายบุคคลเท่านั้นที่จะค้นหาและเข้าถึงพื้นที่ทำงานได้ |
DISCOVERABLE |
ผู้จัดการพื้นที่ทำงานได้ให้สิทธิ์เข้าถึงพื้นที่ทำงานแก่กลุ่มเป้าหมาย ผู้ใช้หรือ Google Groups ที่เพิ่มหรือเชิญให้เข้าร่วมพื้นที่ทำงานเป็นรายบุคคลจะสามารถค้นพบและเข้าถึงพื้นที่ทำงานได้เช่นกัน โปรดดูข้อมูลเพิ่มเติมที่หัวข้อทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้ |
MembershipCount
ช่อง | |
---|---|
joined_direct_human_user_count |
จำนวนผู้ใช้ที่เป็นมนุษย์ที่เข้าร่วมพื้นที่ทำงานโดยตรง ซึ่งไม่ได้นับผู้ใช้ที่เข้าร่วมจากการเข้าร่วมกลุ่มที่เข้าร่วม |
joined_group_count |
จำนวนกลุ่มทั้งหมดที่เข้าร่วมพื้นที่ทำงานโดยตรง |
PermissionSetting
แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน
ช่อง | |
---|---|
managers_allowed |
ผู้จัดการพื้นที่ทำงานมีสิทธิ์นี้หรือไม่ |
members_allowed |
สมาชิกที่ไม่ใช่ผู้จัดการจะมีสิทธิ์นี้หรือไม่ |
PermissionSettings
การตั้งค่าสิทธิ์สำหรับพื้นที่ทำงานที่มีชื่อ หากต้องการตั้งค่าสิทธิ์เมื่อสร้างพื้นที่ทำงาน ให้ระบุช่อง PredefinedPermissionSettings
ในคำขอ
ช่อง | |
---|---|
manage_members_and_groups |
การตั้งค่าสำหรับการจัดการสมาชิกและกลุ่มในพื้นที่ทำงาน |
modify_space_details |
การตั้งค่าสำหรับอัปเดตชื่อ รูปโปรไฟล์ คำอธิบาย และหลักเกณฑ์ของพื้นที่ทำงาน |
toggle_history |
การตั้งค่าเพื่อเปิด/ปิดประวัติพื้นที่ทำงาน |
use_at_mention_all |
การตั้งค่าสำหรับการใช้ @all ในพื้นที่ทำงาน |
manage_apps |
การตั้งค่าสำหรับจัดการแอปในพื้นที่ทำงาน |
manage_webhooks |
การตั้งค่าสำหรับการจัดการเว็บฮุคในพื้นที่ทำงาน |
post_messages |
เอาต์พุตเท่านั้น การตั้งค่าสำหรับการโพสต์ข้อความในพื้นที่ทำงาน |
reply_messages |
การตั้งค่าสำหรับการตอบกลับข้อความในพื้นที่ทำงาน |
PredefinedPermissionSettings
การตั้งค่าสิทธิ์พื้นที่ทำงานที่คุณระบุเมื่อสร้างพื้นที่ทำงานที่มีชื่อ อาจมีการเพิ่มการตั้งค่าอื่นๆ ในอนาคต โปรดดูรายละเอียดเกี่ยวกับการตั้งค่าสิทธิ์ของพื้นที่ทำงานที่มีชื่อที่หัวข้อดูข้อมูลเกี่ยวกับพื้นที่ทำงาน
Enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
ไม่ระบุ โปรดอย่าใช้ |
COLLABORATION_SPACE |
การตั้งค่าเพื่อทำให้พื้นที่ทำงานเป็นพื้นที่การทำงานร่วมกันที่สมาชิกทุกคนสามารถโพสต์ข้อความได้ |
ANNOUNCEMENT_SPACE |
การตั้งค่าเพื่อทำให้พื้นที่ทำงานเป็นพื้นที่ประกาศที่เฉพาะผู้จัดการพื้นที่ทำงานเท่านั้นที่โพสต์ข้อความได้ |
SpaceDetails
รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ
ช่อง | |
---|---|
description |
ไม่บังคับ คำอธิบายของพื้นที่ทำงาน เช่น อธิบายหัวข้อการสนทนาของพื้นที่ทำงาน วัตถุประสงค์การใช้งาน หรือผู้เข้าร่วม รองรับสูงสุด 150 อักขระ |
guidelines |
ไม่บังคับ กฎ ความคาดหวัง และมารยาทของพื้นที่ทำงาน รองรับสูงสุด 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[] |
รายการพื้นที่ทำงานที่อัปเดต |
SpaceEvent
เหตุการณ์ที่แสดงการเปลี่ยนแปลงหรือกิจกรรมในพื้นที่ใน Google Chat ดูข้อมูลเพิ่มเติมได้ที่ทํางานกับเหตุการณ์จาก Google Chat
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของเหตุการณ์พื้นที่ทำงาน รูปแบบ: |
event_time |
เวลาที่เกิดเหตุการณ์ |
event_type |
ประเภทเหตุการณ์ในพื้นที่ทำงาน เหตุการณ์แต่ละประเภทมีเวอร์ชันกลุ่ม ซึ่งแสดงอินสแตนซ์หลายรายการของเหตุการณ์ประเภทนั้นที่เกิดขึ้นในช่วงเวลาสั้นๆ สำหรับคำขอ ประเภทเหตุการณ์ที่รองรับข้อความมีดังนี้
ประเภทเหตุการณ์ที่รองรับการเป็นสมาชิกมีดังนี้
ประเภทเหตุการณ์ที่รองรับรีแอ็กชันมีดังนี้
ประเภทเหตุการณ์ที่รองรับเกี่ยวกับพื้นที่ทำงานมีดังนี้
|
ช่องการรวม
|
|
message_created_event_data |
เปย์โหลดของเหตุการณ์สำหรับข้อความใหม่ ประเภทเหตุการณ์: |
message_updated_event_data |
เปย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดต ประเภทเหตุการณ์: |
message_deleted_event_data |
เปย์โหลดของเหตุการณ์สำหรับข้อความที่ถูกลบ ประเภทเหตุการณ์: |
message_batch_created_event_data |
เปย์โหลดของเหตุการณ์สำหรับข้อความใหม่หลายรายการ ประเภทเหตุการณ์: |
message_batch_updated_event_data |
เปย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดตหลายรายการ ประเภทเหตุการณ์: |
message_batch_deleted_event_data |
เปย์โหลดของเหตุการณ์สำหรับข้อความที่ถูกลบหลายรายการ ประเภทเหตุการณ์: |
space_updated_event_data |
เปย์โหลดของเหตุการณ์สำหรับการอัปเดตพื้นที่ทำงาน ประเภทเหตุการณ์: |
space_batch_updated_event_data |
เปย์โหลดเหตุการณ์สำหรับการอัปเดตหลายรายการในพื้นที่ทำงาน ประเภทเหตุการณ์: |
membership_created_event_data |
เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกใหม่ ประเภทเหตุการณ์: |
membership_updated_event_data |
เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกที่อัปเดตแล้ว ประเภทเหตุการณ์: |
membership_deleted_event_data |
เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกที่ถูกลบ ประเภทเหตุการณ์: |
membership_batch_created_event_data |
เพย์โหลดกิจกรรมสำหรับการเป็นสมาชิกใหม่หลายรายการ ประเภทเหตุการณ์: |
membership_batch_updated_event_data |
เปย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตหลายรายการ ประเภทเหตุการณ์: |
membership_batch_deleted_event_data |
เปย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบหลายรายการ ประเภทเหตุการณ์: |
reaction_created_event_data |
เปย์โหลดเหตุการณ์สำหรับรีแอ็กชันใหม่ ประเภทเหตุการณ์: |
reaction_deleted_event_data |
เปย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้ว ประเภทเหตุการณ์: |
reaction_batch_created_event_data |
เปย์โหลดของเหตุการณ์สำหรับความรู้สึกใหม่หลายรายการ ประเภทเหตุการณ์: |
reaction_batch_deleted_event_data |
เปย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้วหลายรายการ ประเภทเหตุการณ์: |
SpaceReadState
สถานะการอ่านของผู้ใช้ในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน
ช่อง | |
---|---|
name |
ชื่อทรัพยากรและสถานะการอ่านของพื้นที่ทำงาน รูปแบบ: |
last_read_time |
ไม่บังคับ เวลาที่อัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ โดยปกติแล้วจะสอดคล้องกับการประทับเวลาของข้อความที่อ่านล่าสุดหรือการประทับเวลาที่ผู้ใช้ระบุเพื่อทำเครื่องหมายตำแหน่งที่อ่านล่าสุดในพื้นที่ทำงาน |
SpaceUpdatedEventData
เปย์โหลดเหตุการณ์สำหรับพื้นที่ที่อัปเดต
ประเภทเหตุการณ์: google.workspace.chat.space.v1.updated
ช่อง | |
---|---|
space |
พื้นที่ทำงานที่อัปเดตแล้ว |
ชุดข้อความ
ชุดข้อความในพื้นที่ใน Google Chat เช่น การใช้งานที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ
หากระบุชุดข้อความเมื่อสร้างข้อความ คุณสามารถตั้งค่าช่อง messageReplyOption
เพื่อกำหนดสิ่งที่จะเกิดขึ้นหากไม่พบชุดข้อความที่ตรงกัน
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของชุดข้อความ เช่น |
thread_key |
ไม่บังคับ อินพุตสำหรับสร้างหรืออัปเดตชุดข้อความ หากไม่เป็นเช่นนั้น ให้แสดงเฉพาะเอาต์พุต รหัสสำหรับชุดข้อความ รองรับสูงสุด 4,000 อักขระ รหัสนี้จะไม่ซ้ำกันสำหรับแอป Chat ที่ตั้งค่านี้ เช่น หากแอป Chat หลายแอปสร้างข้อความโดยใช้คีย์ชุดข้อความเดียวกัน ระบบจะโพสต์ข้อความในชุดข้อความที่ต่างกัน หากต้องการตอบกลับในชุดข้อความที่สร้างโดยบุคคลหรือแอป Chat อื่น โปรดระบุช่องชุดข้อความ |
ThreadReadState
สถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของสถานะอ่านชุดข้อความ รูปแบบ: |
last_read_time |
เวลาที่อัปเดตสถานะการอ่านชุดข้อความของผู้ใช้ โดยปกติแล้วค่านี้สอดคล้องกับการประทับเวลาของข้อความที่อ่านล่าสุดในชุดข้อความ |
UpdateMembershipRequest
ข้อความขออัปเดตการเป็นสมาชิก
ช่อง | |
---|---|
membership |
ต้องระบุ การเป็นสมาชิกที่จะอัปเดต ระบบจะอัปเดตเฉพาะช่องที่ระบุด้วย |
update_mask |
ต้องระบุ เส้นทางช่องที่จะอัปเดต คั่นค่าหลายค่าด้วยเครื่องหมายจุลภาคหรือใช้ เส้นทางช่องที่รองรับในปัจจุบันมีดังนี้
|
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ |
UpdateMessageRequest
ขออัปเดตข้อความ
ช่อง | |
---|---|
message |
ต้องระบุ ข้อความที่อัปเดตช่องแล้ว |
update_mask |
ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต คั่นค่าหลายค่าด้วยเครื่องหมายจุลภาคหรือใช้ เส้นทางช่องที่รองรับในปัจจุบันมีดังนี้
|
allow_missing |
ไม่บังคับ หาก |
UpdateSpaceReadStateRequest
ข้อความคำขอสำหรับ UpdateSpaceReadState API
ช่อง | |
---|---|
space_read_state |
ต้องระบุ สถานะการอ่านของพื้นที่ทำงานและฟิลด์ที่จะอัปเดต รองรับเฉพาะการอัปเดตสถานะการอ่านสำหรับผู้ใช้ที่โทร หากต้องการอ้างอิงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้
รูปแบบ: users/{user}/spaces/{space}/spaceReadState |
update_mask |
ต้องระบุ เส้นทางช่องที่จะอัปเดต เส้นทางช่องที่รองรับในปัจจุบันมีดังนี้
เมื่อ หากต้องการทำเครื่องหมายพื้นที่ทำงานว่าอ่านแล้ว ให้ตั้งค่า |
UpdateSpaceRequest
คำขออัปเดตพื้นที่ทำงาน 1 รายการ
ช่อง | |
---|---|
space |
ต้องระบุ พื้นที่ทำงานที่มีช่องที่จะอัปเดต ต้องป้อนข้อมูล |
update_mask |
ต้องระบุ เส้นทางช่องที่อัปเดตแล้ว คั่นด้วยเครื่องหมายจุลภาคหากมีหลายรายการ คุณสามารถอัปเดตพื้นที่ทำงานในช่องต่อไปนี้
|
use_admin_access |
true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ของ ค่า |
ผู้ใช้
ผู้ใช้ใน Google Chat เมื่อแสดงผลเป็นเอาต์พุตจากคำขอ หากแอป Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ เอาต์พุตสำหรับทรัพยากร User
จะเติมเฉพาะ name
และ type
ของผู้ใช้เท่านั้น
ช่อง | |
---|---|
name |
ชื่อทรัพยากรสำหรับ Google Chat รูปแบบ: สำหรับ
|
display_name |
เอาต์พุตเท่านั้น ชื่อที่แสดงของผู้ใช้ |
domain_id |
ตัวระบุที่ไม่ซ้ำกันของโดเมน Google Workspace ของผู้ใช้ |
type |
ประเภทผู้ใช้ |
is_anonymous |
เอาต์พุตเท่านั้น เมื่อ |
ประเภท
Enum | |
---|---|
TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum ห้ามใช้ |
HUMAN |
ผู้ใช้ที่เป็นมนุษย์ |
BOT |
ผู้ใช้แอป Chat |
UserMentionMetadata
ข้อมูลเมตาคำอธิบายประกอบสำหรับการพูดถึงผู้ใช้ (@)
ช่อง | |
---|---|
user |
ผู้ใช้พูดถึง |
type |
ประเภทของการพูดถึงผู้ใช้ |
ประเภท
Enum | |
---|---|
TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้ |
ADD |
เพิ่มผู้ใช้ไปยังพื้นที่ทำงาน |
MENTION |
พูดถึงผู้ใช้ในพื้นที่ทำงาน |
WidgetMarkup
วิดเจ็ตเป็นองค์ประกอบ UI ที่แสดงข้อความและรูปภาพ
ช่อง | |
---|---|
buttons[] |
รายการปุ่ม ปุ่มต่างๆ ยังเป็นแบบ |
ช่องการรวม data WidgetMarkup จะมีรายการดังต่อไปนี้ได้เพียง 1 รายการเท่านั้น คุณสามารถใช้ช่อง WidgetMarkup หลายช่องเพื่อแสดงรายการเพิ่มเติมได้ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
text_paragraph |
แสดงย่อหน้าข้อความในวิดเจ็ตนี้ |
image |
แสดงรูปภาพในวิดเจ็ตนี้ |
key_value |
แสดงรายการคีย์-ค่าในวิดเจ็ตนี้ |
ปุ่ม
ปุ่ม ซึ่งอาจเป็นปุ่มข้อความหรือปุ่มรูปภาพก็ได้
ช่อง | |
---|---|
ช่องการรวม
|
|
text_button |
ปุ่มที่มีข้อความและการทำงาน |
image_button |
ปุ่มที่มีรูปภาพและการดําเนินการ |
FormAction
การดําเนินการของแบบฟอร์มจะอธิบายลักษณะการทํางานเมื่อมีการส่งแบบฟอร์ม ตัวอย่างเช่น คุณสามารถเรียกใช้ Apps Script เพื่อจัดการแบบฟอร์ม
ช่อง | |
---|---|
action_method_name |
ชื่อเมธอดจะใช้เพื่อระบุว่าส่วนใดของแบบฟอร์มที่ทริกเกอร์การส่งแบบฟอร์ม ระบบจะส่งข้อมูลนี้กลับไปยังแอป Chat โดยเป็นส่วนหนึ่งของกิจกรรมการคลิกการ์ด คุณสามารถใช้ชื่อเมธอดเดียวกันสำหรับองค์ประกอบหลายรายการที่ทริกเกอร์การทำงานทั่วไปได้ |
parameters[] |
รายการพารามิเตอร์การดำเนินการ |
ActionParameter
รายการพารามิเตอร์สตริงที่ต้องระบุเมื่อมีการเรียกใช้เมธอดการดำเนินการ ตัวอย่างเช่น ลองพิจารณาปุ่มปิดเสียงเตือนชั่วคราว 3 ปุ่ม ได้แก่ ปิดเสียงเตือนชั่วคราวเดี๋ยวนี้ ปิดเสียงเตือนชั่วคราว 1 วัน ปิดเสียงเตือนชั่วคราวสัปดาห์หน้า คุณอาจใช้ action method = snooze()
โดยส่งประเภทการเลื่อนการแจ้งเตือนและเวลาเลื่อนการแจ้งเตือนในรายการพารามิเตอร์สตริง
ช่อง | |
---|---|
key |
ชื่อพารามิเตอร์สำหรับสคริปต์การทำงาน |
value |
ค่าของพารามิเตอร์ |
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 |
URL ของรูปภาพ |
on_click |
การดำเนินการ |
aspect_ratio |
สัดส่วนภาพ (ความกว้างและความสูง) ของรูปภาพนี้ ฟิลด์นี้ช่วยให้คุณกำหนดความสูงที่เหมาะสมให้กับรูปภาพได้ขณะที่รอให้รูปภาพโหลด แต่ไม่ได้มีไว้เพื่อลบล้างสัดส่วนภาพในตัวของรูปภาพ หากไม่ได้ตั้งค่า เซิร์ฟเวอร์จะกรอกข้อมูลโดยการดึงข้อมูลรูปภาพล่วงหน้า |
ImageButton
ปุ่มรูปภาพที่มีการดำเนินการ onclick
ช่อง | |
---|---|
on_click |
การดำเนินการ |
name |
ชื่อของ |
ช่องการรวม icons ระบุไอคอนได้โดยใช้ Icon enum หรือ URL icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
icon |
ไอคอนที่ระบุโดย |
icon_url |
ไอคอนที่ระบุโดย URL |
KeyValue
องค์ประกอบ UI ประกอบด้วยคีย์ (ป้ายกำกับ) และค่า (เนื้อหา) องค์ประกอบนี้ยังอาจมีการดำเนินการบางอย่าง เช่น ปุ่มonclick
ช่อง | |
---|---|
top_label |
ข้อความของป้ายกำกับด้านบน รองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
content |
ข้อความของเนื้อหา รองรับข้อความที่จัดรูปแบบและต้องระบุเสมอ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
content_multiline |
เนื้อหาควรเป็นหลายบรรทัดหรือไม่ |
bottom_label |
ข้อความของป้ายกำกับด้านล่าง รองรับข้อความที่จัดรูปแบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
on_click |
การดำเนินการ |
ช่องการรวม icons ต้องกำหนดไอคอนอย่างน้อย 1 รายการ top_label และ bottom_label icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
icon |
ค่า enum ที่ Chat API แทนที่ด้วยรูปภาพไอคอนที่เกี่ยวข้อง |
icon_url |
ไอคอนที่ระบุโดย URL |
ฟิลด์สหภาพ control วิดเจ็ตการควบคุม คุณตั้งค่า button หรือ switch_widget ได้ แต่ตั้งค่าทั้ง 2 อย่างไม่ได้ control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
button |
ปุ่มที่สามารถคลิกเพื่อเรียกให้เกิดการทำงาน |
OnClick
การดำเนินการ onclick
(เช่น เปิดลิงก์)
ช่อง | |
---|---|
ช่องการรวม
|
|
action |
การทำงานของแบบฟอร์มจะทริกเกอร์โดยการดำเนินการ |
open_link |
การดำเนินการ |
OpenLink
ลิงก์ที่เปิดหน้าต่างใหม่
ช่อง | |
---|---|
url |
URL ที่จะเปิด |
TextButton
ปุ่มที่มีข้อความและการทำงาน onclick
ช่อง | |
---|---|
text |
ข้อความของปุ่ม |
on_click |
การทำงาน |
TextParagraph
ย่อหน้าของข้อความ รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
ช่อง | |
---|---|
text |
|