REST Resource: spaces.messages

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

리소스: Message

Google Chat 메시지

JSON 표현
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  }
}
필드
name

string

spaces/*/messages/* 형식의 리소스 이름입니다.

예: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

sender

object (User)

출력 전용. 메시지를 생성한 사용자입니다.

createTime

string (Timestamp format)

출력 전용. Google Chat 서버에서 메시지가 생성된 시간입니다.

lastUpdateTime

string (Timestamp format)

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

deleteTime

string (Timestamp format)

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

text

string

메일의 일반 텍스트 본문입니다. 이미지, 동영상, 웹페이지 또는 기타 미리보기 가능 항목에 대한 첫 번째 링크는 미리보기 칩을 생성합니다.

cards[]
(deprecated)

object (Card)

지원 중단됨: 대신 cardsV2을 사용하세요.

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

cardsV2[]

object (CardWithId)

다음과 같이 UI 요소와 수정 가능한 위젯을 표시하는 다양한 형식의 상호작용 카드입니다.

  • 서식이 지정된 텍스트
  • 버튼
  • 클릭 가능한 이미지
  • 체크박스
  • 라디오 버튼
  • 입력 위젯

일반적으로 카드는 Chat 메시지의 텍스트 본문 아래에 표시되지만 상황에 따라 대화상자와 같이 다른 위치에 표시될 수도 있습니다.

cardId는 동일한 메시지의 카드에서 사용자 입력 값을 식별하는 고유 식별자입니다.

현재 지원되는 위젯은 다음과 같습니다.

  • TextParagraph
  • DecoratedText
  • Image
  • ButtonList
  • Divider
annotations[]

object (Annotation)

출력 전용. 이 메일의 텍스트와 연결된 주석입니다.

thread

object (Thread)

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

space

object (Space)

메시지가 속한 스페이스 사용자 인증으로 액세스할 때는 스페이스 이름만 채워집니다.

fallbackText

string

실제 카드를 표시할 수 없을 때 사용되는 메시지 카드 (예: 모바일 알림)의 일반 텍스트 설명입니다.

actionResponse

object (ActionResponse)

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

argumentText

string

Chat 앱 언급이 모두 제거된 메시지의 일반 텍스트 본문입니다.

slashCommand

object (SlashCommand)

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

attachment[]

object (Attachment)

사용자가 첨부파일을 업로드했습니다.

matchedUrl

object (MatchedUrl)

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

threadReply

boolean

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

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

clientAssignedMessageId

string

생성 시 할당된 Chat 메시지의 맞춤 이름입니다. client-로 시작해야 하며 최대 63자(영문 기준)의 소문자, 숫자, 하이픈을 포함할 수 있습니다. 이 필드를 지정하여 메시지를 지정된 값으로 가져오거나 업데이트하거나 삭제할 수 있습니다. 사용 예는 생성한 메일 이름 지정을 참고하세요.

emojiReactionSummaries[]

object (EmojiReactionSummary)

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

deletionMetadata

object (DeletionMetadata)

출력 전용. 삭제된 메시지에 관한 정보입니다. deleteTime를 설정하면 메시지가 삭제됩니다.

카드 ID

지정할 Chat 앱 위젯

JSON 표현
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
필드
cardId

string

메시지 cardsV2개에 필요합니다. 이 위젯의 Chat 앱 지정 식별자입니다. 메시지 내에서 범위가 지정됨

card

object (Card)

채팅 앱이 UI 요소와 수정 가능한 위젯을 지정할 수 있게 해주는 카드 proto입니다.

Annotation

메시지의 일반 텍스트 본문과 연결된 주석입니다.

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

Hello @FooBot how are you!"

해당하는 주석 메타데이터:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/107946847022116401880",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
JSON 표현
{
  "type": enum (AnnotationType),
  "startIndex": integer,
  "length": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  }
  // End of list of possible types for union field metadata.
}
필드
type

enum (AnnotationType)

이 주석의 유형입니다.

startIndex

integer

이 주석이 해당하는 일반 텍스트 메시지 본문에서 색인 (0 기반, 포함)을 시작합니다.

length

integer

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

통합 필드 metadata는 주석에 관한 추가 메타데이터입니다. metadata은 다음 중 하나여야 합니다.
userMention

object (UserMentionMetadata)

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

slashCommand

object (SlashCommandMetadata)

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

AnnotationType

주석 유형입니다.

열거형
ANNOTATION_TYPE_UNSPECIFIED Enum의 기본값입니다. 사용하지 마세요.
USER_MENTION 사용자가 멘션되었습니다.
SLASH_COMMAND 슬래시 명령어가 호출됩니다.

User멘션 메타데이터

사용자 멘션 (@)에 대한 주석 메타데이터입니다.

JSON 표현
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
필드
user

object (User)

사용자가 언급했습니다.

type

enum (Type)

사용자 멘션의 유형입니다.

유형

열거형
TYPE_UNSPECIFIED Enum의 기본값입니다. 사용하지 마세요.
ADD 스페이스에 사용자를 추가합니다.
MENTION 스페이스에서 사용자를 멘션합니다.

슬래시 명령어 메타데이터

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

JSON 표현
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
필드
bot

object (User)

명령어가 호출된 Chat 앱

type

enum (Type)

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

commandName

string

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

commandId

string (int64 format)

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

triggersDialog

boolean

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

유형

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

스레드

Google Chat의 대화목록입니다.

JSON 표현
{
  "name": string,
  "threadKey": string
}
필드
name

string

스레드의 리소스 이름입니다.

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

threadKey

string

선택사항. 불투명 대화목록 식별자입니다. 대화목록을 시작하거나 추가하려면 메시지를 만들고 threadKey 또는 thread.name를 지정합니다. 사용 예는 메시지 대화목록 시작 또는 답장하기를 참고하세요.

다른 요청의 경우 출력 전용 필드입니다.

작업 응답

채팅 앱의 응답 게시 방식을 구성하는 데 사용할 수 있는 매개변수입니다.

JSON 표현
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  }
}
필드
type

enum (ResponseType)

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

url

string

입력 전용. 사용자의 인증 또는 구성 URL (REQUEST_CONFIG 응답 유형에만 해당)

dialogAction

object (DialogAction)

입력 전용. 대화상자와 관련된 이벤트에 대한 응답입니다. ResponseType.Dialog을 동반해야 합니다.

응답 유형

Chat 앱 응답 유형입니다.

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

대화상자 작업

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

JSON 표현
{
  "actionStatus": {
    object (ActionStatus)
  },
  "dialog": {
    object (Dialog)
  }
}
필드
actionStatus

object (ActionStatus)

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

dialog

object (Dialog)

입력 전용. 요청에 대한 대화상자

대화상자

대화상자의 카드 본문을 둘러쌉니다.

JSON 표현
{
  "body": {
    object (Card)
  }
}
필드
body

object (Card)

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

작업 상태

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

JSON 표현
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
필드
statusCode

enum (Code)

상태 코드입니다.

userFacingMessage

string

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

코드

gRPC API의 표준 오류 코드입니다.

여러 오류 코드가 적용될 수 있는 경우도 있습니다. 서비스는 적용되는 오류 코드 중 가장 구체적인 코드를 반환해야 합니다. 예를 들어 두 코드가 모두 적용되는 경우 FAILED_PRECONDITION보다는 OUT_OF_RANGE를 사용하세요. 마찬가지로 FAILED_PRECONDITION보다는 NOT_FOUND 또는 ALREADY_EXISTS를 사용해야 합니다.

열거형
OK

오류가 아니며 성공 시 반환됩니다.

HTTP 매핑: 200 OK

CANCELLED

작업이 취소되었습니다. 대개 호출자에 의해 취소됩니다.

HTTP 매핑: 499 클라이언트에서 닫은 요청

UNKNOWN

알 수 없는 오류입니다. 예를 들어 다른 주소 공간에서 수신된 Status 값이 이 주소 공간에서 알려지지 않은 오류 공간에 속하는 경우 이 오류가 반환될 수 있습니다. 오류 정보를 충분히 반환하지 않는 API에서 발생한 오류가 이 오류로 변환될 수도 있습니다.

HTTP 매핑: 500 내부 서버 오류

INVALID_ARGUMENT

클라이언트에서 잘못된 인수를 지정했습니다. 이는 FAILED_PRECONDITION과 다릅니다. INVALID_ARGUMENT는 시스템 상태에 관계없이 문제가 있는 인수를 나타냅니다(예: 잘못된 형식의 파일 이름).

HTTP 매핑: 400 잘못된 요청

DEADLINE_EXCEEDED

작업을 완료하기 전에 기한이 지났습니다. 작업에서 시스템의 상태를 변경하는 경우 작업이 정상적으로 완료되었어도 이 오류가 반환될 수 있습니다. 예를 들어 서버의 성공 응답이 오래 지연되어 기한이 지났을 수 있습니다.

HTTP 매핑: 504 게이트웨이 시간 초과

NOT_FOUND

요청한 일부 항목(예: 파일 또는 디렉터리)을 찾을 수 없습니다.

서버 개발자 참고사항: 단계적 기능 출시, 잠정적 허용 목록 등으로 인해 전체 사용자 클래스에게 요청이 거부된 경우에는 NOT_FOUND를 사용할 수 있습니다. 사용자별 액세스 제어 등으로 인해 사용자 클래스에 속하는 일부 사용자에게 요청이 거부된 경우에는 PERMISSION_DENIED를 사용해야 합니다.

HTTP 매핑: 404 찾을 수 없음

ALREADY_EXISTS

클라이언트에서 만들려고 시도한 항목(예: 파일 또는 디렉토리)이 이미 존재합니다.

HTTP 매핑: 409 충돌

PERMISSION_DENIED

호출자에 지정한 작업을 실행할 권한이 없습니다. 일부 리소스가 소진되었기 때문에 거부된 경우에는 PERMISSION_DENIED가 아닌 RESOURCE_EXHAUSTED를 사용해야 합니다. 호출자를 식별할 수 없는 경우에는 PERMISSION_DENIED가 아닌 UNAUTHENTICATED를 사용해야 합니다. 이 오류 코드는 요청이 유효하다거나, 요청된 항목이 존재한다거나, 다른 전제조건이 충족되었음을 의미하지 않습니다.

HTTP 매핑: 403 금지됨

UNAUTHENTICATED

요청에 작업과 관련된 올바른 사용자 인증 정보가 없습니다.

HTTP 매핑: 401 승인되지 않음

RESOURCE_EXHAUSTED

일부 리소스가 소진되었습니다. 사용자당 할당량이나 전체 파일 시스템의 저장용량이 부족하기 때문일 수 있습니다.

HTTP 매핑: 429 요청한 횟수가 너무 많음

FAILED_PRECONDITION

시스템이 작업 실행에 필요한 상태가 아니기 때문에 작업이 거부되었습니다. 예를 들어 삭제할 디렉터리가 비어 있지 않거나, 디렉터리가 아닌 항목에 rmdir 작업을 적용한 경우입니다.

서비스 구현 시 다음과 같은 가이드라인에 따라 FAILED_PRECONDITION, ABORTED, UNAVAILABLE 중에서 결정할 수 있습니다. (a) 클라이언트에서 실패한 호출만 재시도할 수 있는 경우 UNAVAILABLE을 사용합니다. (b) 클라이언트가 더 높은 수준에서 다시 시도해야 하는 경우 ABORTED를 사용합니다. 예를 들어 클라이언트에서 지정한 테스트 및 설정 실패 시 클라이언트가 읽기-수정-쓰기 시퀀스를 다시 시작해야 함을 나타냅니다. (c) 시스템 상태가 명시적으로 수정될 때까지 클라이언트에서 재시도하지 말아야 하는 경우 FAILED_PRECONDITION을 사용합니다. 예를 들어 디렉터리가 비어 있지 않아서 'rmdir'이 실패한 경우 디렉터리에서 파일이 삭제되지 않는 한 클라이언트는 다시 시도해서는 안 되므로 FAILED_PRECONDITION를 반환해야 합니다.

HTTP 매핑: 400 잘못된 요청

ABORTED

작업이 취소되었습니다. 대개 시퀀서 확인 실패, 트랜잭션 취소 등의 동시 실행 문제가 원인입니다.

FAILED_PRECONDITION, ABORTED, UNAVAILABLE 중에서 결정하는 방법은 위 가이드라인을 참조하세요.

HTTP 매핑: 409 충돌

OUT_OF_RANGE

유효한 범위를 벗어나는 작업을 시도했습니다. 예를 들어 파일 끝을 지나서 탐색하거나 읽으려고 했습니다.

INVALID_ARGUMENT와 달리, 이 오류는 시스템 상태가 변경되면 문제가 해결될 수 있음을 나타냅니다. 예를 들어 32비트 파일 시스템에서 [0,2^32-1] 범위를 벗어나는 오프셋으로 읽으려고 하면 INVALID_ARGUMENT가 발생하지만, 현재 파일 크기를 넘어서는 오프셋으로 읽으려고 하면 OUT_OF_RANGE가 발생합니다.

FAILED_PRECONDITIONOUT_OF_RANGE 간에 다소 겹치는 부분이 있습니다. 공간이 반복되면 호출자가 쉽게 OUT_OF_RANGE 오류를 찾아 완료 여부를 감지할 수 있도록 OUT_OF_RANGE(더 구체적인 오류)을 사용하는 것이 좋습니다.

HTTP 매핑: 400 잘못된 요청

UNIMPLEMENTED

작업이 구현되지 않았거나 이 서비스에서 지원되지 않거나 사용 설정되지 않았습니다.

HTTP 매핑: 501 구현되지 않음

INTERNAL

내부 오류가 발생했습니다. 내부 시스템에서 예상하는 불변 항목에 문제가 있는 경우입니다. 이 오류 코드는 심각한 오류를 위해 예약되어 있습니다.

HTTP 매핑: 500 내부 서버 오류

UNAVAILABLE

현재 서비스를 사용할 수 없습니다. 일시적인 상태일 가능성이 높으며, 잠시 시간을 두고 다시 시도하면 해결될 수 있습니다. 멱등성이 없는 작업을 재시도하는 것이 항상 안전한 것은 아닙니다.

FAILED_PRECONDITION, ABORTED, UNAVAILABLE 중에서 결정하는 방법은 위 가이드라인을 참조하세요.

HTTP 매핑: 503 사용할 수 없는 서비스

DATA_LOSS

복구할 수 없는 데이터 손실이나 손상이 발생했습니다.

HTTP 매핑: 500 내부 서버 오류

슬래시 명령어

Google Chat의 슬래시 명령어

JSON 표현
{
  "commandId": string
}
필드
commandId

string (int64 format)

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

일치하는 URL

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

JSON 표현
{
  "url": string
}
필드
url

string

출력 전용. 일치하는 URL입니다.

그림 이모티콘 반응 요약

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

JSON 표현
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
필드
emoji

object (Emoji)

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

reactionCount

integer

관련 그림 이모티콘을 사용한 총 반응 수입니다.

삭제 메타데이터

삭제된 메시지에 관한 정보입니다. deleteTime를 설정하면 메시지가 삭제됩니다.

JSON 표현
{
  "deletionType": enum (DeletionType)
}
필드
deletionType

enum (DeletionType)

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

삭제 유형

메시지를 삭제한 사용자 및 삭제 방법

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

방법

create

메시지를 만듭니다.

delete

메시지를 삭제합니다.

get

메시지를 반환합니다.

list

차단된 회원과 스페이스의 메시지를 비롯하여 발신자가 참여하고 있는 스페이스에 있는 메시지를 표시합니다.

update

메시지를 업데이트합니다.