Package google.chat.v1

색인

ChatService

개발자가 Google Chat 플랫폼에서 채팅 앱 및 통합을 빌드할 수 있도록 지원합니다.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

지정된 스페이스의 가져오기 프로세스를 완료하고 사용자에게 표시합니다.

앱 인증 및 도메인 전체 위임이 필요합니다. 자세한 내용은 Google Chat 앱이 데이터를 가져오도록 승인하기를 참고하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/chat.import

자세한 내용은 승인 가이드를 참조하세요.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

맞춤 이모티콘을 만듭니다.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/chat.customemojis

자세한 내용은 승인 가이드를 참고하세요.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

통화 채팅 앱, 사용자 또는 Google 그룹의 멤버십을 만듭니다. 다른 채팅 앱의 멤버십 만들기는 지원되지 않습니다. 멤버십을 만들 때 지정된 멤버가 자동 수락 정책을 사용 중지한 경우 이 멤버는 초대되며 참여하기 전에 스페이스 초대를 수락해야 합니다. 그 외의 경우에는 멤버십을 만들면 멤버가 지정된 스페이스에 바로 추가됩니다.

다음 유형의 인증을 지원합니다.

사용 예는 다음을 참조하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

자세한 내용은 승인 가이드를 참고하세요.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Google Chat 스페이스에 메시지를 만듭니다. 예를 보려면 메시지 보내기를 참고하세요.

create() 메서드에는 사용자 인증 또는 앱 인증이 필요합니다. Chat은 요청에 사용하는 인증 유형에 따라 메시지 발신자를 다르게 지정합니다.

다음 이미지는 앱 인증을 사용할 때 Chat에서 메시지를 표시하는 방법을 보여줍니다. Chat에서는 Chat 앱을 메시지 발신자로 표시합니다. 메시지 콘텐츠에는 텍스트(text), 카드(cardsV2), 액세서리 위젯(accessoryWidgets)이 포함될 수 있습니다.

앱 인증과 함께 메시지 전송됨

다음 이미지는 사용자 인증을 사용할 때 Chat에서 메시지를 표시하는 방법을 보여줍니다. Chat은 사용자를 메시지 발신자로 표시하고 Chat 앱의 이름을 표시하여 메시지에 Chat 앱의 속성을 부여합니다. 메시지 내용은 텍스트 (text)만 포함할 수 있습니다.

사용자 인증과 함께 메시지 전송됨

메시지 내용을 포함하여 최대 메시지 크기는 32,000바이트입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

자세한 내용은 승인 가이드를 참조하세요.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

리액션을 만들고 메시지에 추가합니다. 유니코드 그림 이모티콘만 지원됩니다. 예를 보려면 메시지에 반응 추가하기를 참고하세요.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

자세한 내용은 승인 가이드를 참조하세요.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

멤버가 없는 스페이스를 만듭니다. 이름이 지정된 스페이스를 만드는 데 사용할 수 있습니다. 주제별로 그룹화된 스페이스는 지원되지 않습니다. 예시를 보려면 스페이스 만들기를 참고하세요.

스페이스를 만들 때 ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName를 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

개발자 프리뷰 프로그램의 참여자는 spaceType.GROUP_CHAT을 사용하여 가져오기 모드에서 그룹 채팅을 만들 수 있습니다.

다음 유형의 인증을 지원합니다.

앱으로 인증할 때는 요청에 space.customer 필드를 설정해야 합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

자세한 내용은 승인 가이드를 참조하세요.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

맞춤 이모티콘을 삭제합니다.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/chat.customemojis

자세한 내용은 승인 가이드를 참조하세요.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

멤버십을 삭제합니다. 예시는 스페이스에서 사용자 또는 Google Chat 앱 삭제하기를 참고하세요.

다음 유형의 인증을 지원합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

자세한 내용은 승인 가이드를 참고하세요.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

메시지를 삭제합니다. 예를 보려면 메시지 삭제를 참조하세요.

다음 유형의 인증을 지원합니다.

앱 인증을 사용하는 경우 요청은 채팅 앱에서 생성된 메시지만 삭제할 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

자세한 내용은 승인 가이드를 참조하세요.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

메시지에 대한 반응을 삭제합니다. 유니코드 이모티콘만 지원됩니다. 예를 보려면 리액션 삭제를 참고하세요.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

자세한 내용은 승인 가이드를 참고하세요.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

이름이 지정된 스페이스를 삭제합니다. 항상 계층식 삭제를 실행합니다. 즉, 스페이스에 게시된 메시지, 스페이스의 멤버십과 같은 스페이스의 하위 리소스도 삭제됩니다. 예를 보려면 스페이스 삭제를 참고하세요.

다음 유형의 인증을 지원합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

자세한 내용은 승인 가이드를 참조하세요.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

지정된 사용자와의 기존 채팅 메시지를 반환합니다. 채팅 메시지 공간을 찾을 수 없는 경우 404 NOT_FOUND 오류를 반환합니다. 예를 보려면 채팅 메시지 찾기를 참고하세요.

앱 인증을 사용하여 지정된 사용자와 호출하는 Chat 앱 간의 채팅 메시지 스페이스를 반환합니다.

사용자 인증을 사용하여 지정된 사용자와 인증된 사용자 간의 채팅 메시지 공간을 반환합니다.

// 다음 유형의 인증을 지원합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

자세한 내용은 승인 가이드를 참고하세요.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

메시지 첨부파일의 메타데이터를 가져옵니다. 첨부파일 데이터는 media API를 사용하여 가져옵니다. 예시는 메일 첨부파일에 대한 메타데이터 가져오기를 참고하세요. 앱 인증이 필요합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/chat.bot

자세한 내용은 승인 가이드를 참고하세요.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

맞춤 그림 이모티콘에 대한 세부정보를 반환합니다.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/chat.customemojis

자세한 내용은 승인 가이드를 참고하세요.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

멤버십에 대한 세부정보를 반환합니다. 예를 보려면 사용자 또는 Google Chat 앱의 멤버십 세부정보 보기를 참고하세요.

다음 유형의 인증을 지원합니다.

  • 앱 인증

  • 사용자 인증 요청에 use_admin_access 필드를 설정하여 관리자 권한으로 이 메서드를 인증하고 승인할 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

자세한 내용은 승인 가이드를 참고하세요.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

메일에 대한 세부정보를 반환합니다. 예를 보려면 메시지에 대한 세부정보 가져오기를 참고하세요.

다음 유형의 인증을 지원합니다.

참고: 차단된 멤버 또는 스페이스의 메시지가 반환될 수도 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

자세한 내용은 승인 가이드를 참고하세요.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

스페이스에 관한 세부정보를 반환합니다. 예를 보려면 스페이스 세부정보 보기를 참고하세요.

다음 유형의 인증을 지원합니다.

  • 앱 인증

  • 사용자 인증 요청에 use_admin_access 필드를 설정하여 관리자 권한으로 이 메서드를 인증하고 승인할 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

자세한 내용은 승인 가이드를 참조하세요.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Google Chat 스페이스의 이벤트를 반환합니다. 이벤트 페이로드에는 변경된 리소스의 최신 버전이 포함됩니다. 예를 들어 새 메시지에 대한 이벤트를 요청했지만 메시지가 나중에 업데이트된 경우 서버는 이벤트 페이로드에 업데이트된 Message 리소스를 반환합니다.

참고: 이 요청의 스페이스 이벤트 데이터의 스페이스 객체에는 permissionSettings 필드가 반환되지 않습니다.

사용자 인증이 필요합니다. 이벤트를 가져오려면 인증된 사용자가 스페이스의 회원이어야 합니다.

예를 보려면 Google Chat 스페이스에서 이벤트 세부정보 가져오기를 참고하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

자세한 내용은 승인 가이드를 참조하세요.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

스페이스 내에서 사용자의 읽기 상태에 관한 세부정보를 반환하며 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예를 보려면 사용자의 스페이스 읽기 상태에 관한 세부정보 가져오기를 참고하세요.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

자세한 내용은 승인 가이드를 참고하세요.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

대화목록 내에서 사용자의 읽기 상태에 관한 세부정보를 반환하며 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예시는 사용자의 스레드 읽기 상태에 관한 세부정보 가져오기를 참고하세요.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

자세한 내용은 승인 가이드를 참조하세요.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

인증된 사용자에게 표시되는 맞춤 이모티콘을 나열합니다.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/chat.customemojis

자세한 내용은 승인 가이드를 참조하세요.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

스페이스의 멤버십을 나열합니다. 예를 보려면 스페이스에 사용자 및 Google Chat 앱 표시를 참고하세요. 앱 인증을 사용하여 멤버십을 표시하면 Chat 앱이 액세스할 수 있는 스페이스의 멤버십이 표시되지만 자체 멤버십을 포함한 Chat 앱 멤버십은 제외됩니다. 사용자 인증으로 멤버십을 나열하면 인증된 사용자가 액세스할 수 있는 스페이스의 멤버십이 표시됩니다.

다음 유형의 인증을 지원합니다.

  • 앱 인증

  • 사용자 인증 요청에서 use_admin_access 필드를 설정하여 관리자 권한으로 이 메서드를 인증 및 승인할 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

자세한 내용은 승인 가이드를 참조하세요.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

차단된 멤버 및 스페이스의 메시지를 포함하여 발신자가 참여 중인 스페이스의 메시지를 나열합니다. 메시지가 없는 스페이스의 메시지를 나열하면 응답은 빈 객체입니다. REST/HTTP 인터페이스를 사용하는 경우 응답에 빈 JSON 객체 {}가 포함됩니다. 예시는 메시지 나열을 참조하세요.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

자세한 내용은 승인 가이드를 참고하세요.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

메시지에 대한 반응을 나열합니다. 예는 메시지에 대한 반응 나열을 참조하세요.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

자세한 내용은 승인 가이드를 참고하세요.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Google Chat 스페이스의 이벤트를 표시합니다. 각 이벤트에 대한 payload에는 Chat 리소스의 최신 버전이 포함됩니다. 예를 들어 새 스페이스 멤버에 관한 일정을 나열하는 경우 서버에서 최신 멤버십 세부정보가 포함된 Membership 리소스를 반환합니다. 요청된 기간 동안 새 구성원이 삭제된 경우 이벤트 페이로드에 빈 Membership 리소스가 포함됩니다.

사용자 인증이 필요합니다. 이벤트를 나열하려면 인증된 사용자가 스페이스의 구성원여야 합니다.

예시는 Google Chat 스페이스의 이벤트 나열을 참고하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

자세한 내용은 승인 가이드를 참고하세요.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

발신자가 속한 스페이스를 나열합니다. 첫 번째 메시지가 전송되기 전에는 그룹 채팅과 채팅 메시지가 표시되지 않습니다. 예를 보려면 스페이스 목록을 참고하세요.

다음 유형의 인증을 지원합니다.

Google Workspace 조직의 이름이 지정된 모든 스페이스를 나열하려면 대신 Workspace 관리자 권한을 사용하는 spaces.search() 메서드를 사용하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

자세한 내용은 승인 가이드를 참고하세요.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

관리자의 검색을 기반으로 Google Workspace 조직의 스페이스 목록을 반환합니다.

관리자 권한으로 사용자 인증이 필요합니다. 요청에서 use_admin_access를 true로 설정합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

자세한 내용은 승인 가이드를 참조하세요.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

스페이스를 만들고 지정된 사용자를 스페이스에 추가합니다. 호출하는 사용자는 스페이스에 자동으로 추가되며, 요청에서 멤버십으로 지정되면 안 됩니다. 예시는 초기 구성원이 있는 스페이스 설정을 참고하세요.

추가할 실제 사용자를 지정하려면 적절한 membership.member.name를 사용하여 멤버십을 추가합니다. 사람 사용자를 추가하려면 users/{user}를 사용합니다. 여기서 {user}는 사용자의 이메일 주소가 될 수 있습니다. 동일한 Workspace 조직에 있는 사용자의 경우 {user}은 People API에서 사용자를 위한 id이거나 Directory API에서 사용자의 id가 될 수도 있습니다. 예를 들어 user@example.com의 People API Person 프로필 ID가 123456789이면 membership.member.name를 users/user@example.com 또는 users/123456789로 설정하여 스페이스에 사용자를 추가할 수 있습니다.

추가할 Google 그룹을 지정하려면 적절한 membership.group_member.name를 사용하여 멤버십을 추가합니다. Google 그룹을 추가하거나 초대하려면 groups/{group}을 사용합니다. 여기서 {group}는 Cloud ID Groups API에서 그룹에 대한 id입니다. 예를 들어 Cloud Identity Groups lookup API를 사용하여 그룹 이메일 group@example.com의 ID 123456789를 가져온 다음 membership.group_member.name를 groups/123456789로 설정하여 그룹을 스페이스에 추가할 수 있습니다. 그룹 이메일은 지원되지 않으며 Google 그룹은 이름이 지정된 스페이스의 멤버로만 추가할 수 있습니다.

이름이 지정된 스페이스 또는 그룹 채팅의 경우 발신자가 차단 또는 차단하거나, 일부 멤버를 추가할 권한이 없는 경우 해당 멤버는 생성된 스페이스에 추가되지 않습니다.

호출 사용자와 다른 실제 사용자 간에 채팅 메시지(DM)를 만들려면 실제 사용자를 나타내는 멤버십을 정확히 하나 지정합니다. 한 사용자가 다른 사용자를 차단하면 요청이 실패하고 DM이 생성되지 않습니다.

통화 사용자와 통화 앱 간에 DM을 만들려면 Space.singleUserBotDm를 true로 설정하고 멤버십을 지정하지 않습니다. 이 메서드는 호출 앱으로 DM을 설정하는 데만 사용할 수 있습니다. 통화 앱을 스페이스의 멤버로 추가하거나 두 사람 간의 기존 채팅 메시지를 추가하려면 스페이스에 사용자 또는 앱 초대 또는 추가하기를 참고하세요.

