Package google.chat.v1

ButtonList

버튼 목록입니다.

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

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

SelectionItem

SelectionItem 객체의 배열입니다.

string

업데이트된 위젯의 ID입니다. ID는 업데이트 요청을 트리거한 위젯의 ID와 일치해야 합니다.

SelectionItems

위젯 자동 완성 결과 목록

Code

상태 코드입니다.

string

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

AnnotationType

이 주석의 유형입니다.

int32

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

int32

이 주석에 해당하는 일반 텍스트 메시지 본문의 시작 색인 (0부터 시작)입니다.

UserMentionMetadata

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

SlashCommandMetadata

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

RichLinkMetadata

리치 링크의 메타데이터입니다.

string

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

string

선택사항입니다. spaces/{space}/messages/{message}/attachments/{attachment} 형식의 첨부파일 리소스 이름입니다.

string

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

string

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

string

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

string

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

Source

출력 전용입니다. 첨부파일의 소스입니다.

AttachmentDataRef

선택사항입니다. 첨부파일 데이터에 대한 참조입니다. 이 필드는 첨부파일이 있는 메시지를 생성 또는 업데이트하거나 미디어 API를 사용하여 첨부파일 데이터를 다운로드하는 데 사용됩니다.

DriveDataRef

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

string

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

string

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

string

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

Card

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

string

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

형식: spaces/{space}

string

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

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

string

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

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

string

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

형식: spaces/{space}

Space

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

CardHeader

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

Section

섹션은 선 구분자로 구분됩니다.

CardAction

이 카드의 작업입니다.

string

카드 이름입니다.

string

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

OnClick

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

string

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

string

카드 헤더의 부제입니다.

ImageStyle

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

string

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

string

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

WidgetMarkup

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

CustomEmoji

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

string

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

형식: spaces/{space}

Membership

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

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

Chat 앱이 사람 사용자의 멤버십 관계를 만들 때는 특정 승인 범위를 사용하고 특정 필드에 특정 값을 설정해야 합니다.

• 사용자로 인증할 때는 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 사용자 프로필 ID가 123456789인 경우 membership.member.name를 users/user@example.com 또는 users/123456789로 설정하여 사용자를 스페이스에 추가할 수 있습니다.

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

bool

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

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

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

관리 액세스를 사용하여 관리자의 Google Workspace 조직 외부의 사용자를 위한 앱 멤버십을 만들거나 멤버십을 만들 수는 없습니다.

string

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

형식: spaces/{space}

Message

필수 항목입니다. 메시지 본문입니다.

string

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

string

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

MessageReplyOption

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

사용자 상호작용에 응답할 때 이 필드는 무시됩니다. 대화목록 내 상호작용의 경우 답글이 동일한 대화목록에 생성됩니다. 그렇지 않으면 답장이 새 대화목록으로 생성됩니다.

string

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

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

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

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

string

필수 항목입니다. 리액션이 생성된 메시지입니다.

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

Reaction

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

Space

필수 항목입니다. displayName 및 spaceType 필드를 채워야 합니다. SpaceType.SPACE 및 SpaceType.GROUP_CHAT만 지원됩니다. SpaceType.GROUP_CHAT는 importMode이 true로 설정된 경우에만 사용할 수 있습니다.

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

name 스페이스는 서버에 할당되므로 이 필드에 지정된 모든 내용은 무시됩니다.

string

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

string

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

형식: customEmojis/{customEmoji}

string

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

string

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

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

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

예: :valid-emoji-name:

string

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

CustomEmojiPayload

선택사항입니다. 입력 전용입니다. 페이로드 데이터 맞춤 그림 이모티콘을 만들 때 필요합니다.

bytes

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

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

string

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

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

string

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

형식: customEmojis/{customEmoji}

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

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

bool

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

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

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

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

string

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

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

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

bool

선택사항입니다. true인 경우 메시지를 삭제하면 대화목록 답글도 삭제됩니다. false인 경우 메시지에 대화목록 답장이 있으면 삭제가 실패합니다.

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

string

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

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

string

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

형식: spaces/{space}

bool

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

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

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

DeletionType

메시지를 삭제한 사용자를 나타냅니다.

Card

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

ActionStatus

