색인
ChatService
(인터페이스)AccessoryWidget
(메시지)ActionResponse
(메시지)ActionResponse.ResponseType
(열거형)ActionResponse.SelectionItems
(메시지)ActionResponse.UpdatedWidget
(메시지)ActionStatus
(메시지)Annotation
(메시지)AnnotationType
(열거형)AttachedGif
(메시지)Attachment
(메시지)Attachment.Source
(열거형)AttachmentDataRef
(메시지)CardWithId
(메시지)ChatSpaceLinkData
(메시지)CompleteImportSpaceRequest
(메시지)CompleteImportSpaceResponse
(메시지)ContextualAddOnMarkup
(메시지)ContextualAddOnMarkup.Card
(메시지)ContextualAddOnMarkup.Card.CardAction
(메시지)ContextualAddOnMarkup.Card.CardHeader
(메시지)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(열거형)ContextualAddOnMarkup.Card.Section
(메시지)CreateMembershipRequest
(메시지)CreateMessageRequest
(메시지)CreateMessageRequest.MessageReplyOption
(열거형)CreateReactionRequest
(메시지)CreateSpaceRequest
(메시지)CustomEmoji
(메시지)DeleteMembershipRequest
(메시지)DeleteMessageRequest
(메시지)DeleteReactionRequest
(메시지)DeleteSpaceRequest
(메시지)DeletionMetadata
(메시지)DeletionMetadata.DeletionType
(열거형)Dialog
(메시지)DialogAction
(메시지)DriveDataRef
(메시지)DriveLinkData
(메시지)Emoji
(메시지)EmojiReactionSummary
(메시지)FindDirectMessageRequest
(메시지)GetAttachmentRequest
(메시지)GetMembershipRequest
(메시지)GetMessageRequest
(메시지)GetSpaceEventRequest
(메시지)GetSpaceReadStateRequest
(메시지)GetSpaceRequest
(메시지)GetThreadReadStateRequest
(메시지)Group
(메시지)HistoryState
(열거형)ListMembershipsRequest
(메시지)ListMembershipsResponse
(메시지)ListMessagesRequest
(메시지)ListMessagesResponse
(메시지)ListReactionsRequest
(메시지)ListReactionsResponse
(메시지)ListSpaceEventsRequest
(메시지)ListSpaceEventsResponse
(메시지)ListSpacesRequest
(메시지)ListSpacesResponse
(메시지)MatchedUrl
(메시지)Membership
(메시지)Membership.MembershipRole
(열거형)Membership.MembershipState
(열거형)MembershipBatchCreatedEventData
(메시지)MembershipBatchDeletedEventData
(메시지)MembershipBatchUpdatedEventData
(메시지)MembershipCreatedEventData
(메시지)MembershipDeletedEventData
(메시지)MembershipUpdatedEventData
(메시지)Message
(메시지)MessageBatchCreatedEventData
(메시지)MessageBatchDeletedEventData
(메시지)MessageBatchUpdatedEventData
(메시지)MessageCreatedEventData
(메시지)MessageDeletedEventData
(메시지)MessageUpdatedEventData
(메시지)QuotedMessageMetadata
(메시지)Reaction
(메시지)ReactionBatchCreatedEventData
(메시지)ReactionBatchDeletedEventData
(메시지)ReactionCreatedEventData
(메시지)ReactionDeletedEventData
(메시지)RichLinkMetadata
(메시지)RichLinkMetadata.RichLinkType
(열거형)SearchSpacesRequest
(메시지)SearchSpacesResponse
(메시지)SetUpSpaceRequest
(메시지)SlashCommand
(메시지)SlashCommandMetadata
(메시지)SlashCommandMetadata.Type
(열거형)Space
(메시지)Space.AccessSettings
(메시지)Space.AccessSettings.AccessState
(열거형)Space.MembershipCount
(메시지)Space.PermissionSetting
(메시지)Space.PermissionSettings
(메시지)Space.PredefinedPermissionSettings
(열거형)Space.SpaceDetails
(메시지)Space.SpaceThreadingState
(열거형)Space.SpaceType
(열거형)Space.Type
(열거형)SpaceBatchUpdatedEventData
(메시지)SpaceEvent
(메시지)SpaceReadState
(메시지)SpaceUpdatedEventData
(메시지)Thread
(메시지)ThreadReadState
(메시지)UpdateMembershipRequest
(메시지)UpdateMessageRequest
(메시지)UpdateSpaceReadStateRequest
(메시지)UpdateSpaceRequest
(메시지)User
(메시지)User.Type
(열거형)UserMentionMetadata
(메시지)UserMentionMetadata.Type
(열거형)WidgetMarkup
(메시지)WidgetMarkup.Button
(메시지)WidgetMarkup.FormAction
(메시지)WidgetMarkup.FormAction.ActionParameter
(메시지)WidgetMarkup.Icon
(열거형)WidgetMarkup.Image
(메시지)WidgetMarkup.ImageButton
(메시지)WidgetMarkup.KeyValue
(메시지)WidgetMarkup.OnClick
(메시지)WidgetMarkup.OpenLink
(메시지)WidgetMarkup.TextButton
(메시지)WidgetMarkup.TextParagraph
(메시지)
ChatService
개발자가 Google Chat 플랫폼에서 채팅 앱 및 통합을 빌드할 수 있도록 지원합니다.
CompleteImportSpace |
---|
지정된 스페이스에 대한 가져오기 프로세스를 완료하고 사용자에게 표시합니다. 앱 인증 및 도메인 전체 위임이 필요합니다. 자세한 내용은 Google Chat 앱이 데이터를 가져오도록 승인하기를 참고하세요.
|
CreateMembership |
---|
통화 채팅 앱, 사용자 또는 Google 그룹의 멤버십을 만듭니다. 다른 채팅 앱의 멤버십 만들기는 지원되지 않습니다. 멤버십을 만들 때 지정된 멤버가 자동 수락 정책을 사용 중지한 경우 이 멤버는 초대되며 참여하기 전에 스페이스 초대를 수락해야 합니다. 그 외의 경우에는 멤버십을 만들면 멤버가 지정된 스페이스에 바로 추가됩니다. 사용자 인증이 필요합니다. 사용 예는 다음을 참조하세요.
|
CreateMessage |
---|
Google Chat 스페이스에서 메시지를 만듭니다. 예를 보려면 메시지 보내기를 참고하세요.
다음 이미지는 앱 인증을 사용할 때 Chat에서 메시지를 표시하는 방법을 보여줍니다. Chat에서 채팅 앱을 메시지 발신자로 표시합니다. 메시지 내용은 텍스트 ( 다음 이미지는 사용자 인증을 사용할 때 Chat에서 메시지를 표시하는 방법을 보여줍니다. Chat은 사용자를 메시지 발신자로 표시하고 채팅 앱의 이름을 표시함으로써 메시지가 메시지에 기인한 것으로 간주합니다. 메시지 내용은 텍스트 ( 메시지 내용을 포함하여 최대 메시지 크기는 32,000바이트입니다.
|
CreateReaction |
---|
반응을 만들어 메시지에 추가합니다. 유니코드 이모티콘만 지원됩니다. 예를 보려면 메시지에 반응 추가하기를 참고하세요. 사용자 인증이 필요합니다.
|
CreateSpace |
---|
이름이 지정된 스페이스를 만듭니다. 주제별로 그룹화된 스페이스는 지원되지 않습니다. 예시를 보려면 스페이스 만들기를 참고하세요. 스페이스를 만들 때 사용자 인증이 필요합니다.
|
DeleteMembership |
---|
멤버십을 삭제합니다. 예시는 스페이스에서 사용자 또는 Google Chat 앱 삭제하기를 참고하세요. 사용자 인증이 필요합니다.
|
DeleteMessage |
---|
메시지를 삭제합니다. 예를 보려면 메시지 삭제를 참조하세요. 인증이 필요합니다. 앱 인증 및 사용자 인증을 지원합니다. 앱 인증을 사용하는 경우 요청은 채팅 앱에서 생성된 메시지만 삭제할 수 있습니다.
|
DeleteReaction |
---|
메시지에 대한 반응을 삭제합니다. 유니코드 이모티콘만 지원됩니다. 예를 보려면 반응 삭제하기를 참고하세요. 사용자 인증이 필요합니다.
|
DeleteSpace |
---|
이름이 지정된 스페이스를 삭제합니다. 항상 연쇄 삭제를 수행합니다. 즉, 스페이스에 게시된 메시지 및 스페이스의 멤버십과 같은 스페이스의 하위 리소스도 삭제됩니다. 예를 보려면 스페이스 삭제하기를 참고하세요. 스페이스 삭제 권한이 있는 사용자의 사용자 인증이 필요합니다.
|
FindDirectMessage |
---|
지정된 사용자와의 기존 채팅 메시지를 반환합니다. 채팅 메시지 공간을 찾을 수 없으면 사용자 인증을 사용하면 지정된 사용자와 인증된 사용자 사이의 채팅 메시지 공간을 반환합니다. 앱 인증을 사용하면 지정된 사용자와 통화 중인 채팅 앱 사이의 채팅 메시지 공간을 반환합니다.
|
GetAttachment |
---|
메시지 첨부파일의 메타데이터를 가져옵니다. 첨부파일 데이터는 미디어 API를 사용하여 가져옵니다. 예시를 보려면 메일 첨부파일에 대한 메타데이터 가져오기를 참고하세요. 앱 인증이 필요합니다.
|
GetMembership |
---|
멤버십에 대한 세부정보를 반환합니다. 예를 보려면 사용자 또는 Google Chat 앱의 멤버십 세부정보 확인하기를 참고하세요. 인증이 필요합니다. 앱 인증 및 사용자 인증을 지원합니다.
|
GetMessage |
---|
메일에 대한 세부정보를 반환합니다. 예를 보려면 메시지 세부정보 확인하기를 참고하세요. 인증이 필요합니다. 앱 인증 및 사용자 인증을 지원합니다. 참고: 차단된 멤버 또는 스페이스의 메시지가 반환될 수도 있습니다.
|
GetSpace |
---|
스페이스에 관한 세부정보를 반환합니다. 예를 보려면 스페이스 세부정보 보기를 참고하세요. 인증이 필요합니다. 앱 인증 및 사용자 인증을 지원합니다.
|
GetSpaceEvent |
---|
Google Chat 스페이스의 이벤트를 반환합니다. 이벤트 페이로드에는 변경된 리소스의 최신 버전이 포함됩니다. 예를 들어 새 메시지에 대한 이벤트를 요청했지만 메시지가 나중에 업데이트된 경우 서버는 이벤트 페이로드에 업데이트된 사용자 인증이 필요합니다. 이벤트를 가져오려면 인증된 사용자가 스페이스 구성원이어야 합니다. 예시는 Google Chat 스페이스의 일정에 관한 세부정보 확인하기를 참고하세요.
|
GetSpaceReadState |
---|
스페이스 내에서 사용자의 읽기 상태에 관한 세부정보를 반환하며 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예시는 사용자의 스페이스 읽기 상태에 관한 세부정보 가져오기를 참고하세요. 사용자 인증이 필요합니다.
|
GetThreadReadState |
---|
대화목록 내에서 사용자의 읽은 상태에 관한 세부정보를 반환하며 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예시는 사용자의 스레드 읽기 상태에 관한 세부정보 가져오기를 참고하세요. 사용자 인증이 필요합니다.
|
ListMemberships |
---|
스페이스의 멤버십을 나열합니다. 예시를 보려면 스페이스에서 사용자 및 Google Chat 앱 나열을 참고하세요. 앱 인증을 사용하여 멤버십을 나열하면 채팅 앱에서 액세스할 수 있는 스페이스의 멤버십이 표시되지만 자체 채팅 앱 멤버십은 제외됩니다. 사용자 인증을 사용하여 멤버십을 나열하면 인증된 사용자가 액세스할 수 있는 스페이스의 멤버십이 나열됩니다. 인증이 필요합니다. 앱 인증 및 사용자 인증을 지원합니다.
|
ListMessages |
---|
차단된 멤버 및 스페이스의 메시지를 포함하여 발신자가 참여 중인 스페이스의 메시지를 나열합니다. 메시지가 없는 스페이스의 메시지를 나열하는 경우 응답은 빈 객체입니다. REST/HTTP 인터페이스를 사용하는 경우 응답에 빈 JSON 객체
|
ListReactions |
---|
메시지에 대한 반응을 나열합니다. 예는 메시지에 대한 반응 나열을 참조하세요. 사용자 인증이 필요합니다.
|
ListSpaceEvents |
---|
Google Chat 스페이스의 이벤트를 나열합니다. 각 이벤트에 대한 payload에는 Chat 리소스의 최신 버전이 포함됩니다. 예를 들어 새 스페이스 멤버에 관한 일정을 나열하면 서버에서 최신 멤버십 세부정보가 포함된 사용자 인증이 필요합니다. 이벤트를 나열하려면 인증된 사용자가 스페이스 구성원이어야 합니다. 예시는 Google Chat 스페이스의 이벤트 나열을 참고하세요.
|
ListSpaces |
---|
발신자가 속한 스페이스를 나열합니다. 첫 번째 메시지가 전송되기 전에는 그룹 채팅과 채팅 메시지가 표시되지 않습니다. 예는 스페이스 나열을 참고하세요. 인증이 필요합니다. 앱 인증 및 사용자 인증을 지원합니다. 발신자 또는 인증된 사용자에게 표시되는 스페이스를 나열합니다. 첫 번째 메시지가 전송되기 전에는 그룹 채팅과 채팅 메시지가 표시되지 않습니다. Google Workspace 조직별로 이름이 지정된 모든 스페이스를 나열하려면 Workspace 관리자 권한을 사용하는
|
SearchSpaces |
---|
use_admin_access 를 true 로 설정합니다.
|
SetUpSpace |
---|
스페이스를 만들고 지정된 사용자를 추가합니다. 호출하는 사용자는 스페이스에 자동으로 추가되며, 요청에서 멤버십으로 지정되면 안 됩니다. 예시는 초기 참여자로 스페이스 설정하기를 참고하세요. 추가할 실제 구성원을 지정하려면 적절한 추가할 Google 그룹을 지정하려면 적절한 이름이 지정된 스페이스 또는 그룹 채팅의 경우 발신자가 차단 또는 차단되거나, 일부 멤버를 추가할 권한이 없는 경우 해당 멤버는 생성된 스페이스에 추가되지 않습니다. 전화를 거는 사용자와 다른 실제 사용자 간에 채팅 메시지 (DM)를 만들려면 실제 사용자를 나타내는 멤버십을 하나만 지정하세요. 한 사용자가 다른 사용자를 차단하면 요청이 실패하고 DM이 생성되지 않습니다. 통화 사용자와 통화 앱 간에 DM을 만들려면 두 사용자 사이에 이미 채팅 메시지가 있는 경우, 요청 시 한 사용자가 다른 사용자를 차단하더라도 기존 채팅 메시지가 반환됩니다. 대화목록 답장이 있는 스페이스는 지원되지 않습니다. 스페이스를 설정할 때 사용자 인증이 필요합니다.
|
UpdateMembership |
---|
멤버십을 업데이트합니다. 예시는 스페이스에서 사용자의 멤버십 업데이트하기를 참고하세요. 사용자 인증이 필요합니다.
|
UpdateMessage |
---|
메시지를 업데이트합니다. 인증이 필요합니다. 앱 인증 및 사용자 인증을 지원합니다. 앱 인증을 사용하는 경우 요청은 채팅 앱에서 생성된 메시지만 업데이트할 수 있습니다.
|
UpdateSpace |
---|
스페이스를 업데이트합니다. 예를 보려면 스페이스 업데이트하기를 참고하세요.
사용자 인증이 필요합니다.
|
UpdateSpaceReadState |
---|
스페이스 내에서 사용자의 읽기 상태를 업데이트하며 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예는 사용자의 스페이스 읽기 상태 업데이트를 참고하세요. 사용자 인증이 필요합니다.
|
AccessoryWidget
메시지 하단에 표시되는 하나 이상의 대화형 위젯입니다. 자세한 내용은 메일 하단에 대화형 위젯 추가를 참고하세요.
필드 | |
---|---|
통합 필드 action . 작업의 유형입니다. action 은 다음 중 하나여야 합니다. |
|
button_list |
버튼 목록입니다. |
ActionResponse
채팅 앱에서 응답이 게시되는 방식을 구성하는 데 사용할 수 있는 매개변수입니다.
필드 | |
---|---|
type |
입력 전용입니다. 채팅 앱 응답 유형입니다. |
url |
입력 전용입니다. 사용자가 인증하거나 구성할 URL입니다. ( |
dialog_action |
입력 전용입니다. 대화상자와 관련된 상호작용 이벤트에 대한 응답입니다. |
updated_widget |
입력 전용입니다. 업데이트된 위젯의 응답입니다. |
ResponseType
채팅 앱 응답 유형입니다.
열거형 | |
---|---|
TYPE_UNSPECIFIED |
NEW_MESSAGE 로 처리되는 기본 유형입니다. |
NEW_MESSAGE |
주제에 새 메시지로 게시합니다. |
UPDATE_MESSAGE |
채팅 앱의 메시지를 업데이트합니다. 이는 메시지 발신자 유형이 BOT 인 CARD_CLICKED 이벤트에서만 허용됩니다. |
UPDATE_USER_MESSAGE_CARDS |
사용자 메시지의 카드를 업데이트합니다. 일치하는 URL이 있는 MESSAGE 이벤트 또는 메시지 발신자 유형이 HUMAN 인 CARD_CLICKED 이벤트에 대한 응답으로만 허용됩니다. 텍스트는 무시됩니다. |
REQUEST_CONFIG |
사용자에게 추가 인증 또는 구성을 비공개로 요청합니다. |
DIALOG |
대화상자를 표시합니다. |
UPDATE_WIDGET |
위젯 텍스트 자동 완성 옵션 쿼리 |
SelectionItems
위젯 자동 완성 결과 목록입니다.
필드 | |
---|---|
items[] |
SelectionItem 객체의 배열입니다. |
UpdatedWidget
업데이트된 위젯의 응답입니다. 위젯의 자동 완성 옵션을 제공하는 데 사용됩니다.
필드 | |
---|---|
widget |
업데이트된 위젯의 ID입니다. ID는 업데이트 요청을 트리거한 위젯의 ID와 일치해야 합니다. |
통합 필드 updated_widget . 사용자 작업에 대한 응답으로 위젯이 업데이트됩니다. updated_widget 은 다음 중 하나여야 합니다. |
|
suggestions |
위젯 자동 완성 결과 목록 |
ActionStatus
대화상자를 호출하거나 제출하는 요청의 상태를 나타냅니다.
필드 | |
---|---|
status_code |
상태 코드입니다. |
user_facing_message |
사용자에게 요청 상태에 대해 보내는 메시지입니다. 설정하지 않으면 |
Annotation
출력 전용입니다. 메시지의 일반 텍스트 본문과 연결된 주석입니다. 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_index |
이 주석에 해당하는 일반 텍스트 메시지 본문의 시작 색인 (0부터 시작)입니다. |
통합 필드 metadata . 주석에 대한 추가 메타데이터입니다. metadata 은 다음 중 하나여야 합니다. |
|
user_mention |
사용자 멘션의 메타데이터입니다. |
slash_command |
슬래시 명령어의 메타데이터입니다. |
rich_link_metadata |
리치 링크의 메타데이터입니다. |
AnnotationType
주석의 유형입니다.
열거형 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
USER_MENTION |
사용자가 언급됩니다. |
SLASH_COMMAND |
슬래시 명령어가 호출됩니다. |
RICH_LINK |
리치 링크 주석입니다. |
AttachedGif
URL로 지정된 GIF 이미지입니다.
필드 | |
---|---|
uri |
출력 전용입니다. GIF 이미지를 호스팅하는 URL입니다. |
첨부파일
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 Drive 첨부파일에 대한 참조입니다. 이 필드는 Google Drive API에서 사용됩니다. |
소스
첨부파일의 소스입니다.
열거형 | |
---|---|
SOURCE_UNSPECIFIED |
예약되었습니다. |
DRIVE_FILE |
파일이 Google Drive 파일입니다. |
UPLOADED_CONTENT |
파일이 Chat에 업로드됩니다. |
AttachmentDataRef
첨부파일 데이터에 대한 참조입니다.
필드 | |
---|---|
resource_name |
첨부파일 데이터의 리소스 이름입니다. 이 필드는 미디어 API에서 첨부파일 데이터를 다운로드하는 데 사용됩니다. |
attachment_upload_token |
업로드된 첨부파일에 대한 참조가 포함된 불투명 토큰입니다. 클라이언트에서 불투명한 문자열로 처리되며 첨부파일이 있는 Chat 메시지를 만들거나 업데이트하는 데 사용됩니다. |
CardWithId
Google Chat 메시지의 카드.
채팅 앱에서만 카드를 만들 수 있습니다. 채팅 앱이 사용자로 인증되는 경우 메시지에 카드를 포함할 수 없습니다.
카드 빌더로 카드를 디자인하고 미리 봅니다.
카드 빌더 열기필드 | |
---|---|
card_id |
메시지에 여러 카드가 포함된 경우 필수입니다. 메시지 카드의 고유 식별자입니다. |
card |
카드 최대 크기는 32KB입니다. |
ChatSpaceLinkData
Chat 스페이스 링크 관련 데이터입니다.
필드 | |
---|---|
space |
연결된 Chat 스페이스 리소스의 스페이스입니다. 형식: |
thread |
연결된 Chat 스페이스 리소스의 대화목록입니다. 형식: |
message |
연결된 Chat 스페이스 리소스의 메시지입니다. 형식: |
CompleteImportSpaceRequest
스페이스 가져오기 프로세스 완료 요청 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 가져오기 모드 공간의 리소스 이름입니다. 형식: |
CompleteImportSpaceResponse
스페이스 가져오기 프로세스 완료에 대한 응답 메시지입니다.
필드 | |
---|---|
space |
가져오기 모드 공간입니다. |
ContextualAddOnMarkup
이 유형에는 필드가 없습니다.
개발자가 상황별 AddOn의 콘텐츠를 지정할 수 있는 마크업입니다.
카드
카드는 텍스트 및 이미지와 같은 UI 위젯을 포함할 수 있는 UI 요소입니다.
필드 | |
---|---|
header |
카드의 헤더입니다. 헤더에는 일반적으로 제목과 이미지가 포함됩니다. |
sections[] |
섹션은 줄 구분선으로 구분됩니다. |
card_actions[] |
이 카드의 액션입니다. |
name |
카드 이름입니다. |
CardAction
카드 작업은 카드와 연결된 작업입니다. 인보이스 카드의 경우 일반적으로 인보이스 삭제, 이메일 인보이스 발송, 브라우저에서 인보이스 열기 등의 작업이 이루어집니다.
Google Chat 앱에서는 지원되지 않습니다.
필드 | |
---|---|
action_label |
라벨은 작업 메뉴 항목에 표시되곤 했습니다. |
on_click |
이 작업 항목의 온클릭 작업입니다. |
CardHeader
필드 | |
---|---|
title |
제목을 지정해야 합니다. 헤더의 높이가 고정되어 있습니다. 제목과 부제목이 모두 지정된 경우에는 각각 한 줄을 차지합니다. 제목만 지정된 경우 두 줄을 모두 차지합니다. |
subtitle |
카드 헤더의 부제목입니다. |
image_style |
이미지 유형입니다 (예: 정사각형 테두리 또는 원형 테두리). |
image_url |
카드 헤더에 있는 이미지의 URL입니다. |
ImageStyle
열거형 | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
사각형 테두리 |
AVATAR |
원형 테두리 |
섹션
섹션에는 지정된 순서대로 (세로로) 렌더링되는 위젯 모음이 포함됩니다. 모든 플랫폼에서 카드는 좁은 너비가 고정되어 있으므로 현재는 레이아웃 속성 (예: float)이 필요하지 않습니다.
필드 | |
---|---|
header |
섹션의 헤더입니다. 서식이 지정된 텍스트는 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요. |
widgets[] |
섹션에는 위젯이 하나 이상 있어야 합니다. |
CreateMembershipRequest
멤버십 생성 요청 메시지입니다.
필드 | |
---|---|
parent |
필수 항목입니다. 멤버십을 만들 스페이스의 리소스 이름입니다. 형식: space/{space} |
membership |
필수 항목입니다. 생성할 멤버십 관계입니다. |
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리자 액세스 권한을 사용하여 앱 멤버십을 만들거나 관리자의 Google Workspace 조직 외부 사용자를 위한 멤버십을 만드는 기능은 지원되지 않습니다. |
CreateMessageRequest
메시지를 만듭니다.
필드 | |
---|---|
parent |
필수 항목입니다. 메시지를 만들 스페이스의 리소스 이름입니다. 형식: |
message |
필수 항목입니다. 메일 본문입니다. |
thread_key |
선택사항입니다. 지원 중단됨: 대신 |
request_id |
선택사항입니다. 이 메시지의 고유한 요청 ID입니다. 기존 요청 ID를 지정하면 새 메시지가 생성되는 대신 해당 ID로 생성된 메시지가 반환됩니다. |
message_reply_option |
선택사항입니다. 메시지가 대화목록을 시작하는지 아니면 대화목록에 답장할지 지정합니다. 이름이 지정된 스페이스에서만 지원됩니다. |
message_id |
선택사항입니다. 메시지의 커스텀 ID입니다. 메시지의 리소스 이름 (메시지 이 필드의 값은 다음 요구사항을 충족해야 합니다.
자세한 내용은 메시지 이름 지정하기를 참고하세요. |
MessageReplyOption
메시지에 답장하는 방법을 지정합니다. 향후 더 많은 주가 추가될 수 있습니다.
열거형 | |
---|---|
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를 사용하는 것이 좋습니다. 기존 요청 ID를 지정하면 새 스페이스를 만드는 대신 해당 ID로 생성된 스페이스가 반환됩니다. 동일한 채팅 앱에서 인증된 다른 사용자가 있는 기존 요청 ID를 지정하면 오류가 반환됩니다. |
CustomEmoji
맞춤 이모티콘을 나타냅니다.
필드 | |
---|---|
uid |
출력 전용입니다. 맞춤 그림 이모티콘 리소스의 고유 키입니다. |
DeleteMembershipRequest
스페이스의 멤버십 삭제 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 멤버십의 리소스 이름입니다. 채팅 앱에서 실제 사용자의 채팅 데이터를 또는 자신의 멤버십을 사용할 수 있습니다. 채팅 앱에서 다른 앱을 삭제할 수 없음 멤버십입니다. 사람 멤버십을 삭제할 때는 앱 멤버십을 삭제할 때 형식: |
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스 권한으로는 스페이스에서 앱 멤버십을 삭제할 수 없습니다. |
DeleteMessageRequest
메시지 삭제 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 메시지의 리소스 이름입니다. 형식: 메시지에 맞춤 ID를 설정한 경우 |
force |
|
DeleteReactionRequest
메시지에 대한 반응을 삭제합니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 반응의 이름입니다. 형식: |
DeleteSpaceRequest
스페이스 삭제 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 스페이스의 리소스 이름입니다. 형식: |
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
DeletionMetadata
삭제된 메일에 관한 정보입니다. delete_time
가 설정되면 메시지가 삭제됩니다.
필드 | |
---|---|
deletion_type |
메일을 삭제한 사용자를 나타냅니다. |
DeletionType
메일을 삭제한 사용자 및 삭제 방법
열거형 | |
---|---|
DELETION_TYPE_UNSPECIFIED |
이 값은 사용되지 않습니다. |
CREATOR |
사용자가 자신의 메일을 삭제했습니다. |
SPACE_OWNER |
스페이스 소유자가 메시지를 삭제했습니다. |
ADMIN |
Google Workspace 관리자가 메일을 삭제했습니다. |
APP_MESSAGE_EXPIRY |
채팅 앱이 만료되어 자체 메시지를 삭제했습니다. |
CREATOR_VIA_APP |
채팅 앱에서 사용자를 대신하여 메시지를 삭제했습니다. |
SPACE_OWNER_VIA_APP |
Chat 앱에서 스페이스 소유자를 대신하여 메시지를 삭제했습니다. |
Dialog
대화상자의 카드 본문을 둘러싸는 래퍼입니다.
필드 | |
---|---|
body |
입력 전용입니다. 모달에서 렌더링되는 대화상자의 본문 Google Chat 앱에서는 |
DialogAction
대화상자와 요청 상태 코드를 포함합니다.
필드 | |
---|---|
action_status |
입력 전용입니다. 대화상자를 호출하거나 제출하는 요청의 상태입니다. 필요한 경우 사용자에게 상태와 메시지를 표시합니다. 오류 또는 성공 사례를 예로 들 수 있습니다. |
통합 필드 action . 수행할 작업입니다. action 은 다음 중 하나여야 합니다. |
|
dialog |
입력 전용입니다. 요청 대화상자 |
DriveDataRef
드라이브 첨부파일의 데이터에 대한 참조입니다.
필드 | |
---|---|
drive_file_id |
드라이브 파일의 ID입니다. Drive API와 함께 사용합니다. |
DriveLinkData
Google Drive 링크 관련 데이터입니다.
필드 | |
---|---|
drive_data_ref |
Google Drive 파일을 참조하는 DriveDataRef. |
mime_type |
연결된 Google 드라이브 리소스의 MIME 유형입니다. |
그림 이모티콘
메시지에 대한 반응으로 사용되는 그림 이모티콘입니다.
필드 | |
---|---|
통합 필드 content . 그림 이모티콘의 콘텐츠입니다. content 은 다음 중 하나여야 합니다. |
|
unicode |
유니코드 문자열로 표시되는 기본 이모티콘입니다. |
custom_emoji |
출력 전용입니다. 맞춤 그림 이모티콘 |
EmojiReactionSummary
특정 그림 이모티콘으로 메시지에 반응한 사용자 수입니다.
필드 | |
---|---|
emoji |
반응과 관련된 그림 이모티콘입니다. |
reaction_count |
연결된 이모티콘을 사용하는 총 반응 수입니다. |
FindDirectMessageRequest
사용자 리소스를 기반으로 채팅 메시지 공간 가져오기 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 채팅 메시지를 찾을 사용자의 리소스 이름입니다. 형식: |
GetAttachmentRequest
첨부파일 가져오기 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 첨부파일의 리소스 이름으로, |
GetMembershipRequest
스페이스 멤버십 가져오기 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 검색할 멤버십의 리소스 이름입니다. 사용자 인증을 사용하여 앱의 자체 멤버십을 가져오려면 선택적으로 형식: 사용자로 인증되면 사용자의 이메일을 |
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스 권한을 사용하는 경우 스페이스에서 앱 멤버십을 가져올 수 없습니다. |
GetMessageRequest
메시지 가져오기 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 메시지의 리소스 이름입니다. 형식: 메시지에 맞춤 ID를 설정한 경우 |
GetSpaceEventRequest
스페이스 이벤트 가져오기 요청 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 스페이스 이벤트의 리소스 이름입니다. 형식: |
GetSpaceReadStateRequest
GetSpaceReadState API 요청 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 검색할 스페이스 읽기 상태의 리소스 이름입니다. 호출하는 사용자의 읽기 상태 가져오기만 지원합니다. 호출하는 사용자를 참조하려면 다음 중 하나를 설정하세요.
형식: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
단일 스페이스 반환 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 스페이스의 리소스 이름으로, 형식: |
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
GetThreadReadStateRequest
GetThreadReadStateRequest API 요청 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 검색할 스레드 읽기 상태의 리소스 이름입니다. 호출하는 사용자의 읽기 상태 가져오기만 지원합니다. 호출하는 사용자를 참조하려면 다음 중 하나를 설정하세요.
형식: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
그룹
Google Chat의 Google 그룹
필드 | |
---|---|
name |
Google 그룹의 리소스 이름입니다. Cloud ID Groups API의 그룹을 나타냅니다. 형식: groups/{group} |
HistoryState
메시지 및 스페이스의 기록 상태입니다. 메시지 및 대화목록이 생성된 후 보관되는 기간을 지정합니다.
열거형 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
기본값 사용하지 마세요. |
HISTORY_OFF |
채팅 기록이 사용 중지되었습니다. 메시지 및 대화목록은 24시간 동안 보관됩니다. |
HISTORY_ON |
채팅 기록이 사용 설정되었습니다. 메일 및 대화목록의 보관 기간은 조직의 Vault 보관 규칙에 따라 지정됩니다. |
ListMembershipsRequest
멤버십 나열 요청 메시지입니다.
필드 | |
---|---|
parent |
필수 항목입니다. 멤버십 목록을 가져올 스페이스의 리소스 이름입니다. 형식: space/{space} |
page_size |
선택사항입니다. 반환할 최대 멤버십 수입니다. 서비스는 이 값보다 더 적은 수의 값을 반환할 수 있습니다. 지정하지 않으면 최대 100개의 멤버십이 반환됩니다. 최댓값은 1,000입니다. 1,000 이상의 값을 사용하면 1,000으로 자동 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 멤버십을 나열하기 위한 이전 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나눌 때 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예상치 못한 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터 회원의 역할 ( 역할별로 필터링하려면 유형별로 필터링하려면 역할과 유형을 모두 기준으로 필터링하려면
예를 들어 유효한 쿼리는 다음과 같습니다.
다음 쿼리가 잘못되었습니다.
잘못된 쿼리는 |
show_groups |
선택사항입니다. |
show_invited |
선택사항입니다. 현재 사용자 인증이 필요합니다. |
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스 권한을 사용하는 경우 스페이스에 앱 멤버십을 나열할 수 없습니다. |
ListMembershipsResponse
스페이스 멤버십 나열에 대한 응답입니다.
필드 | |
---|---|
memberships[] |
순서가 지정되지 않은 목록입니다. 요청된 (또는 첫 번째) 페이지의 멤버십 목록입니다. |
next_page_token |
결과의 다음 페이지를 검색하기 위해 |
ListMessagesRequest
사용자가 참여 중인 지정된 스페이스의 메시지를 나열합니다.
필드 | |
---|---|
parent |
필수 항목입니다. 메시지를 나열할 스페이스의 리소스 이름입니다. 형식: |
page_size |
반환되는 최대 메시지 수입니다. 서비스는 이 값보다 적은 메시지를 반환할 수 있습니다. 지정하지 않으면 최대 25개가 반환됩니다. 최댓값은 1,000입니다. 1,000 이상의 값을 사용하면 1,000으로 자동 변경됩니다. 음수 값은 |
page_token |
이전 쿼리에서 재개하는 경우 선택사항입니다. 이전 목록 메시지 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나눌 때 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예상치 못한 결과가 발생할 수 있습니다. |
filter |
쿼리 필터 날짜 ( 작성된 날짜를 기준으로 메시지를 필터링하려면 RFC-3339 형식의 타임스탬프와 큰따옴표를 사용하여 스레드별로 필터링하려면 스레드와 날짜로 필터링하려면 쿼리에 예를 들어 유효한 쿼리는 다음과 같습니다.
잘못된 쿼리는 |
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 |
필수 항목입니다. 쿼리 필터 has 원하는 경우 시작 시간 (
시작 시간 또는 종료 시간을 지정하려면 RFC-3339에서 같음 예를 들어 유효한 쿼리는 다음과 같습니다.
다음 쿼리가 잘못되었습니다.
잘못된 쿼리는 |
ListSpaceEventsResponse
스페이스 이벤트 나열을 위한 응답 메시지입니다.
필드 | |
---|---|
space_events[] |
결과는 시간순 (가장 오래된 이벤트순)으로 반환됩니다. |
next_page_token |
더 많은 이벤트를 가져오는 데 사용되는 연속 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다. |
ListSpacesRequest
호출자가 속한 스페이스를 나열하기 위한 요청입니다.
필드 | |
---|---|
page_size |
선택사항입니다. 반환할 최대 공백 수입니다. 서비스는 이 값보다 더 적은 수의 값을 반환할 수 있습니다. 지정하지 않으면 최대 100개의 공백이 반환됩니다. 최댓값은 1,000입니다. 1,000 이상의 값을 사용하면 1,000으로 자동 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 이전 스페이스 목록 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나눌 때 필터 값은 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터 스페이스 유형 ( 공백 유형으로 필터링하려면 예를 들어 유효한 쿼리는 다음과 같습니다.
잘못된 쿼리는 |
ListSpacesResponse
스페이스 나열 요청에 대한 응답입니다.
필드 | |
---|---|
spaces[] |
요청된 (또는 첫 번째) 페이지의 스페이스 목록입니다. |
next_page_token |
토큰을 |
MatchedUrl
Chat 메시지의 일치하는 URL입니다. 채팅 앱에서 일치하는 URL을 미리 볼 수 있습니다. 자세한 내용은 미리보기 링크를 참고하세요.
필드 | |
---|---|
url |
출력 전용입니다. 일치된 URL입니다. |
멤버십
사용자 또는 채팅 앱이 스페이스에 초대되었는지, 스페이스의 일부인지, 없는지와 같은 Google Chat의 멤버십 관계를 나타냅니다.
필드 | |
---|---|
name |
서버에서 할당한 멤버십의 리소스 이름입니다. 형식: |
state |
출력 전용입니다. 멤버십 상태입니다. |
role |
선택사항입니다. Chat 스페이스 내 사용자의 역할에 따라 스페이스에서 허용되는 작업이 결정됩니다. 이 필드는 |
create_time |
선택사항입니다. 변경할 수 없습니다. 멤버십이 생성된 시간(예: 멤버가 스페이스에 참여했거나 스페이스에 초대된 시간)입니다. 이 필드는 가져오기 모드 공간에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다. |
delete_time |
선택사항입니다. 변경할 수 없습니다. 멤버가 스페이스에서 나갔거나 스페이스에서 삭제된 시점 등 멤버십 삭제 시간입니다. 이 필드는 가져오기 모드 공간에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다. |
통합 필드 memberType . 이 멤버십과 연결된 회원입니다. 다른 구성원 유형은 향후 지원될 수 있습니다. memberType 은 다음 중 하나여야 합니다. |
|
member |
멤버십이 해당하는 Google Chat 사용자 또는 앱입니다. 채팅 앱이 사용자로 인증되면 사용자 |
group_member |
멤버십이 해당하는 Google 그룹입니다. |
MembershipRole
Chat 스페이스에서 사용자가 허용하는 작업을 나타냅니다. 향후 더 많은 enum 값이 추가될 수 있습니다.
열거형 | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
기본값 users 의 경우: 스페이스의 멤버가 아니지만 초대할 수 있습니다. Google Groups 의 경우 항상 이 역할이 할당됩니다 (향후 다른 enum 값이 사용될 수 있음). |
ROLE_MEMBER |
스페이스의 구성원입니다. 사용자는 스페이스에 메시지를 보내는 등의 기본 권한을 갖습니다. 1:1 및 이름이 지정되지 않은 그룹 대화에서는 모든 사용자에게 이 역할이 부여됩니다. |
ROLE_MANAGER |
스페이스 관리자입니다. 사용자는 모든 기본 권한과 함께 멤버 추가 또는 삭제와 같이 스페이스를 관리할 수 있는 관리 권한을 갖습니다. SpaceType.SPACE 에서만 지원됩니다. |
MembershipState
멤버와 스페이스의 관계를 지정합니다. 향후 다른 멤버십 상태도 지원될 수 있습니다.
열거형 | |
---|---|
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 |
메시지의 리소스 이름입니다. 형식: 여기서 메시지를 만들 때 맞춤 ID를 설정한 경우 이 ID를 사용하면 |
sender |
출력 전용입니다. 메시지를 작성한 사용자입니다. 채팅 앱이 사용자로 인증되면 사용자 |
create_time |
선택사항입니다. 변경할 수 없습니다. Chat에서 만든 스페이스의 경우 메시지가 생성된 시간입니다. 이 필드는 가져오기 모드 공간에서 사용되는 경우를 제외하고 출력 전용입니다. 가져오기 모드 공간의 경우 원래 생성 시간을 보존하기 위해 이 필드를 소스에서 메시지가 생성된 이전 타임스탬프로 설정합니다. |
last_update_time |
출력 전용입니다. 사용자가 메시지를 마지막으로 수정한 시간입니다. 메시지를 수정한 적이 없는 경우 이 필드는 비어 있습니다. |
delete_time |
출력 전용입니다. Google Chat에서 메시지가 삭제된 시간입니다. 메일이 삭제되지 않는 경우 이 필드는 비어 있습니다. |
text |
메일의 일반 텍스트 본문입니다. 이미지, 동영상 또는 웹페이지에 대한 첫 번째 링크는 미리보기 칩을 생성합니다. Google Chat 사용자를@멘션하거나 스페이스의 모든 사용자를 멘션할 수도 있습니다. 문자 메시지 작성에 대해 자세히 알아보려면 메시지 보내기를 참고하세요. |
formatted_text |
출력 전용입니다. 서식을 전달하기 위해 추가된 마크업이 있는
자세한 내용은 메일에 포함된 텍스트 서식 보기를 참고하세요. |
cards[] |
지원 중단됨: 대신 서식이 지정된 텍스트, 버튼, 클릭 가능한 이미지와 같은 UI 요소를 표시하는 데 사용할 수 있는 풍부한 포맷의 대화형 카드입니다. 카드는 일반적으로 메시지의 일반 텍스트 본문 아래에 표시됩니다. |
cards_v2[] |
카드의 배열입니다. 채팅 앱에서만 카드를 만들 수 있습니다. 채팅 앱이 사용자로 인증되는 경우 메시지에 카드를 포함할 수 없습니다. 카드가 포함된 메시지를 만드는 방법을 알아보려면 메시지 보내기를 참고하세요. 카드 빌더로 카드를 디자인하고 미리 봅니다. 카드 빌더 열기 |
annotations[] |
출력 전용입니다. 이 메시지의 |
thread |
메시지가 속한 대화목록입니다. 사용 예시는 메시지 대화목록 시작 또는 답장하기를 참고하세요. |
space |
|
fallback_text |
메시지 카드의 일반 텍스트 설명으로, 실제 카드를 표시할 수 없을 때 사용됩니다(예: 모바일 알림). |
action_response |
입력 전용입니다. 채팅 앱에서 응답이 게시되는 방식을 구성하는 데 사용할 수 있는 매개변수입니다. |
argument_text |
출력 전용입니다. 모든 채팅 앱 멘션이 삭제된 메시지의 일반 텍스트 본문입니다. |
slash_command |
출력 전용입니다. 슬래시 명령어 정보(해당하는 경우) |
attachment[] |
사용자가 업로드한 첨부파일입니다. |
matched_url |
출력 전용입니다. 링크 미리보기 패턴과 일치하는 |
thread_reply |
출력 전용입니다. 스페이스에서 대화목록 내 답장을 지원하지 않는 경우 이 입력란은 항상 |
client_assigned_message_id |
선택사항입니다. 메시지의 커스텀 ID입니다. 필드를 사용하여 메시지를 식별하거나, 메시지를 가져오거나, 삭제하거나, 업데이트할 수 있습니다. 맞춤 ID를 설정하려면 메시지를 만들 때 |
emoji_reaction_summaries[] |
출력 전용입니다. 메시지의 이모티콘 반응 요약 목록입니다. |
private_message_viewer |
변경할 수 없습니다. 메시지 만들기를 위한 입력입니다. 그렇지 않으면 출력 전용입니다. 메시지를 볼 수 있는 사용자입니다. 설정하면 메시지가 비공개로 설정되며 지정된 사용자와 채팅 앱에만 표시됩니다. 비공개 메시지에는 링크 미리보기 및 첨부파일이 지원되지 않습니다. Chat 앱에서만 비공개 메시지를 보낼 수 있습니다. 채팅 앱이 메시지를 보내기 위해 사용자로 인증하는 경우 메시지는 비공개로 설정할 수 없으며 이 입력란을 생략해야 합니다. 자세한 내용은 비공개로 메시지 보내기를 참고하세요. |
deletion_metadata |
출력 전용입니다. 삭제된 메일에 관한 정보입니다. |
quoted_message_metadata |
출력 전용입니다. 스페이스에서 Google Chat 사용자가 인용한 메시지에 관한 정보입니다. Google Chat 사용자는 메시지를 인용하여 답장할 수 있습니다. |
attached_gifs[] |
출력 전용입니다. 메일에 첨부된 GIF 이미지 |
accessory_widgets[] |
메시지 하단에 표시되는 하나 이상의 대화형 위젯입니다. 텍스트나 카드 또는 텍스트와 카드가 모두 포함된 메시지에 액세서리 위젯을 추가할 수 있습니다. 대화상자가 포함된 메시지에는 지원되지 않습니다. 자세한 내용은 메일 하단에 대화형 위젯 추가를 참고하세요. 액세서리 위젯으로 메시지를 만들려면 앱 인증이 필요합니다. |
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
리치 링크 유형입니다. 향후 더 많은 유형이 추가될 수 있습니다.
열거형 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
DRIVE_FILE |
Google Drive 리치 링크 유형입니다. |
CHAT_SPACE |
Chat 스페이스 리치 링크 유형입니다. 예를 들어 스페이스 스마트 칩이 있습니다. |
SearchSpacesRequest
쿼리를 기반으로 스페이스 목록 검색 요청입니다.
필드 | |
---|---|
use_admin_access |
전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
이 메서드는 현재 관리자 액세스만 지원하므로 이 필드에는 |
page_size |
반환할 최대 공백 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 100개의 공백이 반환됩니다. 최댓값은 1,000입니다. 1,000 이상의 값을 사용하면 1,000으로 자동 변경됩니다. |
page_token |
이전 검색 공간 호출에서 수신된 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나눌 때 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예상치 못한 결과가 발생할 수 있습니다. |
query |
필수 항목입니다. 검색어 다음 매개변수를 사용하여 검색할 수 있습니다.
여러 필드에서 동일한 필드 중에서 다음은 유효한 쿼리 예시입니다.
|
order_by |
선택사항입니다. 스페이스 목록이 정렬되는 방식입니다. 정렬 기준으로 지원되는 속성은 다음과 같습니다.
유효한 정렬 연산 값은 다음과 같습니다.
지원되는 구문은 다음과 같습니다.
|
SearchSpacesResponse
검색 공간 요청에 해당하는 스페이스 목록이 포함된 응답입니다.
필드 | |
---|---|
spaces[] |
요청된 스페이스의 페이지입니다. |
next_page_token |
다음 페이지를 검색하는 데 사용할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 표시되지 않습니다. |
total_size |
모든 페이지에서 검색어와 일치하는 총 공간 수입니다. 결과가 10,000개의 공간을 초과하는 경우 이 값은 추정치입니다. |
SetUpSpaceRequest
스페이스를 만들고 지정된 사용자를 스페이스에 추가하도록 요청합니다.
필드 | |
---|---|
space |
필수 항목입니다. 스페이스를 만들려면 그룹 채팅을 만들려면 사람 간에 1:1 대화를 만들려면 사람과 통화하는 채팅 앱 간에 1:1 대화를 만들려면
|
request_id |
선택사항입니다. 이 요청의 고유 식별자입니다. 임의의 UUID를 사용하는 것이 좋습니다. 기존 요청 ID를 지정하면 새 스페이스를 만드는 대신 해당 ID로 생성된 스페이스가 반환됩니다. 동일한 채팅 앱에서 인증된 다른 사용자가 있는 기존 요청 ID를 지정하면 오류가 반환됩니다. |
memberships[] |
선택사항입니다. 스페이스에 참여하도록 초대할 Google Chat 사용자 또는 그룹입니다. 호출하는 사용자는 자동으로 추가되므로 생략합니다. 현재는 발신자 외에 최대 20개의 멤버십을 허용합니다. 수동 멤버십의 경우 Google 그룹 멤버십의 경우
2개 이상의 멤버십과 함께 정확히 하나의 멤버십과 함께 실제 사용자로 사람과 통화 채팅 앱 간에 1:1 대화를 만드는 경우 ( |
SlashCommand
Google Chat의 슬래시 명령어
필드 | |
---|---|
command_id |
호출된 슬래시 명령어의 ID입니다. |
SlashCommandMetadata
슬래시 명령어의 주석 메타데이터 (/)입니다.
필드 | |
---|---|
bot |
명령어가 호출된 채팅 앱 |
type |
슬래시 명령어의 유형입니다. |
command_name |
호출된 슬래시 명령어의 이름입니다. |
command_id |
호출된 슬래시 명령어의 명령어 ID입니다. |
triggers_dialog |
슬래시 명령어가 대화상자에 사용되는지 여부를 나타냅니다. |
유형
열거형 | |
---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
ADD |
스페이스에 Chat 앱을 추가합니다. |
INVOKE |
스페이스에서 슬래시 명령어를 호출합니다. |
공백
Google Chat의 스페이스 스페이스는 두 명 이상의 사용자 간의 대화 또는 사용자와 Chat 앱 간의 1:1 메시지입니다.
필드 | |
---|---|
name |
스페이스의 리소스 이름입니다. 형식: 여기서 |
type |
출력 전용입니다. 지원 중단됨: 대신 |
space_type |
공간 유형입니다. 스페이스를 만들거나 스페이스의 스페이스 유형을 업데이트할 때 필요합니다. 다른 용도의 경우에만 출력 |
single_user_bot_dm |
선택사항입니다. 스페이스가 Chat 앱과 한 사람 간의 DM인지 여부입니다. |
threaded |
출력 전용입니다. 지원 중단됨: 대신 |
display_name |
스페이스의 표시 이름입니다. 스페이스를 만들 때 필요합니다. 스페이스를 만들거나 채팅 메시지의 경우 이 필드가 비어 있을 수 있습니다. 최대 128자(영문 기준)까지 지원됩니다. |
external_user_allowed |
변경할 수 없습니다. 이 스페이스에 Google Chat 사용자가 구성원으로 허용되는지 여부입니다. Google Workspace 조직에서 스페이스를 만들 때 입력합니다. 다음 조건에서 스페이스를 만들 때는 이 필드를 생략합니다.
기존 스페이스의 경우 이 필드는 출력 전용입니다. |
space_threading_state |
출력 전용입니다. Chat 스페이스의 대화목록 상태입니다. |
space_details |
설명 및 규칙을 포함한 스페이스 세부정보입니다. |
space_history_state |
이 스페이스에 있는 메시지 및 대화목록의 메시지 기록 상태입니다. |
import_mode |
선택사항입니다. Google Workspace로의 데이터 이전 과정에서 이 스페이스가 |
create_time |
선택사항입니다. 변경할 수 없습니다. Chat에서 만든 스페이스의 경우 스페이스가 생성된 시간입니다. 이 필드는 가져오기 모드 공간에서 사용되는 경우를 제외하고 출력 전용입니다. 가져오기 모드 스페이스의 경우 원래 생성 시간을 보존하기 위해 이 필드를 소스에서 스페이스가 생성된 이전 타임스탬프로 설정합니다.
|
last_active_time |
출력 전용입니다. 스페이스에 있는 마지막 메시지의 타임스탬프입니다. |
admin_installed |
출력 전용입니다. Chat 앱을 사용한 채팅 메시지 (DM) 스페이스의 경우, 스페이스가 Google Workspace 관리자가 만들었는지 여부 관리자는 조직의 사용자를 대신하여 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 그룹스만 스페이스에 액세스할 수 있습니다. 자세한 내용은 공유 대상 그룹이 검색할 수 있는 스페이스 만들기를 참고하세요. 형식: Google Workspace 조직의 기본 공유 대상 그룹을 사용하려면 |
AccessState
스페이스의 액세스 상태를 나타냅니다.
열거형 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
액세스 상태를 알 수 없거나 이 API에서 지원되지 않습니다. |
PRIVATE |
다른 사용자 또는 Google Workspace 관리자가 개별적으로 추가하거나 초대한 사용자 또는 Google 그룹스만 스페이스를 검색하고 액세스할 수 있습니다. |
DISCOVERABLE |
스페이스 관리자가 공유 대상 그룹에 스페이스에 대한 액세스 권한을 부여했습니다. 스페이스에 개별적으로 추가되거나 초대된 사용자 또는 Google 그룹도 스페이스를 검색하고 액세스할 수 있습니다. 자세한 내용은 특정 사용자가 검색할 수 있는 스페이스 만들기를 참고하세요. |
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
이름이 지정된 스페이스를 만들 때 지정할 수 있는 스페이스 권한 설정입니다. 향후 더 많은 설정이 추가될 수 있습니다. 이름이 지정된 스페이스의 권한 설정에 대한 자세한 내용은 스페이스에 대해 자세히 알아보기를 참고하세요.
열거형 | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
지정되지 않았습니다. 사용하지 마세요. |
COLLABORATION_SPACE |
스페이스를 모든 멤버가 메시지를 게시할 수 있는 공동작업 스페이스로 만들도록 설정 |
ANNOUNCEMENT_SPACE |
스페이스를 스페이스 관리자만 메시지를 게시할 수 있는 공지사항 스페이스로 설정하도록 설정 |
SpaceDetails
설명 및 규칙을 포함한 스페이스 세부정보입니다.
필드 | |
---|---|
description |
선택사항입니다. 스페이스에 대한 설명입니다. 예를 들어 스페이스의 토론 주제, 기능적 목적 또는 참여자를 설명할 수 있습니다. 최대 150자(영문 기준)까지 입력할 수 있습니다. |
guidelines |
선택사항입니다. 스페이스 규칙, 기대치, 에티켓 최대 5,000자(영문 기준)까지 입력할 수 있습니다. |
SpaceThreadingState
Chat 스페이스의 대화목록 상태 유형을 지정합니다.
열거형 | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
예약되었습니다. |
THREADED_MESSAGES |
메시지 대화목록을 지원하는 이름이 지정된 스페이스 사용자는 메시지에 답장할 때 대화목록 형식으로 답장할 수 있으므로 원본 메시지의 맥락에 따라 응답이 유지됩니다. |
GROUPED_MESSAGES |
대화가 주제별로 정리되는 이름이 지정된 스페이스입니다. 주제 및 주제에 대한 답글은 함께 그룹화됩니다. |
UNTHREADED_MESSAGES |
두 사람 간의 채팅 메시지 (DM) 및 3명 이상의 그룹 대화 |
SpaceType
공간 유형입니다. 스페이스를 만들거나 업데이트할 때 필요합니다. 다른 용도의 경우에만 출력
열거형 | |
---|---|
SPACE_TYPE_UNSPECIFIED |
예약되었습니다. |
SPACE |
메시지를 보내고 파일을 공유하며 공동작업할 수 있는 공간입니다. SPACE 에는 Chat 앱이 포함될 수 있습니다. |
GROUP_CHAT |
3명 이상의 사용자 간 그룹 대화 GROUP_CHAT 에는 Chat 앱이 포함될 수 있습니다. |
DIRECT_MESSAGE |
두 사람 또는 사람과 채팅 앱 간의 1:1 메시지 |
유형
지원 중단됨: 대신 SpaceType
를 사용하세요.
열거형 | |
---|---|
TYPE_UNSPECIFIED |
예약되었습니다. |
ROOM |
둘 이상의 사람이 나누는 대화입니다. |
DM |
사람과 채팅 앱 간의 1:1 채팅 메시지로, 모든 메시지가 평면입니다. 두 사람 간의 채팅 메시지는 여기에 포함되지 않습니다. |
SpaceBatchUpdatedEventData
하나의 스페이스에 대한 여러 업데이트에 대한 이벤트 페이로드입니다.
이벤트 유형: google.workspace.chat.space.v1.batchUpdated
필드 | |
---|---|
spaces[] |
업데이트된 스페이스 목록입니다. |
SpaceEvent
Google Chat 스페이스의 변경사항 또는 활동을 나타내는 이벤트입니다. 자세한 내용은 Google Chat에서 일정 작업하기를 참고하세요.
필드 | |
---|---|
name |
스페이스 이벤트의 리소스 이름입니다. 형식: |
event_time |
이벤트가 발생한 시간입니다. |
event_type |
스페이스 이벤트의 유형입니다. 각 이벤트 유형에는 단기간에 발생하는 여러 이벤트 유형의 인스턴스를 나타내는 일괄 버전이 있습니다. 메시지에 지원되는 이벤트 유형은 다음과 같습니다.
멤버십에 지원되는 이벤트 유형:
반응에 지원되는 이벤트 유형은 다음과 같습니다.
space에 대해 지원되는 이벤트 유형은 다음과 같습니다.
|
통합 필드
|
|
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 |
선택사항입니다. 스레드 생성 또는 업데이트를 위한 입력입니다. 그렇지 않으면 출력 전용입니다. 스레드의 ID입니다. 최대 4,000자(영문 기준)까지 지원됩니다. 이 ID는 이 ID를 설정하는 채팅 앱마다 고유합니다. 예를 들어 여러 채팅 앱에서 동일한 대화목록 키를 사용하여 메시지를 만드는 경우 메시지가 서로 다른 대화목록에 게시됩니다. 사용자 또는 다른 채팅 앱에서 만든 대화목록에서 답장하려면 스레드 |
ThreadReadState
대화목록 내 사용자의 읽은 상태로, 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다.
필드 | |
---|---|
name |
스레드 읽기 상태의 리소스 이름입니다. 형식: |
last_read_time |
사용자의 스레드 읽기 상태가 업데이트된 시간입니다. 일반적으로 대화목록에서 마지막으로 읽은 메시지의 타임스탬프에 해당합니다. |
UpdateMembershipRequest
멤버십 업데이트 요청 메시지입니다.
필드 | |
---|---|
membership |
필수 항목입니다. 업데이트할 멤버십입니다. |
update_mask |
필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값을 쉼표로 구분하거나 현재 지원되는 필드 경로는 다음과 같습니다.
|
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
UpdateMessageRequest
메시지 업데이트 요청입니다.
필드 | |
---|---|
message |
필수 항목입니다. 필드가 포함된 메시지가 업데이트되었습니다. |
update_mask |
필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값을 쉼표로 구분하거나 현재 지원되는 필드 경로는 다음과 같습니다. |
allow_missing |
선택사항입니다. |
UpdateSpaceReadStateRequest
UpdateSpaceReadState API 요청 메시지입니다.
필드 | |
---|---|
space_read_state |
필수 항목입니다. 업데이트할 스페이스 읽기 상태 및 필드입니다. 호출하는 사용자의 읽기 상태 업데이트만 지원합니다. 호출하는 사용자를 참조하려면 다음 중 하나를 설정하세요.
형식: users/{user}/spaces/{space}/spaceReadState |
update_mask |
필수 항목입니다. 업데이트할 필드 경로입니다. 현재 지원되는 필드 경로는 다음과 같습니다.
스페이스를 읽음으로 표시하려면 |
UpdateSpaceRequest
단일 스페이스 업데이트 요청입니다.
필드 | |
---|---|
space |
필수 항목입니다. 업데이트할 필드가 있는 스페이스입니다. |
update_mask |
필수 항목입니다. 업데이트된 필드 경로로, 여러 경로가 있는 경우 쉼표로 구분됩니다. 스페이스의 다음 필드를 업데이트할 수 있습니다.
|
use_admin_access |
true 인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
일부 |
사용자
Google Chat의 사용자입니다. 요청의 출력으로 반환되었을 때 채팅 앱이 사용자로 인증되면 User
리소스의 출력은 사용자의 name
및 type
만 채웁니다.
필드 | |
---|---|
name |
Google Chat 형식:
|
display_name |
출력 전용입니다. 사용자의 표시 이름 |
domain_id |
사용자의 Google Workspace 도메인의 고유 식별자입니다. |
type |
사용자 유형입니다. |
is_anonymous |
출력 전용입니다. |
유형
열거형 | |
---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 않습니다. |
HUMAN |
인간 사용자입니다. |
BOT |
채팅 앱 사용자입니다. |
UserMentionMetadata
사용자 멘션 (@)에 대한 주석 메타데이터입니다.
필드 | |
---|---|
user |
사용자가 언급했습니다. |
type |
사용자 멘션 유형입니다. |
유형
열거형 | |
---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
ADD |
스페이스에 사용자 추가 |
MENTION |
스페이스에서 사용자 멘션 |
WidgetMarkup
위젯은 텍스트와 이미지를 표시하는 UI 요소입니다.
필드 | |
---|---|
buttons[] |
버튼 목록입니다. 버튼도 |
통합 필드 data . WidgetMarkup 에는 다음 항목 중 하나만 포함할 수 있습니다. 여러 WidgetMarkup 필드를 사용하여 더 많은 항목을 표시할 수 있습니다. data 는 다음 중 하나여야 합니다. |
|
text_paragraph |
이 위젯에 텍스트 단락을 표시합니다. |
image |
이 위젯에 이미지를 표시합니다. |
key_value |
이 위젯에 키-값 항목을 표시합니다. |
버튼
버튼 텍스트 버튼 또는 이미지 버튼일 수 있습니다.
필드 | |
---|---|
통합 필드
|
|
text_button |
텍스트와 |
image_button |
이미지와 |
FormAction
양식 작업은 양식이 제출될 때의 동작을 설명합니다. 예를 들어 Apps Script를 호출하여 양식을 처리할 수 있습니다.
필드 | |
---|---|
action_method_name |
메서드 이름은 양식의 어느 부분이 양식 제출을 트리거했는지 식별하는 데 사용됩니다. 이 정보는 카드 클릭 이벤트의 일부로 채팅 앱에 다시 에코됩니다. 공통 동작을 트리거하는 여러 요소에 동일한 메서드 이름을 사용할 수 있습니다. |
parameters[] |
작업 매개변수 목록입니다. |
ActionParameter
작업 메서드가 호출될 때 제공할 문자열 매개변수의 목록입니다. 예를 들어 '지금 다시 알림', '하루에 다시 알림', '다음 주에 다시 알림' 등 세 가지 일시중지 버튼이 있다고 가정해 보겠습니다. action method = snooze()
를 사용하여 문자열 매개변수 목록에 다시 알림 유형과 일시중지 시간을 전달할 수 있습니다.
필드 | |
---|---|
key |
작업 스크립트의 매개변수 이름입니다. |
value |
매개변수의 값입니다. |
아이콘
지원되는 아이콘 집합입니다.
열거형 | |
---|---|
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 |
Chat API에서 제공하는 아이콘의 색인을 생성하는 |
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 . top_label 및 bottom_label 아이콘 중 하나 이상이 정의되어야 합니다. icons 는 다음 중 하나여야 합니다. |
|
icon |
Chat API에 의해 상응하는 아이콘 이미지로 대체되는 열거형 값입니다. |
icon_url |
URL로 지정된 아이콘입니다. |
통합 필드 control . 컨트롤 위젯 button 또는 switch_widget 중 하나를 설정할 수 있지만 둘 다 설정할 수는 없습니다. control 는 다음 중 하나여야 합니다. |
|
button |
클릭하여 작업을 트리거할 수 있는 버튼입니다. |
OnClick
onclick
작업 (예: 링크 열기)
필드 | |
---|---|
통합 필드
|
|
action |
지정된 경우 이 |
open_link |
지정된 경우 이 |
OpenLink
새 창을 여는 링크
필드 | |
---|---|
url |
열려는 URL입니다. |
TextButton
텍스트와 onclick
작업이 있는 버튼
필드 | |
---|---|
text |
버튼의 텍스트입니다. |
on_click |
버튼의 |
TextParagraph
텍스트의 단락입니다. 서식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.
필드 | |
---|---|
text |
|