두 사용자 간에 이미 DM이 있는 경우 요청 시 한 사용자가 다른 사용자를 차단하더라도 기존 DM이 반환됩니다.

대화목록 답글이 있는 스페이스는 지원되지 않습니다. 스페이스를 설정할 때 ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName을 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

자세한 내용은 승인 가이드를 참조하세요.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

멤버십을 업데이트합니다. 예를 보려면 스페이스에서 사용자 멤버십 업데이트를 참고하세요.

다음 유형의 인증을 지원합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

자세한 내용은 승인 가이드를 참조하세요.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

메시지를 업데이트합니다. patch 메서드와 update 메서드에는 차이가 있습니다. patch 메서드는 patch 요청을 사용하는 반면 update 메서드는 put 요청을 사용합니다. patch 메서드를 사용하는 것이 좋습니다. 예는 메시지 업데이트를 참고하세요.

다음 유형의 인증을 지원합니다.

앱 인증을 사용하는 경우 요청은 호출하는 Chat 앱에서 만든 메시지만 업데이트할 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

자세한 내용은 승인 가이드를 참조하세요.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

스페이스를 업데이트합니다. 예를 보려면 스페이스 업데이트하기를 참고하세요.

displayName 필드를 업데이트하는 중에 ALREADY_EXISTS 오류 메시지가 표시되면 다른 표시 이름을 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

다음 유형의 인증을 지원합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

자세한 내용은 승인 가이드를 참조하세요.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

스페이스 내에서 사용자의 읽기 상태를 업데이트하며 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다. 예는 사용자의 스페이스 읽기 상태 업데이트를 참고하세요.

사용자 인증이 필요합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/chat.users.readstate

자세한 내용은 승인 가이드를 참고하세요.

AccessoryWidget

메시지 하단에 표시되는 양방향 위젯 1개 이상 자세한 내용은 메일 하단에 대화형 위젯 추가하기를 참고하세요.

필드
통합 필드 action. 작업 유형입니다. action은 다음 중 하나여야 합니다.
button_list

ButtonList

버튼 목록입니다.

ActionResponse

Chat 앱에서 응답 게시 방법을 구성하는 데 사용할 수 있는 매개변수입니다.

필드
type

ResponseType

입력 전용입니다. Chat 앱 응답 유형입니다.
url

string

입력 전용입니다. 사용자가 인증하거나 구성할 URL입니다. (REQUEST_CONFIG 응답 유형에만 해당)
dialog_action

DialogAction

입력 전용입니다. 대화상자와 관련된 상호작용 이벤트에 대한 응답입니다. ResponseType.Dialog와 함께 사용해야 합니다.
updated_widget

UpdatedWidget

입력 전용입니다. 업데이트된 위젯의 응답입니다.

ResponseType

채팅 앱 응답 유형입니다.

열거형
TYPE_UNSPECIFIED NEW_MESSAGE로 처리되는 기본 유형입니다.
NEW_MESSAGE 주제에 새 메시지로 게시합니다.
UPDATE_MESSAGE 채팅 앱의 메시지를 업데이트합니다. 이는 메시지 발신자 유형이 BOT인 CARD_CLICKED 이벤트에서만 허용됩니다.
UPDATE_USER_MESSAGE_CARDS 사용자 메시지의 카드를 업데이트합니다. 이는 일치하는 URL이 있는 MESSAGE 이벤트 또는 메시지 발신자 유형이 HUMAN인 CARD_CLICKED 이벤트에 대한 응답으로만 허용됩니다. 텍스트는 무시됩니다.
REQUEST_CONFIG 사용자에게 비공개로 추가 인증 또는 구성을 요청합니다.
DIALOG 대화상자를 표시합니다.
UPDATE_WIDGET 위젯 텍스트 자동 완성 옵션 쿼리

SelectionItems

위젯 자동 완성 결과 목록입니다.

필드
items[]

SelectionItem

SelectionItem 객체의 배열입니다.

UpdatedWidget

업데이트된 위젯의 응답입니다. 위젯의 자동 완성 옵션을 제공하는 데 사용됩니다.

필드
widget

string

업데이트된 위젯의 ID입니다. ID는 업데이트 요청을 트리거한 위젯의 ID와 일치해야 합니다.
통합 필드 updated_widget. 사용자 작업에 대한 응답으로 위젯이 업데이트됩니다. updated_widget은 다음 중 하나여야 합니다.
suggestions

SelectionItems

위젯 자동 완성 결과 목록

ActionStatus

대화상자를 호출하거나 제출하는 요청의 상태를 나타냅니다.

필드
status_code

Code

상태 코드입니다.
user_facing_message

string

사용자에게 요청 상태에 관한 메시지입니다. 설정하지 않으면 status_code를 기반으로 하는 일반 메시지가 전송됩니다.

Annotation

출력 전용입니다. 메시지의 일반 텍스트 본문과 연결된 주석입니다. SMS에 기본 서식을 추가하려면 SMS 서식 지정을 참조하세요.

일반 텍스트 메시지 본문 예시:

Hello @FooBot how are you!"

해당 주석 메타데이터:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
필드
type

AnnotationType

이 주석의 유형입니다.
length

int32

이 주석이 해당하는 일반 텍스트 메시지 본문의 하위 문자열 길이입니다.
start_index

int32

이 주석이 해당하는 일반 텍스트 메시지 본문의 시작 인덱스(0부터 시작, 양 끝값 포함)입니다.
통합 필드 metadata. 주석에 대한 추가 메타데이터입니다. metadata은 다음 중 하나여야 합니다.
user_mention

UserMentionMetadata

사용자 멘션의 메타데이터입니다.
slash_command

SlashCommandMetadata

슬래시 명령어의 메타데이터입니다.

AnnotationType

주석의 유형입니다.

열거형
ANNOTATION_TYPE_UNSPECIFIED enum의 기본값입니다. 사용하지 마세요.
USER_MENTION 사용자가 언급됩니다.
SLASH_COMMAND 슬래시 명령어가 호출됩니다.

AttachedGif

URL로 지정된 GIF 이미지입니다.

필드
uri

string

출력 전용입니다. GIF 이미지를 호스팅하는 URL입니다.

첨부파일

Google Chat의 첨부파일

필드
name

string

첨부파일의 리소스 이름으로, spaces/{space}/messages/{message}/attachments/{attachment} 형식입니다.
content_name

string

출력 전용입니다. 전체 경로가 아닌 콘텐츠의 원래 파일 이름입니다.
content_type

string

출력 전용입니다. 파일의 콘텐츠 유형 (MIME 유형)입니다.
thumbnail_uri

string

출력 전용입니다. 사용자에게 첨부파일을 미리 보는 데 사용해야 하는 썸네일 URL입니다. 채팅 앱은 이 URL을 사용하여 첨부파일 콘텐츠를 다운로드해서는 안 됩니다.
download_uri

string

출력 전용입니다. 실제 사용자가 첨부파일을 다운로드할 수 있도록 허용해야 하는 다운로드 URL입니다. 채팅 앱은 이 URL을 사용하여 첨부파일 콘텐츠를 다운로드해서는 안 됩니다.
source

Source

출력 전용입니다. 첨부파일의 소스입니다.
통합 필드 data_ref. 첨부파일에 대한 데이터 참조입니다. data_ref은 다음 중 하나여야 합니다.
attachment_data_ref

AttachmentDataRef

첨부파일 데이터 참조입니다. 이 필드는 media API와 함께 사용하여 첨부파일 데이터를 다운로드하는 데 사용됩니다.
drive_data_ref

DriveDataRef

출력 전용입니다. Google Drive 첨부파일에 대한 참조입니다. 이 필드는 Google Drive API와 함께 사용됩니다.

소스

첨부파일의 소스입니다.

열거형
SOURCE_UNSPECIFIED 예약되었습니다.
DRIVE_FILE 파일이 Google Drive 파일입니다.
UPLOADED_CONTENT 파일이 Chat에 업로드됩니다.

AttachmentDataRef

첨부파일 데이터에 대한 참조입니다.

필드
resource_name

string

첨부파일 데이터의 리소스 이름입니다. 이 필드는 media API와 함께 사용하여 첨부파일 데이터를 다운로드하는 데 사용됩니다.
attachment_upload_token

string

업로드된 첨부파일에 대한 참조가 포함된 불투명 토큰입니다. 클라이언트에서 불투명한 문자열로 처리되며 첨부파일이 있는 Chat 메시지를 만들거나 업데이트하는 데 사용됩니다.

CardWithId

Google Chat 메시지의 카드

채팅 앱에서만 카드를 만들 수 있습니다. 채팅 앱이 사용자로 인증되는 경우 메시지에 카드를 포함할 수 없습니다.

카드 작성 도구로 카드를 디자인하고 미리보기를 확인합니다.

카드 작성 도구 열기

필드
card_id

string

메시지에 여러 카드가 포함된 경우 필수입니다. 메시지의 카드에 대한 고유 식별자입니다.
card

Card

카드 최대 크기는 32KB입니다.

ChatSpaceLinkData

Chat 스페이스 링크 관련 데이터입니다.

필드
space

string

연결된 Chat 스페이스 리소스의 스페이스입니다.

형식: spaces/{space}
thread

string

연결된 Chat 스페이스 리소스의 대화목록입니다.

형식: spaces/{space}/threads/{thread}
message

string

연결된 Chat 스페이스 리소스의 메시지입니다.

형식: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

스페이스의 가져오기 프로세스 완료를 요청하는 메시지입니다.

필드
name

string

필수 항목입니다. 가져오기 모드 스페이스의 리소스 이름입니다.

형식: spaces/{space}

CompleteImportSpaceResponse

스페이스 가져오기 프로세스 완료에 대한 응답 메시지입니다.

필드
space

Space

가져오기 모드 스페이스입니다.

ContextualAddOnMarkup

이 유형에는 필드가 없습니다.

개발자가 상황별 AddOn의 콘텐츠를 지정할 수 있는 마크업입니다.

카드

카드는 텍스트 및 이미지와 같은 UI 위젯을 포함할 수 있는 UI 요소입니다.

필드
header

CardHeader

카드의 헤더입니다. 헤더에는 일반적으로 제목과 이미지가 포함됩니다.
sections[]

Section

섹션은 줄 구분선으로 구분됩니다.
card_actions[]

CardAction

이 카드의 액션입니다.
name

string

카드 이름입니다.

CardAction

카드 작업은 카드와 연결된 작업입니다. 인보이스 카드의 경우 일반적으로 인보이스 삭제, 이메일 인보이스 발송, 브라우저에서 인보이스 열기 등의 작업이 이루어집니다.

Google Chat 앱에서는 지원되지 않습니다.

필드
action_label

string

작업 메뉴 항목에 표시되던 라벨입니다.
on_click

OnClick

이 작업 항목의 onclick 작업입니다.

CardHeader

필드
title

string

제목을 지정해야 합니다. 헤더의 높이는 고정되어 있습니다. 제목과 부제목이 모두 지정된 경우 각각 한 줄을 차지합니다. 제목만 지정하면 두 줄을 모두 차지합니다.
subtitle

string

카드 헤더의 부제목입니다.
image_style

ImageStyle

이미지 유형입니다 (예: 정사각형 테두리 또는 원형 테두리).
image_url

string

카드 헤더의 이미지 URL입니다.

ImageStyle

열거형
IMAGE_STYLE_UNSPECIFIED
IMAGE 사각형 테두리
AVATAR 원형 테두리

섹션

섹션에는 지정된 순서대로(세로로) 렌더링되는 위젯 모음이 포함됩니다. 모든 플랫폼에서 카드는 좁은 너비가 고정되어 있으므로 현재는 레이아웃 속성 (예: float)이 필요하지 않습니다.

필드
header

string

섹션의 헤더입니다. 서식이 지정된 텍스트는 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.
widgets[]

WidgetMarkup

섹션에는 위젯이 하나 이상 포함되어야 합니다.

CreateCustomEmojiRequest

맞춤 그림 이모티콘 생성 요청입니다.

필드
custom_emoji

CustomEmoji

필수 항목입니다. 만들 맞춤 이모티콘입니다.

CreateMembershipRequest

멤버십 생성 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 멤버십을 만들 스페이스의 리소스 이름입니다.

형식: spaces/{space}
membership

Membership

필수 항목입니다. 만들 멤버십 관계입니다.

memberType 필드에는 user.name 및 user.type 필드가 채워진 사용자가 포함되어야 합니다. 서버가 리소스 이름을 할당하고 지정된 항목을 덮어씁니다.

채팅 앱이 실제 사용자를 위한 멤버십 관계를 만드는 경우 특정 승인 범위를 사용하고 특정 필드에 특정 값을 설정해야 합니다.

  • 사용자로 인증할 때는 chat.memberships 승인 범위가 필요합니다.

  • 앱으로 인증할 때는 chat.app.memberships 승인 범위가 필요합니다. 앱으로 인증하는 기능은 다음에서 사용할 수 있습니다.

  • user.type를 HUMAN로 설정하고 user.name를 users/{user} 형식으로 설정합니다. 여기서 {user}는 사용자의 이메일 주소일 수 있습니다. 동일한 Workspace 조직의 사용자의 경우 {user}는 People API의 사용자의 id이거나 Directory API의 사용자의 id일 수도 있습니다. 예를 들어 user@example.com의 People API Person 프로필 ID가 123456789이면 membership.member.name를 users/user@example.com 또는 users/123456789로 설정하여 스페이스에 사용자를 추가할 수 있습니다.

Chat 앱이 자체 멤버십 관계를 만들 때는 사용자로 인증하고 chat.memberships.app 범위를 사용하고 user.type를 BOT로 설정하고 user.name를 users/app로 설정해야 합니다.
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.memberships OAuth 2.0 범위가 필요합니다.

