색인
ChatService(인터페이스)AccessoryWidget(메시지)ActionResponse(메시지)ActionResponse.ResponseType(열거형)ActionResponse.SelectionItems(메시지)ActionResponse.UpdatedWidget(메시지)ActionStatus(메시지)Annotation(메시지)AnnotationType(열거형)AppCommandMetadata(메시지)AppCommandMetadata.AppCommandType(열거형)AttachedGif(메시지)Attachment(메시지)Attachment.Source(열거형)AttachmentDataRef(메시지)Audience(메시지)Availability(메시지)Availability.State(열거형)CalendarEventLinkData(메시지)CardWithId(메시지)ChatSpaceLinkData(메시지)Citation(메시지)CitedSource(메시지)CitedSource.Footer(메시지)CitedSource.Snippet(메시지)CompleteImportSpaceRequest(메시지)CompleteImportSpaceResponse(메시지)ContextualAddOnMarkup(메시지)ContextualAddOnMarkup.Card(메시지)ContextualAddOnMarkup.Card.CardAction(메시지)ContextualAddOnMarkup.Card.CardHeader(메시지)ContextualAddOnMarkup.Card.CardHeader.ImageStyle(열거형)ContextualAddOnMarkup.Card.Section(메시지)CreateCustomEmojiRequest(메시지)CreateMembershipRequest(메시지)CreateMessageNotificationOptions(메시지)CreateMessageNotificationOptions.NotificationType(열거형)CreateMessagePinRequest(메시지)CreateMessageRequest(메시지)CreateMessageRequest.MessageReplyOption(열거형)CreateReactionRequest(메시지)CreateSectionRequest(메시지)CreateSpaceRequest(메시지)CustomEmoji(메시지)CustomEmoji.CustomEmojiPayload(메시지)CustomEmojiMetadata(메시지)CustomStatus(메시지)DeleteCustomEmojiRequest(메시지)DeleteMembershipRequest(메시지)DeleteMessagePinRequest(메시지)DeleteMessageRequest(메시지)DeleteReactionRequest(메시지)DeleteSectionRequest(메시지)DeleteSpaceRequest(메시지)DeletionMetadata(메시지)DeletionMetadata.DeletionType(열거형)Dialog(메시지)DialogAction(메시지)DoNotDisturbMetadata(메시지)DriveDataRef(메시지)DriveLinkData(메시지)Elements(메시지)ElementsImage(메시지)Emoji(메시지)EmojiReactionSummary(메시지)FindDirectMessageRequest(메시지)FindGroupChatsRequest(메시지)FindGroupChatsResponse(메시지)ForwardedMetadata(메시지)GetAttachmentRequest(메시지)GetAvailabilityRequest(메시지)GetCustomEmojiRequest(메시지)GetMembershipRequest(메시지)GetMessageRequest(메시지)GetSpaceEventRequest(메시지)GetSpaceNotificationSettingRequest(메시지)GetSpaceReadStateRequest(메시지)GetSpaceRequest(메시지)GetThreadReadStateRequest(메시지)Group(메시지)HistoryState(열거형)ListCustomEmojisRequest(메시지)ListCustomEmojisResponse(메시지)ListMembershipsRequest(메시지)ListMembershipsResponse(메시지)ListMessagePinsRequest(메시지)ListMessagePinsResponse(메시지)ListMessagesRequest(메시지)ListMessagesResponse(메시지)ListReactionsRequest(메시지)ListReactionsResponse(메시지)ListSectionItemsRequest(메시지)ListSectionItemsResponse(메시지)ListSectionsRequest(메시지)ListSectionsResponse(메시지)ListSpaceEventsRequest(메시지)ListSpaceEventsResponse(메시지)ListSpacesRequest(메시지)ListSpacesResponse(메시지)MarkAsActiveRequest(메시지)MarkAsAwayRequest(메시지)MarkAsDoNotDisturbRequest(메시지)MarkupSyntax(열거형)MatchedUrl(메시지)MeetSpaceLinkData(메시지)MeetSpaceLinkData.HuddleStatus(열거형)MeetSpaceLinkData.Type(열거형)Membership(메시지)Membership.Affiliation(열거형)Membership.MembershipRole(열거형)Membership.MembershipState(열거형)MembershipBatchCreatedEventData(메시지)MembershipBatchDeletedEventData(메시지)MembershipBatchUpdatedEventData(메시지)MembershipCreatedEventData(메시지)MembershipDeletedEventData(메시지)MembershipUpdatedEventData(메시지)Message(메시지)MessageBatchCreatedEventData(메시지)MessageBatchDeletedEventData(메시지)MessageBatchUpdatedEventData(메시지)MessageCreatedEventData(메시지)MessageDeletedEventData(메시지)MessagePin(메시지)MessageUpdatedEventData(메시지)MoveSectionItemRequest(메시지)MoveSectionItemResponse(메시지)PositionSectionRequest(메시지)PositionSectionRequest.Position(열거형)PositionSectionResponse(메시지)QuotedMessageMetadata(메시지)QuotedMessageMetadata.QuoteType(열거형)QuotedMessageSnapshot(메시지)Reaction(메시지)ReactionBatchCreatedEventData(메시지)ReactionBatchDeletedEventData(메시지)ReactionCreatedEventData(메시지)ReactionDeletedEventData(메시지)ReplaceMessageCardsRequest(메시지)ReplaceMessageCardsResponse(메시지)RichLinkMetadata(메시지)RichLinkMetadata.RichLinkType(열거형)SearchMessageResult(메시지)SearchMessagesRequest(메시지)SearchMessagesRequest.SearchMessagesView(열거형)SearchMessagesResponse(메시지)SearchSpacesRequest(메시지)SearchSpacesResponse(메시지)SearchSpacesResponse.SearchSpaceResult(메시지)Section(메시지)Section.SectionType(열거형)SectionItem(메시지)SetUpSpaceRequest(메시지)SlashCommand(메시지)SlashCommandMetadata(메시지)SlashCommandMetadata.Type(열거형)Space(메시지)Space.AccessPermissionSetting(메시지)Space.AccessPermissionSettings(메시지)Space.AccessSettings(메시지)Space.AccessSettings.AccessState(열거형)Space.MembershipCount(메시지)Space.PermissionSetting(메시지)Space.PermissionSettings(메시지)Space.PredefinedPermissionSettings(열거형)Space.Principal(메시지)Space.SpaceDetails(메시지)Space.SpaceThreadingState(열거형)Space.SpaceType(열거형)Space.Type(열거형)SpaceBatchUpdatedEventData(메시지)SpaceEvent(메시지)SpaceNotificationSetting(메시지)SpaceNotificationSetting.MuteSetting(열거형)SpaceNotificationSetting.NotificationSetting(열거형)SpaceReadState(메시지)SpaceUpdatedEventData(메시지)SpaceView(열거형)Thread(메시지)ThreadReadState(메시지)UpdateAvailabilityRequest(메시지)UpdateMembershipRequest(메시지)UpdateMessageRequest(메시지)UpdateSectionRequest(메시지)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 플랫폼에서 Chat 앱 및 통합을 빌드할 수 있습니다.
| CompleteImportSpace |
|---|
|
지정된 스페이스의 가져오기 프로세스를 완료하고 사용자에게 표시합니다. 사용자 인증 및 승인 범위를 사용한 도메인 전체 위임이 필요합니다.
자세한 내용은 Google Chat 앱에서 데이터를 가져오도록 승인하기를 참고하세요.
|
| CreateCustomEmoji |
|---|
|
맞춤 이모티콘을 만듭니다. 맞춤 그림 이모티콘은 Google Workspace 계정에서만 사용할 수 있으며 관리자가 조직에 맞춤 그림 이모티콘을 사용 설정해야 합니다. 자세한 내용은 Google Chat의 맞춤 이모티콘에 관해 알아보기 및 맞춤 이모티콘 권한 관리하기를 참고하세요.
|
| CreateMembership |
|---|
|
호출하는 Chat 앱, 사용자 또는 Google 그룹의 멤버십을 만듭니다. 다른 Chat 앱의 멤버십을 만드는 것은 지원되지 않습니다. 멤버십을 만들 때 지정된 멤버의 자동 수락 정책이 사용 중지되어 있으면 해당 멤버는 초대를 받게 되며 스페이스 초대를 수락해야 참여할 수 있습니다. 그렇지 않으면 멤버십을 만들 때 멤버가 지정된 스페이스에 직접 추가됩니다. 다음 유형의 인증을 지원합니다.
다음 사용 사례에서는 앱 인증이 지원되지 않습니다.
사용 예시는 다음을 참고하세요.
|
| CreateMessage |
|---|
|
Google Chat 스페이스에 메시지를 만듭니다. 예시는 메시지 보내기를 참고하세요. 다음 유형의 인증을 지원합니다.
Chat은 요청에 사용하는 인증 유형에 따라 메시지 발신자를 다르게 지정합니다. 다음 이미지는 앱 인증을 사용할 때 Chat에서 메시지를 표시하는 방법을 보여줍니다. Chat은 채팅 앱을 메시지 발신자로 표시합니다. 메시지 콘텐츠에는 텍스트 ( 다음 이미지는 사용자 인증을 사용할 때 Chat에서 메시지를 어떻게 표시하는지 보여줍니다. Chat은 사용자를 메시지 발신자로 표시하고 Chat 앱의 이름을 표시하여 메시지를 Chat 앱에 할당합니다. 메시지 콘텐츠에는 텍스트 ( 메시지 콘텐츠를 포함한 최대 메시지 크기는 32,000바이트입니다. 웹훅 요청의 경우 응답에 전체 메시지가 포함되지 않습니다. 응답은 요청에 있던 정보 외에
|
| CreateMessagePin |
|---|
|
메시지 고정을 만듭니다. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| CreateReaction |
|---|
|
반응을 만들어 메시지에 추가합니다. 예시는 메시지에 반응 추가를 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| CreateSection |
|---|
|
Google Chat에서 섹션을 만듭니다. 섹션을 사용하면 사용자가 대화를 그룹화하고 Chat 탐색 패널에 표시되는 스페이스 목록을 맞춤설정할 수 있습니다.
|
| CreateSpace |
|---|
|
스페이스를 만듭니다. 다음 유형의 인증을 지원합니다.
앱으로 인증할 때는 요청에 앱으로 인증하면 Chat 앱이 스페이스의 멤버로 추가됩니다. 하지만 사용자 인증과 달리 Chat 앱은 스페이스 관리자로 추가되지 않습니다. 기본적으로 모든 스페이스 멤버가 스페이스에서 Chat 앱을 삭제할 수 있습니다. 스페이스 관리자만 스페이스에서 앱을 삭제할 수 있도록 하려면 스페이스 생성 시 멤버십은 스페이스가
스페이스를 만들 때
|
| DeleteCustomEmoji |
|---|
|
맞춤 이모티콘을 삭제합니다. 기본적으로 사용자는 자신이 만든 맞춤 이모티콘만 삭제할 수 있습니다. 관리자가 지정한 이모티콘 관리자는 조직의 모든 맞춤 이모티콘을 삭제할 수 있습니다. Google Chat의 맞춤 이모티콘에 관해 알아보기를 참고하세요. 맞춤 그림 이모티콘은 Google Workspace 계정에서만 사용할 수 있으며 관리자가 조직에 맞춤 그림 이모티콘을 사용 설정해야 합니다. 자세한 내용은 Google Chat의 맞춤 이모티콘에 관해 알아보기 및 맞춤 이모티콘 권한 관리하기를 참고하세요.
|
| DeleteMembership |
|---|
|
멤버십을 삭제합니다. 예시는 스페이스에서 사용자 또는 Google Chat 앱 삭제하기를 참고하세요. 다음 유형의 인증을 지원합니다.
다음 사용 사례에서는 앱 인증이 지원되지 않습니다.
스페이스 관리자의 멤버십을 삭제하려면 요청자가 스페이스 관리자여야 합니다. 앱 인증을 사용하는 경우 Chat 앱이 스페이스 생성자여야 합니다.
|
| DeleteMessage |
|---|
|
메시지를 삭제합니다. 예시는 메시지 삭제를 참고하세요. 다음 유형의 인증을 지원합니다.
앱 인증을 사용하는 경우 요청은 호출하는 Chat 앱에서 만든 메시지만 삭제할 수 있습니다.
|
| DeleteMessagePin |
|---|
|
메시지 고정을 삭제합니다. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| DeleteReaction |
|---|
|
메시지에 대한 반응을 삭제합니다. 예시는 반응 삭제를 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| DeleteSection |
|---|
|
섹션에 스페이스와 같은 항목이 포함된 경우 항목은 Google Chat의 기본 섹션으로 이동되며 삭제되지 않습니다. 자세한 내용은 Google Chat에서 섹션 만들기 및 정리하기를 참고하세요.
|
| DeleteSpace |
|---|
|
이름이 지정된 스페이스를 삭제합니다. 항상 연속 삭제를 수행합니다. 즉, 스페이스에 게시된 메시지 및 스페이스의 멤버십과 같은 스페이스의 하위 리소스도 삭제됩니다. 예시는 스페이스 삭제를 참고하세요. 다음 유형의 인증을 지원합니다.
|
| FindDirectMessage |
|---|
|
지정된 사용자와의 기존 채팅 메시지를 반환합니다. 채팅 메시지 스페이스가 없으면 앱 인증을 사용하면 지정된 사용자와 호출하는 Chat 앱 간의 채팅 메시지 스페이스를 반환합니다. 사용자 인증을 사용하면 지정된 사용자와 인증된 사용자 간의 채팅 메시지 스페이스를 반환합니다. 다음 유형의 인증을 지원합니다.
|
| FindGroupChats |
|---|
|
호출 사용자가 일부 사용자를 차단하거나 일부 사용자에 의해 차단되고 지정된 전체 사용자 집합이 있는 스페이스를 찾을 수 없는 경우 이 메서드는 차단된 사용자 또는 차단하는 사용자가 포함되지 않은 스페이스를 반환합니다. 지정된 사용자 집합에는 사람 (앱이 아님) 멤버십만 포함되어야 합니다. 사람이 아닌 사용자가 포함된 요청은 스페이스를 반환하지 않습니다. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| GetAttachment |
|---|
|
메일 첨부파일의 메타데이터를 가져옵니다. 첨부파일 데이터는 미디어 API를 사용하여 가져옵니다. 예시는 메일 첨부파일에 관한 메타데이터 가져오기를 참고하세요.
|
| GetAvailability |
|---|
|
Google Chat에서 일반 사용자의 대화 가능 여부 정보를 반환합니다. 예를 들어 사용자가 온라인 상태인지 또는 부재중인지 확인하거나 맞춤 상태 메시지를 가져오는 데 사용할 수 있습니다. 이 메서드는 인증된 사용자의 참석 여부만 가져옵니다. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| GetCustomEmoji |
|---|
|
맞춤 이모티콘에 관한 세부정보를 반환합니다. 맞춤 그림 이모티콘은 Google Workspace 계정에서만 사용할 수 있으며 관리자가 조직에 맞춤 그림 이모티콘을 사용 설정해야 합니다. 자세한 내용은 Google Chat의 맞춤 이모티콘에 관해 알아보기 및 맞춤 이모티콘 권한 관리하기를 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| GetMembership |
|---|
|
멤버십에 대한 세부정보를 반환합니다. 예를 보려면 사용자 또는 Google Chat 앱의 멤버십에 관한 세부정보 가져오기를 참고하세요. 다음 유형의 인증을 지원합니다.
|
| GetMessage |
|---|
|
메시지에 관한 세부정보를 반환합니다. 예시는 메시지 세부정보 가져오기를 참고하세요. 다음 유형의 인증을 지원합니다.
참고: 차단된 멤버 또는 스페이스의 메시지가 반환될 수 있습니다.
|
| GetSpace |
|---|
|
스페이스에 관한 세부정보를 반환합니다. 예시는 스페이스 세부정보 가져오기를 참고하세요. 다음 유형의 인증을 지원합니다.
앱 인증에는 다음과 같은 제한사항이 있습니다.
|
| GetSpaceEvent |
|---|
|
Google Chat 스페이스에서 이벤트를 반환합니다. 이벤트 페이로드에는 변경된 리소스의 최신 버전이 포함됩니다. 예를 들어 새 메시지에 관한 이벤트를 요청했지만 메시지가 나중에 업데이트된 경우 서버는 이벤트 페이로드에서 업데이트된 참고: 이 요청의 스페이스 이벤트 데이터의 스페이스 객체에는 요청된 데이터를 읽는 데 적합한 승인 범위를 사용하여 다음 유형의 인증을 지원합니다.
이벤트를 가져오려면 인증된 호출자가 스페이스의 구성원이어야 합니다. 예시는 Google Chat 스페이스에서 일정에 관한 세부정보 가져오기를 참고하세요.
|
| GetSpaceNotificationSetting |
|---|
|
스페이스 알림 설정을 가져옵니다. 예시는 호출자의 스페이스 알림 설정 가져오기를 참고하세요.
|
| GetSpaceReadState |
|---|
|
스페이스 내 사용자의 읽음 상태에 관한 세부정보를 반환하며, 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예시는 사용자의 스페이스 읽기 상태에 관한 세부정보 가져오기를 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| GetThreadReadState |
|---|
|
읽은 메일과 읽지 않은 메일을 식별하는 데 사용되는 대화목록 내 사용자의 읽기 상태에 관한 세부정보를 반환합니다. 예시는 사용자의 대화목록 읽기 상태에 관한 세부정보 가져오기를 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| ListCustomEmojis |
|---|
|
인증된 사용자에게 표시되는 맞춤 이모티콘을 나열합니다. 맞춤 그림 이모티콘은 Google Workspace 계정에서만 사용할 수 있으며 관리자가 조직에 맞춤 그림 이모티콘을 사용 설정해야 합니다. 자세한 내용은 Google Chat의 맞춤 이모티콘에 관해 알아보기 및 맞춤 이모티콘 권한 관리하기를 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| ListMemberships |
|---|
|
스페이스의 멤버십을 나열합니다. 예시는 스페이스의 사용자 및 Google Chat 앱 나열을 참고하세요. 앱 인증으로 멤버십을 나열하면 Chat 앱이 액세스할 수 있는 스페이스의 멤버십이 나열되지만 자체 멤버십을 포함한 Chat 앱 멤버십은 제외됩니다. 사용자 인증으로 멤버십을 나열하면 인증된 사용자가 액세스할 수 있는 스페이스의 멤버십이 나열됩니다. 다음 유형의 인증을 지원합니다.
|
| ListMessagePins |
|---|
|
스페이스의 메시지 고정을 나열합니다. 사용자는 스페이스에서 중요한 메시지를 고정하여 쉽게 액세스할 수 있습니다. 자세한 내용은 Google Chat에서 대화 고정 또는 고정 해제하기를 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| ListMessages |
|---|
|
차단된 멤버 및 스페이스의 메시지를 포함하여 호출자가 멤버인 스페이스의 메시지를 나열합니다. 새 스페이스 멤버를 알리는 메시지와 같은 시스템 메시지는 포함되지 않습니다. 메시지가 없는 스페이스의 메시지를 나열하면 응답은 빈 객체입니다. REST/HTTP 인터페이스를 사용하는 경우 응답에 빈 JSON 객체인 다음 유형의 인증을 지원합니다.
|
| ListReactions |
|---|
|
메시지에 대한 반응을 나열합니다. 예를 보려면 메시지에 대한 반응 나열을 참고하세요. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| ListSectionItems |
|---|
|
섹션의 항목을 나열합니다. 스페이스만 섹션 항목이 될 수 있습니다. 자세한 내용은 Google Chat에서 섹션 만들기 및 정리하기를 참고하세요.
|
| ListSections |
|---|
|
Chat 사용자가 사용할 수 있는 섹션을 나열합니다. 섹션을 사용하면 사용자가 대화를 그룹화하고 Chat 탐색 패널에 표시되는 스페이스 목록을 맞춤설정할 수 있습니다. 자세한 내용은 Google Chat에서 섹션 만들기 및 정리하기를 참고하세요.
|
| ListSpaceEvents |
|---|
|
Google Chat 스페이스의 이벤트를 나열합니다. 각 이벤트의 페이로드에는 Chat 리소스의 최신 버전이 포함됩니다. 예를 들어 새 스페이스 멤버에 관한 이벤트를 나열하면 서버는 최신 멤버십 세부정보가 포함된 요청된 데이터를 읽는 데 적합한 승인 범위를 사용하여 다음 유형의 인증을 지원합니다.
일정을 나열하려면 인증된 호출자가 스페이스의 멤버여야 합니다. 예시는 Google Chat 스페이스의 이벤트 나열을 참고하세요.
|
| ListSpaces |
|---|
|
호출자가 속한 스페이스를 나열합니다. 그룹 채팅과 채팅 메시지는 첫 번째 메시지가 전송될 때까지 표시되지 않습니다. 예시는 스페이스 목록을 참고하세요. 다음 유형의 인증을 지원합니다.
Google Workspace 조직의 모든 이름이 지정된 스페이스를 나열하려면 Workspace 관리자 권한을 사용하여
|
| MarkAsActive |
|---|
|
Google Chat에서 사용자를 사용자의 사용 가능 여부 상태를 이 메서드는 인증된 사용자의 참석 여부만 업데이트합니다.
|
| MarkAsAway |
|---|
|
Google Chat에서 사용자를 사용자의 상태를 부재중으로 설정하며 사용자의 활동에 영향을 받지 않습니다. 이 메서드는 인증된 사용자의 참석 여부만 업데이트합니다.
|
| MarkAsDoNotDisturb |
|---|
|
Google Chat에서 사용자를 지정된 만료 시간까지 사용자의 참석 여부 상태를 이 메서드는 인증된 사용자의 참석 여부만 업데이트합니다.
|
| MoveSectionItem |
|---|
|
한 섹션에서 다른 섹션으로 항목을 이동합니다. 예를 들어 섹션에 스페이스가 포함된 경우 이 메서드를 사용하여 스페이스를 다른 섹션으로 이동할 수 있습니다. 자세한 내용은 Google Chat에서 섹션 만들기 및 정리하기를 참고하세요.
|
| PositionSection |
|---|
|
섹션의 정렬 순서를 변경합니다. 자세한 내용은 Google Chat에서 섹션 만들기 및 정리하기를 참고하세요.
|
| ReplaceMessageCards |
|---|
|
메시지에 포함된 카드를 대체합니다. Chat 앱은 메시지에 이미 카드가 포함되어 있고 카드가 앱에서 생성된 경우에만 사용자가 만든 메시지의 카드를 대체할 수 있습니다. 앱이 카드를 빈 목록으로 대체하면 카드가 삭제됩니다. 카드를 삭제한 후에는 앱에서 메시지에 카드를 다시 추가할 수 없습니다. 승인 범위가
|
| SearchMessages |
|---|
|
호출하는 사용자가 액세스할 수 있는 Google Chat의 메시지를 검색합니다. 검색 기준과 일치하는 메시지 목록을 반환합니다. 사용자가 액세스할 수 있는 모든 스페이스를 검색하려면 이 API는 모든 메시지 유형을 반환하지 않습니다. 아래에 나열된 메시지 유형은 응답에 포함되지 않습니다.
다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| SearchSpaces |
|---|
|
Google Workspace 조직의 스페이스 목록을 반환합니다. 예를 보려면 스페이스 검색 및 관리를 참고하세요.
다음 유형의 인증을 지원합니다.
|
| SetUpSpace |
|---|
|
스페이스를 만들고 지정된 사용자를 추가합니다. 호출하는 사용자는 스페이스에 자동으로 추가되며 요청에서 멤버십으로 지정해서는 안 됩니다. 예시는 초기 구성원으로 스페이스 설정하기를 참고하세요. 추가할 사용자 구성원을 지정하려면 적절한 추가할 Google 그룹을 지정하려면 적절한 이름이 지정된 스페이스 또는 그룹 채팅의 경우 발신자가 일부 멤버를 차단하거나 일부 멤버에 의해 차단된 경우 또는 일부 멤버를 추가할 권한이 없는 경우 해당 멤버는 생성된 스페이스에 추가되지 않습니다. 호출 사용자와 다른 사용자 간에 채팅 메시지 (DM)를 만들려면 사용자를 나타내는 멤버십을 정확히 하나 지정합니다. 한 사용자가 다른 사용자를 차단하면 요청이 실패하고 채팅 메시지가 생성되지 않습니다. 호출하는 사용자와 호출하는 앱 간에 채팅 메시지를 만들려면 두 사용자 간에 이미 DM이 있는 경우 요청 시 한 사용자가 다른 사용자를 차단하더라도 기존 DM이 반환됩니다. 대화목록 답장이 있는 스페이스는 지원되지 않습니다. 스페이스를 설정할 때 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| UpdateAvailability |
|---|
|
사용자의 참석 여부 정보를 업데이트합니다. 이 메서드를 통해서는 이 메서드는 인증된 사용자의 참석 여부만 업데이트합니다. 다음 승인 범위 중 하나를 사용하는 사용자 인증이 필요합니다.
|
| UpdateMembership |
|---|
|
멤버십을 업데이트합니다. 예시는 스페이스에서 사용자의 멤버십 업데이트를 참고하세요. 다음 유형의 인증을 지원합니다.
|
| UpdateMessage |
|---|
|
메시지를 업데이트합니다. 다음 유형의 인증을 지원합니다.
앱 인증을 사용하는 경우 요청은 호출하는 Chat 앱에서 만든 메시지만 업데이트할 수 있습니다.
|
| UpdateSection |
|---|
|
섹션을 업데이트합니다.
|
| UpdateSpace |
|---|
|
스페이스를 업데이트합니다. 예시는 스페이스 업데이트를 참고하세요.
다음 유형의 인증을 지원합니다.
앱 인증에는 다음과 같은 제한사항이 있습니다.
|
| UpdateSpaceNotificationSetting |
|---|
|
스페이스 알림 설정을 업데이트합니다. 예시는 호출자의 스페이스 알림 설정 업데이트를 참고하세요.
|
| UpdateSpaceReadState |
|---|
|
스페이스 내에서 사용자의 읽음 상태를 업데이트하며, 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예시는 사용자의 스페이스 읽기 상태 업데이트를 참고하세요.
|
AccessoryWidget
메시지 하단에 표시되는 하나 이상의 대화형 위젯입니다. 자세한 내용은 메시지 하단에 대화형 위젯 추가하기를 참고하세요.
| 필드 | |
|---|---|
통합 필드 action. 작업 유형입니다. action은 다음 중 하나여야 합니다. |
|
button_list |
버튼 목록입니다. |
ActionResponse
Chat 앱에서 응답 게시 방법을 구성하는 데 사용할 수 있는 매개변수입니다.
| 필드 | |
|---|---|
type |
입력 전용입니다. 채팅 앱 응답 유형입니다. |
url |
입력 전용입니다. 사용자가 인증하거나 구성할 URL입니다. ( |
dialog_action |
입력 전용입니다. 대화상자와 관련된 상호작용 이벤트에 대한 응답입니다. |
updated_widget |
입력 전용입니다. 업데이트된 위젯의 응답입니다. |
ResponseType
채팅 앱 응답 유형입니다.
| 열거형 | |
|---|---|
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
selectionInput 위젯의 경우 다중 선택 메뉴의 자동 완성 추천을 반환합니다.
| 필드 | |
|---|---|
widget |
업데이트된 위젯의 ID입니다. ID는 업데이트 요청을 트리거한 위젯의 ID와 일치해야 합니다. |
통합 필드 updated_widget. 사용자 작업에 대한 응답으로 위젯이 업데이트되었습니다. updated_widget은 다음 중 하나여야 합니다. |
|
suggestions |
위젯 자동 완성 결과 목록 |
ActionStatus
대화상자를 호출하거나 제출하는 요청의 상태를 나타냅니다.
| 필드 | |
|---|---|
status_code |
상태 코드입니다. |
user_facing_message |
요청 상태에 관해 사용자에게 전송할 메시지입니다. 설정하지 않으면 |
주석
주석은 메시지의 일반 텍스트 본문 또는 start_index 및 length가 0인 Google Docs 또는 Sheets와 같은 Google Workspace 리소스에 연결되는 칩과 연결할 수 있습니다. 문자 메시지에 기본 서식을 추가하려면 문자 메시지 서식 지정을 참고하세요.
일반 텍스트 메일 본문 예시:
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 |
이 주석이 해당하는 일반 텍스트 메시지 본문의 하위 문자열 길이입니다. 없는 경우 길이는 0입니다. |
start_index |
이 주석이 해당하는 일반 텍스트 메시지 본문의 시작 색인 (0부터 시작, 포함)입니다. |
통합 필드 metadata. 주석에 대한 추가 메타데이터입니다. metadata은 다음 중 하나여야 합니다. |
|
user_mention |
사용자 멘션의 메타데이터입니다. |
slash_command |
슬래시 명령어의 메타데이터입니다. |
rich_link_metadata |
리치 링크의 메타데이터입니다. |
custom_emoji_metadata |
맞춤 그림 이모티콘의 메타데이터입니다. |
AnnotationType
주석의 유형입니다.
| 열거형 | |
|---|---|
ANNOTATION_TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
USER_MENTION |
사용자가 멘션됩니다. |
SLASH_COMMAND |
슬래시 명령어가 호출됩니다. |
RICH_LINK |
리치 링크 주석입니다. |
CUSTOM_EMOJI |
맞춤 이모티콘 주석입니다. |
AppCommandMetadata
Chat 앱 명령어에 관한 메타데이터입니다.
| 필드 | |
|---|---|
app_command_id |
Chat API 구성에 지정된 명령어의 ID입니다. |
app_command_type |
Chat 앱 명령어의 유형입니다. |
AppCommandType
Chat 앱 명령어의 유형입니다. 자세한 내용은 Chat 앱 명령어 유형을 참고하세요.
| 열거형 | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
기본값 지정되지 않음. |
SLASH_COMMAND |
슬래시 명령어 사용자가 채팅 메시지로 명령어를 보냅니다. |
QUICK_COMMAND |
빠른 명령어 사용자가 메시지 답장 영역의 Chat 메뉴에서 명령어를 선택합니다. |
MESSAGE_ACTION |
메시지 작업입니다. 사용자가 Chat의 메시지 컨텍스트 메뉴에서 명령어를 선택합니다. |
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 |
Reserved. |
DRIVE_FILE |
파일이 Google Drive 파일입니다. |
UPLOADED_CONTENT |
파일이 Chat에 업로드됩니다. |
AttachmentDataRef
첨부파일 데이터에 대한 참조입니다.
| 필드 | |
|---|---|
resource_name |
선택사항입니다. 첨부파일 데이터의 리소스 이름입니다. 이 필드는 미디어 API와 함께 사용되어 첨부파일 데이터를 다운로드합니다. |
attachment_upload_token |
선택사항입니다. 업로드된 첨부파일에 대한 참조가 포함된 불투명 토큰입니다. 클라이언트에서 불투명 문자열로 처리되며 첨부파일이 있는 채팅 메시지를 만들거나 업데이트하는 데 사용됩니다. |
대상
Google Chat의 타겟층입니다. 공유 대상 그룹은 관리자가 정의한 Google Workspace 조직 내 사용자 그룹을 나타냅니다. 공유 대상 그룹은 특정 사용자 그룹이 스페이스를 검색할 수 있도록 하는 등 리소스의 액세스 및 공개 상태 설정을 구성하는 데 사용됩니다.
자세한 내용은 공유 대상 그룹 및 공유 대상 그룹이 스페이스를 검색할 수 있도록 설정하기를 참고하세요.
| 필드 | |
|---|---|
name |
스페이스를 검색하거나 참여할 수 있는 타겟층의 리소스 이름입니다. 자세한 내용은 공유 대상 그룹이 스페이스를 검색할 수 있도록 설정하기를 참고하세요. 형식: Google Workspace 조직의 기본 공유 대상 그룹을 사용하려면 |
가용성
Google Chat에서 사용자의 현재 대화 가능 상태 정보 (예: 활동 중, 부재중, 방해 금지 모드) 및 맞춤 상태를 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 사용자 참석 여부의 리소스 이름입니다. 형식:
사용자의 이메일 주소 또는 |
state |
출력 전용입니다. 사용자의 현재 참석 가능 여부 상태입니다. |
custom_status |
선택사항입니다. 사용자의 맞춤 상태입니다. |
통합 필드 state_metadata. 사용자의 참석 여부 상태와 관련된 추가 메타데이터입니다. state_metadata은 다음 중 하나여야 합니다. |
|
do_not_disturb_metadata |
출력 전용입니다. 사용자 상태가 DO_NOT_DISTURB로 설정된 경우의 메타데이터입니다. |
주
사용자의 현재 참석 여부 상태를 나타냅니다.
| 열거형 | |
|---|---|
STATE_UNSPECIFIED |
기본값 상태가 지정되지 않았습니다. |
ACTIVE |
최근 활동을 기준으로 사용자가 현재 활성 상태입니다. |
IDLE |
사용자가 현재 유휴 상태입니다. 이 상태는 ACTIVE 상태 이후 AWAY 상태로 전환되기 전의 비활성 기간을 나타냅니다. |
AWAY |
사용자가 현재 자리를 비운 상태입니다. 이는 ACTIVE 또는 IDLE 상태에서 비활성 기간이 지나면 자동으로 설정되거나 사용자가 수동으로 설정할 수 있습니다. MarkAsAway를 통해 수동으로 설정하면 사용자 활동과 관계없이 이 상태가 유지됩니다. |
DO_NOT_DISTURB |
사용자가 수동으로 설정한 방해 금지 모드 상태입니다. |
CalendarEventLinkData
캘린더 일정 링크의 데이터입니다.
| 필드 | |
|---|---|
calendar_id |
연결된 Calendar의 Calendar 식별자입니다. |
event_id |
연결된 캘린더 일정의 일정 식별자입니다. |
CardWithId
Google Chat 채팅 메시지의 카드입니다.
채팅 앱은 앱 인증을 사용하여 카드를 만들 수 있습니다. 개발자 프리뷰 프로그램의 일환으로 Chat 앱이 사용자로 인증하는 경우 카드 메시지를 만들 수 있습니다. Chat 앱이 개발자 프리뷰 프로그램에 속하지 않는 경우 사용자 인증이 있는 카드를 만들 수 없습니다.
카드가 포함된 메시지를 만드는 방법은 메시지 보내기를 참고하세요.
카드 빌더로 카드를 디자인하고 미리 봅니다.
카드 빌더 열기| 필드 | |
|---|---|
card_id |
메시지에 여러 카드가 포함된 경우 필수입니다. 메시지에 있는 카드의 고유 식별자입니다. |
card |
카드 최대 크기는 32KB입니다. |
owner_user |
출력 전용입니다. 카드를 소유한 앱입니다. |
ChatSpaceLinkData
Chat 스페이스 링크의 데이터입니다.
| 필드 | |
|---|---|
space |
연결된 Chat 스페이스 리소스의 스페이스입니다. 형식: |
thread |
연결된 Chat 스페이스 리소스의 대화목록입니다. 형식: |
message |
연결된 Chat 스페이스 리소스의 메시지입니다. 형식: |
인용
<chat-citation data-id="{id}">{text}</chat-citation> 마크업 형식으로 표시되어야 합니다. 인용은 메시지의 markup_syntax가 MARKDOWN로 설정된 경우에만 지원됩니다.Elements.citations에서 참조되지 않은 인용 (메시지 텍스트에 일치하는 <chat-citation> 태그가 없는 인용)은 무시되며 메시지가 거부되지 않습니다.
| 필드 | |
|---|---|
id |
필수 항목입니다. 앱 정의 ID입니다. ASCII 문자와 숫자만 포함해야 하며 63자(영문 기준) 미만이어야 합니다. |
cited_sources[] |
선택사항입니다. 인용과 관련된 소스 목록입니다. 출처는 인용 호버 카드에 표시됩니다. |
CitedSource
| 필드 | |
|---|---|
title |
필수 항목입니다. |
uri |
필수 항목입니다. 이 |
snippet |
선택사항입니다. 소스에서 직접 가져온 정보가 포함된 스니펫입니다. |
footer |
선택사항입니다. 스니펫과 함께 바닥글 형식으로 표시할 추가 정보입니다. |
스니펫
| 필드 | |
|---|---|
text |
선택사항입니다. Chat에서 렌더링될 수 있는 말뭉치에서 직접 가져온 짧은 일반 텍스트 발췌문입니다. 마크다운 형식을 지원하지 않습니다. |
image_preview |
선택사항입니다. 인용을 만들 때 입력으로 제공된 스니펫의 이미지 미리보기입니다. |
CompleteImportSpaceRequest
스페이스의 가져오기 프로세스를 완료하기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져오기 모드 스페이스의 리소스 이름입니다. 형식: |
CompleteImportSpaceResponse
스페이스 가져오기 프로세스 완료에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
space |
가져오기 모드 스페이스입니다. |
ContextualAddOnMarkup
이 유형에는 필드가 없습니다.
개발자가 컨텍스트 부가기능의 콘텐츠를 지정하는 마크업입니다.
카드
카드는 텍스트 및 이미지와 같은 UI 위젯을 포함할 수 있는 UI 요소입니다.
| 필드 | |
|---|---|
header |
카드의 헤더입니다. 헤더에는 일반적으로 제목과 이미지가 포함됩니다. |
sections[] |
섹션은 선 구분자로 구분됩니다. |
card_actions[] |
이 카드의 작업입니다. |
name |
카드 이름입니다. |
CardAction
카드 작업은 카드와 연결된 작업입니다. 인보이스 카드의 경우 일반적인 작업은 인보이스 삭제, 인보이스 이메일 전송 또는 브라우저에서 인보이스 열기입니다.
Google Chat 앱에서 지원되지 않습니다.
| 필드 | |
|---|---|
action_label |
작업 메뉴 항목에 표시되는 라벨입니다. |
on_click |
이 작업 항목의 onclick 작업입니다. |
CardHeader
| 필드 | |
|---|---|
title |
제목을 지정해야 합니다. 헤더의 높이는 고정되어 있습니다. 제목과 부제목이 모두 지정된 경우 각각 한 줄을 차지합니다. 제목만 지정하면 두 줄을 모두 차지합니다. |
subtitle |
카드 헤더의 부제목입니다. |
image_style |
이미지 유형 (예: 정사각형 테두리 또는 원형 테두리)입니다. |
image_url |
카드 헤더에 있는 이미지의 URL입니다. |
ImageStyle
| 열거형 | |
|---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
정사각형 테두리 |
AVATAR |
원형 테두리입니다. |
섹션
섹션에는 지정된 순서대로 (세로로) 렌더링되는 위젯 모음이 포함됩니다. 모든 플랫폼에서 카드의 너비는 좁고 고정되어 있으므로 현재 레이아웃 속성 (예: float)이 필요하지 않습니다.
| 필드 | |
|---|---|
header |
섹션의 헤더입니다. 형식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능의 텍스트 서식 지정을 참고하세요. |
widgets[] |
섹션에는 위젯이 하나 이상 포함되어야 합니다. |
CreateCustomEmojiRequest
맞춤 이모티콘을 만드는 요청입니다.
| 필드 | |
|---|---|
custom_emoji |
필수 항목입니다. 만들 맞춤 이모티콘입니다. |
CreateMembershipRequest
멤버십을 만들기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 멤버십을 만들 스페이스의 리소스 이름입니다. 형식: spaces/{space} |
membership |
필수 항목입니다. 만들 멤버십 관계입니다.
Chat 앱이 사람 사용자의 멤버십 관계를 만들 때는 특정 승인 범위를 사용하고 특정 필드에 특정 값을 설정해야 합니다.
스페이스를 소유한 Workspace 조직 외부의 사용자를 초대하려면 사용자 인증이 필요합니다. Chat 앱이 자체 멤버십 관계를 만들 때는 사용자로 인증하고 |
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스 권한을 사용하여 앱 멤버십을 만들거나 관리자의 Google Workspace 조직 외부 사용자의 멤버십을 만드는 것은 지원되지 않습니다. |
CreateMessageNotificationOptions
메시지가 게시될 때의 알림 동작 옵션입니다.
| 필드 | |
|---|---|
notification_type |
메시지의 알림 유형입니다. |
NotificationType
메시지의 알림 유형 옵션입니다.
| 열거형 | |
|---|---|
NOTIFICATION_TYPE_NONE |
기본 동작입니다. 알림 동작은 사용자가 Chat UI를 사용하여 메시지를 보낼 때와 유사합니다. 사용자 발신자에게는 알림이 전송되지 않습니다. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
수신자에게 강제로 알림을 보냅니다. 이렇게 하면 사용자의 스페이스 알림 설정과 Chat 방해 금지 모드 설정이 무시됩니다. 이 옵션은 기기 수준의 방해 금지 모드 설정을 우회하지 않습니다. 앱 인증이 필요합니다. |
NOTIFICATION_TYPE_SILENT |
수신자에게 알림을 보내지 않고 메일을 읽지 않음으로 표시하지 않습니다. 이는 사용자가 대화를 음소거하거나 Chat 방해 금지 모드를 사용 설정하는 것과 유사하게 작동합니다. 앱 인증이 필요합니다. |
CreateMessagePinRequest
메시지 고정을 만들기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 메시지 고정을 만들 상위 스페이스입니다. 형식: spaces/{space} |
message_pin |
필수 항목입니다. 만들 MessagePin입니다. |
CreateMessageRequest
메시지를 만듭니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 메시지를 만들 스페이스의 리소스 이름입니다. 형식: |
message |
필수 항목입니다. 메일 본문입니다. |
thread_key |
선택사항입니다. 지원 중단됨: 대신 |
request_id |
선택사항입니다. 이 요청의 고유 ID입니다. 임의의 UUID를 사용하는 것이 좋습니다. 요청 ID를 지정하면 요청이 멱등성을 갖게 되므로 동일한 요청 ID를 가진 여러 개의 동일한 요청으로 인해 하나의 메시지만 생성됩니다. 요청된 세부정보가 현재 상태와 다르더라도 동일한 요청 ID를 사용하는 후속 요청은 기존 메시지를 반환하고 메시지를 업데이트하지 않습니다. 이 필드를 효과적으로 사용하려면 다음 안내를 따르세요.
|
message_reply_option |
선택사항입니다. 메시지가 대화목록을 시작하는지 아니면 대화목록에 답장하는지 지정합니다. 이름이 지정된 스페이스에서만 지원됩니다. 사용자 상호작용에 응답할 때는 이 필드가 무시됩니다. 대화목록 내 상호작용의 경우 답장은 동일한 대화목록에 생성됩니다. 그렇지 않으면 답장이 새 대화목록으로 생성됩니다. |
message_id |
선택사항입니다. 메시지의 커스텀 ID입니다. Chat 앱이 메시지의 리소스 이름 (메시지 이 필드의 값은 다음 요구사항을 충족해야 합니다.
자세한 내용은 메시지 이름 지정을 참고하세요. |
create_message_notification_options |
선택사항입니다. 메시지가 게시될 때 알림 동작을 제어합니다. 자세한 내용은 알림 강제 전송 또는 무음 메시지 전송을 참고하세요. |
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 |
필수 항목입니다. 만들 반응입니다. |
CreateSectionRequest
섹션을 만들기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 섹션이 생성되는 상위 리소스 이름입니다. 형식: |
section |
필수 항목입니다. 만들 섹션입니다. |
CreateSpaceRequest
구성원이 없는 이름이 지정된 스페이스를 만드는 요청입니다.
| 필드 | |
|---|---|
space |
필수 항목입니다.
|
request_id |
선택사항입니다. 이 요청의 고유 ID입니다. 임의의 UUID를 사용하는 것이 좋습니다. 요청 ID를 지정하면 요청이 멱등성을 갖게 되므로 동일한 요청 ID를 가진 여러 개의 동일한 요청으로 인해 하나의 스페이스만 생성됩니다. 요청된 세부정보가 현재 상태와 다르더라도 동일한 요청 ID를 사용하는 후속 요청은 기존 스페이스를 반환하고 스페이스를 업데이트하지 않습니다. 이 필드를 효과적으로 사용하려면 다음 안내를 따르세요.
|
CustomEmoji
맞춤 이모티콘을 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 서버에서 할당한 맞춤 이모티콘의 리소스 이름입니다. 형식: |
uid |
출력 전용입니다. 맞춤 이모티콘 리소스의 고유 키입니다. |
emoji_name |
선택사항입니다. 변경할 수 없습니다. 사용자가 제공한 맞춤 이모티콘의 이름으로, 조직 내에서 고유합니다. 맞춤 이모티콘이 생성될 때 필요하며, 그 외의 경우에는 출력 전용입니다. 이모티콘 이름은 콜론으로 시작하고 끝나야 하며, 소문자여야 하고, 영숫자 문자, 하이픈, 밑줄만 포함할 수 있습니다. 하이픈 및 밑줄은 단어를 구분할 때 사용할 수 있으며 연속으로 사용할 수 없습니다. 예: |
temporary_image_uri |
출력 전용입니다. 맞춤 이모티콘의 임시 이미지 URL로, 최소 10분 동안 유효합니다. 맞춤 이모티콘이 생성될 때 응답에 이 필드가 채워지지 않습니다. |
payload |
선택사항입니다. 입력 전용입니다. 페이로드 데이터입니다. 맞춤 이모티콘을 만들 때 필요합니다. |
CustomEmojiPayload
맞춤 이모티콘의 페이로드 데이터입니다.
| 필드 | |
|---|---|
file_content |
필수 항목입니다. 입력 전용입니다. 맞춤 이모티콘에 사용되는 이미지입니다. 페이로드는 256KB 미만이어야 하며 이미지 크기는 정사각형이고 64~500픽셀 사이여야 합니다. 제한사항은 변경될 수 있습니다. |
filename |
필수 항목입니다. 입력 전용입니다. 이미지 파일 이름입니다. 지원되는 파일 확장자: |
CustomEmojiMetadata
맞춤 이모티콘의 주석 메타데이터입니다.
| 필드 | |
|---|---|
custom_emoji |
맞춤 이모티콘입니다. |
CustomStatus
Google Chat에서 사용자의 맞춤 상태를 나타냅니다. 여기에는 사용자가 자신의 연락 가능 여부에 관한 추가 정보를 제공하기 위해 설정하는 짧은 문자 메시지와 이모티콘(선택사항)이 포함됩니다.
| 필드 | |
|---|---|
text |
필수 항목입니다. 맞춤 상태의 텍스트입니다. 최대 길이가 64인 문자열입니다. |
emoji |
필수 항목입니다. 맞춤 상태의 그림 이모티콘입니다. 유니코드 그림 이모티콘만 지원되며 맞춤 그림 이모티콘은 지원되지 않습니다. |
통합 필드 expiration. 맞춤 상태의 만료 시간입니다. 절대 타임스탬프 또는 TTL(수명) 기간으로 지정할 수 있습니다. expiration은 다음 중 하나여야 합니다. |
|
expire_time |
맞춤 상태가 만료되는 시점의 타임스탬프입니다. |
ttl |
입력 전용입니다. 커스텀 상태가 만료되는 TTL(수명) 기간입니다. |
DeleteCustomEmojiRequest
맞춤 이모티콘 삭제 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 맞춤 그림 이모티콘의 리소스 이름입니다. 형식: 그림 이모티콘 이름을 |
DeleteMembershipRequest
스페이스의 멤버십 삭제 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 멤버십의 리소스 이름입니다. 채팅 앱은 사용자 또는 자체 멤버십을 삭제할 수 있습니다. 채팅 앱은 다른 앱의 멤버십을 삭제할 수 없습니다. 사용자 멤버십을 삭제할 때는 사용자 인증이 포함된 앱 멤버십을 삭제할 때 형식: |
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스 권한을 사용하여 스페이스의 앱 멤버십을 삭제할 수 없습니다. |
DeleteMessagePinRequest
메시지 고정을 삭제하기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 메시지 고정의 리소스 이름입니다. 형식: spaces/{space}/messagePins/{message_pin} |
DeleteMessageRequest
메시지 삭제 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 메시지의 리소스 이름입니다. 형식: 메시지에 커스텀 ID를 설정한 경우 |
force |
선택사항입니다. 사용자로 인증하는 경우에만 적용됩니다. Chat 앱으로 인증하는 경우에는 영향을 미치지 않습니다. |
DeleteReactionRequest
메시지에 대한 반응을 삭제합니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 반응의 이름입니다. 형식: |
DeleteSectionRequest
섹션 삭제 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 섹션의 이름입니다. 형식: |
DeleteSpaceRequest
스페이스 삭제 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 스페이스의 리소스 이름입니다. 형식: |
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
DeletionMetadata
삭제된 메시지에 관한 정보입니다. delete_time가 설정되면 메시지가 삭제됩니다.
| 필드 | |
|---|---|
deletion_type |
메시지를 삭제한 사용자를 나타냅니다. |
DeletionType
메시지를 삭제한 사용자 및 삭제 방법 향후 더 많은 값이 추가될 수 있습니다. 메시지를 삭제할 수 있는 경우에 관한 자세한 내용은 Google Chat에서 메시지 수정 또는 삭제하기를 참고하세요.
| 열거형 | |
|---|---|
DELETION_TYPE_UNSPECIFIED |
이 값은 사용되지 않습니다. |
CREATOR |
사용자가 자신의 메시지를 삭제했습니다. |
SPACE_OWNER |
소유자 또는 관리자가 메시지를 삭제했습니다. |
ADMIN |
Google Workspace 관리자가 메시지를 삭제했습니다. 관리자는 스페이스 참여자 또는 Chat 앱에서 보낸 메시지를 포함하여 스페이스의 모든 메시지를 삭제할 수 있습니다. |
APP_MESSAGE_EXPIRY |
채팅 앱이 만료 시 자체 메시지를 삭제했습니다. |
CREATOR_VIA_APP |
Chat 앱이 작성자를 대신하여 메시지를 삭제했습니다 (사용자 인증 사용). |
SPACE_OWNER_VIA_APP |
Chat 앱이 스페이스 관리자를 대신하여 메시지를 삭제했습니다 (사용자 인증 사용). |
SPACE_MEMBER |
스페이스 멤버가 메시지를 삭제했습니다. 사용자는 앱에서 보낸 메시지를 삭제할 수 있습니다. |
Dialog
대화상자의 카드 본문을 둘러싼 래퍼입니다.
| 필드 | |
|---|---|
body |
입력 전용입니다. 모달로 렌더링되는 대화상자의 본문입니다. Google Chat 앱은 |
DialogAction
대화 및 요청 상태 코드를 포함합니다.
| 필드 | |
|---|---|
action_status |
입력 전용입니다. 대화상자를 호출하거나 제출하는 요청의 상태입니다. 필요한 경우 사용자에게 상태 및 메시지를 표시합니다. 예를 들어 오류가 발생하거나 성공한 경우입니다. |
통합 필드 action. 수행할 작업입니다. action은 다음 중 하나여야 합니다. |
|
dialog |
입력 전용입니다. 요청에 대한 대화상자입니다. |
DoNotDisturbMetadata
DO_NOT_DISTURB 사용 가능 상태와 연결된 메타데이터로, 상태가 만료되는 시점을 지정합니다.
| 필드 | |
|---|---|
expiration_time |
출력 전용입니다. 사용자가 DO_NOT_DISTURB로 표시되어야 하는 타임스탬프입니다. 향후 최대 1년까지 가능합니다. |
DriveDataRef
Drive 첨부파일의 데이터에 대한 참조입니다.
| 필드 | |
|---|---|
drive_file_id |
Drive 파일의 ID입니다. Drive API와 함께 사용합니다. |
DriveLinkData
Google Drive 링크의 데이터입니다.
| 필드 | |
|---|---|
drive_data_ref |
Google Drive 파일을 참조하는 DriveDataRef입니다. |
mime_type |
연결된 Google Drive 리소스의 MIME 유형입니다. |
요소
| 필드 | |
|---|---|
cited_sources[] |
메시지 아래에 바닥글 링크로 표시할 소스 목록입니다. 이러한 항목은 인라인으로 참조되지 않습니다. 인라인 참조의 경우 |
citations[] |
메시지 텍스트 내에서 참조되는 인라인 인용 목록 ( |
ElementsImage
| 필드 | |
|---|---|
통합 필드 image. 필수 항목입니다. 지원되는 이미지 표현 중 하나입니다. image은 다음 중 하나여야 합니다. |
|
image_uri |
필수 항목입니다. 이미지의 공개적으로 액세스할 수 있는 URI입니다. |
그림 이모티콘
메시지에 대한 반응으로 사용되는 그림 이모티콘입니다.
| 필드 | |
|---|---|
통합 필드 content. 필수 항목입니다. 그림 이모티콘의 콘텐츠입니다. content은 다음 중 하나여야 합니다. |
|
unicode |
선택사항입니다. 유니코드 문자열로 표현되는 기본 이모티콘입니다. |
custom_emoji |
맞춤 이모티콘입니다. |
EmojiReactionSummary
특정 이모티콘으로 메시지에 반응한 사용자 수입니다.
| 필드 | |
|---|---|
emoji |
출력 전용입니다. 반응과 연결된 이모티콘입니다. |
reaction_count |
출력 전용입니다. 연결된 이모티콘을 사용한 총 반응 수입니다. |
FindDirectMessageRequest
사용자 리소스를 기반으로 채팅 메시지 스페이스를 가져오라는 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 채팅 메시지를 찾을 사용자의 리소스 이름입니다. 형식: |
FindGroupChatsRequest
사용자 리소스를 기반으로 그룹 채팅 스페이스를 가져오라는 요청입니다.
| 필드 | |
|---|---|
users[] |
선택사항입니다. 호출 사용자와의 그룹 채팅에 참여하는 모든 사람 사용자의 리소스 이름입니다. 요청에 Chat 앱을 포함할 수 없습니다. 단일 요청에서 지정할 수 있는 최대 사용자 수는 형식: |
page_size |
선택사항입니다. 반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 10개의 스페이스가 반환됩니다. 최댓값은 30입니다. 30을 초과하는 값을 사용하면 자동으로 30으로 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 그룹 채팅을 찾기 위한 이전 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
space_view |
요청된 스페이스 뷰 유형입니다. 설정하지 않으면 기본값은 |
FindGroupChatsResponse
호출한 사용자와 요청된 사용자가 정확히 포함된 그룹 채팅 스페이스가 포함된 응답입니다.
| 필드 | |
|---|---|
spaces[] |
요청된 (또는 첫 번째) 페이지의 스페이스 목록입니다. |
next_page_token |
결과의 다음 페이지를 검색하기 위해 |
ForwardedMetadata
메시지가 전달된 소스 스페이스에 관한 메타데이터입니다.
| 필드 | |
|---|---|
space |
출력 전용입니다. 원본 스페이스의 리소스 이름입니다. 형식: spaces/{space} |
space_display_name |
출력 전용입니다. 전달 시점의 원본 스페이스 또는 채팅 메시지의 표시 이름입니다. |
GetAttachmentRequest
첨부파일 가져오기 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. |
GetAvailabilityRequest
GetAvailability 메서드에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 검색할 사용 가능 여부의 리소스 이름입니다. 형식: users/{user}/availability
사용자의 이메일 주소 또는 |
GetCustomEmojiRequest
단일 맞춤 그림 이모티콘을 반환하는 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 맞춤 이모티콘의 리소스 이름입니다. 형식: 그림 이모티콘 이름을 |
GetMembershipRequest
스페이스의 멤버십을 가져오기 위한 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 검색할 멤버십의 리소스 이름입니다. 사용자 인증을 사용하여 앱의 자체 멤버십을 가져오려면 원하는 경우 형식: 사용자의 이메일을 |
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스를 사용하는 경우 스페이스에서 앱 멤버십을 가져올 수 없습니다. |
GetMessageRequest
메시지 가져오기 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 메시지의 리소스 이름입니다. 형식: 메시지에 커스텀 ID를 설정한 경우 |
markup_syntax |
선택사항입니다. 채팅 메시지 |
GetSpaceEventRequest
스페이스 이벤트를 가져오기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 스페이스 이벤트의 리소스 이름입니다. 형식: |
GetSpaceNotificationSettingRequest
스페이스 알림 설정을 가져오는 요청 메시지입니다. 호출 사용자의 알림 설정 가져오기만 지원합니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 형식: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
GetSpaceReadState API의 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 검색할 스페이스 읽기 상태의 리소스 이름입니다. 호출 사용자의 읽기 상태 가져오기만 지원합니다. 호출 사용자를 참조하려면 다음 중 하나를 설정합니다.
형식: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
단일 스페이스를 반환하는 요청입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 형식: |
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 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_size |
선택사항입니다. 반환되는 맞춤 이모티콘의 최대 개수입니다. 서비스는 이 값보다 적은 수의 맞춤 그림 이모티콘을 반환할 수 있습니다. 지정하지 않으면 기본값은 25입니다. 최댓값은 200이며 200을 초과하는 값은 200으로 변경됩니다. |
page_token |
선택사항입니다. (이전 쿼리에서 재개하는 경우) 이전 맞춤 이모티콘 나열 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 크리에이터별 필터링을 지원합니다. 작성자로 필터링하려면 유효한 값을 지정해야 합니다. 현재는 예를 들어 다음 쿼리는 호출자가 만든 맞춤 이모티콘을 반환합니다. 잘못된 쿼리는 |
ListCustomEmojisResponse
맞춤 이모티콘을 나열하는 응답입니다.
| 필드 | |
|---|---|
custom_emojis[] |
순서가 지정되지 않은 목록 맞춤 이모티콘 목록입니다. |
next_page_token |
결과의 다음 페이지를 검색하기 위해 |
ListMembershipsRequest
멤버십 나열 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 멤버십 목록을 가져올 스페이스의 리소스 이름입니다. 형식: spaces/{space} |
page_size |
선택사항입니다. 반환할 최대 멤버십 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 멤버십이 최대 100개 반환됩니다. 최댓값은 1,000입니다. 1,000보다 큰 값을 사용하면 자동으로 1,000으로 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 멤버십을 나열하기 위한 이전 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 구성원의 역할 ( 역할별로 필터링하려면 유형별로 필터링하려면 역할과 유형을 모두 기준으로 필터링하려면
예를 들어 다음 쿼리는 유효합니다. 다음 쿼리는 유효하지 않습니다. 잘못된 쿼리는 서버에서 |
show_groups |
선택사항입니다. |
show_invited |
선택사항입니다. 현재 사용자 인증이 필요합니다. |
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
관리 액세스를 사용하는 경우 스페이스의 앱 멤버십을 나열하는 기능은 지원되지 않습니다. |
ListMembershipsResponse
스페이스의 멤버십을 나열하는 응답입니다.
| 필드 | |
|---|---|
memberships[] |
순서가 지정되지 않은 목록 요청된 (또는 첫 번째) 페이지의 멤버십 목록입니다. |
next_page_token |
결과의 다음 페이지를 검색하기 위해 |
ListMessagePinsRequest
메시지 고정 목록을 표시하기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 고정된 항목 컬렉션을 소유한 상위 스페이스입니다. 형식: |
page_size |
선택사항입니다. 반환되는 최대 메시지 고정 수입니다. 서비스가 이 값보다 더 적은 메시지를 반환할 수 있습니다. 최댓값은 100입니다. 100을 초과하는 값을 사용하면 자동으로 100으로 변경됩니다. 지정하지 않으면 최대 100개의 메시지 고정이 반환됩니다. 음수 값은 |
page_token |
선택사항입니다. 이전 메시지 고정 목록 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
ListMessagePinsResponse
메시지 고정을 나열하기 위한 응답 메시지입니다.
| 필드 | |
|---|---|
message_pins[] |
지정된 스페이스의 고정된 메시지입니다. |
next_page_token |
토큰을 |
ListMessagesRequest
사용자가 속한 지정된 스페이스의 메시지를 나열합니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 메시지를 나열할 스페이스의 리소스 이름입니다. 형식: |
page_size |
선택사항입니다. 반환되는 최대 메시지 수입니다. 서비스가 이 값보다 더 적은 메시지를 반환할 수 있습니다. 지정하지 않으면 최대 25개가 반환됩니다. 최댓값은 1,000입니다. 1,000보다 큰 값을 사용하면 자동으로 1,000으로 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 이전 메시지 목록 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 날짜 ( 생성된 날짜를 기준으로 메시지를 필터링하려면 RFC-3339 형식의 타임스탬프와 큰따옴표를 사용하여 대화목록별로 필터링하려면 대화목록과 날짜를 모두 기준으로 필터링하려면 쿼리에 예를 들어 다음 쿼리는 유효합니다. 잘못된 쿼리는 서버에서 |
order_by |
선택사항입니다. 메시지 목록의 정렬 방식입니다. 정렬 작업으로 정렬할 값을 지정합니다. 유효한 정렬 작업 값은 다음과 같습니다.
기본 순서는 |
show_deleted |
선택사항입니다. 삭제된 메시지를 포함할지 여부입니다. 삭제된 메시지에는 삭제된 시간과 삭제에 관한 메타데이터가 포함되지만 메시지 콘텐츠는 사용할 수 없습니다. |
markup_syntax |
선택사항입니다. 채팅 메시지 |
ListMessagesResponse
메시지 나열에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
messages[] |
메시지 목록입니다. |
next_page_token |
토큰을 |
ListReactionsRequest
메시지에 대한 반응을 나열합니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 사용자가 반응한 메시지입니다. 형식: |
page_size |
선택사항입니다. 반환되는 최대 반응 수입니다. 서비스는 이 값보다 적은 반응을 반환할 수 있습니다. 지정하지 않으면 기본값은 25입니다. 최댓값은 200이며 200을 초과하는 값은 200으로 변경됩니다. |
page_token |
선택사항입니다. (이전 쿼리에서 재개하는 경우) 이전 list reactions 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 이모티콘 ( 여러 이모티콘 또는 사용자의 반응을 필터링하려면 이모티콘 및 사용자로 반응을 필터링하려면 쿼리에서 예를 들어 다음 쿼리는 유효합니다. 다음 쿼리는 유효하지 않습니다. 잘못된 쿼리는 |
ListReactionsResponse
반응 나열 요청에 대한 응답입니다.
| 필드 | |
|---|---|
reactions[] |
요청된 (또는 첫 번째) 페이지의 반응 목록입니다. |
next_page_token |
결과의 다음 페이지를 검색하는 연속 토큰입니다. 결과의 마지막 페이지는 비어 있습니다. |
ListSectionItemsRequest
섹션 항목을 나열하기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 이 섹션 항목 컬렉션을 소유한 섹션 리소스 이름인 상위 항목입니다. 호출 사용자의 섹션 항목 나열만 지원합니다. 스페이스로 필터링할 때 와일드 카드 형식: |
page_size |
선택사항입니다. 반환할 최대 섹션 항목 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 10개의 섹션 항목이 반환됩니다. 최댓값은 100입니다. 100을 초과하는 값을 사용하면 자동으로 100으로 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 이전 섹션 항목 나열 호출에서 수신한 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 현재는 스페이스별 필터링만 지원됩니다. 예를 들면 잘못된 쿼리는 |
ListSectionItemsResponse
섹션 항목 나열에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
section_items[] |
지정된 섹션의 섹션 항목입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListSectionsRequest
섹션 나열 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 이 섹션 컬렉션을 소유한 사용자 리소스 이름인 상위 항목입니다. 호출 사용자의 섹션 나열만 지원합니다. 호출 사용자를 참조하려면 다음 중 하나를 설정합니다.
형식: |
page_size |
선택사항입니다. 반환할 최대 섹션 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 10개의 섹션이 반환됩니다. 최댓값은 100입니다. 100을 초과하는 값을 사용하면 자동으로 100으로 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 이전 섹션 나열 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
ListSectionsResponse
섹션 나열에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
sections[] |
지정된 사용자의 섹션입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListSpaceEventsRequest
스페이스 이벤트를 나열하는 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 이벤트가 발생한 Google Chat 스페이스의 리소스 이름입니다. 형식은 |
page_size |
선택사항입니다. 반환되는 최대 스페이스 이벤트 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 음수 값은 |
page_token |
선택사항입니다. 이전 스페이스 이벤트 목록 호출에서 수신한 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우 스페이스 이벤트 목록에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
필수 항목입니다. 쿼리 필터입니다.
원하는 경우 시작 시간 (
시작 시간 또는 종료 시간을 지정하려면 같음 예를 들어 다음 쿼리는 유효합니다. 다음 쿼리는 유효하지 않습니다. 잘못된 쿼리는 서버에서 |
ListSpaceEventsResponse
스페이스 이벤트 목록에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
space_events[] |
결과는 시간순으로 반환됩니다 (가장 오래된 이벤트가 먼저 표시됨). 참고: |
next_page_token |
더 많은 이벤트를 가져오는 데 사용되는 연속 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다. |
ListSpacesRequest
호출자가 멤버인 스페이스를 나열하는 요청입니다.
| 필드 | |
|---|---|
page_size |
선택사항입니다. 반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 100개의 스페이스가 반환됩니다. 최댓값은 1,000입니다. 1,000보다 큰 값을 사용하면 자동으로 1,000으로 변경됩니다. 음수 값은 |
page_token |
선택사항입니다. 이전 스페이스 목록 호출에서 수신한 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
filter |
선택사항입니다. 쿼리 필터입니다. 스페이스 유형 ( 스페이스 유형으로 필터링하려면 예를 들어 다음 쿼리는 유효합니다. 잘못된 쿼리는 서버에서 |
ListSpacesResponse
스페이스 목록 요청에 대한 응답입니다.
| 필드 | |
|---|---|
spaces[] |
요청된 (또는 첫 번째) 페이지의 스페이스 목록입니다. 참고: |
next_page_token |
토큰을 |
MarkAsActiveRequest
MarkAsActive 메서드에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 활성 상태로 표시할 사용 가능 여부의 리소스 이름입니다. 형식: users/{user}/availability
사용자의 이메일 주소 또는 |
통합 필드 expiration. ACTIVE 사용 가능 상태의 만료 시간입니다. 만료 후 사용자가 부재중으로 표시됩니다. 만료 시간이 제공되지 않으면 ACTIVE 상태는 현재 시간으로부터 30분 후에 만료됩니다. expiration은 다음 중 하나여야 합니다. |
|
expire_time |
ACTIVE 상태가 만료되는 절대 타임스탬프입니다. |
ttl |
현재 시간부터 ACTIVE 상태가 만료될 때까지의 기간입니다. 짧은 TTL을 사용하면 이 짧은 시간 후의 활동을 기반으로 사용자의 상태를 효과적으로 재설정할 수 있습니다. |
MarkAsAwayRequest
MarkAsAway 메서드에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 부재중으로 표시할 참석 가능 여부의 리소스 이름입니다. 형식: users/{user}/availability
사용자의 이메일 주소 또는 |
MarkAsDoNotDisturbRequest
MarkAsDoNotDisturb 메서드에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 방해 금지 모드로 표시할 참석 가능 여부의 리소스 이름입니다. 형식: users/{user}/availability
사용자의 이메일 주소 또는 |
통합 필드 expiration. 필수 항목입니다. 방해 금지 모드 사용 가능 상태의 만료 시간입니다. 만료 후 사용자가 부재중으로 표시됩니다. 현재 시간으로부터 최대 1년까지 가능합니다. expiration은 다음 중 하나여야 합니다. |
|
expire_time |
방해 금지 모드 상태가 만료되는 절대 타임스탬프입니다. |
ttl |
현재 시간부터 방해 금지 모드 상태가 만료될 때까지의 기간입니다. |
MarkupSyntax
채팅 메시지 텍스트의 형식을 지정하는 데 사용되는 마크업 문법을 지정합니다. Message 리소스의 text 필드에 적용됩니다.
| 열거형 | |
|---|---|
MARKUP_SYNTAX_UNSPECIFIED |
지정되지 않은 값을 나타냅니다. |
MARKUP_SYNTAX_CHAT |
Google Chat의 마크업 문법을 사용합니다. 자세한 내용은 https://developers.google.com/workspace/chat/format-messages#format-texts를 참고하세요. |
MARKUP_SYNTAX_MARKDOWN |
마크다운 문법을 사용합니다. 이 문법은 CommonMark 사양을 기반으로 하며 추가 확장 프로그램이 있습니다. 자세한 내용은 https://developers.google.com/workspace/chat/format-messages#format-texts를 참고하세요. |
MatchedUrl
채팅 메시지에서 일치하는 URL입니다. 채팅 앱은 일치하는 URL을 미리 볼 수 있습니다. 자세한 내용은 링크 미리보기를 참고하세요.
| 필드 | |
|---|---|
url |
출력 전용입니다. 일치하는 URL입니다. |
MeetSpaceLinkData
Meet 스페이스 링크의 데이터입니다.
| 필드 | |
|---|---|
meeting_code |
연결된 Meet 스페이스의 회의 코드입니다. |
type |
Meet 스페이스의 유형을 나타냅니다. |
huddle_status |
선택사항입니다. 출력 전용입니다. Meet이 허들인 경우 허들의 상태를 나타냅니다. 그렇지 않으면 설정되지 않습니다. |
HuddleStatus
허들 상태
| 열거형 | |
|---|---|
HUDDLE_STATUS_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
STARTED |
허들이 시작되었습니다. |
ENDED |
허들이 종료되었습니다. 이 경우 Meet 스페이스 URI 및 식별자가 더 이상 유효하지 않습니다. |
MISSED |
허들이 부재중입니다. 이 경우 Meet 스페이스 URI 및 식별자가 더 이상 유효하지 않습니다. |
유형
Meet 스페이스의 유형입니다.
| 열거형 | |
|---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
MEETING |
Meet 스페이스는 회의입니다. |
HUDDLE |
Meet 공간은 허들입니다. |
멤버십
사용자 또는 Chat 앱이 스페이스에 초대되었는지, 스페이스에 참여 중인지, 스페이스에 없는지 등 Google Chat의 멤버십 관계를 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 서버에서 할당한 멤버십의 리소스 이름입니다. 형식: |
state |
출력 전용입니다. 멤버십 상태입니다. |
role |
선택사항입니다. Chat 스페이스 내 사용자의 역할로, 스페이스에서 허용되는 작업을 결정합니다. 이 필드는 |
create_time |
선택사항입니다. 변경할 수 없습니다. 멤버십이 생성된 시간입니다(예: 멤버가 스페이스에 참여하거나 참여하도록 초대된 시간). 이 필드는 가져오기 모드 스페이스에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다. |
delete_time |
선택사항입니다. 변경할 수 없습니다. 멤버가 스페이스에서 나가거나 삭제된 시간과 같은 멤버십 삭제 시간입니다. 이 필드는 가져오기 모드 스페이스에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다. |
affiliation |
출력 전용입니다. 스페이스를 소유한 Workspace 조직과 사용자의 관계입니다. 일반 계정이 소유한 스페이스에서 모든 참여자의 소속은 |
통합 필드 memberType. 이 멤버십과 연결된 회원입니다. 향후 다른 구성원 유형이 지원될 수 있습니다. memberType은 다음 중 하나여야 합니다. |
|
member |
선택사항입니다. 멤버십에 해당하는 Google Chat 사용자 또는 앱입니다. Chat 앱이 사용자로 인증하는 경우, 스페이스의 멤버이거나 호출 사용자와 채팅 메시지 (DM) 대화와 같은 이전 친밀도가 있는 경우가 아니면 내부 및 외부 사용자 모두에 대해 사용자 |
group_member |
선택사항입니다. 멤버십이 해당하는 Google 그룹입니다. Google 그룹스의 멤버십을 읽거나 변경하려면 사용자 인증이 필요합니다. |
제휴
스페이스를 소유한 Google Workspace 조직에 대한 사용자의 소속을 나타냅니다. 이 enum에는 향후 더 많은 값이 추가될 수 있습니다.
| 열거형 | |
|---|---|
AFFILIATION_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
INTERNAL |
스페이스를 소유한 동일한 Google Workspace 조직에서 관리하는 계정입니다. |
EXTERNAL |
스페이스를 소유한 Google Workspace 조직 외부의 계정 (예: 일반 계정 또는 다른 Workspace 조직에서 관리하는 계정) |
MANAGED_EXTERNAL |
스페이스를 소유한 Workspace 조직에서 관리하지만 조직 외부의 사용자 (예: 게스트 사용자)를 위해 프로비저닝된 계정입니다. 게스트에 대해 자세히 알아보려면 https://support.google.com/chat/answer/16997417를 참고하세요. |
MembershipRole
Chat 스페이스에서 사용자가 허용하는 작업을 나타냅니다. 향후 더 많은 enum 값이 추가될 수 있습니다.
| 열거형 | |
|---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
기본값 users: 스페이스의 멤버가 아니지만 초대할 수 있습니다. Google Groups: 항상 이 역할이 할당됩니다 (향후 다른 enum 값이 사용될 수 있음). |
ROLE_MEMBER |
스페이스의 구성원입니다. Chat UI에서 이 역할은 멤버라고 합니다. 사용자에게 스페이스에 메시지를 보내는 등의 기본 권한이 있습니다. 관리자와 소유자는 스페이스에서 멤버에게 다음과 같은 추가 권한을 부여할 수 있습니다.
채팅 메시지 및 이름이 지정되지 않은 그룹 대화에서는 모든 사용자가 이 역할을 갖습니다. |
ROLE_MANAGER |
스페이스 소유자 Chat UI에서 이 역할은 소유자라고 합니다. 사용자는 다음을 포함하여 스페이스를 관리할 수 있는 전체 스페이스 권한을 갖습니다.
자세한 내용은 스페이스 소유자 또는 관리자 역할 자세히 알아보기를 참고하세요. |
ROLE_ASSISTANT_MANAGER |
스페이스 관리자 Chat UI에서 이 역할은 관리자라고 합니다. 사용자는
기본적으로 관리자 권한에는 다음이 포함되지만 이에 국한되지는 않습니다.
자세한 내용은 스페이스 설정 관리하기를 참고하세요. |
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 앱이 사용자로 인증하는 경우, 스페이스의 멤버이거나 호출 사용자와 채팅 메시지 (DM) 대화와 같은 이전 친밀도가 있는 경우가 아니면 내부 및 외부 사용자 모두에 대해 사용자 |
create_time |
선택사항입니다. 변경할 수 없습니다. Chat에서 만든 스페이스의 경우 메시지가 생성된 시간입니다. 이 필드는 가져오기 모드 스페이스에서 사용되는 경우를 제외하고 출력 전용입니다. 가져오기 모드 스페이스의 경우 원래 생성 시간을 보존하기 위해 이 필드를 소스에서 메시지가 생성된 이전 타임스탬프로 설정합니다. |
last_update_time |
출력 전용입니다. 사용자가 메시지를 마지막으로 수정한 시간입니다. 메시지가 수정된 적이 없으면 이 필드는 비어 있습니다. |
delete_time |
출력 전용입니다. Google Chat에서 메시지가 삭제된 시간입니다. 메시지가 삭제되지 않으면 이 필드는 비어 있습니다. |
text |
선택사항입니다. 메시지의 일반 텍스트 본문입니다. 이미지, 동영상 또는 웹페이지의 첫 번째 링크는 미리보기 칩을 생성합니다. Google Chat 사용자를 @멘션하거나 스페이스의 모든 사용자를 @멘션할 수도 있습니다. 문자 메시지를 만드는 방법을 알아보려면 메시지 보내기를 참고하세요. |
formatted_text |
출력 전용입니다. 형식을 전달하기 위해 마크업이 추가된
자세한 내용은 메시지로 전송된 텍스트 서식 보기를 참고하세요. |
cards[] |
지원 중단됨: 대신 서식 있는 텍스트, 버튼, 클릭 가능한 이미지와 같은 UI 요소를 표시하는 데 사용할 수 있는 서식 있는 대화형 카드입니다. 카드는 일반적으로 메시지의 일반 텍스트 본문 아래에 표시됩니다. |
cards_v2[] |
선택사항입니다. 카드 배열입니다. 채팅 앱은 앱 인증을 사용하여 카드를 만들 수 있습니다. 개발자 프리뷰 프로그램의 일환으로 Chat 앱이 사용자로 인증하는 경우 카드 메시지를 만들 수 있습니다. Chat 앱이 개발자 프리뷰 프로그램에 속하지 않는 경우 사용자 인증이 있는 카드를 만들 수 없습니다. 카드가 포함된 메시지를 만드는 방법은 메시지 보내기를 참고하세요. 카드 빌더로 카드를 디자인하고 미리 봅니다. 카드 빌더 열기 |
annotations[] |
출력 전용입니다. 주석은 메시지의 일반 텍스트 본문 또는 |
thread |
메일이 속한 대화목록입니다. 사용 예시는 메시지 대화목록 시작 또는 답장을 참고하세요. |
space |
|
fallback_text |
선택사항입니다. 실제 카드를 표시할 수 없는 경우(예: 모바일 알림)에 사용되는 메시지 카드의 일반 텍스트 설명입니다. |
action_response |
입력 전용입니다. Chat 앱에서 응답 게시 방법을 구성하는 데 사용할 수 있는 매개변수입니다. |
argument_text |
출력 전용입니다. 모든 Chat 앱 언급이 삭제된 메시지의 일반 텍스트 본문입니다. |
slash_command |
출력 전용입니다. 슬래시 명령어 정보(해당하는 경우) |
attachment[] |
선택사항입니다. 사용자가 업로드한 첨부파일입니다. |
matched_url |
출력 전용입니다. 링크 미리보기 패턴과 일치하는 채팅 메시지 |
thread_reply |
출력 전용입니다. 스페이스에서 대화목록 답장을 지원하지 않는 경우 이 필드는 항상 |
silent |
출력 전용입니다. 무음 메시지인지 여부입니다. 무음 메시지는 Chat에서 수신자에게 푸시 알림을 표시하지 않는 메시지입니다. |
client_assigned_message_id |
선택사항입니다. 메시지의 커스텀 ID입니다. 필드를 사용하여 메시지를 식별하거나 메시지를 가져오거나 삭제하거나 업데이트할 수 있습니다. 커스텀 ID를 설정하려면 메시지를 만들 때 |
emoji_reaction_summaries[] |
출력 전용입니다. 메시지의 이모티콘 반응 요약 목록입니다. |
private_message_viewer |
선택사항입니다. 변경할 수 없습니다. 메시지를 만들기 위한 입력입니다. 그렇지 않으면 출력 전용입니다. 메시지를 볼 수 있는 사용자입니다. 설정하면 메시지가 비공개로 설정되며 지정된 사용자와 Chat 앱에만 표시됩니다. 요청에 이 필드를 포함하려면 앱 인증을 사용하여 Chat API를 호출하고 다음을 생략해야 합니다. 자세한 내용은 비공개 메시지 보내기를 참고하세요. |
deletion_metadata |
출력 전용입니다. 삭제된 메시지에 관한 정보입니다. |
quoted_message_metadata |
선택사항입니다. 다른 메시지에서 인용하는 메시지에 관한 정보입니다. 메시지를 만들 때 동일한 대화목록 내의 메시지를 인용하거나 루트 메시지를 인용하여 새 루트 메시지를 만들 수 있습니다. 하지만 다른 대화목록의 메시지 답장은 인용할 수 없습니다. 메시지를 업데이트할 때 사용 예시는 다른 메시지 인용을 참고하세요. |
attached_gifs[] |
출력 전용입니다. 메일에 첨부된 GIF 이미지입니다. |
accessory_widgets[] |
선택사항입니다. 메시지 하단에 표시되는 하나 이상의 대화형 위젯입니다. 텍스트, 카드 또는 텍스트와 카드가 모두 포함된 메시지에 액세서리 위젯을 추가할 수 있습니다. 대화가 포함된 메시지에는 지원되지 않습니다. 자세한 내용은 메시지 하단에 대화형 위젯 추가하기를 참고하세요. 액세서리 위젯이 있는 메시지를 만들려면 앱 인증이 필요합니다. |
elements |
선택사항입니다. 요소는 메시지 작성 중에 제공되는 추가 구성요소로, 메시지 텍스트의 특정 부분과 연결될 수도 있고 연결되지 않을 수도 있습니다. 이는 출력 전용이며 메시지 조각 또는 전체 메시지 텍스트와 관련된 보조 정보를 제공하는 주석과 다릅니다. |
markup_syntax |
선택사항입니다. 서버가 메시지 |
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 |
삭제된 메시지입니다. |
MessagePin
채팅 메시지의 고정 자세한 내용은 메시지 고정하기를 참고하세요.
| 필드 | |
|---|---|
name |
식별자. 메시지 고정의 리소스 이름입니다. 형식: |
message |
필수 항목입니다. 변경할 수 없습니다. 고정된 메시지의 리소스 이름입니다. 형식: |
MessageUpdatedEventData
업데이트된 메시지의 이벤트 페이로드입니다.
이벤트 유형: google.workspace.chat.message.v1.updated
| 필드 | |
|---|---|
message |
업데이트된 메시지입니다. |
MoveSectionItemRequest
섹션 간에 섹션 항목을 이동하기 위한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 이동할 섹션 항목의 리소스 이름입니다. 형식: |
target_section |
필수 항목입니다. 섹션 항목을 이동할 섹션의 리소스 이름입니다. 형식: |
MoveSectionItemResponse
섹션 항목 이동에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
section_item |
업데이트된 섹션 항목입니다. |
PositionSectionRequest
섹션 위치를 지정하는 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 위치를 지정할 섹션의 리소스 이름입니다. 형식: |
통합 필드 position. 필수 항목입니다. 섹션의 새 위치입니다. position은 다음 중 하나여야 합니다. |
|
sort_order |
선택사항입니다. 섹션 목록에서 섹션의 절대 위치입니다. 위치는 0보다 커야 합니다. 위치가 섹션 수보다 크면 섹션이 목록 끝에 추가됩니다. 이 작업은 지정된 위치에 섹션을 삽입하고 해당 위치의 원래 섹션과 그 아래의 섹션을 다음 위치로 이동합니다. |
relative_position |
선택사항입니다. 섹션 목록에서 섹션의 상대적 위치입니다. |
직위
섹션의 위치입니다.
| 열거형 | |
|---|---|
POSITION_UNSPECIFIED |
지정되지 않은 위치입니다. |
START |
섹션 목록의 시작입니다. |
END |
섹션 목록 끝 |
PositionSectionResponse
섹션 위치 지정에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
section |
업데이트된 섹션입니다. |
QuotedMessageMetadata
다른 메시지에서 인용하는 메시지에 관한 정보입니다.
메시지를 업데이트할 때 quotedMessageMetadata 필드를 추가하거나 바꿀 수는 없지만 삭제할 수는 있습니다.
사용 예시는 다른 메시지 인용을 참고하세요.
| 필드 | |
|---|---|
name |
필수 항목입니다. 인용된 메시지의 리소스 이름입니다. 형식: |
last_update_time |
필수 항목입니다. 인용된 메시지가 생성된 시점 또는 인용된 메시지가 마지막으로 업데이트된 시점의 타임스탬프입니다. 메시지가 수정된 경우 이 필드(
|
quote_type |
선택사항입니다. 견적 유형을 지정합니다. 설정하지 않으면 이전 버전과의 호환성을 위해 메시지 읽기/쓰기 경로에서 REPLY가 기본값으로 사용됩니다. |
quoted_message_snapshot |
출력 전용입니다. 인용된 메시지 콘텐츠의 스냅샷입니다. |
forwarded_metadata |
출력 전용입니다. 인용된 메시지의 소스 스페이스에 관한 메타데이터입니다. FORWARD 견적 유형에만 채워집니다. |
QuoteType
인용된 메시지의 인용 유형입니다.
| 열거형 | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
Reserved. 이 값은 사용되지 않습니다. |
REPLY |
|
FORWARD |
|
QuotedMessageSnapshot
인용 또는 전달 시 인용된 메시지 내용의 스냅샷을 제공합니다.
| 필드 | |
|---|---|
sender |
출력 전용입니다. 인용된 메시지의 작성자 이름입니다. REPLY 및 FORWARD 인용 유형 모두에 채워집니다. |
text |
출력 전용입니다. 인용된 메시지의 텍스트 콘텐츠 스냅샷입니다. |
formatted_text |
출력 전용입니다. 하이퍼링크, 맞춤 그림 이모티콘, 마크업 등 서식 있는 텍스트를 지원하기 위해 마크업이 추가된 인용 메시지 |
annotations[] |
출력 전용입니다. 인용된 메시지의 텍스트 본문에서 파싱된 주석입니다. FORWARD 견적 유형에만 채워집니다. |
attachments[] |
출력 전용입니다. 인용된 메일에 포함된 첨부파일입니다. 인용된 메시지의 첨부파일 메타데이터 사본입니다. FORWARD 견적 유형에만 채워집니다. |
반응
메시지에 대한 반응입니다.
| 필드 | |
|---|---|
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 |
삭제된 반응입니다. |
ReplaceMessageCardsRequest
ReplaceMessageCards API 메서드의 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 메시지의 리소스 이름입니다. 형식: |
cards_v2[] |
선택사항입니다. 메시지에 포함할 카드 배열입니다. 이 카드는 메시지의 기존 카드를 대체합니다. 비어 있으면 메시지에 포함된 원본 카드가 삭제됩니다. |
ReplaceMessageCardsResponse
이 유형에는 필드가 없습니다.
ReplaceMessageCards API의 응답 메시지입니다.
RichLinkMetadata
리소스에 대한 리치 링크입니다. 리치 링크는 메시지의 일반 텍스트 본문과 연결되거나 start_index 및 length가 0인 Google Docs 또는 Sheets와 같은 Google Workspace 리소스에 연결되는 칩을 나타낼 수 있습니다.
| 필드 | |
|---|---|
uri |
이 링크의 URI입니다. |
rich_link_type |
리치 링크 유형입니다. |
통합 필드 data. 연결된 리소스의 데이터입니다. data은 다음 중 하나여야 합니다. |
|
drive_link_data |
Drive 링크의 데이터입니다. |
chat_space_link_data |
Chat 스페이스 링크의 데이터입니다. |
meet_space_link_data |
Meet 스페이스 링크의 데이터입니다. |
calendar_event_link_data |
캘린더 일정 링크의 데이터입니다. |
RichLinkType
리치 링크 유형입니다. 향후 더 많은 유형이 추가될 수 있습니다.
| 열거형 | |
|---|---|
RICH_LINK_TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
DRIVE_FILE |
Google Drive 리치 링크 유형입니다. |
CHAT_SPACE |
Chat 스페이스 리치 링크 유형입니다. 예를 들어 스페이스 스마트 칩이 있습니다. |
GMAIL_MESSAGE |
Gmail 메일 리치 링크 유형입니다. 구체적으로는 Chat에 공유의 Gmail 칩입니다. API는 GMAIL_MESSAGE 리치 링크가 있는 메시지 읽기만 지원합니다. |
MEET_SPACE |
Meet 메시지 리치 링크 유형입니다. 예를 들어 Meet 칩이 있습니다. |
CALENDAR_EVENT |
Calendar 메시지 리치 링크 유형입니다. 예를 들어 캘린더 칩이 있습니다. |
SearchMessageResult
메시지 검색의 단일 결과 항목입니다.
| 필드 | |
|---|---|
message |
일치하는 메시지입니다. |
space_mute_setting |
메시지가 게시된 스페이스의 호출 사용자의 음소거 설정입니다. 호출자 앱은 이 정보를 사용하여 사용자에 대해 스페이스가 숨겨져 있는지 여부에 따라 메시지를 처리하는 방법을 결정할 수 있습니다. 요청 뷰가
|
read |
호출 사용자가 일치하는 메시지를 읽었는지 여부를 나타냅니다. 요청 뷰가
|
SearchMessagesRequest
메시지 검색을 위한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 검색할 스페이스의 리소스 이름입니다. 사용자가 액세스할 수 있는 모든 스페이스를 검색하려면 이 필드를 검색을 하나 이상의 스페이스로 제한하려면 |
filter |
필수 항목입니다. 검색어입니다. 쿼리는 결과를 필터링하는 데 사용되는 하나 이상의 검색 키워드를 지정할 수 있습니다. 다음 메시지 필드를 사용하여 결과를 필터링할 수도 있습니다.
고급 필터링의 경우 다음 함수도 사용할 수 있습니다.
여러 필드에서 동일한 필드 중:
동일한 쿼리에서 다음 쿼리 예시는 유효합니다. 최대 쿼리 길이는 1,000자(영문 기준)입니다. 잘못된 쿼리는 서버에서 |
page_size |
선택사항입니다. 반환할 최대 결과 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 25개가 반환됩니다. 최댓값은 100입니다. 100을 초과하는 값을 사용하면 자동으로 100으로 변경됩니다. |
page_token |
선택사항입니다. 이전 검색 메시지 호출에서 수신된 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
order_by |
선택사항입니다. 결과 목록이 정렬되는 방식입니다. 정렬 기준으로 지원되는 속성은 다음과 같습니다.
기본 순서는 |
markup_syntax |
선택사항입니다. 채팅 메시지 |
view |
선택사항입니다. 반환할 검색 결과 뷰의 종류를 지정합니다. 기본값은 |
SearchMessagesView
부분 검색 결과에 지원되는 뷰 종류입니다.
| 열거형 | |
|---|---|
SEARCH_MESSAGES_VIEW_UNSPECIFIED |
기본값 / 설정되지 않은 값입니다. API는 BASIC 뷰로 기본 설정됩니다. |
SEARCH_MESSAGES_VIEW_BASIC |
결과에 일치하는 메시지만 포함되고 추가 메타데이터는 포함되지 않습니다. 기본값입니다. |
SEARCH_MESSAGES_VIEW_FULL |
일치하는 메시지와 추가 메타데이터 등 결과의 모든 항목이 포함됩니다. |
SearchMessagesResponse
메시지 검색에 대한 응답 메시지입니다.
| 필드 | |
|---|---|
results[] |
쿼리와 일치하는 검색 결과 목록입니다. |
next_page_token |
다음 페이지를 가져오는 데 사용할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 표시되지 않습니다. |
SearchSpacesRequest
쿼리를 기반으로 스페이스 목록을 검색하는 요청입니다.
| 필드 | |
|---|---|
use_admin_access |
호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
page_size |
반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 100개의 스페이스가 반환됩니다.
|
page_token |
이전 검색 공간 호출에서 수신된 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나누는 경우 제공된 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
query |
필수 항목입니다. 검색어입니다.
여러 필드에서 동일한 필드에서 다음 예시 쿼리는 다음 예시 쿼리는 최대 쿼리 길이는 1,000자(영문 기준)입니다. 잘못된 쿼리는 서버에서 |
order_by |
선택사항입니다. 스페이스 목록이 정렬되는 방식입니다. 정렬 기준으로 지원되는 속성은 다음과 같습니다.
유효한 순서 지정 작업 값은 다음과 같습니다.
지원되는 문법은
|
SearchSpacesResponse
스페이스 검색 요청에 해당하는 스페이스 목록이 포함된 응답입니다.
| 필드 | |
|---|---|
spaces[] |
지원 중단됨: 대신 새 |
next_page_token |
다음 페이지를 가져오는 데 사용할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 표시되지 않습니다.
|
total_size |
모든 페이지에서 쿼리와 일치하는 총 스페이스 수입니다. 결과가 10,000개를 초과하는 경우 이 값은 추정치입니다.
|
results[] |
출력 전용입니다. 쿼리와 일치하는 검색 결과 목록입니다. |
SearchSpaceResult
스페이스 검색의 단일 결과 항목입니다.
| 필드 | |
|---|---|
space |
출력 전용입니다. 일치하는 스페이스입니다. |
섹션
Google Chat의 섹션을 나타냅니다. 섹션은 사용자가 스페이스를 정리하는 데 도움이 됩니다. 섹션에는 두 가지 유형이 있습니다.
시스템 섹션: Google Chat에서 관리하는 사전 정의된 섹션입니다. 리소스 이름은 고정되어 있으며, 만들거나 삭제하거나
display_name를 수정할 수 없습니다. 예를 들면 다음과 같습니다.users/{user}/sections/default-direct-messagesusers/{user}/sections/default-spacesusers/{user}/sections/default-apps
맞춤 섹션: 사용자가 만들고 관리하는 섹션입니다.
CreateSection를 사용하여 맞춤 섹션을 만들려면display_name가 필요합니다. 맞춤 섹션은UpdateSection를 사용하여 업데이트하고DeleteSection를 사용하여 삭제할 수 있습니다.
| 필드 | |
|---|---|
name |
식별자. 섹션의 리소스 이름입니다. 시스템 섹션의 경우 섹션 ID는 상수 문자열입니다.
형식: |
display_name |
선택사항입니다. 섹션의 표시 이름입니다. |
sort_order |
출력 전용입니다. 다른 섹션과 관련된 섹션의 순서입니다. |
type |
필수 항목입니다. 섹션의 유형입니다. |
SectionType
섹션 유형입니다.
| 열거형 | |
|---|---|
SECTION_TYPE_UNSPECIFIED |
지정되지 않은 섹션 유형입니다. |
CUSTOM_SECTION |
맞춤 섹션 |
DEFAULT_DIRECT_MESSAGES |
두 사용자 간의 DIRECT_MESSAGE 또는 맞춤 섹션에 속하지 않는 GROUP_CHAT 스페이스가 포함된 기본 섹션입니다. |
DEFAULT_SPACES |
맞춤 섹션에 속하지 않는 기본 스페이스입니다. |
DEFAULT_APPS |
사용자가 설치한 앱이 포함된 기본 섹션입니다. |
SectionItem
사용자가 정의한 섹션 항목입니다. 섹션 아래에 그룹화된 섹션 항목(예: 스페이스)을 나타내는 데 사용됩니다.
| 필드 | |
|---|---|
name |
식별자. 섹션 항목의 리소스 이름입니다. 형식: |
통합 필드 item. 필수 항목입니다. 섹션 항목입니다. item은 다음 중 하나여야 합니다. |
|
space |
선택사항입니다. 스페이스 리소스 이름입니다. 형식: |
SetUpSpaceRequest
스페이스를 만들고 지정된 사용자를 추가하도록 요청합니다.
| 필드 | |
|---|---|
space |
필수 항목입니다. 스페이스를 만들려면 그룹 채팅을 만들려면 사람 간의 1:1 대화를 만들려면 사용자와 호출하는 Chat 앱 간에 1:1 대화를 만들려면
|
request_id |
선택사항입니다. 이 요청의 고유 ID입니다. 임의의 UUID를 사용하는 것이 좋습니다. 요청 ID를 지정하면 요청이 멱등성을 갖게 되므로 동일한 요청 ID를 가진 여러 개의 동일한 요청으로 인해 하나의 스페이스만 생성됩니다. 요청된 세부정보가 현재 상태와 다르더라도 동일한 요청 ID를 사용하는 후속 요청은 기존 스페이스를 반환하고 스페이스를 업데이트하지 않습니다. 이 필드를 효과적으로 사용하려면 다음 안내를 따르세요.
|
memberships[] |
선택사항입니다. 스페이스에 참여하도록 초대할 Google Chat 사용자 또는 그룹입니다. 호출 사용자는 자동으로 추가되므로 생략합니다. 이 세트는 현재 최대 49명의 멤버십을 허용합니다 (호출자 제외). 사람 멤버십의 경우 Google 그룹스 멤버십의 경우
사용자와 호출하는 Chat 앱 간에 1:1 대화를 만들 때 ( |
SlashCommand
Google Chat의 슬래시 명령어에 관한 메타데이터입니다.
| 필드 | |
|---|---|
command_id |
슬래시 명령어의 ID입니다. |
SlashCommandMetadata
슬래시 명령어 (/)의 주석 메타데이터입니다.
| 필드 | |
|---|---|
bot |
명령어가 호출된 Chat 앱입니다. |
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 앱과 한 명의 사용자 간의 채팅 메시지인지 여부입니다. |
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 앱을 설치하고 채팅 메시지를 설정할 수 있습니다. 관리자 설치를 지원하려면 Chat 앱에 채팅 메시지 기능이 있어야 합니다. |
membership_count |
출력 전용입니다. 가입한 멤버십 수를 회원 유형별로 그룹화한 값입니다. |
access_settings |
선택사항입니다. 스페이스의 액세스 설정을 지정합니다. |
space_uri |
출력 전용입니다. 사용자가 스페이스에 액세스하기 위한 URI입니다. |
import_mode_expire_time |
출력 전용입니다. 스페이스가 가져오기 모드로 유지되는 경우 시스템에서 자동으로 삭제되는 시간입니다. 가져오기 모드에서 생성된 각 스페이스는 만료 시간 전에 이 필드는 가져오기 모드로 생성된 스페이스에만 채워집니다. |
customer |
선택사항입니다. 변경할 수 없습니다. 스페이스 도메인의 고객 ID입니다. 앱 인증을 사용하여 스페이스를 만들고
이 입력란은 채팅 메시지 (DM) 또는 Google Workspace 사용자가 아닌 사용자가 스페이스를 만든 경우에는 채워지지 않습니다. |
통합 필드 space_permission_settings. 스페이스의 권한 설정을 나타냅니다. space_type가 SPACE인 경우에만 채워집니다. space_permission_settings은 다음 중 하나여야 합니다. |
|
predefined_permission_settings |
선택사항입니다. 입력 전용입니다. 사전 정의된 스페이스 권한 설정으로, 스페이스를 만들 때만 입력합니다. 필드가 설정되지 않으면 공동작업 공간이 생성됩니다. 스페이스를 만들면 설정이 사전 정의된 권한 설정을 지정하면 다음이 지원됩니다. |
permission_settings |
선택사항입니다. 기존 스페이스의 스페이스 권한 설정 정확한 스페이스 권한 설정을 업데이트하기 위한 입력으로, 기존 권한 설정이 대체됩니다. 출력에 현재 권한 설정이 표시됩니다. 권한 설정 읽기 및 업데이트는 다음을 지원합니다. |
AccessPermissionSetting
액세스 권한 설정입니다.
| 필드 | |
|---|---|
principals[] |
선택사항입니다. 순서가 지정되지 않은 목록 이 권한에 허용되는 주 구성원입니다. |
AccessPermissionSettings
스페이스의 액세스 권한 설정
| 필드 | |
|---|---|
discover_space_setting |
선택사항입니다. 스페이스를 검색하기 위한 액세스 권한 설정입니다. |
join_space_setting |
선택사항입니다. 스페이스 참여를 위한 액세스 권한 설정입니다. |
view_space_membership_setting |
선택사항입니다. 스페이스 멤버십을 보기 위한 액세스 권한 설정입니다. 스페이스 멤버십을 볼 수 있는 사용자를 업데이트할 때 업데이트 마스크 및 요청 본문에 |
AccessSettings
스페이스의 액세스 설정을 나타냅니다.
| 필드 | |
|---|---|
access_state |
출력 전용입니다. 스페이스의 액세스 상태를 나타냅니다. |
audience |
선택사항입니다. 스페이스를 검색하고, 스페이스에 참여하고, 스페이스의 메시지를 미리 볼 수 있는 타겟층의 리소스 이름입니다. 설정하지 않으면 스페이스에 개별적으로 초대되거나 추가된 사용자 또는 Google 그룹만 스페이스에 액세스할 수 있습니다. 자세한 내용은 공유 대상 그룹이 스페이스를 검색할 수 있도록 설정하기를 참고하세요. 형식: Google Workspace 조직의 기본 공유 대상 그룹을 사용하려면 타겟층 지원 읽기: 앱 인증과 함께 공유 타겟층을 설정하려면 사용자 인증이 필요합니다. |
access_permission_settings |
선택사항입니다. 스페이스의 액세스 권한 설정 스페이스를 만들 때 타겟 잠재고객을 설정하려면 요청에 |
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 |
선택사항입니다. 기본 스페이스 멤버 ( |
assistant_managers_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 |
선택사항입니다. 스페이스에서 메시지에 답장하는 설정입니다. |
view_space_membership |
선택사항입니다. 스페이스 멤버십을 보기 위한 설정입니다. 스페이스 멤버십을 볼 수 있는 사용자를 업데이트할 때 업데이트 마스크 및 요청 본문에 |
PredefinedPermissionSettings
이름이 지정된 스페이스를 만들 때만 지정할 수 있는 사전 정의된 권한 세트입니다. 향후 더 많은 설정이 추가될 수 있습니다. 이름이 지정된 스페이스의 권한 설정에 관한 자세한 내용은 스페이스에 대해 알아보기를 참고하세요.
| 열거형 | |
|---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
지정되지 않음. 사용하지 마세요. |
COLLABORATION_SPACE |
스페이스를 모든 멤버가 메시지를 게시할 수 있는 공동작업 스페이스로 설정합니다. |
ANNOUNCEMENT_SPACE |
스페이스 관리자만 메시지를 게시할 수 있는 공지 스페이스로 설정합니다. |
주 구성원
액세스 권한이 부여된 항목을 나타내는 주 구성원입니다.
| 필드 | |
|---|---|
통합 필드 principal_type. 주 구성원 유형입니다. principal_type은 다음 중 하나여야 합니다. |
|
audience |
잠재고객 |
SpaceDetails
설명 및 규칙을 포함한 스페이스에 관한 세부정보입니다.
| 필드 | |
|---|---|
description |
선택사항입니다. 스페이스에 대한 설명입니다. 예를 들어 스페이스의 토론 주제, 기능적 목적 또는 참여자를 설명합니다. 최대 4,096자(영문 기준)를 지원합니다. |
guidelines |
선택사항입니다. 스페이스의 규칙, 기대치, 에티켓입니다. 최대 5,000자(영문 기준)까지 지원됩니다. |
SpaceThreadingState
Chat 스페이스의 대화목록 상태 유형을 지정합니다.
| 열거형 | |
|---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Reserved. |
THREADED_MESSAGES |
메시지 대화목록을 지원하는 스페이스 사용자가 메시지에 응답할 때 대화목록 내에서 답장할 수 있으므로 원본 메시지의 맥락에 맞게 응답을 유지할 수 있습니다. |
GROUPED_MESSAGES |
주제별로 대화가 정리된 이름이 지정된 스페이스 주제와 답장이 그룹화됩니다. |
UNTHREADED_MESSAGES |
대화목록을 지원하지 않는 스페이스 이 스페이스 대화목록 상태는 다음을 포함한 특수한 경우에만 사용됩니다.
|
SpaceType
스페이스 유형입니다. 스페이스를 만들거나 업데이트할 때 필요합니다. 다른 용도의 경우 출력 전용입니다.
| 열거형 | |
|---|---|
SPACE_TYPE_UNSPECIFIED |
Reserved. |
SPACE |
사용자가 메시지를 보내고 파일을 공유하며 공동작업을 진행하는 공간입니다. SPACE에는 Chat 앱이 포함될 수 있습니다. |
GROUP_CHAT |
3명 이상의 사용자가 참여하는 그룹 대화 GROUP_CHAT에는 Chat 앱이 포함될 수 있습니다. |
DIRECT_MESSAGE |
두 사람 간 또는 사람과 Chat 앱 간의 1:1 메시지입니다. |
유형
지원 중단됨: 대신 SpaceType를 사용하세요.
| 열거형 | |
|---|---|
TYPE_UNSPECIFIED |
Reserved. |
ROOM |
두 명 이상의 사람 간의 대화 |
DM |
사용자와 Chat 앱 간의 1:1 채팅 메시지이며, 모든 메시지가 플랫합니다. 두 사람 간의 채팅 메시지는 포함되지 않습니다. |
SpaceBatchUpdatedEventData
스페이스를 여러 번 업데이트하는 이벤트 페이로드입니다.
이벤트 유형: google.workspace.chat.space.v1.batchUpdated
| 필드 | |
|---|---|
spaces[] |
업데이트된 스페이스 목록입니다. |
SpaceEvent
Google Chat 스페이스의 변경사항 또는 활동을 나타내는 이벤트입니다. 자세한 내용은 Google Chat의 이벤트 작업을 참고하세요.
| 필드 | |
|---|---|
name |
스페이스 이벤트의 리소스 이름입니다. 형식: |
event_time |
이벤트가 발생한 시간입니다. |
event_type |
스페이스 이벤트 유형입니다. 각 이벤트 유형에는 짧은 기간 동안 발생하는 이벤트 유형의 여러 인스턴스를 나타내는 일괄 버전이 있습니다. 메시지에 지원되는 이벤트 유형:
멤버십에 지원되는 이벤트 유형:
반응에 지원되는 이벤트 유형:
스페이스에 대해 지원되는 이벤트 유형:
|
통합 필드
|
|
message_created_event_data |
새 메시지의 이벤트 페이로드입니다. 이벤트 유형: |
message_updated_event_data |
업데이트된 메시지의 이벤트 페이로드입니다. 이벤트 유형: |
message_deleted_event_data |
삭제된 메시지의 이벤트 페이로드입니다. 이벤트 유형: |
message_batch_created_event_data |
여러 새 메시지의 이벤트 페이로드입니다. 이벤트 유형: |
message_batch_updated_event_data |
업데이트된 여러 메시지의 이벤트 페이로드입니다. 이벤트 유형: |
message_batch_deleted_event_data |
삭제된 여러 메시지의 이벤트 페이로드입니다. 이벤트 유형: |
space_updated_event_data |
스페이스 업데이트의 이벤트 페이로드입니다. 이벤트 유형: |
space_batch_updated_event_data |
스페이스를 여러 번 업데이트하는 이벤트 페이로드입니다. 이벤트 유형: |
membership_created_event_data |
새 멤버십의 이벤트 페이로드입니다. 이벤트 유형: |
membership_updated_event_data |
업데이트된 멤버십의 이벤트 페이로드입니다. 이벤트 유형: |
membership_deleted_event_data |
삭제된 멤버십의 이벤트 페이로드입니다. 이벤트 유형: |
membership_batch_created_event_data |
여러 신규 멤버십의 이벤트 페이로드입니다. 이벤트 유형: |
membership_batch_updated_event_data |
업데이트된 여러 멤버십의 이벤트 페이로드입니다. 이벤트 유형: |
membership_batch_deleted_event_data |
삭제된 멤버십 여러 개의 이벤트 페이로드입니다. 이벤트 유형: |
reaction_created_event_data |
새 반응의 이벤트 페이로드입니다. 이벤트 유형: |
reaction_deleted_event_data |
삭제된 반응의 이벤트 페이로드입니다. 이벤트 유형: |
reaction_batch_created_event_data |
여러 개의 새로운 반응에 대한 이벤트 페이로드입니다. 이벤트 유형: |
reaction_batch_deleted_event_data |
삭제된 여러 반응의 이벤트 페이로드입니다. 이벤트 유형: |
SpaceNotificationSetting
스페이스에 있는 사용자의 알림 설정입니다.
| 필드 | |
|---|---|
name |
식별자. 스페이스 알림 설정의 리소스 이름입니다. 형식은 |
notification_setting |
알림 설정입니다. |
mute_setting |
스페이스 알림 음소거 설정입니다. |
MuteSetting
스페이스 알림 음소거 설정 유형입니다.
| 열거형 | |
|---|---|
MUTE_SETTING_UNSPECIFIED |
Reserved. |
UNMUTED |
사용자는 알림 설정에 따라 스페이스에 대한 알림을 받게 됩니다. |
MUTED |
사용자는 알림 설정과 관계없이 스페이스에 대한 알림을 받지 않습니다. |
NotificationSetting
알림 설정 유형입니다. 향후 다른 유형이 지원될 수 있습니다.
| 열거형 | |
|---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
Reserved. |
ALL |
@멘션, 팔로우 중인 대화목록, 새 대화목록의 첫 번째 메시지에 의해 알림이 트리거됩니다. 사용자가 수동으로 팔로우 해제하지 않는 한 모든 새 대화목록이 자동으로 팔로우됩니다. |
MAIN_CONVERSATIONS |
@멘션, 팔로우 중인 대화목록, 새 대화목록의 첫 번째 메시지에 의해 알림이 트리거됩니다. 1:1 채팅 메시지에는 사용할 수 없습니다. |
FOR_YOU |
@멘션, 팔로우 중인 대화목록에 의해 알림이 트리거됩니다. 1:1 채팅 메시지에는 사용할 수 없습니다. |
OFF |
알림이 사용 중지되었습니다. |
SpaceReadState
스페이스 내 사용자의 읽음 상태로, 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다.
| 필드 | |
|---|---|
name |
스페이스 읽기 상태의 리소스 이름입니다. 형식: |
last_read_time |
선택사항입니다. 사용자의 스페이스 읽기 상태가 업데이트된 시간입니다. 일반적으로 이는 마지막으로 읽은 메시지의 타임스탬프 또는 사용자가 스페이스에서 마지막으로 읽은 위치를 표시하기 위해 지정한 타임스탬프에 해당합니다. |
SpaceUpdatedEventData
업데이트된 스페이스의 이벤트 페이로드입니다.
이벤트 유형: google.workspace.chat.space.v1.updated
| 필드 | |
|---|---|
space |
업데이트된 스페이스입니다. |
SpaceView
Space 리소스에 채워야 하는 필드를 지정하는 뷰입니다. 향후 출시 버전과의 호환성을 보장하려면 코드에서 추가 값을 고려하는 것이 좋습니다.
| 열거형 | |
|---|---|
SPACE_VIEW_UNSPECIFIED |
기본값 / 설정되지 않은 값입니다. |
SPACE_VIEW_RESOURCE_NAME_ONLY |
스페이스 리소스 이름만 채웁니다. |
SPACE_VIEW_EXPANDED |
스페이스 리소스 필드를 채웁니다. 참고: permissionSettings 필드는 채워지지 않습니다. SPACE_VIEW_EXPANDED를 지정하는 요청에는 스페이스 데이터를 읽을 수 있는 범위(예: https://www.googleapis.com/auth/chat.spaces 또는 https://www.googleapis.com/auth/chat.spaces.readonly)가 포함되어야 합니다. |
스레드
Google Chat 스페이스의 대화목록입니다. 사용 예시는 메시지 대화목록 시작 또는 답장을 참고하세요.
메시지를 만들 때 대화목록을 지정하는 경우 messageReplyOption 필드를 설정하여 일치하는 대화목록을 찾을 수 없는 경우 어떻게 할지 결정할 수 있습니다.
| 필드 | |
|---|---|
name |
식별자. 대화목록의 리소스 이름입니다. 예: |
thread_key |
선택사항입니다. 대화목록을 만들거나 업데이트하기 위한 입력입니다. 그 외의 경우에는 출력 전용입니다. 대화목록의 ID입니다. 최대 4,000자(영문 기준)까지 지원됩니다. 이 ID는 이를 설정하는 Chat 앱에 고유합니다. 예를 들어 여러 Chat 앱이 동일한 대화목록 키를 사용하여 메시지를 만드는 경우 메시지는 서로 다른 대화목록에 게시됩니다. 사용자 또는 다른 Chat 앱에서 만든 대화목록에 답장하려면 대신 대화목록 |
ThreadReadState
읽은 메일과 읽지 않은 메일을 식별하는 데 사용되는 대화목록 내 사용자의 읽음 상태입니다.
| 필드 | |
|---|---|
name |
대화목록 읽음 상태의 리소스 이름입니다. 형식: |
last_read_time |
사용자의 대화목록 읽기 상태가 업데이트된 시간입니다. 일반적으로 대화목록에서 마지막으로 읽은 메시지의 타임스탬프에 해당합니다. |
UpdateAvailabilityRequest
UpdateAvailability 메서드에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
availability |
필수 항목입니다. 업데이트할 재고입니다. |
update_mask |
필수 항목입니다. 업데이트할 필드 목록입니다. 업데이트할 수 있는 유일한 필드는 |
UpdateMembershipRequest
멤버십 업데이트 요청 메시지입니다.
| 필드 | |
|---|---|
membership |
필수 항목입니다. 업데이트할 멤버십입니다. |
update_mask |
필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값을 쉼표로 구분하거나 현재 지원되는 필드 경로는 다음과 같습니다.
|
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
|
UpdateMessageRequest
메시지 업데이트 요청입니다.
| 필드 | |
|---|---|
message |
필수 항목입니다. 필드가 업데이트된 메시지입니다. |
update_mask |
필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값을 쉼표로 구분하거나 현재 지원되는 필드 경로는 다음과 같습니다. |
allow_missing |
선택사항입니다. |
UpdateSectionRequest
섹션 업데이트 요청 메시지입니다.
| 필드 | |
|---|---|
section |
필수 항목입니다. 업데이트할 섹션입니다. |
update_mask |
필수 항목입니다. 업데이트할 필드를 지정하는 마스크입니다. 현재 지원되는 필드 경로는 다음과 같습니다.
|
UpdateSpaceNotificationSettingRequest
스페이스 알림 설정 업데이트 요청입니다. 호출 사용자의 알림 설정 업데이트만 지원합니다.
| 필드 | |
|---|---|
space_notification_setting |
필수 항목입니다. 스페이스 알림 설정의 리소스 이름은 |
update_mask |
필수 항목입니다. 지원되는 필드 경로:
|
UpdateSpaceReadStateRequest
UpdateSpaceReadState API의 요청 메시지입니다.
| 필드 | |
|---|---|
space_read_state |
필수 항목입니다. 업데이트할 스페이스 읽기 상태 및 필드입니다. 호출 사용자의 읽기 상태 업데이트만 지원합니다. 호출 사용자를 참조하려면 다음 중 하나를 설정합니다.
형식: users/{user}/spaces/{space}/spaceReadState |
update_mask |
필수 항목입니다. 업데이트할 필드 경로입니다. 현재 지원되는 필드 경로는 다음과 같습니다.
스페이스를 읽음으로 표시하려면 |
UpdateSpaceRequest
단일 스페이스를 업데이트하는 요청입니다.
| 필드 | |
|---|---|
space |
필수 항목입니다. 업데이트할 필드가 있는 스페이스입니다. |
update_mask |
필수 항목입니다. 업데이트된 필드 경로입니다. 여러 개인 경우 쉼표로 구분됩니다. 스페이스의 다음 필드를 업데이트할 수 있습니다.
|
use_admin_access |
선택사항입니다. 호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
일부 |
사용자
Google Chat의 사용자입니다.
요청의 출력으로 반환될 때 Chat 앱이 사용자로 인증하는 경우 User 리소스의 출력 (예: 메시지 및 멤버십 API)은 스페이스의 멤버이거나 호출 사용자와 이전에 친밀도가 있는 경우가 아니면 내부 및 외부 사용자 모두에 대해 name 및 type 필드만 채웁니다.
| 필드 | |
|---|---|
name |
Google Chat 형식은
|
display_name |
출력 전용입니다. 사용자의 표시 이름입니다. 앱 인증과 사용자 인증 모두에 채워집니다. 이 필드는 앱 인증으로 이루어진 요청에 대해 항상 채워집니다. 사용자 인증으로 메시지 및 멤버십 API를 호출할 때 이 필드는 메시지의 |
avatar_url |
출력 전용입니다. 사용자의 아바타 이미지 URL입니다. 사용자 인증으로 Messages and Memberships API를 호출하면 이 필드는 메시지의 |
email |
출력 전용입니다. 사용자의 이메일 주소 사용자 인증으로 메시지 및 멤버십 API를 호출할 때 이 필드는 메시지의 |
domain_id |
사용자의 Google Workspace 도메인의 고유 식별자입니다. |
type |
사용자 유형입니다. |
is_anonymous |
출력 전용입니다. |
유형
| 열거형 | |
|---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 않습니다. |
HUMAN |
인간 사용자 |
BOT |
Chat 앱 사용자 |
UserMentionMetadata
사용자 멘션 (@)의 주석 메타데이터입니다.
| 필드 | |
|---|---|
user |
멘션된 사용자입니다. |
type |
사용자 멘션 유형입니다. |
유형
| 열거형 | |
|---|---|
TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 마세요. |
ADD |
스페이스에 사용자를 추가합니다. |
MENTION |
스페이스에서 사용자를 멘션합니다. |
WidgetMarkup
위젯은 텍스트와 이미지를 표시하는 UI 요소입니다.
| 필드 | |
|---|---|
buttons[] |
버튼 목록입니다. 버튼도 |
통합 필드 data. WidgetMarkup에는 다음 항목 중 하나만 포함될 수 있습니다. WidgetMarkup 필드 여러 개를 사용하여 더 많은 항목을 표시할 수 있습니다. data은 다음 중 하나여야 합니다. |
|
text_paragraph |
이 위젯에 텍스트 단락을 표시합니다. |
image |
이 위젯에 이미지를 표시합니다. |
key_value |
이 위젯에 키-값 항목을 표시합니다. |
버튼
A 버튼 텍스트 버튼 또는 이미지 버튼일 수 있습니다.
| 필드 | |
|---|---|
통합 필드
|
|
text_button |
텍스트와 |
image_button |
이미지와 |
FormAction
양식 작업은 양식이 제출될 때의 동작을 설명합니다. 예를 들어 Apps Script를 호출하여 양식을 처리할 수 있습니다.
| 필드 | |
|---|---|
action_method_name |
메서드 이름은 양식 제출을 트리거한 양식의 부분을 식별하는 데 사용됩니다. 이 정보는 카드 클릭 이벤트의 일부로 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 |
이미지의 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에서 해당 아이콘 이미지로 대체되는 enum 값입니다. |
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 |
|