입력 전용입니다. 대화상자를 호출하거나 제출하기 위한 요청의 상태입니다. 필요한 경우 사용자에게 상태와 메시지를 표시합니다. 예를 들어 오류 또는 성공의 경우

Dialog

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

string

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

DriveDataRef

Google Drive 파일을 참조하는 DriveDataRef입니다.

string

연결된 Google Drive 리소스의 mime 유형입니다.

string

선택사항입니다. 유니코드 문자열로 표현되는 기본 이모티콘입니다.

CustomEmoji

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

Emoji

출력 전용입니다. 반응과 연결된 그림 이모티콘입니다.

int32

출력 전용입니다. 연결된 그림 이모티콘을 사용한 총 리액션 수입니다.

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 사용자의 이메일인 경우입니다.

string

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

string

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

형식: customEmojis/{customEmoji}

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

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 사용자의 이메일인 경우입니다.

bool

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

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

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

관리 액세스를 사용하는 경우 스페이스에서 앱 멤버십을 가져오는 기능은 지원되지 않습니다.

string

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

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

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

string

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

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

string

필수 항목입니다. 형식: users/{user}/spaces/{space}/spaceNotificationSetting

• users/me/spaces/{space}/spaceNotificationSetting 또는
• users/user@example.com/spaces/{space}/spaceNotificationSetting 또는
• users/123456789/spaces/{space}/spaceNotificationSetting. 참고: 호출자의 사용자 ID 또는 이메일만 경로에 허용됩니다.

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

string

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

형식: spaces/{space}

bool

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

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

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

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

string

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

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

형식: groups/{group}

int32

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

string

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

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

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

string

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

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

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

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

creator("users/me")

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

CustomEmoji

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

string

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

string

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

형식: spaces/{space}

int32

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

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

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

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

string

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

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

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 오류와 함께 거부됩니다.

bool

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

bool

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

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

bool

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

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

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

관리 액세스를 사용하는 경우 스페이스에 앱 멤버십을 표시할 수 없습니다.

Membership

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

string

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

string

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

형식: spaces/{space}

int32

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

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

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

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

string

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

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

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 오류와 함께 거부됩니다.

string

선택사항입니다. 메시지 목록의 순서 정렬 작업을 기준으로 정렬할 값을 지정합니다. 유효한 순서 지정 작업 값은 다음과 같습니다.

• 오름차순의 경우 ASC

• 내림차순의 경우 DESC

기본 순서는 create_time ASC입니다.

bool

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

Message

메시지 목록

string

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

string

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

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

int32

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

string

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

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

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

string

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

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

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

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

쿼리에서 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 오류와 함께 거부됩니다.

Reaction

요청된 페이지(또는 첫 번째 페이지)의 리액션 목록입니다.

string

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

string

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

형식: spaces/{space}

int32

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

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

string

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

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

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 오류와 함께 서버에서 거부됩니다.

SpaceEvent

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

string

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

int32

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

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

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

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

string

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

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

string

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

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

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

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

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

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

Space

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

string

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

string

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

string

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

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

MembershipState

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

MembershipRole

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

이 필드는 UpdateMembership에서 입력으로만 사용할 수 있습니다.

Timestamp

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

Timestamp

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

User

선택사항입니다. 멤버십이 해당하는 Google Chat 사용자 또는 앱입니다. Chat 앱이 사용자로 인증되면 출력에 사용자 name 및 type가 채워집니다.

Group

선택사항입니다. 멤버십이 해당하는 Google 그룹입니다.

Google 그룹스의 멤버십을 읽거나 변경하려면 사용자 인증이 필요합니다.

MembershipCreatedEventData

새 멤버십 목록입니다.

MembershipDeletedEventData

삭제된 멤버십 목록입니다.

MembershipUpdatedEventData

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

Membership

새 멤버십입니다.

Membership

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

Membership

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

string

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

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

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

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

User

출력 전용입니다. 메시지를 작성한 사용자입니다. Chat 앱이 사용자로 인증되면 출력에 사용자 name 및 type가 채워집니다.

Timestamp

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

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

Timestamp

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

Timestamp

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

string

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

문자 메시지 작성에 관한 자세한 내용은 메시지 보내기를 참고하세요.

string

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

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

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

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

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

자세한 내용은 메시지로 전송된 텍스트 형식 보기를 참고하세요.

Card

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

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