관리 액세스를 사용하여 관리자의 Google Workspace 조직 외부의 사용자를 위한 앱 멤버십을 만들거나 멤버십을 만드는 것은 지원되지 않습니다.

CreateMessageRequest

메시지를 만듭니다.

필드
parent

string

필수 항목입니다. 메시지를 만들 스페이스의 리소스 이름입니다.

형식: spaces/{space}
message

Message

필수 항목입니다. 메일 본문입니다.
thread_key
(deprecated)

string

선택사항입니다. 지원 중단됨: 대신 thread.thread_key를 사용하세요. 대화목록의 ID입니다. 최대 4,000자(영문 기준)까지 지원됩니다. 대화목록을 시작하거나 대화목록에 추가하려면 메시지를 만들고 threadKey 또는 thread.name를 지정합니다. 사용 예는 메시지 대화목록 시작 또는 답장을 참고하세요.
request_id

string

선택사항입니다. 이 메시지의 고유한 요청 ID입니다. 기존 요청 ID를 지정하면 새 메시지를 만드는 대신 해당 ID로 생성된 메시지가 반환됩니다.
message_reply_option

MessageReplyOption

선택사항입니다. 메시지가 대화목록을 시작하는지 아니면 대화목록에 답장할지 지정합니다. 이름이 지정된 스페이스에서만 지원됩니다.
message_id

string

선택사항입니다. 메시지의 커스텀 ID입니다. Chat 앱이 메시지의 리소스 이름(메시지 name 필드에 표시됨)에 시스템 할당 ID를 저장하지 않고도 메시지를 가져오거나 업데이트하거나 삭제할 수 있도록 합니다.

이 필드의 값은 다음 요구사항을 충족해야 합니다.

  • client-로 시작합니다. 예를 들어 client-custom-name는 유효한 맞춤 ID이지만 custom-name는 아닙니다.
  • 최대 63자(영문 기준)이며 소문자, 숫자, 하이픈만 포함할 수 있습니다.
  • 스페이스 내에서 고유합니다. Chat 앱은 여러 메시지에 동일한 맞춤 ID를 사용할 수 없습니다.

자세한 내용은 메시지 이름 지정하기를 참고하세요.

MessageReplyOption

메시지에 답장하는 방법을 지정합니다. 향후 더 많은 주가 추가될 수 있습니다.

열거형
MESSAGE_REPLY_OPTION_UNSPECIFIED 기본값입니다. 새 스레드를 시작합니다. 이 옵션을 사용하면 포함된 thread ID 또는 thread_key가 무시됩니다.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD thread ID 또는 thread_key로 지정된 대화목록에 대한 답장으로 메시지를 만듭니다. 실패하면 메시지가 대신 새 스레드를 시작합니다.
REPLY_MESSAGE_OR_FAIL thread ID 또는 thread_key로 지정된 대화목록에 대한 답장으로 메시지를 만듭니다. 새 thread_key가 사용되면 새 스레드가 생성됩니다. 메시지 생성이 실패하면 대신 NOT_FOUND 오류가 반환됩니다.

CreateReactionRequest

메시지에 대한 반응을 만듭니다.

필드
parent

string

필수 항목입니다. 반응이 생성되는 메시지입니다.

형식: spaces/{space}/messages/{message}
reaction

Reaction

필수 항목입니다. 만들 리액션입니다.

CreateSpaceRequest

멤버 없이 이름이 지정된 스페이스를 만들기 위한 요청입니다.

필드
space

Space

필수 항목입니다. displayName 및 spaceType 필드를 채워야 합니다. SpaceType.SPACE만 지원됩니다.

ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName를 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

개발자 프리뷰 프로그램 회원인 경우 importMode가 true로 설정된 경우 SpaceType.GROUP_CHAT를 사용할 수 있습니다.

name 공간은 서버에서 할당되므로 이 필드에 지정된 모든 항목은 무시됩니다.
request_id

string

선택사항입니다. 이 요청의 고유 식별자입니다. 임의의 UUID를 사용하는 것이 좋습니다. 기존 요청 ID를 지정하면 새 스페이스를 만드는 대신 해당 ID로 생성된 스페이스가 반환됩니다. 인증된 사용자가 다른 동일한 Chat 앱에서 기존 요청 ID를 지정하면 오류가 반환됩니다.

CustomEmoji

맞춤 이모티콘을 나타냅니다.

필드
name

string

식별자. 서버에서 할당한 맞춤 이모티콘의 리소스 이름입니다.

형식: customEmojis/{customEmoji}

uid

string

출력 전용입니다. 맞춤 그림 이모티콘 리소스의 고유 키입니다.
emoji_name

string

변경할 수 없습니다. 사용자가 제공한 맞춤 이모티콘 이름이며 조직 내에서 고유합니다.

맞춤 그림 이모티콘을 만들 때 필요하며, 그렇지 않은 경우에만 출력합니다.

그림 이모티콘 이름은 콜론으로 시작하고 끝나야 하며 소문자여야 하며 영숫자 문자, 하이픈, 밑줄만 포함할 수 있습니다. 하이픈과 밑줄은 단어를 구분할 때 사용해야 하며 연속해서 사용할 수 없습니다.

예: :valid-emoji-name:

temporary_image_uri

string

출력 전용입니다. 맞춤 그림 이모티콘의 이미지 URL로, 10분 이상 유효합니다. 맞춤 그림 이모티콘을 만들 때는 응답에 채워지지 않습니다.

payload

CustomEmojiPayload

입력 전용입니다. 페이로드 데이터.

CustomEmojiPayload

맞춤 이모티콘의 페이로드 데이터입니다.

필드
file_content

bytes

필수 항목입니다. 입력 전용입니다. 맞춤 이모티콘에 사용된 이미지입니다.

페이로드는 256KB 미만이어야 하며 이미지의 크기는 64~500픽셀이어야 합니다. 제한사항은 변경될 수 있습니다.
filename

string

필수 항목입니다. 입력 전용입니다. 이미지 파일 이름입니다.

지원되는 파일 확장자: .png, .jpg, .gif

DeleteCustomEmojiRequest

맞춤 이모티콘 삭제 요청입니다.

필드
name

string

필수 항목입니다. 삭제할 맞춤 그림 이모티콘의 리소스 이름입니다.

형식: customEmojis/{customEmoji}

그림 이모티콘 이름을 {customEmoji}의 별칭으로 사용할 수 있습니다. 예를 들어 customEmojis/:example-emoji:는 :example-emoji:가 맞춤 이모티콘의 이모티콘 이름인 경우입니다.

DeleteMembershipRequest

스페이스의 멤버십 삭제 요청입니다.

필드
name

string

필수 항목입니다. 삭제할 멤버십의 리소스 이름입니다. 채팅 앱은 사람 사용자 또는 자체 멤버십을 삭제할 수 있습니다. 채팅 앱에서 다른 앱을 삭제할 수 없음 멤버십입니다.

사람 멤버십을 삭제할 때는 chat.memberships 범위와 spaces/{space}/members/{member} 형식이 필요합니다. 이메일을 {member}의 별칭으로 사용할 수 있습니다. 예를 들어 spaces/{space}/members/example@gmail.com와 같이 입력합니다. 여기서 example@gmail.com은 Google Chat 사용자의 이메일입니다.

앱 멤버십을 삭제할 때는 chat.memberships.app 범위 및 spaces/{space}/members/app 형식이 필요합니다.

형식: spaces/{space}/members/{member} 또는 spaces/{space}/members/app.
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.memberships OAuth 2.0 범위가 필요합니다.

관리 액세스를 사용하여 스페이스에서 앱 멤버십을 삭제할 수는 없습니다.

DeleteMessageRequest

메시지 삭제 요청입니다.

필드
name

string

필수 항목입니다. 메시지의 리소스 이름입니다.

형식: spaces/{space}/messages/{message}

메시지에 맞춤 ID를 설정한 경우 clientAssignedMessageId 필드의 값을 {message}에 사용할 수 있습니다. 자세한 내용은 메시지 이름 지정하기를 참고하세요.
force

bool

true인 경우 메시지를 삭제하면 대화목록 답글도 삭제됩니다. false인 경우 메시지에 대화목록 답장이 있는 경우 삭제에 실패합니다.

사용자로 인증할 때만 적용됩니다. Chat 앱으로 인증할 때는 영향을 주지 않습니다.

DeleteReactionRequest

메시지에 대한 반응을 삭제합니다.

필드
name

string

필수 항목입니다. 삭제할 리액션의 이름입니다.

형식: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

스페이스 삭제 요청입니다.

필드
name

string

필수 항목입니다. 삭제할 스페이스의 리소스 이름입니다.

형식: spaces/{space}
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.delete OAuth 2.0 범위가 필요합니다.

DeletionMetadata

삭제된 메일에 관한 정보입니다. delete_time가 설정되면 메시지가 삭제됩니다.

필드
deletion_type

DeletionType

메일을 삭제한 사용자를 나타냅니다.

DeletionType

메일을 삭제한 사용자 및 삭제 방법 향후 더 많은 값이 추가될 수 있습니다.

열거형
DELETION_TYPE_UNSPECIFIED 이 값은 사용되지 않습니다.
CREATOR 사용자가 자신의 메시지를 삭제했습니다.
SPACE_OWNER 스페이스 소유자가 메시지를 삭제했습니다.
ADMIN Google Workspace 관리자가 메일을 삭제했습니다.
APP_MESSAGE_EXPIRY 채팅 앱이 만료되어 자체 메시지를 삭제했습니다.
CREATOR_VIA_APP 채팅 앱에서 사용자를 대신하여 메시지를 삭제했습니다.
SPACE_OWNER_VIA_APP Chat 앱에서 스페이스 소유자를 대신하여 메시지를 삭제했습니다.

Dialog

대화상자의 카드 본문을 둘러싸는 래퍼입니다.

필드
body

Card

입력 전용입니다. 모달에서 렌더링되는 대화상자의 본문 Google Chat 앱에서는 DateTimePicker, OnChangeAction 카드 항목을 지원하지 않습니다.

DialogAction

대화상자와 요청 상태 코드를 포함합니다.

필드
action_status

ActionStatus

입력 전용입니다. 대화상자를 호출하거나 제출하기 위한 요청의 상태입니다. 필요한 경우 사용자에게 상태와 메시지를 표시합니다. 예를 들어 오류 또는 성공의 경우
통합 필드 action. 실행할 작업입니다. action은 다음 중 하나여야 합니다.
dialog

Dialog

입력 전용입니다. 요청의 대화상자입니다.

DriveDataRef

Drive 첨부파일의 데이터에 대한 참조입니다.

필드
drive_file_id

string

Drive 파일의 ID입니다. Drive API와 함께 사용합니다.

DriveLinkData

Google Drive 링크 관련 데이터입니다.

필드
drive_data_ref

DriveDataRef

Google Drive 파일을 참조하는 DriveDataRef.
mime_type

string

연결된 Google 드라이브 리소스의 MIME 유형입니다.

그림 이모티콘

메시지에 대한 반응으로 사용되는 이모티콘입니다.

필드
통합 필드 content. 그림 이모티콘의 콘텐츠입니다. content은 다음 중 하나여야 합니다.
unicode

string

유니코드 문자열로 표시되는 기본 이모티콘입니다.
custom_emoji

CustomEmoji

출력 전용입니다. 맞춤 이모티콘

EmojiReactionSummary

메시지에 특정 그림 이모티콘으로 반응한 사용자 수입니다.

필드
emoji

Emoji

반응과 관련된 그림 이모티콘입니다.
reaction_count

int32

연결된 이모티콘을 사용하는 총 반응 수입니다.

FindDirectMessageRequest

사용자 리소스를 기반으로 채팅 메시지 스페이스를 가져오기 위한 요청입니다.

필드
name

string

필수 항목입니다. 채팅 메시지를 찾을 사용자의 리소스 이름입니다.

형식: users/{user}, 여기서 {user}는 People API의 사용자에 대한 id 또는 Directory API의 사용자에 대한 id입니다. 예를 들어 People API 프로필 ID가 123456789인 경우 users/123456789을 name로 사용하여 해당 사용자와의 다이렉트 메시지를 찾을 수 있습니다. 사용자로 인증되면 이메일을 {user}의 별칭으로 사용할 수 있습니다. 예를 들어 users/example@gmail.com은 example@gmail.com가 Google Chat 사용자의 이메일인 경우입니다.

GetAttachmentRequest

첨부파일 가져오기 요청입니다.

필드
name

string

필수 항목입니다. 첨부파일의 리소스 이름으로, spaces/{space}/messages/{message}/attachments/{attachment} 형식입니다.

GetCustomEmojiRequest

단일 맞춤 그림 이모티콘을 반환하기 위한 요청입니다.

필드
name

string

필수 항목입니다. 맞춤 이모티콘의 리소스 이름입니다.

형식: customEmojis/{customEmoji}

그림 이모티콘 이름을 {customEmoji}의 별칭으로 사용할 수 있습니다. 예를 들어 customEmojis/:example-emoji:는 :example-emoji:가 맞춤 이모티콘의 이모티콘 이름인 경우입니다.

GetMembershipRequest

스페이스 멤버십 가져오기 요청입니다.

필드
name

string

필수 항목입니다. 검색할 멤버십의 리소스 이름입니다.

사용자 인증을 사용하여 앱의 자체 멤버십을 가져오려면 선택적으로 spaces/{space}/members/app를 사용하면 됩니다.

형식: spaces/{space}/members/{member} 또는 spaces/{space}/members/app

사용자의 이메일을 {member}의 별칭으로 사용할 수 있습니다. 예를 들어 spaces/{space}/members/example@gmail.com은 example@gmail.com가 Google Chat 사용자의 이메일인 경우입니다.
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.memberships 또는 chat.admin.memberships.readonly OAuth 2.0 범위가 필요합니다.

관리 액세스 권한을 사용하는 경우 스페이스에서 앱 멤버십을 가져올 수 없습니다.

