색인
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
(메시지)CreateCustomEmojiRequest
(메시지)CreateMembershipRequest
(메시지)CreateMessageRequest
(메시지)CreateMessageRequest.MessageReplyOption
(열거형)CreateReactionRequest
(메시지)CreateSpaceRequest
(메시지)CustomEmoji
(메시지)CustomEmoji.CustomEmojiPayload
(메시지)DeleteCustomEmojiRequest
(메시지)DeleteMembershipRequest
(메시지)DeleteMessageRequest
(메시지)DeleteReactionRequest
(메시지)DeleteSpaceRequest
(메시지)DeletionMetadata
(메시지)DeletionMetadata.DeletionType
(열거형)Dialog
(메시지)DialogAction
(메시지)DriveDataRef
(메시지)DriveLinkData
(메시지)Emoji
(메시지)EmojiReactionSummary
(메시지)FindDirectMessageRequest
(메시지)GetAttachmentRequest
(메시지)GetCustomEmojiRequest
(메시지)GetMembershipRequest
(메시지)GetMessageRequest
(메시지)GetSpaceEventRequest
(메시지)GetSpaceNotificationSettingRequest
(메시지)GetSpaceReadStateRequest
(메시지)GetSpaceRequest
(메시지)GetThreadReadStateRequest
(메시지)Group
(메시지)HistoryState
(열거형)ListCustomEmojisRequest
(메시지)ListCustomEmojisResponse
(메시지)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
(메시지)SpaceNotificationSetting
(메시지)SpaceNotificationSetting.MuteSetting
(열거형)SpaceNotificationSetting.NotificationSetting
(열거형)SpaceReadState
(메시지)SpaceUpdatedEventData
(메시지)Thread
(메시지)ThreadReadState
(메시지)UpdateMembershipRequest
(메시지)UpdateMessageRequest
(메시지)UpdateSpaceNotificationSettingRequest
(메시지)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 Platform에서 Chat 앱과 통합을 빌드할 수 있도록 지원합니다.
CompleteImportSpace |
---|
지정된 스페이스의 가져오기 프로세스를 완료하고 사용자에게 표시합니다. 앱 인증 및 도메인 전체 위임이 필요합니다. 자세한 내용은 Google Chat 앱이 데이터를 가져오도록 승인하기를 참고하세요.
|
CreateCustomEmoji |
---|
사용자 인증이 필요합니다.
|
CreateMembership |
---|
호출하는 Chat 앱, 사용자 또는 Google 그룹의 멤버십을 만듭니다. 다른 Chat 앱의 멤버십을 만드는 작업은 지원되지 않습니다. 멤버십을 만들 때 지정된 회원의 자동 수락 정책이 사용 중지된 경우 초대를 받게 되며, 초대를 수락해야만 스페이스에 참여할 수 있습니다. 그렇지 않으면 멤버십을 만들면 지정된 스페이스에 구성원이 직접 추가됩니다. 다음 유형의 인증을 지원합니다. 사용 예시는 다음을 참고하세요.
|
CreateMessage |
---|
Google Chat 스페이스에 메시지를 만듭니다. 예를 보려면 메시지 보내기를 참고하세요.
다음 이미지는 앱 인증을 사용할 때 Chat에서 메시지에 속성을 부여하는 방법을 보여줍니다. Chat에서는 Chat 앱을 메시지 발신자로 표시합니다. 메시지 콘텐츠에는 텍스트 ( 다음 이미지는 사용자 인증을 사용할 때 Chat에서 메시지에 속성을 부여하는 방법을 보여줍니다. Chat은 사용자를 메시지 발신자로 표시하고 Chat 앱의 이름을 표시하여 메시지에 Chat 앱의 속성을 부여합니다. 메시지 콘텐츠에는 텍스트 ( 메일 내용을 포함한 최대 메일 크기는 32,000바이트입니다.
|
CreateReaction |
---|
리액션을 만들고 메시지에 추가합니다. 유니코드 그림 이모티콘만 지원됩니다. 예를 보려면 메시지에 반응 추가하기를 참고하세요. 사용자 인증이 필요합니다.
|
CreateSpace |
---|
스페이스를 만듭니다. 이름이 지정된 스페이스 또는 다음 유형의 인증을 지원합니다. 앱으로 인증할 때는 요청에 생성 시 스페이스 멤버십은 스페이스가
스페이스를 만들 때
|
DeleteCustomEmoji |
---|
사용자 인증이 필요합니다.
|
DeleteMembership |
---|
멤버십을 삭제합니다. 예를 보려면 스페이스에서 사용자 또는 Google Chat 앱 삭제하기를 참고하세요. 다음 유형의 인증을 지원합니다.
|
DeleteMessage |
---|
메시지를 삭제합니다. 예를 보려면 메시지 삭제를 참고하세요. 다음 유형의 인증을 지원합니다. 앱 인증을 사용하는 경우 요청은 호출하는 Chat 앱에서 만든 메시지만 삭제할 수 있습니다.
|
DeleteReaction |
---|
메시지에 대한 반응을 삭제합니다. 유니코드 그림 이모티콘만 지원됩니다. 예를 보려면 리액션 삭제를 참고하세요. 사용자 인증이 필요합니다.
|
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 |
---|
호출자가 속한 스페이스를 나열합니다. 그룹 채팅 및 채팅 메시지는 첫 번째 메시지가 전송될 때까지 표시되지 않습니다. 예를 보려면 스페이스 목록을 참고하세요. 다음 유형의 인증을 지원합니다. Google Workspace 조직의 이름이 지정된 모든 스페이스를 나열하려면 대신 Workspace 관리자 권한을 사용하는
|
SearchSpaces |
---|
관리자의 검색어를 기반으로 Google Workspace 조직의 스페이스 목록을 반환합니다. 관리자 권한이 있는 사용자 인증이 필요합니다. 요청에서
|
SetUpSpace |
---|
스페이스를 만들고 지정된 사용자를 추가합니다. 호출하는 사용자는 스페이스에 자동으로 추가되며 요청에서 멤버십으로 지정해서는 안 됩니다. 예를 보려면 초기 구성원이 있는 스페이스 설정하기를 참고하세요. 추가할 실제 사용자를 지정하려면 적절한 추가할 Google 그룹을 지정하려면 적절한 이름이 지정된 스페이스 또는 그룹 채팅의 경우 호출자가 일부 참여자를 차단하거나 일부 참여자에 의해 차단되었거나 일부 참여자를 추가할 권한이 없는 경우 해당 참여자는 생성된 스페이스에 추가되지 않습니다. 호출 사용자와 다른 실제 사용자 간에 채팅 메시지 (DM)를 만들려면 실제 사용자를 나타내는 멤버십을 정확히 하나 지정합니다. 한 사용자가 다른 사용자를 차단하면 요청이 실패하고 DM이 생성되지 않습니다. 호출 사용자와 호출 앱 간에 채팅 메시지를 만들려면 두 사용자 간에 이미 DM이 있는 경우 요청 시 한 사용자가 다른 사용자를 차단하더라도 기존 DM이 반환됩니다. 대화목록 답글이 있는 스페이스는 지원되지 않습니다. 스페이스를 설정할 때 사용자 인증이 필요합니다.
|
UpdateMembership |
---|
멤버십을 업데이트합니다. 예를 보려면 스페이스에서 사용자 멤버십 업데이트를 참고하세요. 다음 유형의 인증을 지원합니다.
|
UpdateMessage |
---|
메시지를 업데이트합니다. 다음 유형의 인증을 지원합니다. 앱 인증을 사용하는 경우 요청은 호출하는 Chat 앱에서 만든 메시지만 업데이트할 수 있습니다.
|
UpdateSpace |
---|
스페이스를 업데이트합니다. 예시는 스페이스 업데이트를 참고하세요.
다음 유형의 인증을 지원합니다.
|
UpdateSpaceNotificationSetting |
---|
사용자 인증이 필요합니다.
|
UpdateSpaceReadState |
---|
스페이스 내에서 사용자의 읽음 상태를 업데이트합니다. 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예를 보려면 사용자의 스페이스 읽기 상태 업데이트를 참고하세요. 사용자 인증이 필요합니다.
|
AccessoryWidget
메시지 하단에 표시되는 하나 이상의 양방향 위젯입니다. 자세한 내용은 메일 하단에 양방향 위젯 추가하기를 참고하세요.
필드 | |
---|---|
통합 필드 action . 작업 유형입니다. action 은 다음 중 하나여야 합니다. |
|
button_ |
버튼 목록입니다. |
ActionResponse
Chat 앱에서 응답 게시 방법을 구성하는 데 사용할 수 있는 매개변수입니다.
필드 | |
---|---|
type |
입력 전용입니다. Chat 앱 응답 유형입니다. |
url |
입력 전용입니다. 사용자가 인증하거나 구성할 수 있는 URL입니다. ( |
dialog_ |
입력 전용입니다. 대화상자와 관련된 상호작용 이벤트에 대한 응답입니다. |
updated_ |
입력 전용입니다. 업데이트된 위젯의 응답입니다. |
ResponseType
Chat 앱 응답 유형입니다.
열거형 | |
---|---|
TYPE_UNSPECIFIED |
NEW_MESSAGE 로 처리되는 기본 유형입니다. |
NEW_MESSAGE |
주제에 새 메시지로 게시합니다. |
UPDATE_MESSAGE |
Chat 앱의 메시지를 업데이트합니다. 이는 메시지 발신자 유형이 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_ |
상태 코드입니다. |
user_ |
사용자에게 요청 상태에 관한 메시지입니다. 설정하지 않으면 |
Annotation
출력 전용입니다. 메시지의 일반 텍스트 본문과 연결된 주석입니다. 문자 메시지에 기본 서식을 추가하려면 문자 메시지 서식 지정을 참고하세요.
일반 텍스트 메시지 본문의 예:
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부터 시작, 양 끝값 포함)입니다. |
통합 필드 metadata . 주석에 관한 추가 메타데이터입니다. metadata 은 다음 중 하나여야 합니다. |
|
user_ |
사용자 멘션의 메타데이터입니다. |
slash_ |
슬래시 명령어의 메타데이터입니다. |
rich_ |
리치 링크의 메타데이터입니다. |
AnnotationType
주석의 유형입니다.
열거형 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
USER_MENTION |
사용자가 언급됩니다. |
SLASH_COMMAND |
슬래시 명령어가 호출됩니다. |
RICH_LINK |
리치 링크 주석 |
AttachedGif
URL로 지정된 GIF 이미지입니다.
필드 | |
---|---|
uri |
출력 전용입니다. GIF 이미지를 호스팅하는 URL입니다. |
첨부파일
Google Chat의 첨부파일
필드 | |
---|---|
name |
선택사항입니다. |
content_ |
출력 전용입니다. 전체 경로가 아닌 콘텐츠의 원본 파일 이름입니다. |
content_ |
출력 전용입니다. 파일의 콘텐츠 유형 (MIME 유형)입니다. |
thumbnail_ |
출력 전용입니다. 사람 사용자에게 첨부파일을 미리 볼 때 사용해야 하는 썸네일 URL입니다. 채팅 앱은 이 URL을 사용하여 첨부파일 콘텐츠를 다운로드해서는 안 됩니다. |
download_ |
출력 전용입니다. 사람이 첨부파일을 다운로드할 수 있도록 허용하기 위해 사용해야 하는 다운로드 URL입니다. 채팅 앱은 이 URL을 사용하여 첨부파일 콘텐츠를 다운로드해서는 안 됩니다. |
source |
출력 전용입니다. 첨부파일의 소스입니다. |
통합 필드 data_ref . 첨부파일의 데이터 참조입니다. data_ref 은 다음 중 하나여야 합니다. |
|
attachment_ |
선택사항입니다. 첨부파일 데이터 참조입니다. 이 필드는 첨부파일이 있는 메시지를 만들거나 업데이트하거나, media API를 사용하여 첨부파일 데이터를 다운로드하는 데 사용됩니다. |
drive_ |
출력 전용입니다. Google Drive 첨부파일에 대한 참조입니다. 이 필드는 Google Drive API와 함께 사용됩니다. |
소스
첨부파일의 소스입니다.
열거형 | |
---|---|
SOURCE_UNSPECIFIED |
예약됨 |
DRIVE_FILE |
파일이 Google Drive 파일입니다. |
UPLOADED_CONTENT |
파일이 Chat에 업로드됩니다. |
AttachmentDataRef
첨부파일 데이터 참조입니다.
필드 | |
---|---|
resource_ |
선택사항입니다. 첨부파일 데이터의 리소스 이름입니다. 이 필드는 media API와 함께 사용하여 첨부파일 데이터를 다운로드하는 데 사용됩니다. |
attachment_ |
선택사항입니다. 업로드된 첨부파일에 대한 참조가 포함된 불투명 토큰입니다. 클라이언트에서 불투명 문자열로 취급되며 첨부파일이 있는 Chat 메시지를 만들거나 업데이트하는 데 사용됩니다. |
CardWithId
Google Chat 메시지의 카드
Chat 앱만 카드를 만들 수 있습니다. Chat 앱이 사용자로 인증하는 경우 메일에 카드를 포함할 수 없습니다.
카드 작성 도구로 카드를 디자인하고 미리보기를 확인합니다.
카드 빌더 열기필드 | |
---|---|
card_ |
메일에 여러 개의 카드가 포함된 경우 필수입니다. 메시지의 카드에 대한 고유 식별자입니다. |
card |
카드 최대 크기는 32KB입니다. |
ChatSpaceLinkData
Chat 스페이스 링크의 데이터입니다.
필드 | |
---|---|
space |
연결된 Chat 스페이스 리소스의 스페이스입니다. 형식: |
thread |
연결된 Chat 스페이스 리소스의 대화목록입니다. 형식: |
message |
연결된 Chat 스페이스 리소스의 메시지입니다. 형식: |
CompleteImportSpaceRequest
스페이스의 가져오기 프로세스 완료를 요청하는 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 가져오기 모드 스페이스의 리소스 이름입니다. 형식: |
CompleteImportSpaceResponse
스페이스 가져오기 프로세스 완료에 대한 응답 메시지입니다.
필드 | |
---|---|
space |
가져오기 모드 스페이스입니다. |
ContextualAddOnMarkup
이 유형에는 필드가 없습니다.
개발자가 문맥 AddOn의 콘텐츠를 지정할 수 있는 마크업입니다.
카드
카드는 텍스트 및 이미지와 같은 UI 위젯을 포함할 수 있는 UI 요소입니다.
필드 | |
---|---|
header |
카드의 헤더입니다. 헤더에는 일반적으로 제목과 이미지가 포함됩니다. |
sections[] |
섹션은 선 구분자로 구분됩니다. |
card_ |
이 카드의 작업입니다. |
name |
카드 이름입니다. |
CardAction
카드 작업은 카드와 연결된 작업입니다. 인보이스 카드의 일반적인 작업은 인보이스를 삭제하거나, 인보이스를 이메일로 보내거나, 브라우저에서 인보이스를 여는 것입니다.
Google Chat 앱에서는 지원되지 않습니다.
필드 | |
---|---|
action_ |
작업 메뉴 항목에 표시되던 라벨입니다. |
on_ |
이 작업 항목의 onclick 작업입니다. |
CardHeader
필드 | |
---|---|
title |
제목을 지정해야 합니다. 헤더의 높이는 고정되어 있습니다. 제목과 부제목이 모두 지정된 경우 각각 한 줄을 차지합니다. 제목만 지정하면 두 줄을 모두 차지합니다. |
subtitle |
카드 헤더의 부제입니다. |
image_ |
이미지 유형 (예: 정사각형 테두리 또는 원형 테두리)입니다. |
image_ |
카드 헤더의 이미지 URL입니다. |
ImageStyle
열거형 | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
정사각형 테두리 |
AVATAR |
원형 테두리 |
섹션
섹션에는 지정된 순서대로 (세로로) 렌더링되는 위젯 모음이 포함됩니다. 모든 플랫폼에서 카드의 너비는 좁고 고정되어 있으므로 현재 레이아웃 속성 (예: 플로팅)이 필요하지 않습니다.
필드 | |
---|---|
header |
섹션의 헤더입니다. 서식이 지정된 텍스트는 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요. |
widgets[] |
섹션에는 위젯이 하나 이상 포함되어야 합니다. |
CreateCustomEmojiRequest
맞춤 이모티콘을 만들기 위한 요청입니다.
필드 | |
---|---|
custom_ |
필수 항목입니다. 만들 맞춤 이모티콘입니다. |
CreateMembershipRequest
멤버십 생성을 위한 요청 메시지입니다.
필드 | |
---|---|
parent |
필수 항목입니다. 멤버십을 만들 스페이스의 리소스 이름입니다. 형식: spaces/{space} |
membership |
필수 항목입니다. 만들 멤버십 관계입니다.
Chat 앱이 사람 사용자의 멤버십 관계를 만들 때는 특정 승인 범위를 사용하고 특정 필드에 특정 값을 설정해야 합니다.
스페이스를 소유한 Workspace 조직 외부의 사용자를 초대하려면 사용자 인증이 필요합니다. Chat 앱이 자체 멤버십 관계를 만들 때는 사용자로 인증하고 |
use_ |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스를 사용하여 관리자의 Google Workspace 조직 외부의 사용자를 위한 앱 멤버십을 만들거나 멤버십을 만들 수는 없습니다. |
CreateMessageRequest
메시지를 만듭니다.
필드 | |
---|---|
parent |
필수 항목입니다. 메시지를 만들 스페이스의 리소스 이름입니다. 형식: |
message |
필수 항목입니다. 메시지 본문입니다. |
thread_key |
선택사항입니다. 지원 중단됨: 대신 |
request_ |
선택사항입니다. 이 메시지의 고유한 요청 ID입니다. 기존 요청 ID를 지정하면 새 메시지를 만드는 대신 해당 ID로 생성된 메시지가 반환됩니다. |
message_ |
선택사항입니다. 메시지가 대화목록을 시작하는지 또는 대화목록에 답장하는지 지정합니다. 이름이 지정된 스페이스에서만 지원됩니다. 사용자 상호작용에 응답할 때는 이 필드가 무시됩니다. 대화목록 내 상호작용의 경우 답글이 동일한 대화목록에 생성됩니다. 그렇지 않으면 답장이 새 대화목록으로 생성됩니다. |
message_ |
선택사항입니다. 메시지의 맞춤 ID입니다. Chat 앱이 메시지의 리소스 이름 (메시지 이 필드의 값은 다음 요구사항을 충족해야 합니다.
자세한 내용은 메시지 이름 지정하기를 참고하세요. |
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_ |
선택사항입니다. 이 요청의 고유 식별자입니다. 임의의 UUID를 사용하는 것이 좋습니다. 기존 요청 ID를 지정하면 새 스페이스를 만드는 대신 해당 ID로 생성된 스페이스가 반환됩니다. 인증된 사용자가 다른 동일한 Chat 앱에서 기존 요청 ID를 지정하면 오류가 반환됩니다. |
CustomEmoji
맞춤 이모티콘을 나타냅니다.
필드 | |
---|---|
name |
식별자. 서버에서 할당한 맞춤 이모티콘의 리소스 이름입니다. 형식: |
uid |
출력 전용입니다. 맞춤 그림 이모티콘 리소스의 고유 키입니다. |
emoji_ |
선택사항입니다. 변경할 수 없습니다. 조직 내에서 고유한 맞춤 이모티콘의 사용자 제공 이름입니다. 맞춤 이모티콘이 생성될 때 필요하며 그 외의 경우에는 출력만 합니다. 그림 이모티콘 이름은 콜론으로 시작하고 끝내야 하며 소문자여야 하며 영숫자 문자, 하이픈, 밑줄만 포함할 수 있습니다. 하이픈 및 밑줄은 단어를 구분할 때 사용할 수 있으며 연속으로 사용할 수 없습니다. 예: |
temporary_ |
출력 전용입니다. 맞춤 이모티콘의 이미지 URL로, 10분 이상 유효합니다. 맞춤 이모티콘이 생성될 때는 응답에 채워지지 않습니다. |
payload |
선택사항입니다. 입력 전용입니다. 페이로드 데이터 맞춤 이모티콘을 만들 때 필요합니다. |
CustomEmojiPayload
맞춤 이모티콘의 페이로드 데이터입니다.
필드 | |
---|---|
file_ |
필수 항목입니다. 입력 전용입니다. 맞춤 이모티콘에 사용된 이미지입니다. 페이로드는 256KB 미만이어야 하며 이미지의 크기는 64~500픽셀이어야 합니다. 제한사항은 변경될 수 있습니다. |
filename |
필수 항목입니다. 입력 전용입니다. 이미지 파일 이름입니다. 지원되는 파일 확장자: |
DeleteCustomEmojiRequest
맞춤 이모티콘 삭제 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 맞춤 그림 이모티콘의 리소스 이름입니다. 형식: 그림 이모티콘 이름을 |
DeleteMembershipRequest
스페이스의 멤버십 삭제 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 멤버십의 리소스 이름입니다. 채팅 앱은 사람 사용자 또는 자체 멤버십을 삭제할 수 있습니다. 채팅 앱은 다른 앱의 멤버십을 삭제할 수 없습니다. 사용자 멤버십을 삭제할 때는 앱 멤버십을 삭제할 때는 형식: |
use_ |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스를 사용하여 스페이스에서 앱 멤버십을 삭제할 수는 없습니다. |
DeleteMessageRequest
메시지 삭제 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 메시지의 리소스 이름입니다. 형식: 메시지에 맞춤 ID를 설정한 경우 |
force |
선택사항입니다. |
DeleteReactionRequest
메시지에 대한 반응을 삭제합니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 리액션의 이름입니다. 형식: |
DeleteSpaceRequest
스페이스 삭제 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 삭제할 스페이스의 리소스 이름입니다. 형식: |
use_ |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
DeletionMetadata
삭제된 메일에 대한 정보입니다. delete_time
가 설정되면 메시지가 삭제됩니다.
필드 | |
---|---|
deletion_ |
메시지를 삭제한 사용자를 나타냅니다. |
DeletionType
메시지를 삭제한 사용자와 삭제 방법 향후 더 많은 값이 추가될 수 있습니다.
열거형 | |
---|---|
DELETION_TYPE_UNSPECIFIED |
이 값은 사용되지 않습니다. |
CREATOR |
사용자가 자신의 메시지를 삭제했습니다. |
SPACE_OWNER |
스페이스 소유자가 메시지를 삭제했습니다. |
ADMIN |
Google Workspace 관리자가 메시지를 삭제했습니다. |
APP_MESSAGE_EXPIRY |
Chat 앱이 만료 시 자체 메시지를 삭제했습니다. |
CREATOR_VIA_APP |
Chat 앱에서 사용자를 대신하여 메시지를 삭제했습니다. |
SPACE_OWNER_VIA_APP |
Chat 앱에서 스페이스 소유자를 대신하여 메시지를 삭제했습니다. |
Dialog
대화상자의 카드 본문을 둘러싸는 래퍼입니다.
필드 | |
---|---|
body |
입력 전용입니다. 모달에서 렌더링되는 대화상자 본문입니다. Google Chat 앱은 |
DialogAction
대화상자 및 요청 상태 코드가 포함됩니다.
필드 | |
---|---|
action_ |
입력 전용입니다. 대화상자를 호출하거나 제출하기 위한 요청의 상태입니다. 필요한 경우 사용자에게 상태 및 메시지를 표시합니다. 예를 들어 오류 또는 성공의 경우 |
통합 필드 action . 실행할 작업입니다. action 은 다음 중 하나여야 합니다. |
|
dialog |
입력 전용입니다. 요청의 대화상자입니다. |
DriveDataRef
Drive 첨부파일의 데이터에 대한 참조입니다.
필드 | |
---|---|
drive_ |
Drive 파일의 ID입니다. Drive API와 함께 사용합니다. |
DriveLinkData
Google Drive 링크의 데이터입니다.
필드 | |
---|---|
drive_ |
Google Drive 파일을 참조하는 DriveDataRef입니다. |
mime_ |
연결된 Google Drive 리소스의 mime 유형입니다. |
그림 이모티콘
메시지에 대한 반응으로 사용되는 이모티콘입니다.
필드 | |
---|---|
통합 필드 content . 필수 항목입니다. 이모티콘의 콘텐츠입니다. content 은 다음 중 하나여야 합니다. |
|
unicode |
선택사항입니다. 유니코드 문자열로 표현되는 기본 이모티콘입니다. |
custom_ |
출력 전용입니다. 맞춤 이모티콘 |
EmojiReactionSummary
메시지에 특정 그림 이모티콘으로 반응한 사용자 수입니다.
필드 | |
---|---|
emoji |
출력 전용입니다. 반응과 연결된 그림 이모티콘입니다. |
reaction_ |
출력 전용입니다. 연결된 그림 이모티콘을 사용한 총 리액션 수입니다. |
FindDirectMessageRequest
사용자 리소스를 기반으로 채팅 메시지 스페이스를 가져오기 위한 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 채팅 메시지를 찾을 사용자의 리소스 이름입니다. 형식: |
GetAttachmentRequest
첨부파일 가져오기 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. |
GetCustomEmojiRequest
단일 맞춤 그림 이모티콘을 반환하도록 요청합니다.
필드 | |
---|---|
name |
필수 항목입니다. 맞춤 이모티콘의 리소스 이름입니다. 형식: 그림 이모티콘 이름을 |
GetMembershipRequest
스페이스 멤버십 가져오기 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 검색할 멤버십의 리소스 이름입니다. 사용자 인증을 사용하여 앱 자체 멤버십을 가져오려면 원하는 경우 형식: 사용자의 이메일을 |
use_ |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스를 사용하는 경우 스페이스에서 앱 멤버십을 가져오는 기능은 지원되지 않습니다. |
GetMessageRequest
메시지 가져오기 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 메시지의 리소스 이름입니다. 형식: 메시지에 맞춤 ID를 설정한 경우 |
GetSpaceEventRequest
스페이스 이벤트 가져오기 요청 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 스페이스 이벤트의 리소스 이름입니다. 형식: |
GetSpaceNotificationSettingRequest
스페이스 알림 설정을 가져오기 위한 메시지 요청입니다. 호출하는 사용자의 알림 설정만 가져올 수 있습니다.
필드 | |
---|---|
name |
필수 항목입니다. 형식: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
GetSpaceReadState API의 요청 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 검색할 스페이스 읽기 상태의 리소스 이름입니다. 호출하는 사용자의 읽기 상태만 가져옵니다. 호출 사용자를 참조하려면 다음 중 하나를 설정합니다.
형식: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
단일 공백을 반환하는 요청입니다.
필드 | |
---|---|
name |
필수 항목입니다. 형식: |
use_ |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
GetThreadReadStateRequest
GetThreadReadStateRequest API의 요청 메시지입니다.
필드 | |
---|---|
name |
필수 항목입니다. 검색할 스레드 읽기 상태의 리소스 이름입니다. 호출하는 사용자의 읽기 상태만 가져옵니다. 호출 사용자를 참조하려면 다음 중 하나를 설정합니다.
형식: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
그룹
Google Chat의 Google 그룹
필드 | |
---|---|
name |
Google 그룹의 리소스 이름입니다. Cloud Identity Groups API에서 그룹을 나타냅니다. 형식: groups/{group} |
HistoryState
메시지 및 스페이스의 기록 상태입니다. 메시지 및 대화목록이 생성된 후 보관되는 기간을 지정합니다.
열거형 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
기본값 사용하지 마세요. |
HISTORY_OFF |
기록이 사용 중지되어 있습니다. 메시지 및 대화목록은 24시간 동안 보관됩니다. |
HISTORY_ON |
대화 기록이 사용 설정됨 조직의 Vault 보관 규칙에 따라 메일 및 대화목록이 보관되는 기간이 지정됩니다. |
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 관리자여야 합니다.
관리 액세스를 사용하는 경우 스페이스에 앱 멤버십을 표시할 수 없습니다. |
ListMembershipsResponse
스페이스 멤버십을 나열하는 응답입니다.
필드 | |
---|---|
memberships[] |
순서가 지정되지 않은 목록 요청된 페이지 (또는 첫 번째 페이지)의 멤버십 목록입니다. |
next_ |
결과의 다음 페이지를 검색하기 위해 |
ListMessagesRequest
사용자가 속한 지정된 스페이스의 메시지를 나열합니다.
필드 | |
---|---|
parent |
필수 항목입니다. 메시지를 표시할 스페이스의 리소스 이름입니다. 형식: |
page_ |
선택사항입니다. 반환되는 최대 메시지 수입니다. 서비스가 이 값보다 적은 메시지를 반환할 수 있습니다. 지정하지 않으면 최대 25개가 반환됩니다. 최대 값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다. 음수 값은 |
page_ |
선택사항입니다. 이전 list messages 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 가져오려면 이 매개변수를 제공합니다. 페이지로 나누는 경우, 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 날짜 ( 생성 날짜별로 메시지를 필터링하려면 RFC-3339 형식의 타임스탬프와 따옴표로 묶인 대화목록별로 필터링하려면 스레드와 날짜를 모두 기준으로 필터링하려면 쿼리에서 예를 들어 다음 쿼리는 유효합니다.
잘못된 쿼리는 서버에서 |
order_ |
선택사항입니다. 메시지 목록의 순서입니다. 정렬 작업에 따라 정렬할 값을 지정합니다. 유효한 순서 지정 작업 값은 다음과 같습니다.
기본 순서는 |
show_ |
선택사항입니다. 삭제된 메시지를 포함할지 여부입니다. 삭제된 메일에는 삭제 시간과 삭제에 관한 메타데이터가 포함되지만 메시지 콘텐츠는 사용할 수 없습니다. |
ListMessagesResponse
메시지 목록에 대한 응답 메시지입니다.
필드 | |
---|---|
messages[] |
메시지 목록 |
next_ |
토큰을 |
ListReactionsRequest
메시지에 대한 반응을 표시합니다.
필드 | |
---|---|
parent |
필수 항목입니다. 사용자가 반응한 메시지입니다. 형식: |
page_ |
선택사항입니다. 반환된 최대 리액션 수입니다. 서비스는 이 값보다 적은 리액션을 반환할 수 있습니다. 지정하지 않으면 기본값은 25입니다. 최댓값은 200이며, 200을 초과하는 값은 200으로 변경됩니다. |
page_ |
선택사항입니다. (이전 쿼리에서 재개하는 경우) 이전 list reactions 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 이모티콘 ( 여러 이모티콘 또는 사용자의 반응을 필터링하려면 이모티콘 및 사용자별로 반응을 필터링하려면 쿼리에서 예를 들어 다음 쿼리는 유효합니다.
다음 쿼리는 유효하지 않습니다.
잘못된 쿼리는 서버에서 |
ListReactionsResponse
리액션 목록 요청에 대한 응답입니다.
필드 | |
---|---|
reactions[] |
요청된 페이지 (또는 첫 번째 페이지)의 리액션 목록입니다. |
next_ |
결과의 다음 페이지를 가져오는 연속 토큰입니다. 결과의 마지막 페이지에는 비어 있습니다. |
ListSpaceEventsRequest
등록정보 공간 이벤트 요청 메시지입니다.
필드 | |
---|---|
parent |
필수 항목입니다. 이벤트가 발생한 Google Chat 스페이스의 리소스 이름입니다. 형식: |
page_ |
선택사항입니다. 반환된 최대 스페이스 이벤트 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 음수 값은 |
page_ |
선택사항입니다. 이전 list space events 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, 공간 이벤트 목록에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
필수 항목입니다. 쿼리 필터입니다. has 원하는 경우 시작 시간 (
시작 시간 또는 종료 시간을 지정하려면 RFC-3339의 등호 예를 들어 다음 쿼리는 유효합니다.
다음 쿼리는 유효하지 않습니다.
잘못된 쿼리는 서버에서 |
ListSpaceEventsResponse
스페이스 이벤트를 나열하기 위한 응답 메시지입니다.
필드 | |
---|---|
space_ |
결과는 시간순으로 반환됩니다 (가장 오래된 이벤트부터 먼저 반환됨). 참고: 목록 요청의 경우 스페이스 객체에 |
next_ |
더 많은 이벤트를 가져오는 데 사용되는 연속 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다. |
ListSpacesRequest
호출자가 참여 중인 스페이스를 나열해 달라는 요청입니다.
필드 | |
---|---|
page_ |
선택사항입니다. 반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 100개의 스페이스가 반환됩니다. 최대 값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다. 음수 값은 |
page_ |
선택사항입니다. 이전 list spaces 호출에서 받은 페이지 토큰입니다. 후속 페이지를 가져오려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 스페이스 유형 ( 스페이스 유형으로 필터링하려면 예를 들어 다음 쿼리는 유효합니다.
잘못된 쿼리는 서버에서 |
ListSpacesResponse
스페이스 목록 요청에 대한 응답입니다.
필드 | |
---|---|
spaces[] |
요청된 페이지 (또는 첫 번째 페이지)의 스페이스 목록입니다. 참고: 목록 요청의 경우 스페이스 객체에 |
next_ |
토큰을 |
MatchedUrl
Chat 메시지에서 일치하는 URL입니다. 채팅 앱은 일치하는 URL을 미리 볼 수 있습니다. 자세한 내용은 링크 미리보기를 참고하세요.
필드 | |
---|---|
url |
출력 전용입니다. 일치한 URL입니다. |
멤버십
사용자 또는 Chat 앱이 스페이스에 초대되었는지, 스페이스에 참여 중인지, 스페이스에 참여하지 않았는지와 같은 Google Chat의 멤버십 관계를 나타냅니다.
필드 | |
---|---|
name |
식별자. 서버에서 할당한 멤버십의 리소스 이름입니다. 형식: |
state |
출력 전용입니다. 멤버십 상태입니다. |
role |
선택사항입니다. Chat 스페이스 내에서 사용자의 역할로, 스페이스에서 허용되는 작업을 결정합니다. 이 필드는 |
create_ |
선택사항입니다. 변경할 수 없습니다. 멤버십 생성 시간입니다(예: 멤버가 스페이스에 참여했거나 스페이스 참여를 초대받은 시간). 이 필드는 가져오기 모드 스페이스에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다. |
delete_ |
선택사항입니다. 변경할 수 없습니다. 멤버십이 삭제된 시간입니다(예: 멤버가 스페이스에서 나가거나 삭제된 시간). 이 필드는 가져오기 모드 스페이스에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다. |
통합 필드 memberType . 이 멤버십과 연결된 회원입니다. 향후 다른 회원 유형이 지원될 수 있습니다. memberType 은 다음 중 하나여야 합니다. |
|
member |
선택사항입니다. 멤버십이 해당하는 Google Chat 사용자 또는 앱입니다. Chat 앱이 사용자로 인증하면 출력에 사용자 |
group_ |
선택사항입니다. 멤버십이 해당하는 Google 그룹입니다. 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 |
출력 전용입니다. 메시지를 작성한 사용자입니다. Chat 앱이 사용자로 인증하면 출력에 사용자 |
create_ |
선택사항입니다. 변경할 수 없습니다. Chat에서 생성된 스페이스의 경우 메시지가 생성된 시간입니다. 이 필드는 가져오기 모드 스페이스에서 사용되는 경우를 제외하고 출력 전용입니다. 가져오기 모드 스페이스의 경우 원래 생성 시간을 보존하려면 이 필드를 소스에서 메일이 생성된 이전 타임스탬프로 설정합니다. |
last_ |
출력 전용입니다. 사용자가 메시지를 마지막으로 수정한 시간입니다. 메시지를 수정한 적이 없는 경우 이 필드는 비어 있습니다. |
delete_ |
출력 전용입니다. Google Chat에서 메시지가 삭제된 시간입니다. 메시지가 삭제되지 않은 경우 이 필드는 비어 있습니다. |
text |
선택사항입니다. 메시지의 일반 텍스트 본문입니다. 이미지, 동영상 또는 웹페이지의 첫 번째 링크는 미리보기 칩을 생성합니다. Google Chat 사용자를@멘션하거나 스페이스의 모든 사용자를 멘션할 수도 있습니다. 문자 메시지 작성에 관한 자세한 내용은 메시지 보내기를 참고하세요. |
formatted_ |
출력 전용입니다. 서식을 전달하기 위해 마크업이 추가된
자세한 내용은 메시지로 전송된 텍스트 형식 보기를 참고하세요. |
cards[] |
지원 중단됨: 대신 서식이 지정된 텍스트, 버튼, 클릭 가능한 이미지와 같은 UI 요소를 표시하는 데 사용할 수 있는 양식 지정된 양방향 카드입니다. 카드는 일반적으로 메시지의 일반 텍스트 본문 아래에 표시됩니다. |
cards_ |
선택사항입니다. 카드의 배열입니다. Chat 앱만 카드를 만들 수 있습니다. Chat 앱이 사용자로 인증하는 경우 메일에 카드를 포함할 수 없습니다. 카드가 포함된 메시지를 만드는 방법은 메시지 보내기를 참고하세요. 카드 작성 도구로 카드를 디자인하고 미리보기를 확인합니다. 카드 빌더 열기 |
annotations[] |
출력 전용입니다. 이 메시지의 |
thread |
메일이 속한 대화목록입니다. 사용 예는 메시지 대화목록 시작 또는 답장을 참고하세요. |
space |
|
fallback_ |
선택사항입니다. 메시지 카드에 대한 일반 텍스트 설명으로, 실제 카드를 표시할 수 없는 경우에 사용됩니다(예: 모바일 알림). |
action_ |
입력 전용입니다. Chat 앱에서 응답 게시 방법을 구성하는 데 사용할 수 있는 매개변수입니다. |
argument_ |
출력 전용입니다. 모든 Chat 앱 멘션이 제거된 메시지의 일반 텍스트 본문입니다. |
slash_ |
출력 전용입니다. 슬래시 명령어 정보(해당하는 경우) |
attachment[] |
선택사항입니다. 사용자가 업로드한 첨부파일입니다. |
matched_ |
출력 전용입니다. 링크 미리보기 패턴과 일치하는 |
thread_ |
출력 전용입니다. 스페이스에서 대화목록의 답글을 지원하지 않는 경우 이 필드는 항상 |
client_ |
선택사항입니다. 메시지의 맞춤 ID입니다. 필드를 사용하여 메시지를 식별하거나 메시지를 가져오거나 삭제하거나 업데이트할 수 있습니다. 맞춤 ID를 설정하려면 메시지를 만들 때 |
emoji_ |
출력 전용입니다. 메시지에 있는 이모티콘 반응 요약 목록입니다. |
private_ |
선택사항입니다. 변경할 수 없습니다. 메시지 생성을 위한 입력입니다. 그 외의 경우에는 출력만 합니다. 메시지를 볼 수 있는 사용자입니다. 이 필드를 설정하면 메시지가 비공개로 설정되며 지정된 사용자와 Chat 앱에만 표시됩니다. 요청에 이 필드를 포함하려면 앱 인증을 사용하여 Chat API를 호출하고 다음을 생략해야 합니다. 자세한 내용은 비공개 메시지 보내기를 참고하세요. |
deletion_ |
출력 전용입니다. 삭제된 메일에 대한 정보입니다. |
quoted_ |
출력 전용입니다. Google Chat 사용자가 스페이스에서 인용한 메시지에 관한 정보입니다. Google Chat 사용자는 메시지를 인용하여 답장할 수 있습니다. |
attached_ |
출력 전용입니다. 메일에 첨부된 GIF 이미지입니다. |
accessory_ |
선택사항입니다. 메시지 하단에 표시되는 하나 이상의 양방향 위젯입니다. 텍스트, 카드 또는 텍스트와 카드가 모두 포함된 메시지에 액세서리 위젯을 추가할 수 있습니다. 대화상자가 포함된 메시지에는 지원되지 않습니다. 자세한 내용은 메일 하단에 양방향 위젯 추가하기를 참고하세요. 액세서리 위젯으로 메시지를 만들려면 앱 인증이 필요합니다. |
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_ |
Drive 링크의 데이터입니다. |
chat_ |
Chat 스페이스 링크의 데이터입니다. |
RichLinkType
리치 링크 유형입니다. 향후 더 많은 유형이 추가될 수 있습니다.
열거형 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
DRIVE_FILE |
Google Drive 리치 링크 유형입니다. |
CHAT_SPACE |
Chat 스페이스 리치 링크 유형입니다. 예를 들어 스페이스 스마트 칩이 있습니다. |
SearchSpacesRequest
검색어를 기반으로 스페이스 목록을 검색하기 위한 요청입니다.
필드 | |
---|---|
use_ |
호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
이 메서드는 현재 관리자 액세스만 지원하므로 이 필드에는 |
page_ |
반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 100개의 스페이스가 반환됩니다. 최대 값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다. |
page_ |
이전 검색 공간 호출에서 수신된 토큰입니다. 후속 페이지를 가져오려면 이 매개변수를 제공합니다. 페이지로 나누는 경우, 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
query |
필수 항목입니다. 검색어입니다. 다음 매개변수를 사용하여 검색할 수 있습니다.
여러 필드에서 동일한 필드에서 다음 쿼리 예시는 유효합니다.
|
order_ |
선택사항입니다. 스페이스 목록의 순서입니다. 정렬에 사용할 수 있는 지원되는 속성은 다음과 같습니다.
유효한 순서 지정 작업 값은 다음과 같습니다.
지원되는 구문은 다음과 같습니다.
|
SearchSpacesResponse
검색 스페이스 요청에 해당하는 스페이스 목록이 포함된 응답입니다.
필드 | |
---|---|
spaces[] |
요청된 스페이스의 페이지입니다. |
next_ |
다음 페이지를 가져오는 데 사용할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 없습니다. |
total_ |
모든 페이지에서 쿼리와 일치하는 스페이스의 총 개수입니다. 결과가 10,000개가 넘는 공백인 경우 이 값은 추정치입니다. |
SetUpSpaceRequest
스페이스를 만들고 지정된 사용자를 스페이스에 추가하도록 요청합니다.
필드 | |
---|---|
space |
필수 항목입니다. 스페이스를 만들려면 그룹 채팅을 만들려면 사람 간의 1:1 대화를 만들려면 사람과 호출하는 Chat 앱 간에 1:1 대화를 만들려면
|
request_ |
선택사항입니다. 이 요청의 고유 식별자입니다. 임의의 UUID를 사용하는 것이 좋습니다. 기존 요청 ID를 지정하면 새 스페이스를 만드는 대신 해당 ID로 생성된 스페이스가 반환됩니다. 인증된 사용자가 다른 동일한 Chat 앱에서 기존 요청 ID를 지정하면 오류가 반환됩니다. |
memberships[] |
선택사항입니다. 스페이스에 초대할 Google Chat 사용자 또는 그룹입니다. 호출하는 사용자는 자동으로 추가되므로 생략합니다. 현재 이 세트는 호출자 외에도 최대 20개의 멤버십을 허용합니다. 사용자 멤버십의 경우 Google 그룹 멤버십의 경우
사람과 호출하는 Chat 앱 간에 1:1 대화를 만들 때 ( |
SlashCommand
Google Chat의 슬래시 명령어
필드 | |
---|---|
command_ |
호출된 슬래시 명령어의 ID입니다. |
SlashCommandMetadata
슬래시 명령어 (/)의 주석 메타데이터입니다.
필드 | |
---|---|
bot |
명령어가 호출된 Chat 앱입니다. |
type |
슬래시 명령어 유형입니다. |
command_ |
호출된 슬래시 명령어의 이름입니다. |
command_ |
호출된 슬래시 명령어의 명령어 ID입니다. |
triggers_ |
슬래시 명령어가 대화상자용인지 여부를 나타냅니다. |
유형
열거형 | |
---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
ADD |
스페이스에 Chat 앱을 추가합니다. |
INVOKE |
스페이스에서 슬래시 명령어를 호출합니다. |
공백
Google Chat의 스페이스 스페이스는 두 명 이상의 사용자 간의 대화 또는 사용자와 Chat 앱 간의 일대일 메시지입니다.
필드 | |
---|---|
name |
식별자. 공간의 리소스 이름입니다. 형식: 여기서 |
type |
출력 전용입니다. 지원 중단됨: 대신 |
space_ |
선택사항입니다. 스페이스 유형입니다. 스페이스를 만들거나 스페이스의 스페이스 유형을 업데이트할 때 필요합니다. 다른 용도에 대해서만 출력합니다. |
single_ |
선택사항입니다. 스페이스가 Chat 앱과 한 명의 사용자 간의 DM인지 여부입니다. |
threaded |
출력 전용입니다. 지원 중단됨: 대신 |
display_ |
선택사항입니다. 스페이스의 표시 이름입니다. 채팅 메시지의 경우 이 필드가 비어 있을 수 있습니다. 최대 128자(영문 기준)를 지원합니다. |
external_ |
선택사항입니다. 변경할 수 없습니다. 이 스페이스에서 Google Chat 사용자를 회원으로 허용하는지 여부입니다. Google Workspace 조직에서 스페이스를 만들 때 입력합니다. 다음과 같은 조건에서 스페이스를 만들 때 이 필드를 생략합니다.
기존 스페이스의 경우 이 필드는 출력 전용입니다. |
space_ |
출력 전용입니다. Chat 스페이스의 대화목록 상태입니다. |
space_ |
선택사항입니다. 설명 및 규칙을 포함한 스페이스에 관한 세부정보입니다. |
space_ |
선택사항입니다. 이 스페이스의 메시지 및 대화목록에 대한 메시지 기록 상태입니다. |
import_ |
선택사항입니다. 이 스페이스가 Google Workspace로의 데이터 이전의 일환으로
|
create_ |
선택사항입니다. 변경할 수 없습니다. Chat에서 만든 스페이스의 경우 스페이스가 생성된 시간입니다. 이 필드는 가져오기 모드 스페이스에서 사용되는 경우를 제외하고 출력 전용입니다. 가져오기 모드 스페이스의 경우 원래 생성 시간을 보존하려면 이 필드를 소스에서 스페이스가 생성된 이전 타임스탬프로 설정하세요.
|
last_ |
출력 전용입니다. 스페이스의 마지막 메시지의 타임스탬프입니다. |
admin_ |
출력 전용입니다. Chat 앱이 있는 채팅 메시지 (DM) 스페이스의 경우 Google Workspace 관리자가 스페이스를 만들었는지 여부입니다. 관리자는 조직의 사용자를 대신하여 Chat 앱을 설치하고 채팅 메시지를 설정할 수 있습니다. 관리자 설치를 지원하려면 Chat 앱에 채팅 메시지 기능이 있어야 합니다. |
membership_ |
출력 전용입니다. 회원 유형별로 그룹화된 가입 멤버십 수입니다. |
access_ |
선택사항입니다. 스페이스의 액세스 설정을 지정합니다. |
space_ |
출력 전용입니다. 사용자가 스페이스에 액세스할 수 있는 URI입니다. |
import_ |
출력 전용입니다. 스페이스가 가져오기 모드로 유지되는 경우 시스템에서 자동으로 삭제하는 시간입니다. 가져오기 모드에서 생성된 각 스페이스는 이 필드는 가져오기 모드로 만든 스페이스에 대해서만 채워집니다. |
customer |
선택사항입니다. 변경할 수 없습니다. 스페이스의 도메인 고객 ID입니다. 앱 인증으로 스페이스를 만들고
DM의 경우 이 필드가 채워지지 않습니다. |
통합 필드 사용자 인증이 필요합니다. |
|
predefined_ |
선택사항입니다. 입력 전용입니다. 사전 정의된 스페이스 권한 설정으로, 스페이스를 만들 때만 입력합니다. 이 필드가 설정되지 않으면 공동작업 공간이 생성됩니다. 스페이스를 만든 후 설정이 |
permission_ |
선택사항입니다. 기존 스페이스의 스페이스 권한 설정 기존 권한 설정이 대체되는 정확한 스페이스 권한 설정을 업데이트하기 위한 입력입니다. 출력에 현재 권한 설정이 나열됩니다. |
AccessSettings
공간의 액세스 설정을 나타냅니다.
필드 | |
---|---|
access_ |
출력 전용입니다. 스페이스의 액세스 상태를 나타냅니다. |
audience |
선택사항입니다. 스페이스를 검색하고, 스페이스에 참여하며, 스페이스의 메시지를 미리 볼 수 있는 공유 대상 그룹의 리소스 이름입니다. 이 옵션을 선택 해제하면 스페이스에 개별적으로 초대되거나 추가된 사용자 또는 Google 그룹만 스페이스에 액세스할 수 있습니다. 자세한 내용은 공유 스페이스를 공유 대상 그룹에 표시하기를 참고하세요. 형식: Google Workspace 조직의 기본 공유 대상 그룹을 사용하려면 공유 대상 그룹을 읽으면 다음 작업을 할 수 있습니다. 앱 인증과 함께 공유 대상 그룹을 설정하려면 사용자 인증이 필요합니다. |
AccessState
스페이스의 액세스 상태를 나타냅니다.
열거형 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
액세스 상태를 알 수 없거나 이 API에서 지원되지 않습니다. |
PRIVATE |
다른 사용자 또는 Google Workspace 관리자가 개별적으로 추가하거나 초대한 사용자 또는 Google 그룹스만 스페이스를 검색하고 액세스할 수 있습니다. |
DISCOVERABLE |
스페이스 관리자가 공유 대상 그룹에 스페이스 액세스 권한을 부여했습니다. 스페이스에 개별적으로 추가되거나 초대된 사용자 또는 Google 그룹도 스페이스를 검색하고 액세스할 수 있습니다. 자세한 내용은 특정 사용자에게 스페이스를 검색 가능하도록 설정하기를 참고하세요. 검색 가능한 스페이스를 만들려면 사용자 인증이 필요합니다. |
MembershipCount
스페이스의 멤버십 수를 카테고리별로 그룹화하여 나타냅니다.
필드 | |
---|---|
joined_ |
출력 전용입니다. 스페이스에 직접 참여한 사람 수입니다. 참여 그룹의 멤버십을 통해 참여한 사용자는 포함되지 않습니다. |
joined_ |
출력 전용입니다. 스페이스에 직접 참여한 모든 그룹의 수입니다. |
PermissionSetting
스페이스 권한 설정을 나타냅니다.
필드 | |
---|---|
managers_ |
선택사항입니다. 스페이스 관리자에게 이 권한이 있는지 여부입니다. |
members_ |
선택사항입니다. 관리자가 아닌 구성원에게 이 권한이 있는지 여부입니다. |
PermissionSettings
기존 이름이 지정된 스페이스를 업데이트할 때 지정할 수 있는 권한 설정
스페이스를 만들 때 권한 설정을 지정하려면 요청에 PredefinedPermissionSettings
필드를 지정합니다.
필드 | |
---|---|
manage_ |
선택사항입니다. 스페이스에서 구성원 및 그룹을 관리하기 위한 설정입니다. |
modify_ |
선택사항입니다. 스페이스 이름, 아바타, 설명, 가이드라인을 업데이트하기 위한 설정입니다. |
toggle_ |
선택사항입니다. 스페이스 기록을 사용 설정 또는 사용 중지하는 설정입니다. |
use_ |
선택사항입니다. 스페이스에서 @all을 사용할 수 있는 설정입니다. |
manage_ |
선택사항입니다. 스페이스에서 앱을 관리하기 위한 설정입니다. |
manage_ |
선택사항입니다. 스페이스에서 웹훅을 관리하기 위한 설정입니다. |
post_ |
출력 전용입니다. 스페이스에 메시지를 게시하기 위한 설정입니다. |
reply_ |
선택사항입니다. 스페이스에서 메시지에 답장하기 위한 설정입니다. |
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 |
두 사람 또는 사람과 Chat 앱 간의 1:1 메시지 |
유형
지원 중단됨: 대신 SpaceType
를 사용하세요.
열거형 | |
---|---|
TYPE_UNSPECIFIED |
예약됨 |
ROOM |
두 명 이상의 인간 간의 대화 |
DM |
사람과 Chat 앱 간의 1:1 채팅 메시지로, 모든 메시지가 평면입니다. 사람 간의 채팅 메시지는 여기에 포함되지 않습니다. |
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
스페이스 알림 음소거 설정 유형입니다.
열거형 | |
---|---|
MUTE_SETTING_UNSPECIFIED |
예약됨 |
UNMUTED |
사용자는 알림 설정에 따라 스페이스에 대한 알림을 받게 됩니다. |
MUTED |
사용자는 알림 설정과 관계없이 스페이스에 대한 알림을 받지 못합니다. |
NotificationSetting
알림 설정 유형입니다.
열거형 | |
---|---|
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_ |
선택사항입니다. 대화목록을 만들거나 업데이트하기 위한 입력입니다. 그렇지 않으면 출력만 합니다. 대화목록의 ID입니다. 최대 4,000자(영문 기준)를 지원합니다. 이 ID는 이를 설정하는 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 |
Google Chat 형식:
|
display_ |
출력 전용입니다. 사용자의 표시 이름입니다. |
domain_ |
사용자의 Google Workspace 도메인의 고유 식별자입니다. |
type |
사용자 유형 |
is_ |
출력 전용입니다. |
유형
열거형 | |
---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 않습니다. |
HUMAN |
실제 사용자 |
BOT |
Chat 앱 사용자 |
UserMentionMetadata
사용자 멘션 (@)의 주석 메타데이터입니다.
필드 | |
---|---|
user |
언급된 사용자입니다. |
type |
사용자 멘션 유형입니다. |
유형
열거형 | |
---|---|
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
작업 메서드가 호출될 때 제공할 문자열 매개변수 목록입니다. 예를 들어 지금 일시중지, 하루 일시중지, 다음 주 일시중지라는 세 가지 일시중지 버튼을 생각해 보세요. 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입니다. |
on_ |
|
aspect_ |
이 이미지의 가로세로 비율 (너비 및 높이)입니다. 이 필드를 사용하면 이미지가 로드될 때까지 기다리는 동안 이미지의 올바른 높이를 예약할 수 있습니다. 이미지의 내장 가로세로 비율을 재정의하기 위한 것이 아닙니다. 설정하지 않으면 서버가 이미지를 미리 로드하여 채웁니다. |
ImageButton
onclick
작업이 있는 이미지 버튼
필드 | |
---|---|
on_ |
|
name |
접근성에 사용되는 이 |
통합 필드 icons . 아이콘은 Icon enum 또는 URL로 지정할 수 있습니다. icons 은 다음 중 하나여야 합니다. |
|
icon |
Chat API에서 제공하는 아이콘의 색인을 생성하는 |
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 중 하나 이상을 정의해야 합니다. icons 은 다음 중 하나여야 합니다. |
|
icon |
Chat API에서 해당 아이콘 이미지로 대체하는 enum 값입니다. |
icon_ |
URL로 지정된 아이콘입니다. |
통합 필드 control . 제어 위젯 button 또는 switch_widget 중 하나를 설정할 수 있지만 둘 다 설정할 수는 없습니다. control 은 다음 중 하나여야 합니다. |
|
button |
클릭하여 작업을 트리거할 수 있는 버튼입니다. |
OnClick
onclick
작업 (예: 링크 열기)
필드 | |
---|---|
통합 필드
|
|
action |
지정된 경우 이 |
open_ |
이 |
OpenLink
새 창을 여는 링크입니다.
필드 | |
---|---|
url |
열려는 URL입니다. |
TextButton
텍스트와 onclick
작업이 있는 버튼
필드 | |
---|---|
text |
버튼의 텍스트입니다. |
on_ |
버튼의 |
TextParagraph
텍스트 한 단락 서식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요.
필드 | |
---|---|
text |
|