CardWithId

선택사항입니다. 카드의 배열입니다.

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

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

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

Annotation

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

Thread

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

Space

출력 전용입니다. Chat 앱이 사용자로 인증되면 출력은 스페이스 name만 채웁니다.

string

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

ActionResponse

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

string

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

SlashCommand

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

Attachment

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

MatchedUrl

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

bool

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

스페이스에서 대화목록 내 답장을 지원하지 않는 경우 이 입력란은 항상 false입니다.

string

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

EmojiReactionSummary

출력 전용입니다. 메시지의 이모티콘 반응 요약 목록입니다.

User

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

• 첨부파일
• 액세서리 위젯

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

DeletionMetadata

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

QuotedMessageMetadata

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

AttachedGif

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

AccessoryWidget

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

액세서리 위젯으로 메시지를 만들려면 앱 인증이 필요합니다.

MessageCreatedEventData

새 메시지 목록

MessageDeletedEventData

삭제된 메시지 목록

MessageUpdatedEventData

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

Message

새 메시지

Message

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

Message

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

string

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

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

Timestamp

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

string

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

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

User

출력 전용입니다. 리액션을 만든 사용자입니다.

Emoji

필수 항목입니다. 반응에 사용된 그림 이모티콘입니다.

ReactionCreatedEventData

새로운 리액션 목록입니다.

ReactionDeletedEventData

삭제된 반응 목록입니다.

Reaction

새 반응

Reaction

삭제된 반응입니다.

string

이 링크의 URI입니다.

RichLinkType

리치 링크 유형입니다.

DriveLinkData

Drive 링크의 데이터입니다.

ChatSpaceLinkData

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

bool

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

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

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

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

int32

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

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

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

string

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

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

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")

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

Space

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

string

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

int32

모든 페이지에서 쿼리와 일치하는 스페이스의 총 개수입니다. 결과가 10,000개가 넘는 공백인 경우 이 값은 추정치입니다.

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를 설정하지 마세요.

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

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

string

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

Membership

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

현재 이 세트는 호출자 외에도 최대 20개의 멤버십을 허용합니다.

사용자 멤버십의 경우 Membership.member 필드에 name가 채워진 user(형식: users/{user})가 포함되어야 하며 type은 User.Type.HUMAN로 설정되어야 합니다. 스페이스를 설정할 때만 사람 사용자를 추가할 수 있습니다. 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로 설정할 때 선택사항입니다.

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

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

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

int64

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

User

명령어가 호출된 채팅 앱

Type

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

string

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

int64

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

bool

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

string

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

형식: spaces/{space}

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

Type

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

SpaceType

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

bool

선택사항입니다. 스페이스가 Chat 앱과 한 사람 간의 DM인지 여부입니다.

bool

출력 전용입니다. 지원 중단됨: 대신 spaceThreadingState를 사용하세요. 이 스페이스의 메시지 대화목록 표시 여부입니다.

string

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

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

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

bool

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

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

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

SpaceThreadingState

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

SpaceDetails

선택사항입니다. 설명 및 규칙을 포함한 스페이스에 관한 세부정보입니다.

HistoryState

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

bool

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

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

Timestamp

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

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

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

Timestamp

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

bool

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

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

MembershipCount

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

AccessSettings

선택사항입니다. 스페이스의 액세스 설정을 지정합니다. space_type가 SPACE일 때만 채워집니다.

string

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

string

선택사항입니다. 변경할 수 없습니다. 스페이스의 도메인에 대한 고객 ID입니다. 앱 인증으로 스페이스를 만들고 SpaceType이 SPACE인 경우에만 필요하며, 그 외의 경우에는 설정하면 안 됩니다.

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

DM의 경우 이 필드가 채워지지 않습니다.

PredefinedPermissionSettings

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

PermissionSettings

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

AccessState

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

string

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

형식: audiences/{audience}

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

타겟층 읽기 지원:

• 사용자 인증

• chat.app.spaces 범위가 포함된 관리자 승인이 포함된 앱 인증

앱 인증과 함께 chat.bot 범위를 사용하는 경우 이 필드에는 값이 채워지지 않습니다.

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

int32

출력 전용입니다. 스페이스에 직접 참여한 사람 수입니다. 참여 그룹의 멤버십을 통해 참여한 사용자는 포함되지 않습니다.