GetMessageRequest

메시지 가져오기 요청입니다.

필드
name

string

필수 항목입니다. 메시지의 리소스 이름입니다.

형식: spaces/{space}/messages/{message}

메시지에 맞춤 ID를 설정한 경우 {message}에 clientAssignedMessageId 필드의 값을 사용할 수 있습니다. 자세한 내용은 메시지 이름 지정하기를 참고하세요.

GetSpaceEventRequest

스페이스 이벤트 가져오기 요청 메시지입니다.

필드
name

string

필수 항목입니다. 스페이스 이벤트의 리소스 이름입니다.

형식: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

GetSpaceReadState API 요청 메시지입니다.

필드
name

string

필수 항목입니다. 검색할 스페이스 읽기 상태의 리소스 이름입니다.

호출하는 사용자의 읽기 상태만 가져옵니다.

호출하는 사용자를 참조하려면 다음 중 하나를 설정하세요.

  • me 별칭입니다. 예를 들면 users/me/spaces/{space}/spaceReadState입니다.

  • Workspace 이메일 주소 예를 들면 users/user@example.com/spaces/{space}/spaceReadState입니다.

  • 사용자 ID입니다. 예를 들면 users/123456789/spaces/{space}/spaceReadState입니다.

형식: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

단일 공백을 반환하는 요청입니다.

필드
name

string

필수 항목입니다. 스페이스의 리소스 이름으로, spaces/{space} 형식입니다.

형식: spaces/{space}
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.spaces 또는 chat.admin.spaces.readonly OAuth 2.0 범위가 필요합니다.

GetThreadReadStateRequest

GetThreadReadStateRequest API의 요청 메시지입니다.

필드
name

string

필수 항목입니다. 검색할 스레드 읽기 상태의 리소스 이름입니다.

호출하는 사용자의 읽기 상태만 가져옵니다.

호출하는 사용자를 참조하려면 다음 중 하나를 설정하세요.

  • me 별칭입니다. 예를 들면 users/me/spaces/{space}/threads/{thread}/threadReadState입니다.

  • Workspace 이메일 주소 예를 들면 users/user@example.com/spaces/{space}/threads/{thread}/threadReadState입니다.

  • 사용자 ID입니다. 예를 들면 users/123456789/spaces/{space}/threads/{thread}/threadReadState입니다.

형식: users/{user}/spaces/{space}/threads/{thread}/threadReadState

그룹

Google Chat의 Google 그룹

필드
name

string

Google 그룹의 리소스 이름입니다.

Cloud Identity Groups API의 그룹을 나타냅니다.

형식: groups/{group}

HistoryState

메시지 및 스페이스의 기록 상태입니다. 메시지 및 대화목록이 생성된 후 보관되는 기간을 지정합니다.

열거형
HISTORY_STATE_UNSPECIFIED 기본값 사용하지 마세요.
HISTORY_OFF 채팅 기록이 사용 중지되었습니다. 메시지 및 대화목록은 24시간 동안 보관됩니다.
HISTORY_ON 채팅 기록이 사용 설정되었습니다. 조직의 Vault 보관 규칙에 따라 메일 및 대화목록이 보관되는 기간이 지정됩니다.

ListCustomEmojisRequest

맞춤 그림 이모티콘 목록을 반환하기 위한 요청입니다.

필드
page_size

int32

선택사항입니다. 반환되는 맞춤 그림 이모티콘의 최대 개수입니다. 서비스는 이 값보다 적은 수의 맞춤 그림 이모티콘을 반환할 수 있습니다. 지정하지 않으면 기본값은 25입니다. 최댓값은 200이며, 200을 초과하는 값은 200으로 변경됩니다.
page_token

string

선택사항입니다. (이전 쿼리에서 재개하는 경우)

이전 목록 맞춤 이모티콘 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지로 나눌 때 필터 값은 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
filter

string

선택사항입니다. 쿼리 필터입니다.

크리에이터별 필터링을 지원합니다.

크리에이터별로 필터링하려면 유효한 값을 지정해야 합니다. 현재는 creator("users/me") 및 NOT creator("users/me")만 호출하는 사용자가 만들었는지 여부를 기준으로 맞춤 이모티콘을 필터링할 수 있습니다.

예를 들어 다음 쿼리는 호출자가 만든 맞춤 이모티콘을 반환합니다.

creator("users/me")

잘못된 쿼리는 서버에서 INVALID_ARGUMENT 오류와 함께 거부됩니다.

ListCustomEmojisResponse

맞춤 이모티콘 목록에 대한 응답입니다.

필드
custom_emojis[]

CustomEmoji

순서가 지정되지 않은 목록입니다. 요청된 페이지(또는 첫 번째 페이지)의 맞춤 이모티콘 목록입니다.
next_page_token

string

결과의 다음 페이지를 검색하기 위해 pageToken로 전송할 수 있는 토큰입니다. 비어 있으면 후속 페이지가 없습니다.

ListMembershipsRequest

멤버십 나열 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 멤버십 목록을 가져올 스페이스의 리소스 이름입니다.

형식: spaces/{space}
page_size

int32

선택사항입니다. 반환할 최대 멤버십 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 100개의 멤버십이 반환됩니다.

최대값은 1,000입니다. 1,000 이상의 값을 사용하면 1,000으로 자동 변경됩니다.

음수 값은 INVALID_ARGUMENT 오류를 반환합니다.
page_token

string

선택사항입니다. 이전에 멤버십을 나열하기 위해 호출한 때 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다.

페이지로 나누는 경우, 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예상치 못한 결과가 발생할 수 있습니다.
filter

string

선택사항입니다. 쿼리 필터입니다.

회원의 역할 (role) 및 유형 (member.type)으로 멤버십을 필터링할 수 있습니다.

역할별로 필터링하려면 role를 ROLE_MEMBER 또는 ROLE_MANAGER로 설정합니다.

유형별로 필터링하려면 member.type를 HUMAN 또는 BOT로 설정합니다. != 연산자를 사용하여 member.type를 필터링할 수도 있습니다.

역할과 유형을 모두 기준으로 필터링하려면 AND 연산자를 사용하세요. 역할 또는 유형으로 필터링하려면 OR 연산자를 사용합니다.

use_admin_access가 true로 설정된 경우 member.type = "HUMAN" 또는 member.type != "BOT"가 필요합니다. 다른 회원 유형 필터는 거부됩니다.

예를 들어 유효한 쿼리는 다음과 같습니다.

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

다음 쿼리가 잘못되었습니다.

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

잘못된 쿼리는 서버에서 INVALID_ARGUMENT 오류와 함께 거부됩니다.
show_groups

bool

선택사항입니다. true인 경우 다른 유형의 멤버십 외에도 Google Group와 연결된 멤버십도 반환합니다. filter가 설정되면 필터 기준과 일치하지 않는 Google Group 멤버십은 반환되지 않습니다.
show_invited

bool

선택사항입니다. true인 경우 다른 유형의 멤버십 외에 invited 회원과 연결된 멤버십도 반환됩니다. 필터가 설정된 경우 필터 기준과 일치하지 않는 invited 멤버십은 반환되지 않습니다.

현재 사용자 인증이 필요합니다.
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

전화를 거는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.memberships.readonly 또는 chat.admin.memberships OAuth 2.0 범위가 필요합니다.

관리 액세스 권한을 사용하는 경우 스페이스에 앱 멤버십을 나열할 수 없습니다.

ListMembershipsResponse

스페이스 멤버십 나열에 대한 응답입니다.

필드
memberships[]

Membership

순서가 지정되지 않은 목록입니다. 요청된 (또는 첫 번째) 페이지의 멤버십 목록입니다.
next_page_token

string

결과의 다음 페이지를 검색하기 위해 pageToken로 전송할 수 있는 토큰입니다. 비어 있으면 후속 페이지가 없습니다.

ListMessagesRequest

사용자가 참여 중인 지정된 스페이스의 메시지를 나열합니다.

필드
parent

string

필수 항목입니다. 메시지를 표시할 스페이스의 리소스 이름입니다.

형식: spaces/{space}
page_size

int32

반환되는 최대 메시지 수입니다. 서비스가 이 값보다 적은 메시지를 반환할 수 있습니다.

지정하지 않으면 최대 25개가 반환됩니다.

최댓값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다.

음수 값은 INVALID_ARGUMENT 오류를 반환합니다.
page_token

string

이전 쿼리에서 재개하는 경우 선택사항입니다.

이전 목록 메시지 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다.

페이지로 나눌 때 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
filter

string

쿼리 필터

날짜(create_time) 및 대화목록(thread.name)을 기준으로 메시지를 필터링할 수 있습니다.

생성 날짜별로 메시지를 필터링하려면 RFC-3339 형식의 타임스탬프와 따옴표로 묶은 create_time를 지정합니다. "2023-04-21T11:30:00-04:00"를 예로 들 수 있습니다. 보다 큰 연산자 >를 사용하여 타임스탬프 이후에 생성된 메시지를 나열하거나 보다 작은 연산자 <를 사용하여 타임스탬프 이전에 생성된 메시지를 나열할 수 있습니다. 시간 간격 내의 메시지를 필터링하려면 두 타임스탬프 사이에 AND 연산자를 사용합니다.

대화목록별로 필터링하려면 thread.name를 지정하고 형식을 spaces/{space}/threads/{thread}로 지정합니다. 쿼리당 thread.name 하나만 지정할 수 있습니다.

스레드와 날짜로 필터링하려면 쿼리에 AND 연산자를 사용합니다.

예를 들어 다음 쿼리는 유효합니다.

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

잘못된 쿼리는 서버에서 INVALID_ARGUMENT 오류와 함께 거부됩니다.
order_by

string

이전 쿼리에서 재개하는 경우 선택사항입니다.

메시지 목록의 순서를 지정하는 방법입니다. 순서 연산으로 정렬할 값을 지정합니다. 유효한 순서 지정 작업 값은 다음과 같습니다.

  • ASC: 오름차순

  • 내림차순의 경우 DESC

기본 순서는 create_time ASC입니다.
show_deleted

bool

삭제된 메시지를 포함할지 여부입니다. 삭제된 메일에는 삭제 시간과 삭제에 관한 메타데이터가 포함되지만 메시지 콘텐츠는 사용할 수 없습니다.

ListMessagesResponse

메시지 목록에 대한 응답 메시지입니다.

필드
messages[]

Message

메시지 목록입니다.
next_page_token

string

토큰을 pageToken로 전송하여 결과의 다음 페이지를 검색할 수 있습니다. 비어 있으면 후속 페이지가 없습니다.

ListReactionsRequest

메시지에 대한 반응을 표시합니다.

필드
parent

string

필수 항목입니다. 사용자가 반응한 메시지입니다.

형식: spaces/{space}/messages/{message}
page_size

int32

선택사항입니다. 반환되는 반응의 최대 개수입니다. 서비스는 이 값보다 적은 리액션을 반환할 수 있습니다. 지정하지 않으면 기본값은 25입니다. 최댓값은 200입니다. 200을 초과하는 값은 200으로 변경됩니다.
page_token

string

선택사항입니다. (이전 쿼리에서 재개하는 경우)

이전 list reactions 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지로 나눌 때 필터 값은 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
filter

string

선택사항입니다. 쿼리 필터입니다.

이모티콘 (emoji.unicode 또는 emoji.custom_emoji.uid) 및 사용자 (user.name)별로 반응을 필터링할 수 있습니다.

여러 이모티콘 또는 사용자의 반응을 필터링하려면 OR 연산자(예: emoji.unicode = "🙂" OR emoji.unicode = "👍" 및 user.name = "users/AAAAAA" OR user.name = "users/BBBBBB")를 사용하여 유사한 필드를 조인합니다.

이모티콘과 사용자별로 반응을 필터링하려면 emoji.unicode = "🙂" AND user.name = "users/AAAAAA"와 같은 AND 연산자를 사용합니다.

쿼리에서 AND와 OR를 모두 사용하는 경우 괄호로 그룹화합니다.

예를 들어 유효한 쿼리는 다음과 같습니다.

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

다음 쿼리가 잘못되었습니다.

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

잘못된 쿼리는 서버에서 INVALID_ARGUMENT 오류와 함께 거부됩니다.

ListReactionsResponse

리액션 목록 요청에 대한 응답입니다.

필드
reactions[]

Reaction

요청된 (또는 첫 번째) 페이지의 반응 목록입니다.
next_page_token

string

결과의 다음 페이지를 가져오는 연속 토큰입니다. 결과의 마지막 페이지는 비어 있습니다.

ListSpaceEventsRequest

등록정보 공간 이벤트 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 이벤트가 발생한 Google Chat 스페이스의 리소스 이름입니다.

형식: spaces/{space}
page_size

int32

선택사항입니다. 반환되는 스페이스 이벤트의 최대 개수입니다. 서비스는 이 값보다 더 적은 수의 값을 반환할 수 있습니다.

음수 값은 INVALID_ARGUMENT 오류를 반환합니다.
page_token

string

이전 목록 공간 이벤트 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지로 나누는 경우, 공간 이벤트 목록에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예상치 못한 결과가 발생할 수 있습니다.
filter

string

필수 항목입니다. 쿼리 필터

has : 연산자를 사용하여 이벤트 유형(event_type)을 하나 이상 지정해야 합니다. 여러 이벤트 유형으로 필터링하려면 OR 연산자를 사용합니다. 필터에서 일괄 이벤트 유형을 생략합니다. 요청은 관련된 일괄 이벤트를 자동으로 반환합니다. 예를 들어 새 반응 (google.workspace.chat.reaction.v1.created)으로 필터링하는 경우 서버는 일괄 새 반응 이벤트 (google.workspace.chat.reaction.v1.batchCreated)도 반환합니다. 지원되는 이벤트 유형 목록은 SpaceEvents 참조 문서를 확인하세요.

