ดัชนี
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
(ข้อความ)CreateCustomEmojiRequest
(ข้อความ)CreateMembershipRequest
(ข้อความ)CreateMessageRequest
(ข้อความ)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(ข้อความ)CreateSpaceRequest
(ข้อความ)CustomEmoji
(ข้อความ)CustomEmoji.CustomEmojiPayload
(ข้อความ)DeleteCustomEmojiRequest
(ข้อความ)DeleteMembershipRequest
(ข้อความ)DeleteMessageRequest
(ข้อความ)DeleteReactionRequest
(ข้อความ)DeleteSpaceRequest
(ข้อความ)DeletionMetadata
(ข้อความ)DeletionMetadata.DeletionType
(enum)Dialog
(ข้อความ)DialogAction
(ข้อความ)DriveDataRef
(ข้อความ)DriveLinkData
(ข้อความ)Emoji
(ข้อความ)EmojiReactionSummary
(ข้อความ)FindDirectMessageRequest
(ข้อความ)GetAttachmentRequest
(ข้อความ)GetCustomEmojiRequest
(ข้อความ)GetMembershipRequest
(ข้อความ)GetMessageRequest
(ข้อความ)GetSpaceEventRequest
(ข้อความ)GetSpaceNotificationSettingRequest
(ข้อความ)GetSpaceReadStateRequest
(ข้อความ)GetSpaceRequest
(ข้อความ)GetThreadReadStateRequest
(ข้อความ)Group
(ข้อความ)HistoryState
(enum)ListCustomEmojisRequest
(ข้อความ)ListCustomEmojisResponse
(ข้อความ)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
(ข้อความ)SpaceNotificationSetting
(ข้อความ)SpaceNotificationSetting.MuteSetting
(enum)SpaceNotificationSetting.NotificationSetting
(enum)SpaceReadState
(ข้อความ)SpaceUpdatedEventData
(ข้อความ)Thread
(ข้อความ)ThreadReadState
(ข้อความ)UpdateMembershipRequest
(ข้อความ)UpdateMessageRequest
(ข้อความ)UpdateSpaceNotificationSettingRequest
(ข้อความ)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 นําเข้าข้อมูล
|
CreateCustomEmoji |
---|
ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
CreateMembership |
---|
สร้างการเป็นสมาชิกสำหรับแอป Chat ที่ใช้โทร ผู้ใช้ หรือ Google Group ระบบไม่รองรับการสร้างการเป็นสมาชิกสำหรับแอป Chat อื่นๆ เมื่อสร้างการเป็นสมาชิก หากสมาชิกที่ระบุปิดนโยบายการยอมรับโดยอัตโนมัติไว้ ระบบจะส่งคำเชิญให้สมาชิกดังกล่าว และสมาชิกจะต้องยอมรับคำเชิญให้เข้าร่วมพื้นที่ทำงานก่อนจึงจะเข้าร่วมได้ หรือจะสร้างการเป็นสมาชิกเพื่อเพิ่มสมาชิกไปยังพื้นที่ทำงานที่ระบุโดยตรงก็ได้ รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
ดูตัวอย่างการใช้งานได้ที่
|
CreateMessage |
---|
สร้างข้อความในพื้นที่ใน Google Chat โปรดดูตัวอย่างที่หัวข้อส่งข้อความ วิธีการ รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์ของแอป Chat จะแสดงแอป Chat เป็นผู้ส่งข้อความ เนื้อหาของข้อความอาจมีข้อความ ( รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์ผู้ใช้ Chat จะแสดงผู้ใช้เป็นผู้ส่งข้อความและระบุแหล่งที่มาของแอป Chat ในข้อความด้วยการแสดงชื่อแอป เนื้อหาของข้อความต้องมีเฉพาะข้อความ ( ขนาดข้อความสูงสุดซึ่งรวมถึงเนื้อหาข้อความคือ 32,000 ไบต์
|
CreateReaction |
---|
สร้างความรู้สึกและเพิ่มลงในข้อความ ระบบรองรับเฉพาะอีโมจิแบบ Unicode เท่านั้น โปรดดูตัวอย่างที่หัวข้อเพิ่มรีแอ็กชันในข้อความ ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
CreateSpace |
---|
สร้างพื้นที่ทำงาน ใช้สร้างพื้นที่ทำงานที่มีชื่อหรือแชทเป็นกลุ่มใน รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ เมื่อตรวจสอบสิทธิ์เป็นแอป คุณต้องตั้งค่าฟิลด์ การเป็นสมาชิกของพื้นที่ทำงานเมื่อสร้างจะขึ้นอยู่กับว่าพื้นที่ทำงานสร้างขึ้นใน
หากได้รับข้อความแสดงข้อผิดพลาด
|
DeleteCustomEmoji |
---|
ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
DeleteMembership |
---|
ลบการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้อนำผู้ใช้หรือแอป Google Chat ออกจากพื้นที่ทำงาน รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
DeleteMessage |
---|
ลบข้อความ โปรดดูตัวอย่างที่หัวข้อลบข้อความ รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ เมื่อใช้การตรวจสอบสิทธิ์ของแอป คำขอจะลบได้เฉพาะข้อความที่สร้างโดยแอป Chat ที่โทรเข้ามาเท่านั้น
|
DeleteReaction |
---|
ลบความรู้สึกที่มีต่อข้อความ ระบบรองรับเฉพาะอีโมจิแบบ Unicode เท่านั้น โปรดดูตัวอย่างที่หัวข้อลบความรู้สึก ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
DeleteSpace |
---|
ลบพื้นที่ทำงานที่มีชื่อ ดำเนินการลบแบบตามลำดับขั้นเสมอ ซึ่งหมายความว่าระบบจะลบทรัพยากรย่อยของพื้นที่ทำงานด้วย เช่น ข้อความที่โพสต์ในพื้นที่ทำงานและการเป็นสมาชิกในพื้นที่ทำงาน โปรดดูตัวอย่างที่หัวข้อลบพื้นที่ทำงาน รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
FindDirectMessage |
---|
แสดงข้อความส่วนตัวที่มีอยู่กับผู้ใช้ที่ระบุ หากไม่พบพื้นที่ข้อความส่วนตัว ระบบจะแสดงข้อผิดพลาด เมื่อใช้การตรวจสอบสิทธิ์แอป ให้แสดงพื้นที่ข้อความส่วนตัวระหว่างผู้ใช้ที่ระบุกับแอป Chat ที่เรียก เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ระบบจะแสดงพื้นที่ข้อความส่วนตัวระหว่างผู้ใช้ที่ระบุกับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว // รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
GetAttachment |
---|
รับข้อมูลเมตาของไฟล์แนบข้อความ ระบบจะดึงข้อมูลไฟล์แนบโดยใช้ media API โปรดดูตัวอย่างที่หัวข้อรับข้อมูลเมตาเกี่ยวกับไฟล์แนบของข้อความ ต้องใช้การตรวจสอบสิทธิ์แอป
|
GetCustomEmoji |
---|
ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
GetMembership |
---|
แสดงรายละเอียดเกี่ยวกับการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Google Chat รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
GetMessage |
---|
แสดงรายละเอียดเกี่ยวกับข้อความ โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับข้อความ รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ หมายเหตุ: อาจแสดงข้อความจากสมาชิกหรือพื้นที่ทำงานที่ถูกบล็อก
|
GetSpace |
---|
แสดงรายละเอียดเกี่ยวกับพื้นที่ทำงาน โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับพื้นที่ทำงาน รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
GetSpaceEvent |
---|
แสดงผลกิจกรรมจากพื้นที่ทำงานใน Google Chat เพย์โหลดเหตุการณ์จะมีทรัพยากรเวอร์ชันล่าสุดที่มีการเปลี่ยนแปลง เช่น หากคุณขอเหตุการณ์เกี่ยวกับข้อความใหม่ แต่ข้อความได้รับการอัปเดตในภายหลัง เซิร์ฟเวอร์จะแสดงผลทรัพยากร หมายเหตุ: ระบบจะไม่แสดงฟิลด์ ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้ ผู้ใช้ที่ตรวจสอบสิทธิ์ต้องเป็นสมาชิกของพื้นที่ทำงานจึงจะดูเหตุการณ์ได้ โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับกิจกรรมจากพื้นที่ทำงาน Google Chat
|
GetSpaceNotificationSetting |
---|
ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
GetSpaceReadState |
---|
แสดงรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ซึ่งใช้ในการระบุข้อความที่อ่านแล้วและยังไม่อ่าน โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับสถานะการอ่านพื้นที่ทำงานของผู้ใช้ ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
GetThreadReadState |
---|
แสดงรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้ในการระบุข้อความที่อ่านและยังไม่ได้อ่าน โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับสถานะการอ่านชุดข้อความของผู้ใช้ ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
ListCustomEmojis |
---|
ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
ListMemberships |
---|
แสดงการเป็นสมาชิกในพื้นที่ทำงาน โปรดดูตัวอย่างที่หัวข้อแสดงรายการผู้ใช้และแอป Google Chat ในพื้นที่ทำงาน การแสดงการเป็นสมาชิกด้วยการตรวจสอบสิทธิ์ของแอปจะแสดงการเป็นสมาชิกในพื้นที่ทำงานที่แอป Chat มีสิทธิ์เข้าถึง แต่ไม่รวมการเป็นสมาชิกแอป Chat รวมถึงการเป็นสมาชิกของแอปเอง การแสดงข้อมูลการเป็นสมาชิกด้วยการตรวจสอบสิทธิ์ผู้ใช้จะแสดงข้อมูลการเป็นสมาชิกในพื้นที่ทำงานที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมีสิทธิ์เข้าถึง รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
ListMessages |
---|
แสดงรายการข้อความในพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก รวมถึงข้อความจากสมาชิกและพื้นที่ทำงานที่ถูกบล็อก หากคุณแสดงรายการข้อความจากพื้นที่ทำงานที่ไม่มีข้อความ คำตอบจะเป็นออบเจ็กต์ว่าง เมื่อใช้อินเทอร์เฟซ REST/HTTP การตอบกลับจะมีออบเจ็กต์ JSON ว่าง ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
ListReactions |
---|
แสดงรายการความรู้สึกที่มีต่อข้อความ โปรดดูตัวอย่างที่หัวข้อแสดงรายการความรู้สึกที่มีต่อข้อความ ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
ListSpaceEvents |
---|
แสดงเหตุการณ์จากพื้นที่ทำงานใน Google Chat เพย์โหลดของเหตุการณ์แต่ละรายการจะมีทรัพยากร Chat เวอร์ชันล่าสุด ตัวอย่างเช่น หากคุณแสดงเหตุการณ์เกี่ยวกับสมาชิกใหม่ของพื้นที่ทำงาน เซิร์ฟเวอร์จะแสดงผลแหล่งข้อมูล ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้ หากต้องการแสดงรายการกิจกรรม ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วต้องเป็นสมาชิกของสเปซ โปรดดูตัวอย่างที่หัวข้อแสดงรายการเหตุการณ์จากพื้นที่ทำงานใน Google Chat
|
ListSpaces |
---|
แสดงรายการพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก แชทเป็นกลุ่มและ DM จะไม่แสดงจนกว่าจะมีการส่งข้อความแรก ดูตัวอย่างได้ที่แสดงรายการพื้นที่ทำงาน รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ หากต้องการแสดงรายการพื้นที่ทำงานที่มีชื่อทั้งหมดตามองค์กร Google Workspace ให้ใช้เมธอด
|
SearchSpaces |
---|
แสดงรายการพื้นที่ทำงานในองค์กร Google Workspace ตามการค้นหาของผู้ดูแลระบบ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบ ในคําขอ ให้ตั้งค่า
|
SetUpSpace |
---|
สร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุ ระบบจะเพิ่มผู้ใช้ที่โทรเข้ามาในพื้นที่ทำงานโดยอัตโนมัติ และไม่ควรระบุเป็นสมาชิกในคำขอ โปรดดูตัวอย่างที่หัวข้อตั้งค่าพื้นที่ทำงานที่มีสมาชิกเริ่มต้น หากต้องการระบุสมาชิกที่เป็นบุคคลที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย หากต้องการระบุกลุ่ม Google ที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย สำหรับพื้นที่ทำงานหรือแชทเป็นกลุ่มที่มีชื่อ หากผู้โทรบล็อกหรือถูกบล็อกโดยสมาชิกบางราย หรือไม่มีสิทธิ์เพิ่มสมาชิกบางราย ระบบจะไม่เพิ่มสมาชิกเหล่านั้นในพื้นที่ทำงานที่สร้างขึ้น หากต้องการสร้างข้อความส่วนตัว (DM) ระหว่างผู้ใช้ที่โทรกับผู้ใช้ที่เป็นบุคคลธรรมดาอีกคนหนึ่ง ให้ระบุการเป็นสมาชิก 1 รายการเพื่อแสดงถึงผู้ใช้ที่เป็นบุคคลธรรมดา หากผู้ใช้รายหนึ่งบล็อกผู้ใช้อีกรายหนึ่ง คำขอจะไม่สำเร็จและระบบจะไม่สร้าง DM หากต้องการสร้าง DM ระหว่างผู้ใช้ที่โทรและแอปการโทร ให้ตั้งค่า หากผู้ใช้ 2 รายมี DM อยู่แล้ว แม้ว่าผู้ใช้รายหนึ่งจะบล็อกอีกรายหนึ่งในขณะที่ส่งคำขอ ระบบก็จะแสดง DM ที่มีอยู่ ไม่รองรับพื้นที่ทำงานที่มีการตอบกลับแบบแยกชุดข้อความ หากได้รับข้อความแสดงข้อผิดพลาด ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
UpdateMembership |
---|
อัปเดตการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้ออัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ทำงาน รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
UpdateMessage |
---|
อัปเดตข้อความ วิธีการ รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ เมื่อใช้การตรวจสอบสิทธิ์ของแอป คำขอจะอัปเดตได้เฉพาะข้อความที่สร้างโดยแอป Chat ที่โทรเข้ามาเท่านั้น
|
UpdateSpace |
---|
อัปเดตพื้นที่ทำงาน โปรดดูตัวอย่างที่หัวข้ออัปเดตพื้นที่ทำงาน หากคุณอัปเดตช่อง รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้
|
UpdateSpaceNotificationSetting |
---|
ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
UpdateSpaceReadState |
---|
อัปเดตสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ซึ่งใช้ในการระบุข้อความที่อ่านแล้วและยังไม่อ่าน โปรดดูตัวอย่างที่หัวข้ออัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้
|
AccessoryWidget
วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 1 รายการที่ปรากฏที่ด้านล่างของข้อความ โปรดดูรายละเอียดที่หัวข้อเพิ่มวิดเจ็ตแบบอินเทอร์แอกทีฟที่ด้านล่างของข้อความ
ช่อง | |
---|---|
ฟิลด์สหภาพ action ประเภทการดําเนินการ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
button_ |
รายการปุ่ม |
ActionResponse
พารามิเตอร์ที่แอป Chat สามารถใช้เพื่อกำหนดค่าวิธีโพสต์คำตอบ
ช่อง | |
---|---|
type |
อินพุตเท่านั้น ประเภทการตอบกลับของแอป Chat |
url |
อินพุตเท่านั้น URL สำหรับให้ผู้ใช้ตรวจสอบสิทธิ์หรือกําหนดค่า (สําหรับคำตอบประเภท |
dialog_ |
อินพุตเท่านั้น การตอบสนองต่อเหตุการณ์การโต้ตอบที่เกี่ยวข้องกับกล่องโต้ตอบ ต้องมาพร้อมกับ |
updated_ |
อินพุตเท่านั้น การตอบสนองของวิดเจ็ตที่อัปเดต |
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_ |
รหัสสถานะ |
user_ |
ข้อความที่จะส่งให้ผู้ใช้เกี่ยวกับสถานะคำขอ หากไม่ได้ตั้งค่า ระบบจะส่งข้อความทั่วไปตาม |
หมายเหตุ
เอาต์พุตเท่านั้น คําอธิบายประกอบที่เชื่อมโยงกับเนื้อหาข้อความธรรมดา หากต้องการเพิ่มการจัดรูปแบบพื้นฐานใน SMS โปรดดูจัดรูปแบบ SMS
ตัวอย่างเนื้อหาข้อความธรรมดา
Hello @FooBot how are you!"
ข้อมูลเมตาของคำอธิบายประกอบที่เกี่ยวข้อง
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
ช่อง | |
---|---|
type |
ประเภทของคำอธิบายประกอบนี้ |
length |
ความยาวของสตริงย่อยในเนื้อหาข้อความแบบข้อความธรรมดาที่คำอธิบายประกอบนี้สอดคล้องกับ |
start_ |
ดัชนีเริ่มต้น (แบบนับจาก 0 ไปจนถึง 1) ในเนื้อหาข้อความธรรมดาที่คำอธิบายประกอบนี้สอดคล้องกับ |
ฟิลด์สหภาพ metadata ข้อมูลเมตาเพิ่มเติมเกี่ยวกับคำอธิบายประกอบ metadata ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
user_ |
ข้อมูลเมตาของการพูดถึงผู้ใช้ |
slash_ |
ข้อมูลเมตาสำหรับคำสั่งเครื่องหมายทับ |
rich_ |
ข้อมูลเมตาของลิงก์ริชมีเดีย |
AnnotationType
ประเภทคำอธิบายประกอบ
Enum | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum อย่าใช้ |
USER_MENTION |
มีการพูดถึงผู้ใช้ |
SLASH_COMMAND |
ระบบเรียกใช้คำสั่งเครื่องหมายทับ |
RICH_LINK |
คําอธิบายประกอบลิงก์ที่มีการจัดรูปแบบ |
AttachedGif
รูปภาพ GIF ที่ระบุด้วย URL
ช่อง | |
---|---|
uri |
เอาต์พุตเท่านั้น URL ที่โฮสต์รูปภาพ GIF |
ไฟล์แนบ
ไฟล์แนบใน Google Chat
ช่อง | |
---|---|
name |
ไม่บังคับ ชื่อทรัพยากรของไฟล์แนบในรูปแบบ |
content_ |
เอาต์พุตเท่านั้น ชื่อไฟล์ต้นฉบับของเนื้อหา ไม่ใช่เส้นทางแบบสมบูรณ์ |
content_ |
เอาต์พุตเท่านั้น ประเภทเนื้อหา (ประเภท MIME) ของไฟล์ |
thumbnail_ |
เอาต์พุตเท่านั้น URL ของภาพปกที่ควรใช้แสดงตัวอย่างไฟล์แนบต่อผู้ใช้ แอปรับแชทไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ |
download_ |
เอาต์พุตเท่านั้น URL การดาวน์โหลดที่ควรใช้เพื่อให้ผู้ใช้ดาวน์โหลดไฟล์แนบได้ แอปรับแชทไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ |
source |
เอาต์พุตเท่านั้น แหล่งที่มาของไฟล์แนบ |
ฟิลด์สหภาพ data_ref การอ้างอิงข้อมูลไปยังไฟล์แนบ data_ref ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
attachment_ |
ไม่บังคับ การอ้างอิงข้อมูลไฟล์แนบ ช่องนี้ใช้ในการสร้างหรืออัปเดตข้อความที่มีไฟล์แนบ หรือใช้กับ Media API เพื่อดาวน์โหลดข้อมูลไฟล์แนบ |
drive_ |
เอาต์พุตเท่านั้น การอ้างอิงไฟล์แนบ Google ไดรฟ์ ช่องนี้ใช้กับ Google Drive API |
แหล่งที่มา
แหล่งที่มาของไฟล์แนบ
Enum | |
---|---|
SOURCE_UNSPECIFIED |
สงวนไว้ |
DRIVE_FILE |
ไฟล์เป็นไฟล์ Google ไดรฟ์ |
UPLOADED_CONTENT |
ระบบจะอัปโหลดไฟล์ไปยัง Chat |
AttachmentDataRef
การอ้างอิงข้อมูลไฟล์แนบ
ช่อง | |
---|---|
resource_ |
ไม่บังคับ ชื่อทรัพยากรของข้อมูลไฟล์แนบ ฟิลด์นี้ใช้กับ Media API เพื่อดาวน์โหลดข้อมูลไฟล์แนบ |
attachment_ |
ไม่บังคับ โทเค็นแบบทึบที่มีข้อมูลอ้างอิงถึงไฟล์แนบที่อัปโหลด ลูกค้าจะถือว่าสตริงนี้เป็นสตริงทึบและใช้เพื่อสร้างหรืออัปเดตข้อความใน Chat ที่มีไฟล์แนบ |
CardWithId
การ์ดในข้อความ Google Chat
เฉพาะแอป Chat เท่านั้นที่สร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ ข้อความจะไม่มีการ์ด
ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด
เปิดเครื่องมือสร้างการ์ดช่อง | |
---|---|
card_ |
ต้องระบุหากข้อความมีหลายการ์ด ตัวระบุที่ไม่ซ้ำกันสำหรับการ์ดในข้อความ |
card |
การ์ด ขนาดสูงสุดคือ 32 KB |
ChatSpaceLinkData
ข้อมูลสำหรับลิงก์พื้นที่ใน Chat
ช่อง | |
---|---|
space |
พื้นที่ของทรัพยากรพื้นที่ใน Chat ที่ลิงก์ รูปแบบ: |
thread |
ชุดข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์ รูปแบบ: |
message |
ข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์ รูปแบบ: |
CompleteImportSpaceRequest
ข้อความคำขอสำหรับการนำเข้าพื้นที่ทำงานให้เสร็จสมบูรณ์
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานโหมดการนําเข้า รูปแบบ: |
CompleteImportSpaceResponse
ข้อความตอบกลับสำหรับกระบวนการนำเข้าพื้นที่ทำงานที่เสร็จสมบูรณ์
ช่อง | |
---|---|
space |
พื้นที่ทำงานโหมดการนำเข้า |
ContextualAddOnMarkup
ประเภทนี้ไม่มีช่อง
มาร์กอัปสำหรับนักพัฒนาแอปเพื่อระบุเนื้อหาของส่วนเสริมตามบริบท
การ์ด
การ์ดคือองค์ประกอบ UI ที่อาจมีวิดเจ็ต UI เช่น ข้อความและรูปภาพ
ช่อง | |
---|---|
header |
ส่วนหัวของการ์ด โดยปกติแล้วส่วนหัวจะมีชื่อและรูปภาพ |
sections[] |
ส่วนต่างๆ จะคั่นด้วยเส้นแบ่ง |
card_ |
การดำเนินการของการ์ดนี้ |
name |
ชื่อของการ์ด |
CardAction
การดําเนินการของการ์ดคือการดําเนินการที่เกี่ยวข้องกับการ์ด สําหรับการ์ดใบแจ้งหนี้ การดําเนินการทั่วไป ได้แก่ ลบใบแจ้งหนี้ ส่งใบแจ้งหนี้ทางอีเมล หรือเปิดใบแจ้งหนี้ในเบราว์เซอร์
แอป Google Chat ไม่รองรับ
ช่อง | |
---|---|
action_ |
ป้ายกำกับเคยแสดงในรายการเมนูการทำงาน |
on_ |
การดำเนินการ onclick สำหรับรายการการดำเนินการนี้ |
CardHeader
ช่อง | |
---|---|
title |
ต้องระบุชื่อ ส่วนหัวมีความสูงคงที่: หากระบุทั้งชื่อและคำบรรยาย แต่ละรายการจะใช้พื้นที่ 1 บรรทัด หากระบุเฉพาะชื่อ ชื่อนั้นจะกินพื้นที่ทั้ง 2 บรรทัด |
subtitle |
คำบรรยายของส่วนหัวของการ์ด |
image_ |
ประเภทของรูปภาพ (เช่น เส้นขอบสี่เหลี่ยมจัตุรัสหรือเส้นขอบกลม) |
image_ |
URL ของรูปภาพในส่วนหัวของการ์ด |
ImageStyle
Enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
เส้นขอบสี่เหลี่ยมจัตุรัส |
AVATAR |
เส้นขอบวงกลม |
ส่วน
ส่วนประกอบด้วยคอลเล็กชันวิดเจ็ตที่แสดงผล (แนวตั้ง) ตามลำดับที่ระบุ การ์ดในทุกแพลตฟอร์มมีความกว้างคงที่แคบ จึงไม่จำเป็นต้องใช้พร็อพเพอร์ตี้เลย์เอาต์ (เช่น ลอย) ในตอนนี้
ช่อง | |
---|---|
header |
ส่วนหัวของส่วน รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
widgets[] |
ส่วนต้องมีวิดเจ็ตอย่างน้อย 1 รายการ |
CreateCustomEmojiRequest
คำขอสร้างอีโมจิที่กำหนดเอง
ช่อง | |
---|---|
custom_ |
ต้องระบุ อีโมจิที่กำหนดเองที่จะสร้าง |
CreateMembershipRequest
ข้อความขอสร้างการเป็นสมาชิก
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก รูปแบบ: spaces/{space} |
membership |
ต้องระบุ ความสัมพันธ์ของการเป็นสมาชิกที่จะสร้าง ช่อง เมื่อแอป Chat สร้างความสัมพันธ์การเป็นสมาชิกสำหรับผู้ใช้ที่เป็นบุคคลธรรมดา แอปต้องใช้ขอบเขตการให้สิทธิ์บางอย่างและตั้งค่าที่เฉพาะเจาะจงสำหรับบางช่อง ดังนี้
การเชิญผู้ใช้ภายนอกองค์กร Workspace ที่เป็นเจ้าของพื้นที่ทำงานต้องอาศัยการตรวจสอบสิทธิ์ผู้ใช้ เมื่อแอป Chat สร้างความสัมพันธ์การเป็นสมาชิกของตนเอง แอปต้องตรวจสอบสิทธิ์ในฐานะผู้ใช้ และใช้ขอบเขต |
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ ระบบไม่รองรับการสร้างการเป็นสมาชิกแอปหรือการสร้างการเป็นสมาชิกสำหรับผู้ใช้ภายนอกองค์กร Google Workspace ของผู้ดูแลระบบโดยใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ |
CreateMessageRequest
สร้างข้อความ
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างข้อความ รูปแบบ: |
message |
ต้องระบุ เนื้อหาข้อความ |
thread_key |
ไม่บังคับ เลิกใช้งานแล้ว: ให้ใช้ |
request_ |
ไม่บังคับ รหัสคำขอที่ไม่ซ้ำกันสำหรับข้อความนี้ การระบุรหัสคำขอที่มีอยู่จะแสดงข้อความที่สร้างด้วยรหัสนั้นแทนการสร้างข้อความใหม่ |
message_ |
ไม่บังคับ ระบุว่าข้อความเริ่มชุดข้อความหรือตอบกลับชุดข้อความ รองรับเฉพาะในพื้นที่ทํางานที่มีชื่อเท่านั้น ระบบจะไม่สนใจช่องนี้เมื่อตอบสนองต่อการโต้ตอบของผู้ใช้ สําหรับการโต้ตอบภายในชุดข้อความ ระบบจะสร้างการตอบกลับในชุดข้อความเดียวกัน ไม่เช่นนั้น ระบบจะสร้างการตอบกลับเป็นชุดข้อความใหม่ |
message_ |
ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ ช่วยให้แอป 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_ |
ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับคำขอนี้ ขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอที่มีอยู่จะแสดงพื้นที่ทำงานที่สร้างด้วยรหัสนั้นแทนการสร้างพื้นที่ทำงานใหม่ การระบุรหัสคำขอที่มีอยู่จากแอป Chat เดียวกันที่มีผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์คนละรายจะแสดงข้อผิดพลาด |
CustomEmoji
แสดงอีโมจิที่กำหนดเอง
ช่อง | |
---|---|
name |
ตัวระบุ ชื่อทรัพยากรของอีโมจิที่กำหนดเองซึ่งเซิร์ฟเวอร์กำหนด รูปแบบ: |
uid |
เอาต์พุตเท่านั้น คีย์ที่ไม่ซ้ำกันสำหรับแหล่งข้อมูลอีโมจิที่กำหนดเอง |
emoji_ |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ ชื่อที่ผู้ใช้ระบุสำหรับอีโมจิที่กำหนดเอง ซึ่งต้องไม่ซ้ำกันภายในองค์กร ต้องระบุเมื่อสร้างอีโมจิที่กำหนดเอง ไม่เช่นนั้นให้แสดงผลเท่านั้น ชื่ออีโมจิต้องขึ้นต้นและลงท้ายด้วยโคลอน ต้องเป็นตัวพิมพ์เล็ก และประกอบไปด้วยอักขระที่เป็นตัวอักษรและตัวเลข เครื่องหมายขีดกลาง และเครื่องหมายขีดล่างคละกันเท่านั้น ควรใช้ขีดกลางและขีดล่างเพื่อแยกคำ แต่จะใช้ต่อกันไม่ได้ ตัวอย่าง: |
temporary_ |
เอาต์พุตเท่านั้น URL รูปภาพสำหรับอีโมจิที่กำหนดเอง ซึ่งใช้งานได้อย่างน้อย 10 นาที โปรดทราบว่าระบบจะไม่ป้อนข้อมูลนี้ในการตอบกลับเมื่อสร้างอีโมจิที่กำหนดเอง |
payload |
ไม่บังคับ อินพุตเท่านั้น ข้อมูลเพย์โหลด ต้องระบุเมื่อสร้างอีโมจิที่กำหนดเอง |
CustomEmojiPayload
ข้อมูลเพย์โหลดสำหรับอีโมจิที่กำหนดเอง
ช่อง | |
---|---|
file_ |
ต้องระบุ อินพุตเท่านั้น รูปภาพที่ใช้สําหรับอีโมจิที่กําหนดเอง เพย์โหลดต้องไม่เกิน 256 KB และขนาดของรูปภาพต้องอยู่ระหว่าง 64 ถึง 500 พิกเซล ข้อจำกัดเหล่านี้อาจมีการเปลี่ยนแปลง |
filename |
ต้องระบุ อินพุตเท่านั้น ชื่อไฟล์ภาพ นามสกุลไฟล์ที่รองรับ ได้แก่ |
DeleteCustomEmojiRequest
คำขอลบอีโมจิที่กำหนดเอง
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อแหล่งข้อมูลของอีโมจิที่กำหนดเองที่จะลบ รูปแบบ: คุณสามารถใช้ชื่ออีโมจิเป็นชื่อแทนสำหรับ |
DeleteMembershipRequest
คำขอให้ลบการเป็นสมาชิกในพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อแหล่งข้อมูลของการเป็นสมาชิกที่จะลบ แอปแชทสามารถลบการเป็นสมาชิกของผู้ใช้หรือของตนเองได้ แอป Chat จะลบการเป็นสมาชิกของแอปอื่นๆ ไม่ได้ เมื่อลบการเป็นสมาชิกของบุคคลธรรมดา ต้องใช้รูปแบบ เมื่อลบการเป็นสมาชิกแอป ต้องใช้ขอบเขต รูปแบบ: |
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ การลบการเป็นสมาชิกแอปในพื้นที่ทำงานไม่รองรับการใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ |
DeleteMessageRequest
คำขอให้ลบข้อความ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของข้อความ รูปแบบ: หากตั้งค่ารหัสที่กำหนดเองสำหรับข้อความไว้ คุณจะใช้ค่าจากฟิลด์ |
force |
ไม่บังคับ เมื่อ ใช้ได้เมื่อตรวจสอบสิทธิ์ในฐานะผู้ใช้เท่านั้น ไม่มีผลเมื่อตรวจสอบสิทธิ์เป็นแอป Chat |
DeleteReactionRequest
ลบความรู้สึกที่มีต่อข้อความ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของรีแอ็กชันที่จะลบ รูปแบบ: |
DeleteSpaceRequest
คำขอลบพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะลบ รูปแบบ: |
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ |
DeletionMetadata
ข้อมูลเกี่ยวกับข้อความที่ลบ ระบบจะลบข้อความเมื่อตั้งค่าเป็น delete_time
ช่อง | |
---|---|
deletion_ |
บ่งบอกว่าใครลบข้อความ |
DeletionType
ผู้ที่ลบข้อความและวิธีลบ ในอนาคตอาจมีการเพิ่มค่าอื่นๆ เข้ามา
Enum | |
---|---|
DELETION_TYPE_UNSPECIFIED |
ค่านี้ไม่ได้ใช้งาน |
CREATOR |
ผู้ใช้ลบข้อความของตนเอง |
SPACE_OWNER |
เจ้าของพื้นที่ทำงานลบข้อความแล้ว |
ADMIN |
ผู้ดูแลระบบ Google Workspace ลบข้อความแล้ว |
APP_MESSAGE_EXPIRY |
แอป Chat ลบข้อความของตัวเองเมื่อข้อความหมดอายุ |
CREATOR_VIA_APP |
แอป Chat ลบข้อความในนามของผู้ใช้ |
SPACE_OWNER_VIA_APP |
แอป Chat ลบข้อความในนามของเจ้าของพื้นที่ทำงาน |
Dialog
Wrapper ของเนื้อหาการ์ดของกล่องโต้ตอบ
ช่อง | |
---|---|
body |
อินพุตเท่านั้น เนื้อความของกล่องโต้ตอบซึ่งแสดงผลในโมดอล แอป Google Chat ไม่รองรับเอนทิตีการ์ด |
DialogAction
มีกล่องโต้ตอบและรหัสสถานะคำขอ
ช่อง | |
---|---|
action_ |
อินพุตเท่านั้น สถานะคําขอเรียกใช้หรือส่งกล่องโต้ตอบ แสดงสถานะและข้อความต่อผู้ใช้ หากจําเป็น เช่น ในกรณีที่เกิดข้อผิดพลาดหรือดำเนินการสำเร็จ |
ฟิลด์สหภาพ action การดำเนินการที่จะทำ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
dialog |
อินพุตเท่านั้น กล่องโต้ตอบสําหรับคําขอ |
DriveDataRef
การอ้างอิงข้อมูลของไฟล์แนบในไดรฟ์
ช่อง | |
---|---|
drive_ |
รหัสของไฟล์ในไดรฟ์ ใช้กับ Drive API |
DriveLinkData
ข้อมูลสำหรับลิงก์ Google ไดรฟ์
ช่อง | |
---|---|
drive_ |
DriveDataRef ที่อ้างอิงไฟล์ Google ไดรฟ์ |
mime_ |
ประเภท MIME ของทรัพยากร Google ไดรฟ์ที่ลิงก์ |
อีโมจิ
อีโมจิที่ใช้แสดงความรู้สึกต่อข้อความ
ช่อง | |
---|---|
ฟิลด์สหภาพ content ต้องระบุ เนื้อหาของอีโมจิ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
unicode |
ไม่บังคับ อีโมจิพื้นฐานที่แสดงด้วยสตริง Unicode |
custom_ |
เอาต์พุตเท่านั้น อีโมจิที่กำหนดเอง |
EmojiReactionSummary
จำนวนคนที่รีแอ็กต่อข้อความด้วยอีโมจิที่เฉพาะเจาะจง
ช่อง | |
---|---|
emoji |
เอาต์พุตเท่านั้น อีโมจิที่เชื่อมโยงกับรีแอ็กชัน |
reaction_ |
เอาต์พุตเท่านั้น จำนวนรีแอ็กชันทั้งหมดที่ใช้อีโมจิที่เกี่ยวข้อง |
FindDirectMessageRequest
คำขอรับพื้นที่ทำงานของข้อความส่วนตัวตามทรัพยากรของผู้ใช้
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของผู้ใช้ที่จะค้นหาข้อความส่วนตัวด้วย รูปแบบ: |
GetAttachmentRequest
ขอรับไฟล์แนบ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของไฟล์แนบในรูปแบบ |
GetCustomEmojiRequest
คำขอแสดงอีโมจิที่กำหนดเองรายการเดียว
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของอีโมจิที่กำหนดเอง รูปแบบ: คุณสามารถใช้ชื่ออีโมจิเป็นชื่อแทนสำหรับ |
GetMembershipRequest
ขอเป็นสมาชิกของพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อแหล่งข้อมูลของการเป็นสมาชิกที่จะดึงข้อมูล หากต้องการเป็นสมาชิกของแอปเองโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณสามารถใช้ รูปแบบ: คุณสามารถใช้อีเมลของผู้ใช้เป็นอีเมลแทนสำหรับ |
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ระบบไม่รองรับการสมัครเป็นสมาชิกแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ |
GetMessageRequest
ขอรับข้อความ
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของข้อความ รูปแบบ: หากตั้งรหัสที่กำหนดเองสำหรับข้อความไว้ คุณจะใช้ค่าจากฟิลด์ |
GetSpaceEventRequest
ข้อความขอรับกิจกรรมในพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของเหตุการณ์ในช่อง รูปแบบ: |
GetSpaceNotificationSettingRequest
ส่งคำขอข้อความเพื่อรับการตั้งค่าการแจ้งเตือนในพื้นที่ทำงาน รองรับเฉพาะการรับการตั้งค่าการแจ้งเตือนสําหรับผู้ใช้ที่โทรเท่านั้น
ช่อง | |
---|---|
name |
ต้องระบุ รูปแบบ: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
ข้อความคําขอสําหรับ GetSpaceReadState API
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านพื้นที่ทำงานที่จะดึงข้อมูล รองรับเฉพาะการดูสถานะการอ่านสำหรับผู้ใช้ที่โทรเท่านั้น หากต้องการอ้างอิงถึงผู้ใช้ที่โทรเข้ามา ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้
รูปแบบ: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
คำขอแสดงผลพื้นที่ทำงานเดียว
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานในรูปแบบ รูปแบบ: |
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 |
GetThreadReadStateRequest
ข้อความคําขอสําหรับ GetThreadReadStateRequest API
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านชุดข้อความที่จะดึงข้อมูล รองรับเฉพาะการดูสถานะการอ่านสำหรับผู้ใช้ที่โทรเท่านั้น หากต้องการอ้างอิงถึงผู้ใช้ที่โทรเข้ามา ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้
รูปแบบ: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
กลุ่ม
Google Group ใน Google Chat
ช่อง | |
---|---|
name |
ชื่อทรัพยากรสําหรับ Google Group แสดงถึงกลุ่มใน Cloud Identity Groups API รูปแบบ: groups/{group} |
HistoryState
สถานะประวัติสำหรับข้อความและพื้นที่ทำงาน ระบุระยะเวลาเก็บข้อความและชุดข้อความการสนทนาหลังจากสร้าง
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
ค่าเริ่มต้น โปรดอย่าใช้ |
HISTORY_OFF |
ประวัติปิดอยู่ ข้อความและชุดข้อความจะเก็บไว้ 24 ชั่วโมง |
HISTORY_ON |
ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาที่จะเก็บรักษาข้อความและชุดข้อความ |
ListCustomEmojisRequest
คำขอแสดงรายการอีโมจิที่กำหนดเอง
ช่อง | |
---|---|
page_ |
ไม่บังคับ จำนวนสูงสุดของอีโมจิที่กำหนดเองที่แสดง บริการจะแสดงอีโมจิที่กำหนดเองได้น้อยกว่าค่านี้ หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น 25 ค่าสูงสุดคือ 200 ระบบจะเปลี่ยนค่าที่มากกว่า 200 เป็น 200 |
page_ |
ไม่บังคับ (หากกลับมาดำเนินการต่อจากการค้นหาก่อนหน้า) โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้อีโมจิที่กำหนดเองของรายการก่อนหน้านี้ ระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับคอลที่ระบุโทเค็นหน้า การส่งค่าอื่นอาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองข้อความค้นหา รองรับการกรองตามครีเอเตอร์ หากต้องการกรองตามครีเอเตอร์ คุณต้องระบุค่าที่ถูกต้อง ปัจจุบันระบบยอมรับเฉพาะ ตัวอย่างเช่น การค้นหาต่อไปนี้จะแสดงอีโมจิที่กำหนดเองซึ่งผู้เรียกใช้สร้างขึ้น
เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด |
ListCustomEmojisResponse
การตอบสนองต่อรายการอีโมจิที่กำหนดเอง
ช่อง | |
---|---|
custom_ |
รายการที่ไม่เรียงลําดับ รายการอีโมจิที่กำหนดเองในหน้าที่ขอ (หรือหน้าแรก) |
next_ |
โทเค็นที่คุณส่งเป็น |
ListMembershipsRequest
ข้อความขอแสดงข้อมูลการเป็นสมาชิก
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะดึงข้อมูลรายชื่อสมาชิก รูปแบบ: spaces/{space} |
page_ |
ไม่บังคับ จำนวนการเป็นสมาชิกสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงข้อมูลการเป็นสมาชิกไม่เกิน 100 รายการ ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ ค่าลบจะแสดงผลข้อผิดพลาด |
page_ |
ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ก่อนหน้านี้เพื่อแสดงรายการการเป็นสมาชิก ระบุพารามิเตอร์นี้เพื่อดึงข้อมูลหน้าถัดไป เมื่อแบ่งหน้าเว็บ พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองข้อความค้นหา คุณสามารถกรองการเป็นสมาชิกตามบทบาท ( หากต้องการกรองตามบทบาท ให้ตั้งค่า หากต้องการกรองตามประเภท ให้ตั้งค่า หากต้องการกรองตามทั้งบทบาทและประเภท ให้ใช้โอเปอเรเตอร์ ต้องระบุ ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง
การค้นหาต่อไปนี้ไม่ถูกต้อง
เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด |
show_ |
ไม่บังคับ เมื่อ |
show_ |
ไม่บังคับ เมื่อเป็น ปัจจุบันต้องมีการตรวจสอบสิทธิ์ผู้ใช้ |
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ระบบไม่รองรับการแสดงข้อมูลการเป็นสมาชิกแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ |
ListMembershipsResponse
การตอบสนองต่อรายการการเป็นสมาชิกของพื้นที่ทำงาน
ช่อง | |
---|---|
memberships[] |
รายการที่ไม่เรียงลําดับ รายการการเป็นสมาชิกในหน้าที่ขอ (หรือหน้าแรก) |
next_ |
โทเค็นที่คุณส่งเป็น |
ListMessagesRequest
แสดงรายการข้อความในพื้นที่ทำงานที่ระบุซึ่งผู้ใช้เป็นสมาชิก
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะแสดงรายการข้อความ รูปแบบ: |
page_ |
ไม่บังคับ จำนวนข้อความสูงสุดที่แสดง บริการอาจแสดงผลข้อความน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 25 รายการ ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ ค่าลบจะแสดงผลข้อผิดพลาด |
page_ |
ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้รายการข้อความก่อนหน้านี้ ระบุพารามิเตอร์นี้เพื่อดึงข้อมูลหน้าถัดไป เมื่อแบ่งหน้าเว็บ พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองข้อความค้นหา คุณสามารถกรองข้อความตามวันที่ ( หากต้องการกรองข้อความตามวันที่สร้าง ให้ระบุ หากต้องการกรองตามชุดข้อความ ให้ระบุ หากต้องการกรองตามทั้งชุดข้อความและวันที่ ให้ใช้โอเปอเรเตอร์ ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง
เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด |
order_ |
ไม่บังคับ ลำดับรายการข้อความ ระบุค่าที่จะจัดเรียงตามการดำเนินการจัดเรียง ค่าการดำเนินการจัดเรียงที่ใช้ได้มีดังนี้
การจัดเรียงเริ่มต้นคือ |
show_ |
ไม่บังคับ เลือกว่าจะรวมข้อความที่ลบไปแล้วหรือไม่ ข้อความที่ถูกลบจะมีเวลาที่ถูกลบและข้อมูลเมตาเกี่ยวกับการลบ แต่เนื้อหาข้อความจะใช้งานไม่ได้ |
ListMessagesResponse
ข้อความตอบกลับสำหรับข้อความข้อมูล
ช่อง | |
---|---|
messages[] |
รายการข้อความ |
next_ |
คุณส่งโทเค็นเป็น |
ListReactionsRequest
แสดงรายการความรู้สึกที่มีต่อข้อความ
ช่อง | |
---|---|
parent |
ต้องระบุ ข้อความที่ผู้ใช้แสดงความรู้สึก รูปแบบ: |
page_ |
ไม่บังคับ จำนวนรีแอ็กชันสูงสุดที่แสดง บริการจะแสดงความรู้สึกได้น้อยกว่าค่านี้ หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น 25 ค่าสูงสุดคือ 200 ระบบจะเปลี่ยนค่าที่มากกว่า 200 เป็น 200 |
page_ |
ไม่บังคับ (หากกลับมาดำเนินการต่อจากการค้นหาก่อนหน้า) โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้การโต้ตอบรายการก่อนหน้านี้ ระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับคอลที่ระบุโทเค็นหน้า การส่งค่าอื่นอาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองข้อความค้นหา คุณสามารถกรองรีแอ็กชันตามอีโมจิ ( หากต้องการกรองรีแอ็กชันสำหรับอีโมจิหรือผู้ใช้หลายรายการ ให้รวมช่องที่คล้ายกันด้วยโอเปอเรเตอร์ หากต้องการกรองรีแอ็กชันตามอีโมจิและผู้ใช้ ให้ใช้โอเปอเรเตอร์ หากคําค้นหาใช้ทั้ง ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง
การค้นหาต่อไปนี้ไม่ถูกต้อง
เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด |
ListReactionsResponse
การตอบกลับคำขอรีแอ็กชันรายการ
ช่อง | |
---|---|
reactions[] |
รายการความรู้สึกในหน้าที่ขอ (หรือหน้าแรก) |
next_ |
โทเค็นการดําเนินการต่อเพื่อดึงข้อมูลหน้าถัดไปของผลการค้นหา หน้าสุดท้ายของผลการค้นหาจะว่างเปล่า |
ListSpaceEventsRequest
ข้อความขอแสดงกิจกรรมในพื้นที่ทำงาน
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรของพื้นที่ใน Google Chat ที่เหตุการณ์เกิดขึ้น รูปแบบ: |
page_ |
ไม่บังคับ จํานวนเหตุการณ์ในพื้นที่สูงสุดที่แสดง บริการอาจแสดงผลน้อยกว่าค่านี้ ค่าลบจะแสดงผลข้อผิดพลาด |
page_ |
ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้เหตุการณ์พื้นที่รายการก่อนหน้านี้ ระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุเพื่อแสดงเหตุการณ์ของพื้นที่ทำงานต้องตรงกับการเรียกที่ให้โทเค็นหน้า การส่งค่าอื่นไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด |
filter |
ต้องระบุ ตัวกรองข้อความค้นหา คุณต้องระบุประเภทเหตุการณ์ ( คุณยังกรองตามเวลาเริ่มต้น (
หากต้องการระบุเวลาเริ่มต้นหรือเวลาสิ้นสุด ให้ใช้โอเปอเรเตอร์เท่ากับ ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง
การค้นหาต่อไปนี้ไม่ถูกต้อง
เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด |
ListSpaceEventsResponse
ข้อความตอบกลับสำหรับการแสดงกิจกรรมในพื้นที่ทำงาน
ช่อง | |
---|---|
space_ |
ระบบจะแสดงผลลัพธ์ตามลําดับเวลา (เหตุการณ์เก่าสุดก่อน) หมายเหตุ: ระบบจะไม่แสดงฟิลด์ |
next_ |
โทเค็นการดําเนินการต่อที่ใช้ดึงข้อมูลเหตุการณ์เพิ่มเติม หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป |
ListSpacesRequest
คำขอแสดงรายการพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก
ช่อง | |
---|---|
page_ |
ไม่บังคับ จำนวนพื้นที่ทำงานสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 100 ช่องว่าง ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ ค่าลบจะแสดงผลข้อผิดพลาด |
page_ |
ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้รายการพื้นที่ทำงานก่อนหน้านี้ ระบุพารามิเตอร์นี้เพื่อดึงข้อมูลหน้าถัดไป เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับคอลที่ระบุโทเค็นหน้า การส่งค่าอื่นอาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด |
filter |
ไม่บังคับ ตัวกรองข้อความค้นหา คุณสามารถกรองพื้นที่ทำงานตามประเภทพื้นที่ทำงาน ( หากต้องการกรองตามประเภทพื้นที่ทำงาน คุณต้องระบุค่า Enum ที่ถูกต้อง เช่น ตัวอย่างเช่น คําค้นหาต่อไปนี้ถูกต้อง
เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด |
ListSpacesResponse
การตอบกลับคําขอแสดงรายการพื้นที่ทํางาน
ช่อง | |
---|---|
spaces[] |
รายการพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก) หมายเหตุ: ระบบจะไม่แสดงฟิลด์ |
next_ |
คุณส่งโทเค็นเป็น |
MatchedUrl
URL ที่ตรงกันในข้อความ Chat แอปแชทจะดูตัวอย่าง URL ที่ตรงกันได้ ดูข้อมูลเพิ่มเติมได้ที่ดูตัวอย่างลิงก์
ช่อง | |
---|---|
url |
เอาต์พุตเท่านั้น URL ที่ตรงกัน |
การเป็นสมาชิก
แสดงความสัมพันธ์การเป็นสมาชิกใน Google Chat เช่น ผู้ใช้หรือแอป Chat ได้รับเชิญให้เข้าร่วม เป็นส่วนหนึ่งของ หรือไม่ได้อยู่ในพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ตัวระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่เซิร์ฟเวอร์กำหนด รูปแบบ: |
state |
เอาต์พุตเท่านั้น สถานะการเป็นสมาชิก |
role |
ไม่บังคับ บทบาทของผู้ใช้ในพื้นที่ใน Chat ซึ่งกำหนดการดำเนินการที่ผู้ใช้ได้รับอนุญาตในพื้นที่ ช่องนี้ใช้ได้เฉพาะเป็นอินพุตใน |
create_ |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ เวลาสร้างการเป็นสมาชิก เช่น เมื่อสมาชิกเข้าร่วมหรือได้รับเชิญให้เข้าร่วมพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นในกรณีที่ใช้เพื่อนำเข้าการเป็นสมาชิกที่ผ่านมาในพื้นที่ทำงานโหมดการนําเข้า |
delete_ |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ เวลาลบการเป็นสมาชิก เช่น เมื่อสมาชิกออกจากหรือถูกนำออกจากพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นในกรณีที่ใช้เพื่อนำเข้าการเป็นสมาชิกที่ผ่านมาในพื้นที่ทำงานโหมดการนําเข้า |
ฟิลด์สหภาพ memberType สมาชิกที่เชื่อมโยงกับการเป็นสมาชิกนี้ ทั้งนี้ เราอาจรองรับสมาชิกประเภทอื่นๆ ในอนาคต memberType ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
member |
ไม่บังคับ ผู้ใช้หรือแอป Google Chat ที่เชื่อมโยงกับการเป็นสมาชิก หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะสร้างผู้ใช้ |
group_ |
ไม่บังคับ Google Group ที่เป็นสมาชิก การอ่านหรือแก้ไขการเป็นสมาชิกของ Google Groups ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ |
MembershipRole
แสดงการดำเนินการที่ผู้ใช้ได้รับอนุญาตในพื้นที่ใน Chat อาจมีการเพิ่มค่า Enum อื่นๆ ในอนาคต
Enum | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
ค่าเริ่มต้น สำหรับ users : ผู้ใช้ดังกล่าวไม่ใช่สมาชิกของพื้นที่ทำงาน แต่สามารถเชิญได้ สำหรับ Google Groups : ระบบจะกำหนดบทบาทนี้ให้เสมอ (อาจใช้ค่าอื่นๆ ของ Enum ในอนาคต) |
ROLE_MEMBER |
สมาชิกของพื้นที่ทำงาน ผู้ใช้มีสิทธิ์พื้นฐาน เช่น ส่งข้อความไปยังพื้นที่ทำงาน ทุกคนมีบทบาทนี้ในการสนทนาแบบ 1:1 และแบบกลุ่มที่ไม่มีชื่อ |
ROLE_MANAGER |
ผู้จัดการพื้นที่ทำงาน ผู้ใช้จะมีสิทธิ์พื้นฐานทั้งหมดรวมถึงสิทธิ์ระดับผู้ดูแลระบบที่อนุญาตให้จัดการพื้นที่ทำงานได้ เช่น การเพิ่มหรือนำสมาชิกออก ใช้ได้ใน SpaceType.SPACE เท่านั้น |
MembershipState
ระบุความสัมพันธ์ของสมาชิกกับพื้นที่ทำงาน ในอนาคตเราอาจรองรับรัฐอื่นๆ ที่เป็นสมาชิกด้วย
Enum | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
ค่าเริ่มต้น อย่าใช้ |
JOINED |
ระบบจะเพิ่มผู้ใช้ไปยังพื้นที่ทำงานและผู้ใช้จะเข้าร่วมพื้นที่ทำงานได้ |
INVITED |
ผู้ใช้ได้รับเชิญให้เข้าร่วมพื้นที่ทำงาน แต่ยังไม่ได้เข้าร่วม |
NOT_A_MEMBER |
ผู้ใช้ไม่ได้อยู่ในพื้นที่ทำงานและไม่มีคำเชิญที่รอดำเนินการให้เข้าร่วมพื้นที่ทำงาน |
MembershipBatchCreatedEventData
เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกใหม่หลายรายการ
ประเภทกิจกรรม: google.workspace.chat.membership.v1.batchCreated
ช่อง | |
---|---|
memberships[] |
รายการการเป็นสมาชิกใหม่ |
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_ |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ สำหรับพื้นที่ทำงานที่สร้างใน Chat จะเป็นเวลาที่สร้างข้อความ ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ทำงานโหมดการนําเข้า สำหรับพื้นที่ทำงานโหมดการนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาย้อนหลังเมื่อสร้างข้อความในแหล่งที่มาเพื่อเก็บรักษาเวลาสร้างเดิม |
last_ |
เอาต์พุตเท่านั้น เวลาล่าสุดที่ผู้ใช้แก้ไขข้อความ หากไม่เคยมีการแก้ไขข้อความ ช่องนี้จะว่างเปล่า |
delete_ |
เอาต์พุตเท่านั้น เวลาที่มีการลบข้อความใน Google Chat หากไม่เคยลบข้อความ ช่องนี้จะว่างเปล่า |
text |
ไม่บังคับ เนื้อความข้อความที่เป็นข้อความธรรมดา ลิงก์แรกไปยังรูปภาพ วิดีโอ หรือหน้าเว็บจะสร้างชิปตัวอย่าง นอกจากนี้ คุณยัง@พูดถึงผู้ใช้ Google Chat หรือทุกคนในพื้นที่ทำงานได้ด้วย ดูข้อมูลเกี่ยวกับการสร้าง SMS ได้ที่ส่งข้อความ |
formatted_ |
เอาต์พุตเท่านั้น มีข้อความ
ดูข้อมูลเพิ่มเติมได้ที่ดูการจัดรูปแบบข้อความที่ส่งในข้อความ |
cards[] |
เลิกใช้งานแล้ว: ให้ใช้ การ์ดแบบริชมีเดียที่จัดรูปแบบและเป็นแบบอินเทอร์แอกทีฟ ซึ่งคุณใช้แสดงองค์ประกอบ UI ได้ เช่น ข้อความที่จัดรูปแบบ ปุ่ม และรูปภาพที่คลิกได้ โดยปกติแล้วการ์ดจะแสดงใต้เนื้อหาข้อความธรรมดา |
cards_ |
ไม่บังคับ อาร์เรย์ของ cards เฉพาะแอป Chat เท่านั้นที่สร้างการ์ดได้ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ ข้อความจะไม่มีการ์ด ดูวิธีสร้างข้อความที่มีการ์ดได้ที่ส่งข้อความ ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด เปิดเครื่องมือสร้างการ์ด |
annotations[] |
เอาต์พุตเท่านั้น คําอธิบายประกอบที่เชื่อมโยงกับ |
thread |
ชุดข้อความที่ข้อความเป็นสมาชิก ดูตัวอย่างการใช้งานได้ที่เริ่มหรือตอบกลับชุดข้อความ |
space |
เอาต์พุตเท่านั้น หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะแสดงเฉพาะในพื้นที่ทำงาน |
fallback_ |
ไม่บังคับ คำอธิบายแบบข้อความธรรมดาของการ์ดข้อความ ซึ่งจะใช้เมื่อการ์ดจริงแสดงไม่ได้ เช่น การแจ้งเตือนบนอุปกรณ์เคลื่อนที่ |
action_ |
อินพุตเท่านั้น พารามิเตอร์ที่แอป Chat สามารถใช้เพื่อกำหนดค่าวิธีโพสต์คำตอบ |
argument_ |
เอาต์พุตเท่านั้น เนื้อหาข้อความที่เป็นข้อความธรรมดาซึ่งนำการพูดถึงแอป Chat ทั้งหมดออกแล้ว |
slash_ |
เอาต์พุตเท่านั้น ข้อมูลคำสั่งเครื่องหมายทับ (หากมี) |
attachment[] |
ไม่บังคับ ไฟล์แนบที่ผู้ใช้อัปโหลด |
matched_ |
เอาต์พุตเท่านั้น URL ใน |
thread_ |
เอาต์พุตเท่านั้น เมื่อเป็น หากพื้นที่ทำงานไม่รองรับการตอบกลับในชุดข้อความ ช่องนี้จะแสดงเป็น |
client_ |
ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ คุณสามารถใช้ฟิลด์เพื่อระบุข้อความ หรือเพื่อรับ ลบ หรืออัปเดตข้อความ หากต้องการตั้งค่ารหัสที่กำหนดเอง ให้ระบุช่อง |
emoji_ |
เอาต์พุตเท่านั้น รายการสรุปรีแอ็กชันด้วยอีโมจิในข้อความ |
private_ |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ อินพุตสำหรับการสร้างข้อความ ไม่เช่นนั้นจะเป็นเอาต์พุตเท่านั้น ผู้ใช้ที่ดูข้อความได้ เมื่อตั้งค่าแล้ว ข้อความจะเป็นแบบส่วนตัวและผู้ใช้ที่ระบุและแอป Chat เท่านั้นที่จะเห็นข้อความดังกล่าว หากต้องการรวมช่องนี้ในคำขอ คุณต้องเรียกใช้ Chat API โดยใช้การตรวจสอบสิทธิ์ของแอปและละเว้นรายการต่อไปนี้ โปรดดูรายละเอียดที่หัวข้อส่งข้อความเป็นการส่วนตัว |
deletion_ |
เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ลบ ระบบจะลบข้อความเมื่อตั้งค่าเป็น |
quoted_ |
เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ผู้ใช้ Google Chat ยกมาในพื้นที่ทำงาน ผู้ใช้ Google Chat สามารถยกข้อความมาเพื่อตอบได้ |
attached_ |
เอาต์พุตเท่านั้น รูปภาพ GIF ที่แนบมากับข้อความ |
accessory_ |
ไม่บังคับ วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 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_ |
เอาต์พุตเท่านั้น การประทับเวลาที่สร้างข้อความที่ยกมาหรือเวลาที่อัปเดตข้อความที่ยกมาครั้งล่าสุด |
รีแอ็กชัน
รีแอ็กชันต่อข้อความ
ช่อง | |
---|---|
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_ |
ประเภทของลิงก์ริชมีเดีย |
ฟิลด์สหภาพ data ข้อมูลสําหรับทรัพยากรที่ลิงก์ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
drive_ |
ข้อมูลสำหรับลิงก์ไดรฟ์ |
chat_ |
ข้อมูลสำหรับลิงก์พื้นที่ใน Chat |
RichLinkType
ประเภทของริชมีเดีย ในอนาคตอาจมีการเพิ่มประเภทอื่นๆ เข้ามา
Enum | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum อย่าใช้ |
DRIVE_FILE |
ประเภทลิงก์ริชมีเดียของ Google ไดรฟ์ |
CHAT_SPACE |
ประเภทลิงก์ริชมีเดียของพื้นที่ใน Chat เช่น ชิปอัจฉริยะของพื้นที่ทำงาน |
SearchSpacesRequest
คำขอค้นหารายการพื้นที่ทำงานตามคำค้นหา
ช่อง | |
---|---|
use_ |
เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ขอบเขต OAuth 2.0 ปัจจุบันวิธีการนี้รองรับเฉพาะสิทธิ์เข้าถึงระดับผู้ดูแลระบบ จึงยอมรับเฉพาะ |
page_ |
จำนวนพื้นที่ทำงานสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 100 ช่องว่าง ค่าสูงสุดคือ 1,000 หากคุณใช้ค่ามากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ |
page_ |
โทเค็นที่ได้รับจากการเรียกใช้พื้นที่การค้นหาก่อนหน้า ระบุพารามิเตอร์นี้เพื่อดึงข้อมูลหน้าถัดไป เมื่อแบ่งหน้าเว็บ พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นไปยังพารามิเตอร์อื่นๆ อาจทําให้ได้ผลลัพธ์ที่ไม่คาดคิด |
query |
ต้องระบุ คำค้นหา คุณค้นหาได้โดยใช้พารามิเตอร์ต่อไปนี้
ต้องระบุ ช่องต่างๆ รองรับเฉพาะโอเปอเรเตอร์ ในช่องเดียวกัน ตัวอย่างคำค้นหาที่ถูกต้องมีดังนี้
|
order_ |
ไม่บังคับ ลำดับการจัดเรียงรายการพื้นที่ทำงาน แอตทริบิวต์ที่รองรับสำหรับการจัดเรียงมีดังนี้
ค่าการดำเนินการจัดเรียงที่ใช้ได้มีดังนี้
ไวยากรณ์ที่รองรับมีดังนี้
|
SearchSpacesResponse
การตอบกลับพร้อมรายการพื้นที่ทำงานที่สอดคล้องกับคำขอพื้นที่ทำงานการค้นหา
ช่อง | |
---|---|
spaces[] |
หน้าของพื้นที่ทำงานที่ขอ |
next_ |
โทเค็นที่ใช้ดึงข้อมูลหน้าถัดไปได้ หากช่องนี้ว่างเปล่า จะไม่มีหน้าถัดไป |
total_ |
จํานวนพื้นที่โฆษณาทั้งหมดที่ตรงกับคําค้นหาในทุกหน้า หากผลลัพธ์มีจำนวนมากกว่า 10,000 ช่อง ค่านี้จะเป็นค่าโดยประมาณ |
SetUpSpaceRequest
คำขอสร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุ
ช่อง | |
---|---|
space |
ต้องระบุ ต้องกรอกข้อมูลในช่อง หากต้องการสร้างพื้นที่ทำงาน ให้ตั้งค่า หากต้องการสร้างแชทเป็นกลุ่ม ให้ตั้งค่า หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างผู้ใช้ ให้ตั้งค่า หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างบุคคลกับแอป Chat ที่ใช้โทร ให้ตั้งค่า หากมี |
request_ |
ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับคำขอนี้ ขอแนะนำให้ใช้ UUID แบบสุ่ม การระบุรหัสคำขอที่มีอยู่จะแสดงพื้นที่ทำงานที่สร้างด้วยรหัสนั้นแทนการสร้างพื้นที่ทำงานใหม่ การระบุรหัสคำขอที่มีอยู่จากแอป Chat เดียวกันที่มีผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์คนละรายจะแสดงข้อผิดพลาด |
memberships[] |
ไม่บังคับ ผู้ใช้หรือกลุ่ม Google Chat ที่จะเชิญให้เข้าร่วมพื้นที่ทำงาน ละเว้นผู้ใช้ที่โทร เนื่องจากระบบจะเพิ่มผู้ใช้ดังกล่าวโดยอัตโนมัติ ปัจจุบันชุดนี้อนุญาตให้มีสมาชิกได้สูงสุด 20 คน (นอกเหนือจากผู้โทร) สำหรับการเป็นสมาชิกของบุคคลธรรมดา ช่อง สําหรับการเป็นสมาชิกกลุ่ม Google ฟิลด์ ไม่บังคับเมื่อตั้งค่า ต้องระบุเมื่อตั้งค่า ต้องระบุเมื่อตั้งค่า ต้องว่างเปล่าเมื่อสร้างการสนทนาแบบ 1:1 ระหว่างบุคคลกับแอป Chat ที่โทร (เมื่อตั้งค่า |
SlashCommand
คำสั่งเครื่องหมายทับใน Google Chat
ช่อง | |
---|---|
command_ |
รหัสของคำสั่ง Slash ที่เรียกใช้ |
SlashCommandMetadata
ข้อมูลเมตาคำอธิบายประกอบสำหรับคำสั่งเครื่องหมายทับ (/)
ช่อง | |
---|---|
bot |
แอป Chat ที่เรียกใช้คําสั่ง |
type |
ประเภทของคำสั่งเครื่องหมายทับ |
command_ |
ชื่อของคำสั่งขีดกลางที่เรียกใช้ |
command_ |
รหัสคําสั่งของคําสั่งขีดกลางที่เรียกใช้ |
triggers_ |
ระบุว่าคำสั่งเครื่องหมายทับมีไว้สำหรับกล่องโต้ตอบหรือไม่ |
ประเภท
Enum | |
---|---|
TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum อย่าใช้ |
ADD |
เพิ่มแอป Chat ไปยังพื้นที่ทำงาน |
INVOKE |
เรียกใช้คำสั่งเครื่องหมายทับในพื้นที่ทำงาน |
Space
พื้นที่ทำงานใน Google Chat พื้นที่ทำงานคือการสนทนาระหว่างผู้ใช้ตั้งแต่ 2 คนขึ้นไป หรือข้อความแบบ 1:1 ระหว่างผู้ใช้กับแอป Chat
ช่อง | |
---|---|
name |
ตัวระบุ ชื่อทรัพยากรของพื้นที่ทำงาน รูปแบบ: โดยที่ |
type |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ให้ใช้ |
space_ |
ไม่บังคับ ประเภทพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานหรืออัปเดตประเภทพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นๆ เท่านั้น |
single_ |
ไม่บังคับ พื้นที่ทำงานเป็น DM ระหว่างแอป Chat กับบุคคลธรรมดาหรือไม่ |
threaded |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ให้ใช้ |
display_ |
ไม่บังคับ ชื่อที่แสดงของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานที่มี สำหรับข้อความส่วนตัว ช่องนี้อาจว่างเปล่า รองรับอักขระได้สูงสุด 128 ตัว |
external_ |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ พื้นที่ทำงานนี้อนุญาตให้ผู้ใช้ Google Chat เป็นสมาชิกหรือไม่ ข้อมูลที่จะป้อนเมื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace ละเว้นช่องนี้เมื่อสร้างพื้นที่ทำงานในเงื่อนไขต่อไปนี้
สำหรับพื้นที่ทำงานที่มีอยู่ ช่องนี้จะแสดงผลเท่านั้น |
space_ |
เอาต์พุตเท่านั้น สถานะการแยกชุดข้อความในพื้นที่ใน Chat |
space_ |
ไม่บังคับ รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ |
space_ |
ไม่บังคับ สถานะประวัติข้อความสำหรับข้อความและชุดข้อความในพื้นที่ทำงานนี้ |
import_ |
ไม่บังคับ พื้นที่ทำงานนี้สร้างขึ้นใน การสร้างพื้นที่ทำงานใน |
create_ |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ สำหรับพื้นที่ทำงานที่สร้างใน Chat จะเป็นเวลาที่สร้างพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้ในพื้นที่ทำงานโหมดการนําเข้า สำหรับพื้นที่ทำงานในโหมดการนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาย้อนหลังเมื่อสร้างพื้นที่ทำงานในแหล่งที่มาเพื่อเก็บรักษาเวลาสร้างเดิม ระบบจะป้อนข้อมูลในเอาต์พุตเมื่อ |
last_ |
เอาต์พุตเท่านั้น การประทับเวลาของข้อความล่าสุดในพื้นที่ทำงาน |
admin_ |
เอาต์พุตเท่านั้น สำหรับพื้นที่ทำงานของข้อความส่วนตัว (DM) ที่มีแอป Chat ระบุว่าพื้นที่ทำงานนั้นสร้างโดยผู้ดูแลระบบ Google Workspace หรือไม่ ผู้ดูแลระบบสามารถติดตั้งและตั้งค่าข้อความส่วนตัวด้วยแอป Chat ในนามของผู้ใช้ในองค์กร แอป Chat ของคุณต้องมีการรับส่งข้อความส่วนตัวเพื่อรองรับการติดตั้งโดยผู้ดูแลระบบ |
membership_ |
เอาต์พุตเท่านั้น จำนวนการเป็นสมาชิกที่เข้าร่วมซึ่งจัดกลุ่มตามประเภทสมาชิก สร้างขึ้นเมื่อ |
access_ |
ไม่บังคับ ระบุการตั้งค่าการเข้าถึงของพื้นที่ทำงาน ระบบจะป้อนข้อมูลเฉพาะเมื่อ |
space_ |
เอาต์พุตเท่านั้น URI สำหรับผู้ใช้ในการเข้าถึงพื้นที่ทำงาน |
import_ |
เอาต์พุตเท่านั้น เวลาระบบจะลบพื้นที่ทำงานโดยอัตโนมัติหากพื้นที่ทำงานยังคงอยู่ในโหมดการนำเข้า พื้นที่ทำงานแต่ละรายการที่สร้างในโหมดการนำเข้าต้องออกจากโหมดนี้ก่อนเวลาหมดอายุโดยใช้ ช่องนี้จะสร้างขึ้นสำหรับพื้นที่ทำงานที่สร้างด้วยโหมดการนำเข้าเท่านั้น |
customer |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ รหัสลูกค้าของโดเมนของพื้นที่ทำงาน จำเป็นต้องใช้เฉพาะเมื่อสร้างพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์ของแอปและ ในรูปแบบ ระบบจะไม่ป้อนข้อมูลในช่องนี้สำหรับ DM |
ฟิลด์สหภาพ ต้องมีการการตรวจสอบสิทธิ์ของผู้ใช้ |
|
predefined_ |
ไม่บังคับ อินพุตเท่านั้น การตั้งค่าสิทธิ์ของพื้นที่ทำงานที่กำหนดไว้ล่วงหน้า ให้ป้อนเฉพาะเมื่อสร้างพื้นที่ทำงานเท่านั้น หากไม่ได้ตั้งค่าช่อง ระบบจะสร้างพื้นที่ทำงานร่วมกัน หลังจากสร้างพื้นที่ทำงานแล้ว ระบบจะป้อนการตั้งค่าในช่อง |
permission_ |
ไม่บังคับ การตั้งค่าสิทธิ์ของพื้นที่ทำงานสำหรับพื้นที่ทำงานที่มีอยู่ อินพุตสำหรับการอัปเดตการตั้งค่าสิทธิ์ของพื้นที่ทำงานที่แน่นอน ซึ่งจะแทนที่การตั้งค่าสิทธิ์ที่มีอยู่ เอาต์พุตจะแสดงการตั้งค่าสิทธิ์ปัจจุบัน |
AccessSettings
แสดงถึงการตั้งค่าการเข้าถึงของพื้นที่ทำงาน
ช่อง | |
---|---|
access_ |
เอาต์พุตเท่านั้น ระบุสถานะการเข้าถึงของพื้นที่ทำงาน |
audience |
ไม่บังคับ ชื่อทรัพยากรของกลุ่มเป้าหมายที่ค้นพบพื้นที่ทำงาน เข้าร่วมพื้นที่ทำงาน และดูตัวอย่างข้อความในพื้นที่ทำงานได้ หากไม่ได้ตั้งค่าไว้ จะมีเพียงผู้ใช้หรือ Google Group ที่ได้รับเชิญหรือเพิ่มไปยังพื้นที่ทำงานทีละคนเท่านั้นที่เข้าถึงพื้นที่ทำงานได้ โปรดดูรายละเอียดที่หัวข้อทําให้พื้นที่ทํางานค้นพบได้ในกลุ่มเป้าหมาย รูปแบบ: หากต้องการใช้กลุ่มเป้าหมายเริ่มต้นสําหรับองค์กร Google Workspace ให้ตั้งค่าเป็น การอ่านกลุ่มเป้าหมายรองรับการดำเนินการต่อไปนี้
ช่องนี้จะไม่มีข้อมูลเมื่อใช้ขอบเขต การตั้งค่ากลุ่มเป้าหมายต้องใช้การตรวจสอบสิทธิ์ของผู้ใช้ |
AccessState
แสดงสถานะการเข้าถึงของพื้นที่ทำงาน
Enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
ไม่ทราบสถานะการเข้าถึงหรือไม่รองรับใน API นี้ |
PRIVATE |
เฉพาะผู้ใช้หรือ Google Groups ที่ได้รับเชิญหรือเพิ่มโดยผู้ใช้รายอื่นหรือผู้ดูแลระบบ Google Workspace เท่านั้นที่จะค้นพบและเข้าถึงพื้นที่ทำงานได้ |
DISCOVERABLE |
ผู้จัดการพื้นที่ทำงานได้ให้สิทธิ์เข้าถึงพื้นที่ทำงานแก่กลุ่มเป้าหมาย ผู้ใช้หรือ Google Group ที่ได้รับการเพิ่มหรือเชิญให้เข้าร่วมพื้นที่ทำงานทีละคนจะค้นพบและเข้าถึงพื้นที่ทำงานนั้นได้เช่นกัน โปรดดูข้อมูลเพิ่มเติมที่หัวข้อทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้ การสร้างพื้นที่ทำงานที่ค้นพบได้ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ |
MembershipCount
แสดงจํานวนการเป็นสมาชิกของพื้นที่ทํางานซึ่งแบ่งออกเป็นหมวดหมู่
ช่อง | |
---|---|
joined_ |
เอาต์พุตเท่านั้น จำนวนผู้ใช้ที่เข้าร่วมพื้นที่ทำงานโดยตรง โดยไม่นับรวมผู้ใช้ที่เข้าร่วมจากการเป็นสมาชิกในกลุ่มที่เข้าร่วม |
joined_ |
เอาต์พุตเท่านั้น จำนวนกลุ่มทั้งหมดที่เข้าร่วมพื้นที่ทำงานโดยตรง |
PermissionSetting
แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน
ช่อง | |
---|---|
managers_ |
ไม่บังคับ ผู้จัดการพื้นที่ทำงานมีสิทธิ์นี้หรือไม่ |
members_ |
ไม่บังคับ สมาชิกที่ไม่ใช่ผู้จัดการมีสิทธิ์นี้หรือไม่ |
PermissionSettings
การตั้งค่าสิทธิ์ที่คุณระบุได้เมื่ออัปเดตพื้นที่ทำงานที่มีชื่อที่มีอยู่
หากต้องการตั้งค่าสิทธิ์เมื่อสร้างพื้นที่ทำงาน ให้ระบุช่อง PredefinedPermissionSettings
ในคำขอ
ช่อง | |
---|---|
manage_ |
ไม่บังคับ การตั้งค่าสำหรับจัดการสมาชิกและกลุ่มในพื้นที่ทำงาน |
modify_ |
ไม่บังคับ การตั้งค่าสำหรับการอัปเดตชื่อ รูปโปรไฟล์ คำอธิบาย และหลักเกณฑ์ของพื้นที่ทำงาน |
toggle_ |
ไม่บังคับ การตั้งค่าสำหรับเปิดและปิดประวัติพื้นที่ทำงาน |
use_ |
ไม่บังคับ การตั้งค่าสำหรับการใช้ @all ในพื้นที่ทำงาน |
manage_ |
ไม่บังคับ การตั้งค่าสำหรับการจัดการแอปในพื้นที่ทำงาน |
manage_ |
ไม่บังคับ การตั้งค่าสำหรับการจัดการเว็บฮุคในพื้นที่ทำงาน |
post_ |
เอาต์พุตเท่านั้น การตั้งค่าสำหรับการโพสต์ข้อความในพื้นที่ทำงาน |
reply_ |
ไม่บังคับ การตั้งค่าสำหรับการตอบกลับข้อความในพื้นที่ทำงาน |
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 ซึ่งข้อความทั้งหมดจะแสดงแบบแบน โปรดทราบว่าการดำเนินการนี้ไม่รวมถึงข้อความส่วนตัวระหว่างบุคคล |
SpaceBatchUpdatedEventData
เพย์โหลดเหตุการณ์สำหรับการอัปเดตพื้นที่ทำงานหลายรายการ
ประเภทกิจกรรม: google.workspace.chat.space.v1.batchUpdated
ช่อง | |
---|---|
spaces[] |
รายการพื้นที่ทำงานที่อัปเดตแล้ว |
SpaceEvent
เหตุการณ์ที่แสดงถึงการเปลี่ยนแปลงหรือกิจกรรมในพื้นที่ทำงานของ Google Chat ดูข้อมูลเพิ่มเติมได้ที่ทํางานกับเหตุการณ์จาก Google Chat
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของเหตุการณ์พื้นที่ทำงาน รูปแบบ: |
event_ |
เวลาที่เกิดเหตุการณ์ |
event_ |
ประเภทเหตุการณ์ในพื้นที่ทำงาน เหตุการณ์แต่ละประเภทมีเวอร์ชันกลุ่ม ซึ่งแสดงอินสแตนซ์หลายรายการของเหตุการณ์ประเภทนั้นที่เกิดขึ้นในช่วงเวลาสั้นๆ สําหรับคําขอ ประเภทเหตุการณ์ที่รองรับสําหรับข้อความ
ประเภทเหตุการณ์ที่รองรับสำหรับการเป็นสมาชิก
ประเภทเหตุการณ์ที่รองรับสำหรับรีแอ็กชัน
ประเภทเหตุการณ์ที่รองรับเกี่ยวกับพื้นที่ทำงาน
|
ฟิลด์สหภาพ
|
|
message_ |
เพย์โหลดเหตุการณ์สําหรับข้อความใหม่ ประเภทเหตุการณ์: |
message_ |
เพย์โหลดเหตุการณ์สําหรับข้อความที่อัปเดต ประเภทเหตุการณ์: |
message_ |
เพย์โหลดเหตุการณ์สําหรับข้อความที่ลบ ประเภทกิจกรรม: |
message_ |
เพย์โหลดเหตุการณ์สําหรับข้อความใหม่หลายรายการ ประเภทกิจกรรม: |
message_ |
เพย์โหลดเหตุการณ์สําหรับข้อความที่อัปเดตหลายรายการ ประเภทเหตุการณ์: |
message_ |
เพย์โหลดเหตุการณ์สําหรับข้อความที่ลบหลายรายการ ประเภทเหตุการณ์: |
space_ |
เพย์โหลดเหตุการณ์สำหรับการอัปเดตพื้นที่ทำงาน ประเภทเหตุการณ์: |
space_ |
เพย์โหลดเหตุการณ์สำหรับการอัปเดตพื้นที่ทำงานหลายรายการ ประเภทเหตุการณ์: |
membership_ |
เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกใหม่ ประเภทกิจกรรม: |
membership_ |
เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตแล้ว ประเภทกิจกรรม: |
membership_ |
เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบ ประเภทกิจกรรม: |
membership_ |
เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกใหม่หลายรายการ ประเภทกิจกรรม: |
membership_ |
เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตหลายรายการ ประเภทเหตุการณ์: |
membership_ |
เพย์โหลดเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบหลายรายการ ประเภทเหตุการณ์: |
reaction_ |
เพย์โหลดเหตุการณ์สำหรับรีแอ็กชันใหม่ ประเภทกิจกรรม: |
reaction_ |
เพย์โหลดเหตุการณ์สําหรับรีแอ็กชันที่ลบไปแล้ว ประเภทกิจกรรม: |
reaction_ |
เพย์โหลดเหตุการณ์สำหรับรีแอ็กชันใหม่หลายรายการ ประเภทเหตุการณ์: |
reaction_ |
เพย์โหลดเหตุการณ์สําหรับรีแอ็กชันที่ลบหลายรายการ ประเภทกิจกรรม: |
SpaceNotificationSetting
การตั้งค่าการแจ้งเตือนของผู้ใช้ในพื้นที่ทำงาน
ช่อง | |
---|---|
name |
ตัวระบุ ชื่อทรัพยากรของการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน รูปแบบ: |
notification_ |
การตั้งค่าการแจ้งเตือน |
mute_ |
การตั้งค่าปิดการแจ้งเตือนพื้นที่ทำงาน |
MuteSetting
ประเภทการตั้งค่าการปิดเสียงการแจ้งเตือนของพื้นที่ทำงาน
Enum | |
---|---|
MUTE_SETTING_UNSPECIFIED |
สงวนไว้ |
UNMUTED |
ผู้ใช้จะได้รับการแจ้งเตือนสำหรับพื้นที่ทำงานตามการตั้งค่าการแจ้งเตือน |
MUTED |
ผู้ใช้จะไม่ได้รับการแจ้งเตือนใดๆ สำหรับพื้นที่ทำงานนั้น ไม่ว่าจะตั้งค่าการแจ้งเตือนไว้อย่างไรก็ตาม |
NotificationSetting
ประเภทการตั้งค่าการแจ้งเตือน
Enum | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
สงวนไว้ |
ALL |
การแจ้งเตือนจะทริกเกอร์โดย @การพูดถึง ชุดข้อความที่ติดตาม ข้อความแรกของชุดข้อความใหม่ ระบบจะติดตามชุดข้อความใหม่ทั้งหมดโดยอัตโนมัติ เว้นแต่ผู้ใช้จะเลิกติดตามด้วยตนเอง |
MAIN_CONVERSATIONS |
การแจ้งเตือนจะทริกเกอร์โดย @การพูดถึง ชุดข้อความที่ติดตาม ข้อความแรกของชุดข้อความใหม่ ใช้งานกับข้อความส่วนตัวแบบ 1:1 ไม่ได้ |
FOR_YOU |
การแจ้งเตือนจะทริกเกอร์เมื่อมีการ @พูดถึง ชุดข้อความที่ติดตาม ใช้งานกับข้อความส่วนตัวแบบ 1:1 ไม่ได้ |
OFF |
การแจ้งเตือนปิดอยู่ |
SpaceReadState
สถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของสถานะการอ่านพื้นที่ทำงาน รูปแบบ: |
last_ |
ไม่บังคับ เวลาที่มีการอัปเดตสถานะการอ่านพื้นที่ทำงานของผู้ใช้ โดยปกติแล้วการประทับเวลานี้จะสอดคล้องกับการประทับเวลาของข้อความที่อ่านล่าสุด หรือการประทับเวลาที่ผู้ใช้ระบุไว้เพื่อทําเครื่องหมายตําแหน่งการอ่านล่าสุดในพื้นที่ทำงาน |
SpaceUpdatedEventData
เพย์โหลดเหตุการณ์สำหรับพื้นที่ทำงานที่อัปเดตแล้ว
ประเภทเหตุการณ์: google.workspace.chat.space.v1.updated
ช่อง | |
---|---|
space |
พื้นที่ทำงานที่อัปเดต |
ชุดข้อความ
ชุดข้อความในพื้นที่ใน Google Chat ดูตัวอย่างการใช้งานได้ที่เริ่มหรือตอบกลับชุดข้อความ
หากระบุชุดข้อความเมื่อสร้างข้อความ คุณจะตั้งค่าช่อง messageReplyOption
เพื่อกำหนดสิ่งที่จะเกิดขึ้นหากไม่พบชุดข้อความที่ตรงกัน
ช่อง | |
---|---|
name |
ตัวระบุ ชื่อทรัพยากรของเธรด ตัวอย่าง: |
thread_ |
ไม่บังคับ อินพุตสำหรับสร้างหรืออัปเดตชุดข้อความ หรือจะแสดงผลลัพธ์เท่านั้นก็ได้ รหัสของชุดข้อความ รองรับอักขระได้สูงสุด 4,000 ตัว รหัสนี้จะซ้ำกันเฉพาะในแอป Chat ที่ตั้งรหัส ตัวอย่างเช่น หากแอป Chat หลายแอปสร้างข้อความโดยใช้คีย์ชุดข้อความเดียวกัน ระบบจะโพสต์ข้อความเหล่านั้นในชุดข้อความที่แตกต่างกัน หากต้องการตอบกลับในชุดข้อความที่บุคคลหรือแอป Chat อื่นสร้างขึ้น ให้ระบุช่อง |
ThreadReadState
สถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของสถานะการอ่านชุดข้อความ รูปแบบ: |
last_ |
เวลาที่มีการอัปเดตสถานะการอ่านชุดข้อความของผู้ใช้ โดยปกติแล้วค่านี้สอดคล้องกับการประทับเวลาของข้อความที่อ่านล่าสุดในชุดข้อความ |
UpdateMembershipRequest
ข้อความคำขออัปเดตการเป็นสมาชิก
ช่อง | |
---|---|
membership |
ต้องระบุ การเป็นสมาชิกที่จะอัปเดต ระบบจะอัปเดตเฉพาะช่องที่ระบุด้วย |
update_ |
ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต คั่นหลายค่าด้วยคอมมา หรือใช้ เส้นทางฟิลด์ที่รองรับในปัจจุบัน
|
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ |
UpdateMessageRequest
ส่งคำขออัปเดตข้อความ
ช่อง | |
---|---|
message |
ต้องระบุ ข้อความที่มีช่องที่อัปเดตแล้ว |
update_ |
ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต คั่นหลายค่าด้วยคอมมา หรือใช้ เส้นทางฟิลด์ที่รองรับในปัจจุบัน
|
allow_ |
ไม่บังคับ หากไม่พบ |
UpdateSpaceNotificationSettingRequest
คำขออัปเดตการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน รองรับเฉพาะการอัปเดตการตั้งค่าการแจ้งเตือนสำหรับผู้ใช้ที่โทรเท่านั้น
ช่อง | |
---|---|
space_ |
ต้องระบุ ชื่อทรัพยากรสําหรับการตั้งค่าการแจ้งเตือนของพื้นที่ทํางานต้องป้อนในรูปแบบ |
update_ |
ต้องระบุ เส้นทางฟิลด์ที่รองรับ: - |
UpdateSpaceReadStateRequest
ข้อความคําขอสําหรับ UpdateSpaceReadState API
ช่อง | |
---|---|
space_ |
ต้องระบุ สถานะการอ่านพื้นที่ทำงานและฟิลด์ที่จะอัปเดต รองรับเฉพาะการอัปเดตสถานะการอ่านสำหรับผู้ใช้ที่โทรเข้ามาเท่านั้น หากต้องการอ้างอิงถึงผู้ใช้ที่โทรเข้ามา ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้
รูปแบบ: users/{user}/spaces/{space}/spaceReadState |
update_ |
ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต เส้นทางฟิลด์ที่รองรับในปัจจุบัน
เมื่อ หากต้องการทําเครื่องหมายพื้นที่ทํางานว่าอ่านแล้ว ให้ตั้งค่า |
UpdateSpaceRequest
คำขออัปเดตพื้นที่ทำงานเดียว
ช่อง | |
---|---|
space |
ต้องระบุ พื้นที่ทำงานที่มีช่องที่จะอัปเดต |
update_ |
ต้องระบุ เส้นทางฟิลด์ที่อัปเดตแล้ว โดยคั่นด้วยคอมมาหากมีหลายรายการ คุณสามารถอัปเดตช่องต่อไปนี้สำหรับพื้นที่ทำงาน
|
use_ |
ไม่บังคับ เมื่อ ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน ต้องใช้ ระบบไม่รองรับค่า |
ผู้ใช้
ผู้ใช้ใน Google Chat เมื่อแสดงผลเป็นเอาต์พุตจากคำขอ หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตสำหรับทรัพยากร User
จะแสดงเฉพาะ name
และ type
ของผู้ใช้
ช่อง | |
---|---|
name |
ชื่อทรัพยากรสำหรับ รูปแบบ: สำหรับ
|
display_ |
เอาต์พุตเท่านั้น ชื่อที่แสดงของผู้ใช้ |
domain_ |
ตัวระบุที่ไม่ซ้ำของโดเมน Google Workspace ของผู้ใช้ |
type |
ประเภทผู้ใช้ |
is_ |
เอาต์พุตเท่านั้น เมื่อเป็น |
ประเภท
Enum | |
---|---|
TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum โปรดอย่าใช้ |
HUMAN |
ผู้ใช้ที่เป็นบุคคล |
BOT |
ผู้ใช้แอป Chat |
UserMentionMetadata
ข้อมูลเมตาของคำอธิบายประกอบสำหรับการพูดถึงผู้ใช้ (@)
ช่อง | |
---|---|
user |
ผู้ใช้ที่กล่าวถึง |
type |
ประเภทการพูดถึงผู้ใช้ |
ประเภท
Enum | |
---|---|
TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum อย่าใช้ |
ADD |
เพิ่มผู้ใช้ไปยังพื้นที่ทำงาน |
MENTION |
พูดถึงผู้ใช้ในพื้นที่ทำงาน |
WidgetMarkup
วิดเจ็ตคือองค์ประกอบ UI ที่แสดงข้อความและรูปภาพ
ช่อง | |
---|---|
buttons[] |
รายการปุ่ม Buttons ก็เป็น |
ฟิลด์สหภาพ data WidgetMarkup อาจมีรายการใดรายการหนึ่งต่อไปนี้เท่านั้น คุณใช้ช่อง WidgetMarkup ได้หลายช่องเพื่อแสดงรายการเพิ่มเติม data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
text_ |
แสดงย่อหน้าข้อความในวิดเจ็ตนี้ |
image |
แสดงรูปภาพในวิดเจ็ตนี้ |
key_ |
แสดงรายการคีย์-ค่าในวิดเจ็ตนี้ |
ปุ่ม
ปุ่ม อาจเป็นปุ่มข้อความหรือปุ่มรูปภาพ
ช่อง | |
---|---|
ฟิลด์สหภาพ
|
|
text_ |
ปุ่มที่มีข้อความและการดำเนินการ |
image_ |
ปุ่มที่มีรูปภาพและการดําเนินการ |
FormAction
การดำเนินการของแบบฟอร์มจะอธิบายลักษณะการทำงานเมื่อส่งแบบฟอร์ม เช่น คุณสามารถเรียกใช้ Apps Script เพื่อจัดการแบบฟอร์ม
ช่อง | |
---|---|
action_ |
ระบบจะใช้ชื่อเมธอดเพื่อระบุส่วนใดของแบบฟอร์มที่ทริกเกอร์การส่งแบบฟอร์ม ระบบจะส่งข้อมูลนี้กลับไปยังแอป 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 ของรูปภาพ |
on_ |
การดำเนินการ |
aspect_ |
สัดส่วนภาพของรูปภาพนี้ (ความกว้างและความสูง) ช่องนี้ช่วยให้คุณจองความสูงที่เหมาะสมสำหรับรูปภาพขณะรอให้รูปภาพโหลด แต่ไม่ได้มีไว้เพื่อลบล้างสัดส่วนภาพที่ฝังอยู่ในรูปภาพ หากไม่ได้ตั้งค่าไว้ เซิร์ฟเวอร์จะเติมค่านี้โดยการจัดเก็บรูปภาพล่วงหน้า |
ImageButton
ปุ่มรูปภาพที่มีการดำเนินการ onclick
ช่อง | |
---|---|
on_ |
การดำเนินการ |
name |
ชื่อของ |
ฟิลด์สหภาพ icons คุณสามารถระบุไอคอนด้วย Icon enum หรือ URL icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
icon |
ไอคอนที่ระบุโดย |
icon_ |
ไอคอนที่ระบุโดย URL |
KeyValue
องค์ประกอบ UI มีคีย์ (ป้ายกำกับ) และค่า (เนื้อหา) องค์ประกอบนี้ยังมีการดำเนินการบางอย่าง เช่น ปุ่ม onclick
ด้วย
ช่อง | |
---|---|
top_ |
ข้อความของป้ายกำกับด้านบน รองรับข้อความที่มีการจัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
content |
ข้อความของเนื้อหา รองรับข้อความที่มีการจัดรูปแบบและจำเป็นต้องใช้เสมอ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
content_ |
ในกรณีที่เนื้อหาควรเป็นหลายบรรทัด |
bottom_ |
ข้อความของป้ายกำกับด้านล่าง รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace |
on_ |
การดำเนินการ |
ฟิลด์สหภาพ icons ต้องกำหนดไอคอน top_label และ bottom_label อย่างน้อย 1 รายการ icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
icon |
ค่า Enum ที่ Chat API แทนที่ด้วยรูปภาพไอคอนที่เกี่ยวข้อง |
icon_ |
ไอคอนที่ระบุโดย URL |
ฟิลด์สหภาพ control วิดเจ็ตการควบคุม คุณจะตั้งค่า button หรือ switch_widget ได้ แต่จะตั้งค่าทั้ง 2 อย่างไม่ได้ control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
button |
ปุ่มที่คลิกได้เพื่อเรียกให้แสดงการดำเนินการ |
OnClick
การดำเนินการ onclick
(เช่น เปิดลิงก์)
ช่อง | |
---|---|
ฟิลด์สหภาพ
|
|
action |
การดำเนินการของแบบฟอร์มจะทริกเกอร์โดยการดำเนินการ |
open_ |
การดำเนินการ |
OpenLink
ลิงก์ที่เปิดหน้าต่างใหม่
ช่อง | |
---|---|
url |
URL ที่จะเปิด |
TextButton
ปุ่มที่มีข้อความและการดำเนินการ onclick
ช่อง | |
---|---|
text |
ข้อความของปุ่ม |
on_ |
การดำเนินการ |
TextParagraph
ย่อหน้าข้อความ รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
ช่อง | |
---|---|
text |
|