int32

출력 전용입니다. 스페이스에 직접 참여한 모든 그룹의 수입니다.

bool

선택사항입니다. 스페이스 관리자에게 이 권한이 있는지 여부입니다.

bool

선택사항입니다. 관리자가 아닌 구성원에게 이 권한이 있는지 여부입니다.

PermissionSetting

선택사항입니다. 스페이스에서 멤버 및 그룹을 관리하기 위한 설정

PermissionSetting

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

PermissionSetting

선택사항입니다. 스페이스 기록을 사용 설정 또는 사용 중지하는 설정입니다.

PermissionSetting

선택사항입니다. 스페이스에서 @all을 사용할 수 있는 설정입니다.

PermissionSetting

선택사항입니다. 스페이스에서 앱을 관리하기 위한 설정

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

string

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

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

string

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

최대 5,000자(영문 기준)까지 지원합니다.

SpaceUpdatedEventData

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

string

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

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

Timestamp

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

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

스페이스에 관한 지원되는 이벤트 유형은 다음과 같습니다.

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

MessageCreatedEventData

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

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

MessageUpdatedEventData

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

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

MessageDeletedEventData

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

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

MessageBatchCreatedEventData

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

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

MessageBatchUpdatedEventData

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

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

MessageBatchDeletedEventData

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

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

SpaceUpdatedEventData

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

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

SpaceBatchUpdatedEventData

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

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

MembershipCreatedEventData

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

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

MembershipUpdatedEventData

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

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

MembershipDeletedEventData

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

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

MembershipBatchCreatedEventData

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

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

MembershipBatchUpdatedEventData

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

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

MembershipBatchDeletedEventData

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

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

ReactionCreatedEventData

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

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

ReactionDeletedEventData

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

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

ReactionBatchCreatedEventData

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

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

ReactionBatchDeletedEventData

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

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

string

식별자. 스페이스 알림 설정의 리소스 이름입니다. 형식: users/{user}/spaces/{space}/spaceNotificationSetting

NotificationSetting

알림 설정입니다.

MuteSetting

스페이스 알림 음소거 설정입니다.

string

스페이스 읽기 상태의 리소스 이름입니다.

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

Timestamp

선택사항입니다. 사용자의 스페이스 읽기 상태가 업데이트된 시간입니다. 일반적으로 이는 마지막으로 읽은 메시지의 타임스탬프 또는 사용자가 스페이스에서 마지막으로 읽은 위치를 표시하기 위해 지정한 타임스탬프와 일치합니다.

Space

업데이트된 스페이스

string

식별자. 대화목록의 리소스 이름입니다.

예: spaces/{space}/threads/{thread}

string

선택사항입니다. 대화목록을 만들거나 업데이트하기 위한 입력입니다. 그렇지 않으면 출력만 합니다. 대화목록의 ID입니다. 최대 4,000자(영문 기준)를 지원합니다.

이 ID는 이 ID를 설정하는 채팅 앱마다 고유합니다. 예를 들어 여러 Chat 앱에서 동일한 대화목록 키를 사용하여 메시지를 만드는 경우 메시지가 서로 다른 대화목록에 게시됩니다. 사용자 또는 다른 채팅 앱에서 만든 대화목록에서 답장하려면 스레드 name 필드를 대신 지정하세요.

string

스레드 읽기 상태의 리소스 이름입니다.

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

Timestamp

사용자의 스레드 읽기 상태가 업데이트된 시간입니다. 일반적으로 이 값은 대화목록에서 마지막으로 읽은 메시지의 타임스탬프와 일치합니다.

Membership

필수 항목입니다. 업데이트할 멤버십입니다. update_mask로 지정된 필드만 업데이트됩니다.

FieldMask

필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값을 쉼표로 구분하거나 *를 사용하여 모든 필드 경로를 업데이트합니다.

현재 지원되는 필드 경로는 다음과 같습니다.

• role

bool

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

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

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

Message

필수 항목입니다. 필드가 포함된 메시지가 업데이트되었습니다.

FieldMask

필수 항목입니다. 업데이트할 필드 경로입니다. 여러 값은 쉼표로 구분하거나 *를 사용하여 모든 필드 경로를 업데이트합니다.

현재 지원되는 필드 경로는 다음과 같습니다.