원하는 경우 시작 시간 (start_time) 및 종료 시간 (end_time)으로 필터링할 수도 있습니다.

  • start_time: 스페이스 이벤트 나열을 시작할 배타적 타임스탬프입니다. 최대 28일 전에 발생한 이벤트를 표시할 수 있습니다. 지정하지 않으면 지난 28일 동안의 스페이스 이벤트가 표시됩니다.
  • end_time: 스페이스 이벤트가 표시되는 타임스탬프까지의 범위입니다. 지정하지 않으면 요청 시점까지 이벤트가 나열됩니다.

시작 시간 또는 종료 시간을 지정하려면 RFC-3339의 등호 = 연산자와 형식을 사용합니다. start_time 및 end_time로 모두 필터링하려면 AND 연산자를 사용하세요.

예를 들어 유효한 쿼리는 다음과 같습니다.

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

다음 쿼리가 잘못되었습니다.

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

잘못된 쿼리는 서버에서 INVALID_ARGUMENT 오류와 함께 거부됩니다.

ListSpaceEventsResponse

스페이스 이벤트 나열을 위한 응답 메시지입니다.

필드
space_events[]

SpaceEvent

결과는 시간순으로 반환됩니다(가장 오래된 이벤트가 먼저 반환됨). 참고: 목록 요청의 경우 스페이스 객체에 permissionSettings 필드가 반환되지 않습니다.
next_page_token

string

더 많은 이벤트를 가져오는 데 사용되는 연속 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

ListSpacesRequest

호출자가 참여 중인 스페이스를 나열해 달라는 요청입니다.

필드
page_size

int32

선택사항입니다. 반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 100개의 스페이스가 반환됩니다.

최댓값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다.

음수 값은 INVALID_ARGUMENT 오류를 반환합니다.
page_token

string

선택사항입니다. 이전 list spaces 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다.

페이지로 나누는 경우 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
filter

string

선택사항입니다. 쿼리 필터

스페이스 유형(space_type)을 기준으로 스페이스를 필터링할 수 있습니다.

공백 유형으로 필터링하려면 SPACE 또는 GROUP_CHAT (space_type는 SPACE_TYPE_UNSPECIFIED일 수 없음)와 같은 유효한 enum 값을 지정해야 합니다. 여러 공백 유형을 쿼리하려면 OR 연산자를 사용합니다.

예를 들어 유효한 쿼리는 다음과 같습니다.

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

잘못된 쿼리는 서버에서 INVALID_ARGUMENT 오류와 함께 거부됩니다.

ListSpacesResponse

스페이스 목록 요청에 대한 응답입니다.

필드
spaces[]

Space

요청된 (또는 첫 번째) 페이지의 스페이스 목록입니다. 참고: 목록 요청의 경우 스페이스 객체에 permissionSettings 필드가 반환되지 않습니다.
next_page_token

string

토큰을 pageToken으로 전송하여 결과의 다음 페이지를 검색할 수 있습니다. 비어 있으면 후속 페이지가 없습니다.

MatchedUrl

Chat 메시지에서 일치하는 URL입니다. 채팅 앱은 일치하는 URL을 미리 볼 수 있습니다. 자세한 내용은 링크 미리보기를 참고하세요.

필드
url

string

출력 전용입니다. 일치된 URL입니다.

멤버십

사용자 또는 채팅 앱이 스페이스에 초대되었는지, 스페이스의 일부인지, 없는지와 같은 Google Chat의 멤버십 관계를 나타냅니다.

필드
name

string

서버에서 할당한 멤버십의 리소스 이름입니다.

형식: spaces/{space}/members/{member}
state

MembershipState

출력 전용입니다. 멤버십 상태입니다.
role

MembershipRole

선택사항입니다. Chat 스페이스 내에서 사용자의 역할로, 스페이스에서 허용되는 작업을 결정합니다.

이 필드는 UpdateMembership의 입력값으로만 사용할 수 있습니다.
create_time

Timestamp

선택사항입니다. 변경할 수 없습니다. 멤버십 생성 시간입니다(예: 멤버가 스페이스에 참여했거나 스페이스 참여를 초대받은 시간). 이 필드는 가져오기 모드 스페이스에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다.
delete_time

Timestamp

선택사항입니다. 변경할 수 없습니다. 멤버가 스페이스에서 나갔거나 스페이스에서 삭제된 시점 등 멤버십 삭제 시간입니다. 이 필드는 가져오기 모드 스페이스에서 이전 멤버십을 가져오는 데 사용되는 경우를 제외하고 출력 전용입니다.
통합 필드 memberType. 이 멤버십과 연결된 회원입니다. 다른 구성원 유형은 향후 지원될 수 있습니다. memberType은 다음 중 하나여야 합니다.
member

User

멤버십이 해당하는 Google Chat 사용자 또는 앱입니다. 채팅 앱이 사용자로 인증되면 사용자 name 및 type이 출력됩니다.
group_member

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[]

MembershipCreatedEventData

신규 멤버십 목록입니다.

MembershipBatchDeletedEventData

삭제된 여러 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.batchDeleted

필드
memberships[]

MembershipDeletedEventData

삭제된 멤버십 목록

MembershipBatchUpdatedEventData

업데이트된 여러 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.batchUpdated

필드
memberships[]

MembershipUpdatedEventData

업데이트된 멤버십 목록입니다.

MembershipCreatedEventData

새 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.created.

필드
membership

Membership

새 멤버십입니다.

MembershipDeletedEventData

삭제된 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.deleted

필드
membership

Membership

삭제된 멤버십입니다. name 및 state 필드만 채워집니다.

MembershipUpdatedEventData

업데이트된 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.updated

필드
membership

Membership

업데이트된 멤버십입니다.

메시지

Google Chat 스페이스의 메시지

필드
name

string

메시지의 리소스 이름입니다.

형식: spaces/{space}/messages/{message}

여기서 {space}는 메시지가 게시된 스페이스의 ID이고 {message}는 메시지에 시스템에서 할당한 ID입니다. spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB를 예로 들 수 있습니다.

메시지를 만들 때 커스텀 ID를 설정하면 이 ID를 사용하여 {message}를 clientAssignedMessageId 필드의 값으로 바꿔 요청에서 메시지를 지정할 수 있습니다. spaces/AAAAAAAAAAA/messages/client-custom-name를 예로 들 수 있습니다. 자세한 내용은 메시지 이름 지정하기를 참고하세요.
sender

User

출력 전용입니다. 메시지를 작성한 사용자입니다. 채팅 앱이 사용자로 인증되면 사용자 name 및 type이 출력됩니다.
create_time

Timestamp

선택사항입니다. 변경할 수 없습니다. Chat에서 만든 스페이스의 경우 메시지가 생성된 시간입니다. 이 필드는 가져오기 모드 공간에서 사용되는 경우를 제외하고 출력 전용입니다.

가져오기 모드 스페이스의 경우 원래 생성 시간을 보존하려면 이 필드를 소스에서 메일이 생성된 이전 타임스탬프로 설정합니다.
last_update_time

Timestamp

출력 전용입니다. 사용자가 메시지를 마지막으로 수정한 시간입니다. 메시지를 수정한 적이 없는 경우 이 필드는 비어 있습니다.
delete_time

Timestamp

출력 전용입니다. Google Chat에서 메시지가 삭제된 시간입니다. 메일이 삭제되지 않는 경우 이 필드는 비어 있습니다.
text

string

메시지의 일반 텍스트 본문입니다. 이미지, 동영상 또는 웹페이지의 첫 번째 링크는 미리보기 칩을 생성합니다. Google Chat 사용자를 @멘션하거나 스페이스의 모든 사용자를 멘션할 수도 있습니다.

문자 메시지 작성에 대해 자세히 알아보려면 메시지 보내기를 참고하세요.
formatted_text

string

