REST Resource: spaces.messages

리소스: 메시지

Google Chat 스페이스의 메시지

JSON 표현
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": 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)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
필드
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

object (User)

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

createTime

string (Timestamp format)

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

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

lastUpdateTime

string (Timestamp format)

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

deleteTime

string (Timestamp format)

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

text

string

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

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

formattedText

string

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

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

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

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

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

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

cards[]
(deprecated)

object (Card)

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

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

cardsV2[]

object (CardWithId)

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

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

카드가 포함된 메시지를 만드는 방법을 알아보려면 메시지 보내기를 참고하세요.

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

카드 빌더 열기

annotations[]

object (Annotation)

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

thread

object (Thread)

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

space

object (Space)

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

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

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

emojiReactionSummaries[]

object (EmojiReactionSummary)

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

privateMessageViewer

object (User)

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

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

deletionMetadata

object (DeletionMetadata)

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

quotedMessageMetadata

object (QuotedMessageMetadata)

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

attachedGifs[]

object (AttachedGif)

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

accessoryWidgets[]

object (AccessoryWidget)

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

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

CardWithId

Google Chat 메시지의 카드.

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

카드 빌더로 카드를 디자인하고 미리 봅니다.

카드 빌더 열기

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

string

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

card

object (Card)

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

Annotation

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

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

Hello @FooBot how are you!"

해당 주석 메타데이터:

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

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

enum (AnnotationType)

이 주석의 유형입니다.

length

integer

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

startIndex

integer

이 주석이 해당하는 일반 텍스트 메시지 본문의 시작 인덱스(0부터 시작, 양 끝값 포함)입니다.

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

object (UserMentionMetadata)

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

slashCommand

object (SlashCommandMetadata)

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

AnnotationType

주석의 유형입니다.

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

UserMentionMetadata

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

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

object (User)

사용자가 언급했습니다.

type

enum (Type)

사용자 멘션 유형입니다.

유형

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

SlashCommandMetadata

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

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

object (User)

명령어가 호출된 채팅 앱

type

enum (Type)

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

commandName

string

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

commandId

string (int64 format)

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

triggersDialog

boolean

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

유형

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

RichLinkMetadata

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

JSON 표현
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  }
  // End of list of possible types for union field data.
}
필드
uri

string

이 링크의 URI입니다.

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

RichLinkType

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

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

DriveLinkData

Google Drive 링크의 데이터입니다.

JSON 표현
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
필드
driveDataRef

object (DriveDataRef)

Google Drive 파일을 참조하는 DriveDataRef.

mimeType

string

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

ChatSpaceLinkData

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

JSON 표현
{
  "space": string,
  "thread": string,
  "message": string
}
필드
space

string

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

형식: spaces/{space}

thread

string

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

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

message

string

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

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

스레드

Google Chat 스페이스의 대화목록 사용 예는 메시지 대화목록 시작 또는 답장을 참고하세요.

메일을 만들 때 대화목록을 지정하면 messageReplyOption 필드를 설정하여 일치하는 대화목록을 찾을 수 없는 경우 어떻게 할지 결정할 수 있습니다.

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

string

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

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

threadKey

string

선택사항입니다. 스레드 생성 또는 업데이트를 위한 입력입니다. 그렇지 않으면 출력만 합니다. 스레드의 ID입니다. 최대 4,000자(영문 기준)를 지원합니다.

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

ActionResponse

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

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

enum (ResponseType)

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

url

string

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

dialogAction

object (DialogAction)

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

updatedWidget

object (UpdatedWidget)

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

ResponseType

Chat 앱 응답 유형입니다.

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

DialogAction

대화상자 및 요청 상태 코드가 포함됩니다.

JSON 표현
{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
필드
actionStatus

object (ActionStatus)

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

통합 필드 action. 수행할 작업입니다. action은 다음 중 하나여야 합니다.
dialog

object (Dialog)

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

Dialog

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

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

object (Card)

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

ActionStatus

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

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 내부 서버 오류

UpdatedWidget

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

JSON 표현
{
  "widget": string,

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
필드
widget

string

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

통합 필드 updated_widget. 사용자 작업에 대한 응답으로 위젯이 업데이트됩니다. updated_widget은 다음 중 하나여야 합니다.
suggestions

object (SelectionItems)

위젯 자동 완성 결과 목록

SelectionItems

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

JSON 표현
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
필드
items[]

object (SelectionItem)

SelectionItem 객체의 배열입니다.

SlashCommand

Google Chat의 슬래시 명령어

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

string (int64 format)

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

MatchedUrl

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

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

string

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

EmojiReactionSummary

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

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

object (Emoji)

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

reactionCount

integer

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

DeletionMetadata

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

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

enum (DeletionType)

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

DeletionType

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

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

QuotedMessageMetadata

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

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

string

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

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

lastUpdateTime

string (Timestamp format)

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

AttachedGif

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

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

string

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

AccessoryWidget

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

JSON 표현
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
필드
통합 필드 action. 작업 유형입니다. action은 다음 중 하나여야 합니다.
buttonList

object (ButtonList)

버튼 목록입니다.

메서드

create

Google Chat 스페이스에 메시지를 만듭니다.

delete

메시지를 삭제합니다.

get

메시지에 관한 세부정보를 반환합니다.

list

발신자가 참여 중인 스페이스의 메시지(차단된 회원 및 스페이스의 메시지 포함)를 표시합니다.

patch

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

update

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