• text

• attachment

• cards(앱 인증 필요)

• cards_v2(앱 인증 필요)

• accessory_widgets (앱 인증 필요)

bool

선택사항입니다. true 및 메시지를 찾을 수 없는 경우 새 메시지가 생성되고 updateMask는 무시됩니다. 지정된 메시지 ID는 클라이언트가 할당한 것이어야 합니다. 그러지 않으면 요청이 실패합니다.

SpaceNotificationSetting

필수 항목입니다. 스페이스 알림 설정의 리소스 이름은 users/{user}/spaces/{space}/spaceNotificationSetting 형식으로 채워야 합니다. update_mask로 지정된 필드만 업데이트됩니다.

FieldMask

필수 항목입니다. 지원되는 필드 경로: - notification_setting - mute_setting

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

FieldMask

필수 항목입니다. 업데이트할 필드 경로입니다. 현재 지원되는 필드 경로는 다음과 같습니다.

• last_read_time

last_read_time가 최신 메시지 생성 시간보다 이전이면 스페이스가 UI에 읽지 않은 상태로 표시됩니다.

스페이스를 읽은 것으로 표시하려면 last_read_time를 최신 메시지 생성 시간보다 나중에(더 큰) 발생한 값으로 설정합니다. last_read_time는 최신 메시지 생성 시간과 일치하도록 강제됩니다. 스페이스 읽기 상태는 스페이스의 최상위 대화에 표시되는 메시지의 읽기 상태에만 영향을 미칩니다. 대화목록의 답장은 이 타임스탬프의 영향을 받지 않으며 대신 대화목록 읽기 상태를 사용합니다.

Space

필수 항목입니다. 업데이트할 필드가 있는 스페이스입니다. Space.name은 spaces/{space} 형식으로 채워야 합니다. 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 유형이 있는 경우 표시 이름을 업데이트할 때 지정된 스페이스에 space_type 마스크와 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

bool

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

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

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

일부 FieldMask 값은 관리자 액세스를 사용하여 지원되지 않습니다. 자세한 내용은 update_mask 설명을 참고하세요.

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 사용자 프로필 ID가 123456789인 경우 users/user@example.com를 별칭으로 사용하여 users/123456789를 참조할 수 있습니다. 표준 리소스 이름 (예: users/123456789)만 API에서 반환됩니다.

string

출력 전용입니다. 사용자의 표시 이름입니다.

string

사용자의 Google Workspace 도메인의 고유 식별자입니다.

Type

사용자 유형

bool

출력 전용입니다. true인 경우 사용자가 삭제되거나 프로필이 표시되지 않습니다.

User

언급된 사용자입니다.

Type

사용자 멘션 유형입니다.

Button

버튼 목록입니다. Buttons도 oneof data이며 이 필드 중 하나만 설정해야 합니다.

TextParagraph

이 위젯에 텍스트 단락을 표시합니다.

Image

이 위젯에 이미지를 표시합니다.

KeyValue

이 위젯에 키-값 항목을 표시합니다.

TextButton

텍스트와 onclick 작업이 있는 버튼

ImageButton

이미지와 onclick 작업이 있는 버튼

string

메서드 이름은 양식의 어떤 부분에서 양식 제출이 트리거되었는지 식별하는 데 사용됩니다. 이 정보는 카드 클릭 이벤트의 일부로 Chat 앱에 다시 반영됩니다. 공통 동작을 트리거하는 여러 요소에 동일한 메서드 이름을 사용할 수 있습니다.

ActionParameter

작업 매개변수 목록입니다.

string

작업 스크립트의 매개변수 이름입니다.

string

매개변수의 값입니다.

string

이미지의 URL입니다.

OnClick

onclick 작업

double

이 이미지의 가로세로 비율(너비 및 높이)입니다. 이 필드를 사용하면 이미지가 로드될 때까지 기다리는 동안 이미지의 올바른 높이를 예약할 수 있습니다. 이미지의 내장 가로세로 비율을 재정의하기 위한 것이 아닙니다. 설정하지 않으면 서버가 이미지를 미리 로드하여 채웁니다.

OnClick

onclick 작업

string

접근성에 사용되는 이 image_button의 이름입니다. 이름이 지정되지 않으면 기본값이 제공됩니다.

Icon