출력 전용입니다. 서식을 전달하기 위해 추가된 마크업이 있는 text 메시지를 포함합니다. 이 필드는 UI에 표시되는 모든 서식을 캡처하지 못할 수 있지만 다음을 포함합니다.

  • 굵게, 기울임꼴, 취소선, 고정폭, 고정폭 블록, 글머리기호 목록의 마크업 구문

  • <users/{user}> 형식을 사용하는 사용자 멘션

  • <{url}|{rendered_text}> 형식을 사용하는 맞춤 하이퍼링크. 여기서 첫 번째 문자열은 URL이고 두 번째 문자열은 렌더링된 텍스트입니다(예: <http://example.com|custom text>).

  • :{emoji_name}: 형식을 사용하는 맞춤 그림 이모티콘(예: :smile:) 이는 웃는 얼굴 이모티콘에 사용되는 U+1F600와 같은 유니코드 이모티콘에는 적용되지 않습니다.

자세한 내용은 메일에 포함된 텍스트 서식 보기를 참고하세요.
cards[]
(deprecated)

Card

지원 중단됨: 대신 cards_v2를 사용하세요.

서식이 지정된 텍스트, 버튼, 클릭 가능한 이미지와 같은 UI 요소를 표시하는 데 사용할 수 있는 양식 지정된 양방향 카드입니다. 카드는 일반적으로 메시지의 일반 텍스트 본문 아래에 표시됩니다. cards 및 cards_v2의 최대 크기는 32KB입니다.
cards_v2[]

CardWithId

카드의 배열입니다.

채팅 앱에서만 카드를 만들 수 있습니다. Chat 앱이 사용자로 인증하는 경우 메일에 카드를 포함할 수 없습니다.

카드가 포함된 메시지를 만드는 방법은 메시지 보내기를 참고하세요.

카드 작성 도구로 카드를 디자인하고 미리보기를 확인합니다.

카드 작성 도구 열기
annotations[]

Annotation

출력 전용입니다. 이 메시지의 text와 연결된 주석입니다.
thread

Thread

메일이 속한 대화목록입니다. 사용 예는 메시지 대화목록 시작 또는 답장을 참고하세요.
space

Space

채팅 앱이 사용자로 인증되면 공백 name이 출력됩니다.
fallback_text

string

메시지 카드에 대한 일반 텍스트 설명으로, 실제 카드를 표시할 수 없는 경우에 사용됩니다(예: 모바일 알림).
action_response

ActionResponse

입력 전용입니다. Chat 앱에서 응답 게시 방법을 구성하는 데 사용할 수 있는 매개변수입니다.
argument_text

string

출력 전용입니다. 모든 채팅 앱 멘션이 삭제된 메시지의 일반 텍스트 본문입니다.
slash_command

SlashCommand

출력 전용입니다. 슬래시 명령어 정보(해당하는 경우)
attachment[]

Attachment

사용자가 업로드한 첨부파일입니다.
matched_url

MatchedUrl

출력 전용입니다. 링크 미리보기 패턴과 일치하는 spaces.messages.text의 URL입니다. 자세한 내용은 미리보기 링크를 참고하세요.
thread_reply

bool

출력 전용입니다. true인 경우 메시지는 답장 대화목록의 응답입니다. false인 경우 메시지가 스페이스의 최상위 대화에서 대화목록의 첫 번째 메시지 또는 대화목록 답장이 없는 메시지로 표시됩니다.

스페이스에서 대화목록의 답글을 지원하지 않는 경우 이 필드는 항상 false입니다.
client_assigned_message_id

string

선택사항입니다. 메시지의 맞춤 ID입니다. 필드를 사용하여 메시지를 식별하거나, 메시지를 가져오거나, 삭제하거나, 업데이트할 수 있습니다. 맞춤 ID를 설정하려면 메시지를 만들 때 messageId 필드를 지정합니다. 자세한 내용은 메시지 이름 지정하기를 참고하세요.
emoji_reaction_summaries[]

EmojiReactionSummary

출력 전용입니다. 메시지에 있는 그림 이모티콘 반응 요약 목록입니다.
private_message_viewer

User

변경할 수 없습니다. 메시지 만들기를 위한 입력입니다. 그렇지 않으면 출력 전용입니다. 메시지를 볼 수 있는 사용자입니다. 설정하면 메시지가 비공개로 설정되며 지정된 사용자와 채팅 앱에만 표시됩니다. 요청에 이 필드를 포함하려면 앱 인증을 사용하여 Chat API를 호출하고 다음을 생략해야 합니다.

자세한 내용은 비공개 메시지 보내기를 참고하세요.
deletion_metadata

DeletionMetadata

출력 전용입니다. 삭제된 메일에 대한 정보입니다. delete_time가 설정되면 메시지가 삭제됩니다.
quoted_message_metadata

QuotedMessageMetadata

출력 전용입니다. 스페이스에서 Google Chat 사용자가 인용한 메시지에 관한 정보입니다. Google Chat 사용자는 메시지를 인용하여 답장할 수 있습니다.
attached_gifs[]

AttachedGif

출력 전용입니다. 메일에 첨부된 GIF 이미지입니다.
accessory_widgets[]

AccessoryWidget

메시지 하단에 표시되는 양방향 위젯 1개 이상 텍스트, 카드 또는 텍스트와 카드가 모두 포함된 메시지에 액세서리 위젯을 추가할 수 있습니다. 대화상자가 포함된 메시지에는 지원되지 않습니다. 자세한 내용은 메일 하단에 대화형 위젯 추가하기를 참고하세요.

액세서리 위젯을 사용하여 메시지를 만들려면 앱 인증이 필요합니다.

MessageBatchCreatedEventData

여러 새 메시지의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.message.v1.batchCreated

필드
messages[]

MessageCreatedEventData

새 메시지 목록

MessageBatchDeletedEventData

삭제된 여러 메시지에 대한 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.message.v1.batchDeleted

필드
messages[]

MessageDeletedEventData

삭제된 메일 목록입니다.

MessageBatchUpdatedEventData

업데이트된 여러 메시지의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.message.v1.batchUpdated

필드
messages[]

MessageUpdatedEventData

업데이트된 메시지 목록입니다.

MessageCreatedEventData

새 메시지의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.message.v1.created

필드
message

Message

새 메시지

MessageDeletedEventData

삭제된 메시지의 이벤트 페이로드.

이벤트 유형: google.workspace.chat.message.v1.deleted

필드
message

Message

삭제된 메시지 name, createTime, deleteTime, deletionMetadata 필드만 채워집니다.

MessageUpdatedEventData

업데이트된 메시지의 이벤트 페이로드.

이벤트 유형: google.workspace.chat.message.v1.updated

필드
message

Message

업데이트된 메시지입니다.

QuotedMessageMetadata

인용된 메일에 대한 정보입니다.

필드
name

string

출력 전용입니다. 인용된 메시지의 리소스 이름입니다.

형식: spaces/{space}/messages/{message}
last_update_time

Timestamp

출력 전용입니다. 따옴표로 묶인 메시지가 생성되었거나 따옴표로 묶인 메시지가 마지막으로 업데이트된 시점의 타임스탬프입니다.

리액션

메시지에 대한 반응입니다.

필드
name

string

반응의 리소스 이름입니다.

형식: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

출력 전용입니다. 반응을 만든 사용자입니다.
emoji

Emoji

반응에 사용된 이모티콘입니다.

ReactionBatchCreatedEventData

여러 새 반응의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.reaction.v1.batchCreated

필드
reactions[]

ReactionCreatedEventData

새 리액션의 목록입니다.

ReactionBatchDeletedEventData

삭제된 여러 반응의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.reaction.v1.batchDeleted

필드
reactions[]

ReactionDeletedEventData

삭제된 반응 목록입니다.

ReactionCreatedEventData

새 반응의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.reaction.v1.created

필드
reaction

Reaction

새로운 리액션입니다.

ReactionDeletedEventData

삭제된 반응의 이벤트 페이로드입니다.

유형: google.workspace.chat.reaction.v1.deleted

필드
reaction

Reaction

삭제된 반응입니다.

RichLinkMetadata

리소스에 대한 리치 링크입니다.

필드
uri

string

이 링크의 URI입니다.
통합 필드 data. 연결된 리소스의 데이터입니다. data은 다음 중 하나여야 합니다.

RichLinkType

리치 링크 유형입니다. 향후 더 많은 유형이 추가될 수 있습니다.

열거형
DRIVE_FILE Google Drive 리치 링크 유형입니다.
CHAT_SPACE Chat 스페이스 리치 링크 유형입니다. 예를 들어 스페이스 스마트 칩이 있습니다.

SearchSpacesRequest

검색어를 기반으로 스페이스 목록을 검색하기 위한 요청입니다.

필드
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.spaces.readonly 또는 chat.admin.spaces OAuth 2.0 범위가 필요합니다.

이 메서드는 현재 관리자 액세스만 지원하므로 이 필드에는 true만 허용됩니다.
page_size

int32

반환할 최대 공백 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 100개의 공백이 반환됩니다.

최대값은 1,000입니다. 1,000 이상의 값을 사용하면 1,000으로 자동 변경됩니다.
page_token

string

이전 검색 공간 호출에서 수신된 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다.

페이지로 나누는 경우, 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
query

string

필수 항목입니다. 검색어

다음 매개변수를 사용하여 검색할 수 있습니다.

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time 및 last_active_time는 RFC-3339 형식의 타임스탬프를 허용하며 지원되는 비교 연산자는 =, <, >, <=, >=입니다.

customer는 필수 항목이며 스페이스를 가져올 고객을 나타내는 데 사용됩니다. 유일하게 지원되는 값은 customers/my_customer입니다.

display_name는 HAS(:) 연산자만 허용합니다. 일치할 텍스트는 먼저 토큰으로 토큰화되고 각 토큰은 스페이스의 display_name 어디서나 하위 문자열로 대소문자 구분 없이 독립적으로 접두사 일치됩니다. 예를 들어 Fun Eve는 Fun event 또는 The evening was fun과 일치하지만 notFun event 또는 even과는 일치하지 않습니다.

external_user_allowed는 true 또는 false를 허용합니다.

space_history_state는 space 리소스의 historyState 필드에 있는 값만 허용합니다.

space_type는 필수이며 유효한 값은 SPACE뿐입니다.

여러 필드에서 AND 연산자만 지원됩니다. 유효한 예는 space_type = "SPACE" AND display_name:"Hello"이고 잘못된 예는 space_type = "SPACE" OR display_name:"Hello"입니다.

동일한 필드에서 space_type는 AND 또는 OR 연산자를 지원하지 않습니다. display_name, 'space_history_state', 'external_user_allowed' OR 연산자만 지원합니다. last_active_time 및 create_time는 AND 및 OR 연산자를 모두 지원합니다. AND는 last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"와 같은 간격을 나타내는 데만 사용할 수 있습니다.

다음은 유효한 쿼리 예시입니다.

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

선택사항입니다. 스페이스 목록의 순서

정렬 기준으로 지원되는 속성은 다음과 같습니다.

  • membership_count.joined_direct_human_user_count: 스페이스에 직접 참여한 사람 사용자 수를 나타냅니다.
  • last_active_time: 요건을 충족하는 항목이 이 스페이스의 주제에 마지막으로 추가된 시간을 나타냅니다.
  • create_time: 스페이스 생성 시간을 나타냅니다.

유효한 순서 연산 값은 다음과 같습니다.

  • 오름차순의 경우 ASC 기본값

  • DESC: 내림차순

지원되는 구문은 다음과 같습니다.

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

검색 공간 요청에 해당하는 스페이스 목록이 포함된 응답입니다.

필드
spaces[]

Space

요청된 스페이스의 페이지입니다.
next_page_token

string

다음 페이지를 검색하는 데 사용할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 없습니다.
total_size

int32

모든 페이지에서 검색어와 일치하는 총 공간 수입니다. 결과가 10,000개의 공간을 초과하는 경우 이 값은 추정치입니다.

SetUpSpaceRequest

스페이스를 만들고 지정된 사용자를 스페이스에 추가하도록 요청합니다.

필드
space

Space

필수 항목입니다. Space.spaceType 필드는 필수 입력란입니다.

스페이스를 만들려면 Space.spaceType를 SPACE로 설정하고 Space.displayName를 설정합니다. 스페이스를 설정할 때 ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName을 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

그룹 채팅을 만들려면 Space.spaceType를 GROUP_CHAT로 설정합니다. Space.displayName를 설정하면 안 됩니다.

사람 간의 1:1 대화를 만들려면 Space.spaceType를 DIRECT_MESSAGE로 설정하고 Space.singleUserBotDm를 false로 설정합니다. Space.displayName 또는 Space.spaceDetails를 설정하지 않습니다.

사람과 통화하는 채팅 앱 간에 1:1 대화를 만들려면 Space.spaceType를 DIRECT_MESSAGE로, Space.singleUserBotDm를 true로 설정합니다. Space.displayName 또는 Space.spaceDetails를 설정하지 마세요.

DIRECT_MESSAGE 스페이스가 이미 있는 경우 새 스페이스를 만드는 대신 해당 공백이 반환됩니다.
request_id

string

선택사항입니다. 이 요청의 고유 식별자입니다. 임의의 UUID를 사용하는 것이 좋습니다. 기존 요청 ID를 지정하면 새 스페이스를 만드는 대신 해당 ID로 생성된 스페이스가 반환됩니다. 인증된 사용자가 다른 동일한 Chat 앱에서 기존 요청 ID를 지정하면 오류가 반환됩니다.
memberships[]

Membership

선택사항입니다. 스페이스에 참여하도록 초대할 Google Chat 사용자 또는 그룹입니다. 호출하는 사용자는 자동으로 추가되므로 생략합니다.

현재는 발신자 외에 최대 20개의 멤버십을 허용합니다.

수동 멤버십의 경우 Membership.member 필드에 name가 채워지고 (형식: users/{user}) type가 User.Type.HUMAN로 설정된 user가 포함되어야 합니다. 스페이스를 설정할 때만 사람 사용자를 추가할 수 있습니다. Chat 앱 추가는 통화 앱을 통한 채팅 메시지 설정에만 지원됩니다. 사용자의 이메일을 {user}의 별칭으로 사용하여 구성원을 추가할 수도 있습니다. 예를 들어 user.name는 users/example@gmail.com일 수 있습니다. Gmail 사용자 또는 외부 Google Workspace 도메인의 사용자를 초대하려면 {user}에 사용자의 이메일을 사용해야 합니다.

Google 그룹 멤버십의 경우 Membership.group_member 필드에 name가 채워진 group가 포함되어야 합니다(형식 groups/{group}). Space.spaceType를 SPACE로 설정할 때만 Google 그룹을 추가할 수 있습니다.

Space.spaceType를 SPACE로 설정하는 경우 선택사항입니다.

Space.spaceType을 GROUP_CHAT로 설정할 때 멤버십 2개 이상과 함께 필요합니다.

정확히 하나의 멤버십과 함께 실제 사용자로 Space.spaceType를 DIRECT_MESSAGE로 설정할 때 필요합니다.

사람과 호출하는 Chat 앱 간에 1:1 대화를 만들 때(Space.spaceType를 DIRECT_MESSAGE로, Space.singleUserBotDm를 true로 설정할 때) 비워야 합니다.

SlashCommand

Google Chat의 슬래시 명령어

필드
command_id

int64

호출된 슬래시 명령어의 ID입니다.

SlashCommandMetadata

슬래시 명령어의 주석 메타데이터 (/)입니다.

필드
bot

User

명령어가 호출된 채팅 앱
type

Type

슬래시 명령어 유형입니다.
command_name

string

호출된 슬래시 명령어의 이름입니다.
command_id

int64

호출된 슬래시 명령어의 명령어 ID입니다.
triggers_dialog

bool

슬래시 명령어가 대화상자용인지 여부를 나타냅니다.

유형

열거형
TYPE_UNSPECIFIED enum의 기본값입니다. 사용하지 마세요.
ADD 스페이스에 Chat 앱을 추가합니다.
INVOKE 스페이스에서 슬래시 명령어를 호출합니다.

공백

Google Chat의 스페이스 스페이스는 두 명 이상의 사용자 간의 대화 또는 사용자와 Chat 앱 간의 1:1 메시지입니다.

필드
name

string

공간의 리소스 이름입니다.

형식: spaces/{space}

여기서 {space}는 스페이스의 시스템 할당 ID를 나타냅니다. spaces.list() 메서드를 호출하거나 스페이스 URL에서 스페이스 ID를 가져올 수 있습니다. 예를 들어 스페이스 URL이 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA이면 스페이스 ID는 AAAAAAAAA입니다.
type
(deprecated)

Type

출력 전용입니다. 지원 중단됨: 대신 space_type를 사용하세요. 스페이스 유형입니다.
space_type

SpaceType

스페이스 유형입니다. 스페이스를 만들거나 스페이스의 스페이스 유형을 업데이트할 때 필요합니다. 다른 용도의 경우에만 출력
single_user_bot_dm

bool

선택사항입니다. 스페이스가 Chat 앱과 한 명의 사용자 간의 DM인지 여부입니다.
threaded
(deprecated)

bool

출력 전용입니다. 지원 중단됨: 대신 spaceThreadingState를 사용하세요. 이 스페이스에서 메시지가 대화목록 형식으로 표시되는지 여부입니다.
display_name

string

스페이스의 표시 이름입니다. spaceType이 SPACE인 스페이스를 만들 때 필요합니다. 스페이스를 만들거나 displayName를 업데이트할 때 ALREADY_EXISTS 오류 메시지가 표시되면 다른 displayName를 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

채팅 메시지의 경우 이 필드가 비어 있을 수 있습니다.

최대 128자(영문 기준)까지 지원됩니다.
external_user_allowed

bool

변경할 수 없습니다. 이 스페이스에서 Google Chat 사용자를 회원으로 허용하는지 여부입니다. Google Workspace 조직에서 스페이스를 만들 때 입력합니다. 다음과 같은 조건에서 스페이스를 만들 때 이 필드를 생략합니다.

  • 인증된 사용자가 일반 계정 (비관리 사용자 계정)을 사용합니다. 기본적으로 일반 계정으로 만든 스페이스는 모든 Google Chat 사용자를 허용합니다.

기존 스페이스의 경우 이 필드는 출력 전용입니다.
space_threading_state

SpaceThreadingState

출력 전용입니다. Chat 스페이스의 대화목록 상태입니다.
space_details

SpaceDetails

설명 및 규칙을 포함한 스페이스 세부정보입니다.
space_history_state

HistoryState

이 스페이스에 있는 메시지 및 대화목록의 메시지 기록 상태입니다.
import_mode

bool

선택사항입니다. 이 스페이스가 Google Workspace로의 데이터 이전의 일환으로 Import Mode에서 생성되었는지 여부입니다. 스페이스가 가져오는 동안 가져오기가 완료될 때까지 사용자에게 표시되지 않습니다.

Import Mode에서 스페이스를 만들려면 사용자 인증이 필요합니다.
create_time

Timestamp

선택사항입니다. 변경할 수 없습니다. Chat에서 만든 스페이스의 경우 스페이스가 생성된 시간입니다. 이 필드는 가져오기 모드 공간에서 사용되는 경우를 제외하고 출력 전용입니다.

가져오기 모드 스페이스의 경우 원래 생성 시간을 보존하기 위해 이 필드를 소스에서 스페이스가 생성된 이전 타임스탬프로 설정합니다.

spaceType가 GROUP_CHAT 또는 SPACE인 경우에만 출력에 채워집니다.
last_active_time

Timestamp

출력 전용입니다. 스페이스의 마지막 메시지의 타임스탬프입니다.

admin_installed

bool

출력 전용입니다. Chat 앱이 있는 채팅 메시지(DM) 스페이스의 경우 Google Workspace 관리자가 스페이스를 만들었는지 여부입니다. 관리자는 조직의 사용자를 대신하여 Chat 앱을 설치하고 채팅 메시지를 설정할 수 있습니다.

관리자 설치를 지원하려면 Chat 앱에 채팅 메시지 기능이 있어야 합니다.
membership_count

MembershipCount

출력 전용입니다. 구성원 유형별로 그룹화된 가입된 멤버십 수입니다. space_type가 SPACE, DIRECT_MESSAGE 또는 GROUP_CHAT일 때 채워집니다.

access_settings

AccessSettings

선택사항입니다. 스페이스의 액세스 설정을 지정합니다. space_type이 SPACE인 경우에만 채워집니다.
space_uri

string

출력 전용입니다. 사용자가 스페이스에 액세스할 수 있는 URI입니다.
customer

string

선택사항입니다. 변경할 수 없습니다. 스페이스의 도메인 고객 ID입니다. 앱 인증을 사용하여 스페이스를 만들 때만 필요하며 SpaceType가 SPACE일 때만 필요합니다. 그렇지 않으면 이 값을 설정해서는 안 됩니다.

customers/{customer} 형식에서 customer는 [Admin SDK 고객 리소스]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers)의 id입니다. 비공개 앱에서도 customers/my_customer 별칭을 사용하여 앱과 동일한 Google Workspace 조직에 스페이스를 만들 수 있습니다.

채팅 메시지의 경우 이 필드가 채워지지 않습니다.

통합 필드 space_permission_settings. 스페이스의 권한 설정을 나타냅니다. space_type이 SPACE인 경우에만 채워집니다.

사용자 인증이 필요합니다. space_permission_settings은 다음 중 하나여야 합니다.
predefined_permission_settings

PredefinedPermissionSettings

선택사항입니다. 입력 전용입니다. 사전 정의된 스페이스 권한 설정으로, 스페이스를 만들 때만 입력할 수 있습니다. 이 필드가 설정되지 않으면 공동작업 공간이 생성됩니다. 스페이스를 만든 후 설정이 PermissionSettings 필드에 채워집니다.
permission_settings

PermissionSettings

선택사항입니다. 기존 스페이스의 스페이스 권한 설정 기존 권한 설정이 대체되는 정확한 스페이스 권한 설정을 업데이트하기 위한 입력입니다. 출력에 현재 권한 설정이 나열됩니다.

AccessSettings

공간의 액세스 설정을 나타냅니다.

필드
access_state

AccessState

출력 전용입니다. 스페이스의 액세스 상태를 나타냅니다.
audience

string

선택사항입니다. 스페이스를 검색하고, 스페이스에 참여하고, 스페이스의 메시지를 미리 볼 수 있는 공유 대상 그룹의 리소스 이름입니다. 이 옵션을 선택 해제하면 스페이스에 개별적으로 초대되거나 추가된 사용자 또는 Google 그룹만 스페이스에 액세스할 수 있습니다. 자세한 내용은 공유 스페이스를 공유 대상 그룹에 표시하기를 참고하세요.

형식: audiences/{audience}

Google Workspace 조직의 기본 공유 대상 그룹을 사용하려면 audiences/default로 설정합니다.

타겟층 읽기 지원:

이 필드는 앱 인증과 함께 chat.bot 범위를 사용할 때 채워지지 않습니다.

공유 대상 그룹을 설정하려면 사용자 인증이 필요합니다.

AccessState

스페이스의 액세스 상태를 나타냅니다.

열거형
ACCESS_STATE_UNSPECIFIED 액세스 상태를 알 수 없거나 이 API에서 지원되지 않습니다.
PRIVATE 다른 사용자 또는 Google Workspace 관리자가 개별적으로 추가하거나 초대한 사용자 또는 Google 그룹스만 스페이스를 검색하고 액세스할 수 있습니다.
DISCOVERABLE

스페이스 관리자가 공유 대상 그룹에 스페이스에 대한 액세스 권한을 부여했습니다. 스페이스에 개별적으로 추가되거나 초대된 사용자 또는 Google 그룹도 스페이스를 검색하고 액세스할 수 있습니다. 자세한 내용은 특정 사용자에게 스페이스를 검색 가능하도록 설정하기를 참고하세요.

검색 가능한 스페이스를 만들려면 사용자 인증이 필요합니다.

MembershipCount

스페이스의 멤버십 수를 카테고리별로 그룹화하여 나타냅니다.

필드
joined_direct_human_user_count

int32

스페이스에 직접 참여한 실제 사용자 수로, 참여한 그룹의 멤버십으로 참여한 사용자는 포함되지 않습니다.
joined_group_count

int32

스페이스에 직접 참여한 모든 그룹 수입니다.

PermissionSetting

스페이스 권한 설정을 나타냅니다.

필드
managers_allowed

bool

스페이스 관리자에게 이 권한이 있는지 여부입니다.
members_allowed

bool

관리자가 아닌 구성원이 이 권한을 가지고 있는지 여부입니다.

PermissionSettings

기존의 이름이 지정된 스페이스를 업데이트할 때 지정할 수 있는 권한 설정입니다.

스페이스를 만들 때 권한 설정을 설정하려면 요청에 PredefinedPermissionSettings 필드를 지정합니다.

필드
manage_members_and_groups

PermissionSetting

스페이스에서 구성원 및 그룹을 관리하기 위한 설정입니다.
modify_space_details

PermissionSetting

스페이스 이름, 아바타, 설명, 가이드라인을 업데이트하기 위한 설정입니다.
toggle_history

PermissionSetting

스페이스 기록을 사용 또는 사용 중지하도록 설정하는 설정입니다.
use_at_mention_all

PermissionSetting

스페이스에서 @all을 사용하도록 설정합니다.
manage_apps

PermissionSetting

스페이스에서 앱을 관리하기 위한 설정입니다.
manage_webhooks

PermissionSetting

스페이스에서 웹훅을 관리하기 위한 설정입니다.
post_messages

PermissionSetting

출력 전용입니다. 스페이스에서 메시지를 게시하기 위한 설정
reply_messages

PermissionSetting

스페이스에서 메시지에 답장하기 위한 설정입니다.

PredefinedPermissionSettings

이름이 지정된 스페이스를 만들 때만 지정할 수 있는 사전 정의된 권한 설정입니다. 향후 더 많은 설정이 추가될 수 있습니다. 이름이 지정된 스페이스의 권한 설정에 관한 자세한 내용은 스페이스 알아보기를 참고하세요.

열거형
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED 지정되지 않았습니다. 사용하지 마세요.
COLLABORATION_SPACE 스페이스를 모든 구성원이 메시지를 게시할 수 있는 공동작업 스페이스로 설정하는 기능입니다.
ANNOUNCEMENT_SPACE 스페이스를 스페이스 관리자만 메시지를 게시할 수 있는 공지사항 스페이스로 설정합니다.

SpaceDetails

설명 및 규칙을 포함한 스페이스 세부정보입니다.

필드
description

string

선택사항입니다. 스페이스에 대한 설명입니다. 예를 들어 스페이스의 토론 주제, 기능적 목적 또는 참여자를 설명합니다.

최대 150자(영문 기준)를 지원합니다.
guidelines

string

선택사항입니다. 스페이스의 규칙, 기대사항, 에티켓

최대 5,000자(영문 기준)까지 입력할 수 있습니다.

SpaceThreadingState

Chat 스페이스의 대화목록 상태 유형을 지정합니다.

열거형
SPACE_THREADING_STATE_UNSPECIFIED 예약됨
THREADED_MESSAGES 메시지 대화목록을 지원하는 이름이 지정된 스페이스 사용자가 메시지에 응답할 때 대화목록에서 답장하면 원본 메시지의 맥락에서 응답이 유지됩니다.
GROUPED_MESSAGES 대화가 주제별로 정리되는 이름이 지정된 스페이스입니다. 주제 및 주제에 대한 답글은 함께 그룹화됩니다.
UNTHREADED_MESSAGES 두 사람 간의 채팅 메시지(DM) 및 3명 이상의 사용자 간의 그룹 대화

SpaceType

스페이스 유형입니다. 스페이스를 만들거나 업데이트할 때 필요합니다. 다른 용도로만 출력합니다.

열거형
SPACE_TYPE_UNSPECIFIED 예약됨
SPACE 사용자가 메시지를 보내고, 파일을 공유하고, 공동작업을 할 수 있는 공간입니다. SPACE에는 Chat 앱이 포함될 수 있습니다.
GROUP_CHAT 3명 이상의 사용자 간의 그룹 대화 GROUP_CHAT에는 Chat 앱이 포함될 수 있습니다.
DIRECT_MESSAGE 두 사람 또는 사람과 채팅 앱 간의 1:1 메시지

유형

지원 중단됨: 대신 SpaceType를 사용하세요.

열거형
TYPE_UNSPECIFIED 예약됨
ROOM 둘 이상의 사람이 나누는 대화입니다.
DM 사람과 채팅 앱 간의 1:1 채팅 메시지로, 모든 메시지가 평면입니다. 사람 간의 채팅 메시지는 여기에 포함되지 않습니다.

SpaceBatchUpdatedEventData

스페이스의 여러 업데이트에 대한 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.space.v1.batchUpdated

필드
spaces[]

SpaceUpdatedEventData

업데이트된 스페이스 목록입니다.

SpaceEvent

Google Chat 스페이스의 변경사항 또는 활동을 나타내는 이벤트입니다. 자세한 내용은 Google Chat에서 일정 작업하기를 참고하세요.

필드
name

string

스페이스 이벤트의 리소스 이름입니다.

형식: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

이벤트가 발생한 시간입니다.
event_type

string

스페이스 이벤트 유형입니다. 각 이벤트 유형에는 단기간에 발생하는 여러 이벤트 유형의 인스턴스를 나타내는 일괄 버전이 있습니다. spaceEvents.list() 요청의 경우 쿼리 필터에서 일괄 이벤트 유형을 생략합니다. 기본적으로 서버는 이벤트 유형과 배치 버전을 모두 반환합니다.

메시지에 지원되는 이벤트 유형:

  • 새 메시지: google.workspace.chat.message.v1.created
  • 업데이트된 메시지: google.workspace.chat.message.v1.updated
  • 삭제된 메시지: google.workspace.chat.message.v1.deleted
  • 여러 개의 새 메시지: google.workspace.chat.message.v1.batchCreated
  • 업데이트된 여러 메시지: google.workspace.chat.message.v1.batchUpdated
  • 여러 개의 삭제된 메일: google.workspace.chat.message.v1.batchDeleted

멤버십에 지원되는 이벤트 유형:

  • 새 멤버십: google.workspace.chat.membership.v1.created
  • 업데이트된 멤버십: google.workspace.chat.membership.v1.updated
  • 삭제된 멤버십: google.workspace.chat.membership.v1.deleted
  • 여러 신규 멤버십: google.workspace.chat.membership.v1.batchCreated
  • 여러 업데이트된 멤버십: google.workspace.chat.membership.v1.batchUpdated
  • 여러 개의 삭제된 멤버십: google.workspace.chat.membership.v1.batchDeleted

리액션에 지원되는 이벤트 유형:

  • 새 반응: google.workspace.chat.reaction.v1.created
  • 삭제된 반응: google.workspace.chat.reaction.v1.deleted
  • 여러 개의 새로운 반응: google.workspace.chat.reaction.v1.batchCreated
  • 여러 개의 삭제된 반응: google.workspace.chat.reaction.v1.batchDeleted

space에 대해 지원되는 이벤트 유형은 다음과 같습니다.

  • 업데이트된 스페이스: google.workspace.chat.space.v1.updated
  • 여러 스페이스 업데이트: google.workspace.chat.space.v1.batchUpdated

통합 필드 payload.

payload는 다음 중 하나여야 합니다.
message_created_event_data

MessageCreatedEventData

새 메시지의 이벤트 페이로드.

이벤트 유형: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

업데이트된 메시지의 이벤트 페이로드.

이벤트 유형: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

삭제된 메시지의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

여러 새 메시지의 이벤트 페이로드.

이벤트 유형: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

업데이트된 여러 메시지의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

삭제된 여러 메시지에 대한 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

스페이스 업데이트의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

스페이스의 여러 업데이트에 대한 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

새 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

업데이트된 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

삭제된 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

여러 새 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

업데이트된 여러 멤버십의 이벤트 페이로드

이벤트 유형: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

삭제된 여러 멤버십의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

새 반응의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

삭제된 반응의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

여러 새 반응의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

삭제된 여러 반응의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.reaction.v1.batchDeleted

SpaceReadState

스페이스 내 사용자의 읽기 상태로, 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다.

필드
name

string

스페이스 읽기 상태의 리소스 이름입니다.

형식: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

선택사항입니다. 사용자의 스페이스 읽기 상태가 업데이트된 시간입니다. 일반적으로 마지막으로 읽은 메시지의 타임스탬프 또는 스페이스에서 마지막으로 읽은 위치를 표시하기 위해 사용자가 지정한 타임스탬프에 해당합니다.

SpaceUpdatedEventData

업데이트된 스페이스의 이벤트 페이로드입니다.

이벤트 유형: google.workspace.chat.space.v1.updated

필드
space

Space

업데이트된 스페이스

스레드

Google Chat 스페이스의 대화목록 사용 예시는 메시지 대화목록 시작 또는 답장하기를 참고하세요.

메시지를 만들 때 대화목록을 지정하면 messageReplyOption 필드를 설정하여 일치하는 대화목록이 없을 때 어떻게 할지 결정할 수 있습니다.

필드
name

string

대화목록의 리소스 이름입니다.

예: spaces/{space}/threads/{thread}
thread_key

string

선택사항입니다. 대화목록을 만들거나 업데이트하기 위한 입력입니다. 그렇지 않으면 출력만 합니다. 대화목록의 ID입니다. 최대 4,000자(영문 기준)를 지원합니다.

이 ID는 이를 설정하는 Chat 앱에 고유합니다. 예를 들어 여러 Chat 앱에서 동일한 대화목록 키를 사용하여 메시지를 만드는 경우 메시지가 서로 다른 대화목록에 게시됩니다. 사용자 또는 다른 채팅 앱에서 만든 대화목록에서 답장하려면 스레드 name 필드를 대신 지정하세요.

ThreadReadState

대화목록 내 사용자의 읽은 상태로, 읽은 메시지와 읽지 않은 메시지를 식별하는 데 사용됩니다.

필드
name

string

스레드 읽기 상태의 리소스 이름입니다.

형식: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

사용자의 대화목록 읽기 상태가 업데이트된 시간입니다. 일반적으로 대화목록에서 마지막으로 읽은 메시지의 타임스탬프에 해당합니다.

UpdateMembershipRequest

멤버십 업데이트 요청 메시지입니다.

필드
membership

Membership

필수 항목입니다. 업데이트할 멤버십입니다. update_mask로 지정된 필드만 업데이트됩니다.
update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값은 쉼표로 구분하거나 *를 사용하여 모든 필드 경로를 업데이트합니다.

현재 지원되는 필드 경로는 다음과 같습니다.

  • role
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.memberships OAuth 2.0 범위가 필요합니다.

UpdateMessageRequest

메시지 업데이트 요청입니다.

필드
message

Message

필수 항목입니다. 필드가 업데이트된 메시지
update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값을 쉼표로 구분하거나 *를 사용하여 모든 필드 경로를 업데이트합니다.

현재 지원되는 필드 경로는 다음과 같습니다.
allow_missing

bool

선택사항입니다. true 및 메시지를 찾을 수 없는 경우 새 메시지가 생성되고 updateMask는 무시됩니다. 지정된 메시지 ID는 client-assigned되어야 합니다. 그렇지 않으면 요청이 실패합니다.

UpdateSpaceReadStateRequest

UpdateSpaceReadState API의 요청 메시지입니다.

필드
space_read_state

SpaceReadState

필수 항목입니다. 업데이트할 스페이스 읽기 상태 및 필드입니다.

호출 사용자의 읽기 상태 업데이트만 지원합니다.

호출 사용자를 참조하려면 다음 중 하나를 설정합니다.

  • me 별칭입니다. 예를 들면 users/me/spaces/{space}/spaceReadState입니다.

  • Workspace 이메일 주소 예를 들면 users/user@example.com/spaces/{space}/spaceReadState입니다.

  • 사용자 ID입니다. 예를 들면 users/123456789/spaces/{space}/spaceReadState입니다.

형식: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

필수 항목입니다. 업데이트할 필드 경로입니다. 현재 지원되는 필드 경로는 다음과 같습니다.

  • last_read_time

last_read_time가 최근 메시지 작성 시간 이전이면 UI에 스페이스가 읽지 않은 상태로 표시됩니다.

스페이스를 읽은 것으로 표시하려면 last_read_time를 최신 메시지 생성 시간보다 나중에(더 큰) 발생한 값으로 설정합니다. last_read_time는 최근 메시지 생성 시간과 일치하도록 강제 적용됩니다. 스페이스 읽기 상태는 스페이스의 최상위 대화에 표시되는 메시지의 읽기 상태에만 영향을 미칩니다. 대화목록의 답장은 이 타임스탬프의 영향을 받지 않으며 대신 스레드 읽기 상태에 의존합니다.

UpdateSpaceRequest

단일 스페이스 업데이트 요청입니다.

필드
space

Space

필수 항목입니다. 업데이트할 필드가 있는 스페이스입니다. Space.name은 spaces/{space} 형식으로 채워야 합니다. update_mask로 지정된 필드만 업데이트됩니다.
update_mask

FieldMask

필수 항목입니다. 업데이트된 필드 경로로, 여러 경로가 있는 경우 쉼표로 구분됩니다.

스페이스의 다음 필드를 업데이트할 수 있습니다.

space_details: 스페이스 설명을 업데이트합니다. 최대 150자(영문 기준)를 지원합니다.

display_name: spaceType 필드가 SPACE인 스페이스의 표시 이름 업데이트만 지원합니다. ALREADY_EXISTS 오류 메시지가 표시되면 다른 값을 사용해 보세요. Google Workspace 조직 내의 기존 스페이스에서 이미 이 표시 이름을 사용하고 있을 수 있습니다.

space_type: GROUP_CHAT 스페이스 유형을 SPACE로 변경하는 것만 지원합니다. 업데이트 마스크에 space_type와 함께 display_name를 포함하고 지정된 스페이스에 비어 있지 않은 표시 이름과 SPACE 스페이스 유형이 있는지 확인합니다. 표시 이름을 업데이트할 때 지정된 공간에 space_type 마스크와 SPACE 유형을 포함하는 것은 기존 스페이스에 이미 SPACE 유형이 있는 경우 선택사항입니다. 다른 방법으로 스페이스 유형을 업데이트하려고 하면 잘못된 인수 오류가 발생합니다. space_type는 useAdminAccess에서 지원되지 않습니다.

space_history_state: 스페이스의 기록을 사용 설정 또는 중지하여 스페이스 기록 설정을 업데이트합니다. Google Workspace 조직에 기록 설정이 사용 설정된 경우에만 지원됩니다. 스페이스 기록 상태를 업데이트하려면 요청에서 다른 모든 필드 마스크를 생략해야 합니다. space_history_state은 useAdminAccess에서 지원되지 않습니다.

access_settings.audience: 스페이스를 검색하고, 스페이스에 참여하고, spaceType 필드가 SPACE인 이름이 지정된 스페이스의 메시지를 미리 볼 수 있는 사용자의 액세스 설정을 업데이트합니다. 기존 스페이스에 공유 대상 그룹이 있는 경우 이 필드 마스크의 값을 생략하여 공유 대상 그룹을 삭제하고 스페이스 액세스를 제한할 수 있습니다. 스페이스의 액세스 설정을 업데이트하려면 인증하는 사용자가 스페이스 관리자여야 하며 요청에서 다른 모든 필드 마스크를 생략해야 합니다. 스페이스가 가져오기 모드인 경우 이 필드를 업데이트할 수 없습니다. 자세한 내용은 특정 사용자가 검색할 수 있는 스페이스 만들기를 참고하세요. access_settings.audience는 useAdminAccess에서 지원되지 않습니다.

permission_settings: 스페이스의 권한 설정 변경을 지원합니다. 권한 설정을 업데이트할 때는 permissionSettings 필드 마스크만 지정할 수 있으며 다른 필드 마스크는 동시에 업데이트할 수 없습니다. permissionSettings은 useAdminAccess에서 지원되지 않습니다. 지원되는 필드 마스크는 다음과 같습니다.

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.spaces OAuth 2.0 범위가 필요합니다.

일부 FieldMask 값은 관리 액세스 사용 시 지원되지 않습니다. 자세한 내용은 update_mask의 설명을 참고하세요.

사용자

Google Chat의 사용자입니다. 요청의 출력으로 반환될 때 Chat 앱이 사용자로 인증하면 User 리소스의 출력은 사용자의 name 및 type만 채웁니다.

필드
name

string

Google Chat user의 리소스 이름입니다.

형식: users/{user} users/app은 호출 앱 bot 사용자의 별칭으로 사용할 수 있습니다.

human users의 경우 {user}는 다음과 동일한 사용자 식별자입니다.

  • People API에서 Person의 id입니다. 예를 들어 Chat API의 users/123456789는 People API의 123456789 사용자 프로필 ID와 동일한 사용자를 나타냅니다.

  • Admin SDK Directory API의 사용자에 대한 id입니다.

  • 사용자의 이메일 주소는 API 요청에서 {user}의 별칭으로 사용될 수 있습니다. 예를 들어 user@example.com의 People API Person 프로필 ID가 123456789이면 users/user@example.com를 별칭으로 사용하여 users/123456789를 참조할 수 있습니다. 표준 리소스 이름 (예: users/123456789)만 API에서 반환됩니다.
display_name

string

출력 전용입니다. 사용자의 표시 이름
domain_id

string

사용자의 Google Workspace 도메인의 고유 식별자입니다.
type

Type

사용자 유형입니다.
is_anonymous

bool

출력 전용입니다. true인 경우 사용자가 삭제되거나 프로필이 표시되지 않습니다.

유형

열거형
TYPE_UNSPECIFIED enum의 기본값입니다. 사용하지 않습니다.
HUMAN 실제 사용자
BOT Chat 앱 사용자

UserMentionMetadata

사용자 멘션 (@)에 대한 주석 메타데이터입니다.

필드
user

User

사용자가 언급했습니다.
type

Type

사용자 멘션 유형입니다.

유형

열거형
TYPE_UNSPECIFIED enum의 기본값입니다. 사용하지 마세요.
ADD 스페이스에 사용자 추가
MENTION 스페이스에서 사용자 멘션

WidgetMarkup

위젯은 텍스트와 이미지를 표시하는 UI 요소입니다.

필드
buttons[]

Button

버튼 목록입니다. Buttons도 oneof data이며 이 필드 중 하나만 설정해야 합니다.
통합 필드 data. WidgetMarkup에는 다음 항목 중 하나만 포함할 수 있습니다. WidgetMarkup 필드를 여러 개 사용하여 더 많은 항목을 표시할 수 있습니다. data은 다음 중 하나여야 합니다.
text_paragraph

TextParagraph

이 위젯에 텍스트 단락을 표시합니다.
image

Image

이 위젯에 이미지를 표시합니다.
key_value

KeyValue

이 위젯에 키-값 항목을 표시합니다.

버튼

버튼 텍스트 버튼 또는 이미지 버튼일 수 있습니다.

필드

통합 필드 type.

type는 다음 중 하나여야 합니다.
text_button

TextButton

텍스트와 onclick 작업이 있는 버튼
image_button

ImageButton

이미지와 onclick 작업이 있는 버튼

FormAction

양식 작업은 양식이 제출될 때의 동작을 나타냅니다. 예를 들어 Apps Script를 호출하여 양식을 처리할 수 있습니다.

필드
action_method_name

string

메서드 이름은 양식의 어느 부분이 양식 제출을 트리거했는지 식별하는 데 사용됩니다. 이 정보는 카드 클릭 이벤트의 일부로 Chat 앱에 다시 반영됩니다. 공통 동작을 트리거하는 여러 요소에 동일한 메서드 이름을 사용할 수 있습니다.
parameters[]

ActionParameter

작업 매개변수 목록입니다.

ActionParameter

작업 메서드가 호출될 때 제공할 문자열 매개변수의 목록입니다. 예를 들어 '지금 다시 알림', '하루에 다시 알림', '다음 주에 다시 알림' 등 세 가지 일시중지 버튼이 있다고 가정해 보겠습니다. action method = snooze()를 사용하여 문자열 매개변수 목록에 다시 알림 유형과 일시중지 시간을 전달할 수 있습니다.

필드
key

string

작업 스크립트의 매개변수 이름입니다.
value

string

매개변수의 값입니다.

아이콘

지원되는 아이콘 집합입니다.

열거형
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

string

이미지의 URL입니다.
on_click

OnClick

onclick 작업
aspect_ratio

double

이미지의 가로세로 비율 (너비 및 높이)입니다. 이 입력란을 사용하면 이미지가 로드되는 동안 이미지의 높이를 적절하게 예약할 수 있습니다. 이미지의 기본 가로세로 비율을 재정의하는 것은 아닙니다. 설정하지 않으면 서버에서 이미지를 미리 가져와 이미지를 채웁니다.

ImageButton

onclick 작업이 있는 이미지 버튼

필드
on_click

OnClick

onclick 작업
name

string

접근성에 사용되는 이 image_button의 이름입니다. 이 이름이 지정되지 않은 경우 기본값이 제공됩니다.
통합 필드 icons. 아이콘은 Icon enum 또는 URL로 지정할 수 있습니다. icons은 다음 중 하나여야 합니다.
icon

Icon

Chat API에서 제공하는 아이콘의 색인을 생성하는 enum로 지정된 아이콘입니다.
icon_url

string

URL로 지정된 아이콘입니다.

KeyValue

UI 요소에는 키 (라벨)와 값 (콘텐츠)이 있습니다. 이 요소는 onclick 버튼과 같은 일부 작업도 포함할 수 있습니다.

필드
top_label

string

상단 라벨의 텍스트입니다. 서식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.
content

string

콘텐츠의 텍스트입니다. 서식 있는 텍스트가 지원되며 항상 필수사항입니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.
content_multiline

bool

콘텐츠가 여러 줄이어야 하는 경우
bottom_label

string

하단 라벨의 텍스트입니다. 서식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요.
on_click

OnClick

onclick 작업 상단 라벨, 하단 라벨, 콘텐츠 영역만 클릭할 수 있습니다.
통합 필드 icons. 아이콘 top_label 및 bottom_label 중 하나 이상을 정의해야 합니다. icons은 다음 중 하나여야 합니다.
icon

Icon

Chat API에 의해 상응하는 아이콘 이미지로 대체되는 열거형 값입니다.
icon_url

string

URL로 지정된 아이콘입니다.
통합 필드 control. 제어 위젯 button 또는 switch_widget 중 하나를 설정할 수 있지만 둘 다 설정할 수는 없습니다. control은 다음 중 하나여야 합니다.
button

Button

클릭하여 작업을 트리거할 수 있는 버튼입니다.

OnClick

onclick 작업(예: 링크 열기)

필드

통합 필드 data.

data는 다음 중 하나여야 합니다.
action

FormAction

지정된 경우 이 onclick 작업에 의해 양식 작업이 트리거됩니다.

TextButton

텍스트와 onclick 작업이 있는 버튼

필드
text

string

버튼의 텍스트입니다.
on_click

OnClick

버튼의 onclick 작업

TextParagraph

텍스트 단락 서식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.

필드
text

string