string

Required if the message contains multiple cards. A unique identifier for a card in a message.

object (Card)

A card. Maximum size is 32 KB.

enum (AnnotationType)

The type of this annotation.

integer

Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.

integer

Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.

object (UserMentionMetadata)

The metadata of user mention.

object (SlashCommandMetadata)

The metadata for a slash command.

object (RichLinkMetadata)

The metadata for a rich link.

object (CustomEmojiMetadata)

The metadata for a custom emoji.

object (User)

The user mentioned.

enum (Type)

The type of user mention.

object (User)

The Chat app whose command was invoked.

enum (Type)

The type of slash command.

string

The name of the invoked slash command.

string (int64 format)

The command ID of the invoked slash command.

boolean

Indicates whether the slash command is for a dialog.

string

The URI of this link.

enum (RichLinkType)

The rich link type.

object (DriveLinkData)

Data for a drive link.

object (ChatSpaceLinkData)

Data for a chat space link.

object (MeetSpaceLinkData)

Data for a Meet space link.

object (CalendarEventLinkData)

Data for a Calendar event link.

object (DriveDataRef)

ADriveDataRef which references a Google Drive file.

string

The mime type of the linked Google Drive resource.

string

The space of the linked Chat space resource.

Format:spaces/{space}

string

The thread of the linked Chat space resource.

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

string

The message of the linked Chat space resource.

Format:spaces/{space}/messages/{message}

string

Meeting code of the linked Meet space.

enum (Type)

Indicates the type of the Meet space.

enum (HuddleStatus)

Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.

string

TheCalendar identifier of the linked Calendar.

string

TheEvent identifier of the linked Calendar event.

object (CustomEmoji)

The custom emoji.

string

Identifier. Resource name of the thread.

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

string

Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters.

This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the threadname field instead.

enum (ResponseType)

Input only. The type of Chat app response.

string

Input only. URL for users to authenticate or configure. (Only forREQUEST_CONFIG response types.)

object (DialogAction)

Input only. A response to an interaction event related to adialog. Must be accompanied byResponseType.Dialog.

object (UpdatedWidget)

Input only. The response of the updated widget.

object (ActionStatus)

Input only. Status for a request to either invoke or submit adialog. Displays a status and message to users, if necessary. For example, in case of an error or success.

object (Dialog)

Input only.Dialog for the request.

object (Card)

Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities:DateTimePicker,OnChangeAction.

enum (Code)

The status code.

string

The message to send users about the status of their request. If unset, a generic message based on thestatusCode is sent.

Not an error; returned on success.

HTTP Mapping: 200 OK

The operation was cancelled, typically by the caller.

HTTP Mapping: 499 Client Closed Request

Unknown error. For example, this error may be returned when aStatus value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error.

HTTP Mapping: 500 Internal Server Error

The client specified an invalid argument. Note that this differs fromFAILED_PRECONDITION.INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).

HTTP Mapping: 400 Bad Request

The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.

HTTP Mapping: 504 Gateway Timeout

Some requested entity (e.g., file or directory) was not found.

Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist,NOT_FOUND may be used. If a request is denied for some users within a class of users, such as user-based access control,PERMISSION_DENIED must be used.

HTTP Mapping: 404 Not Found

The entity that a client attempted to create (e.g., file or directory) already exists.

HTTP Mapping: 409 Conflict

The caller does not have permission to execute the specified operation.PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (useRESOURCE_EXHAUSTED instead for those errors).PERMISSION_DENIED must not be used if the caller can not be identified (useUNAUTHENTICATED instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions.

HTTP Mapping: 403 Forbidden

The request does not have valid authentication credentials for the operation.

HTTP Mapping: 401 Unauthorized

Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.

HTTP Mapping: 429 Too Many Requests

The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc.

Service implementors can use the following guidelines to decide betweenFAILED_PRECONDITION,ABORTED, andUNAVAILABLE: (a) UseUNAVAILABLE if the client can retry just the failing call. (b) UseABORTED if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) UseFAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. For example, if an "rmdir" fails because the directory is non-empty,FAILED_PRECONDITION should be returned since the client should not retry unless the files are deleted from the directory.

HTTP Mapping: 400 Bad Request

The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort.

See the guidelines above for deciding betweenFAILED_PRECONDITION,ABORTED, andUNAVAILABLE.

HTTP Mapping: 409 Conflict

The operation was attempted past the valid range. E.g., seeking or reading past end-of-file.

UnlikeINVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generateINVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generateOUT_OF_RANGE if asked to read from an offset past the current file size.

There is a fair bit of overlap betweenFAILED_PRECONDITION andOUT_OF_RANGE. We recommend usingOUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for anOUT_OF_RANGE error to detect when they are done.

HTTP Mapping: 400 Bad Request

The operation is not implemented or is not supported/enabled in this service.

HTTP Mapping: 501 Not Implemented

Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors.

HTTP Mapping: 500 Internal Server Error

The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.

See the guidelines above for deciding betweenFAILED_PRECONDITION,ABORTED, andUNAVAILABLE.

HTTP Mapping: 503 Service Unavailable

Unrecoverable data loss or corruption.

HTTP Mapping: 500 Internal Server Error

string

The ID of the updated widget. The ID must match the one for the widget that triggered the update request.

object (SelectionItems)

List of widget autocomplete results

object (SelectionItem)

An array of the SelectionItem objects.

string (int64 format)

The ID of the slash command.

string

Output only. The URL that was matched.

object (Emoji)

Output only. Emoji associated with the reactions.

integer

Output only. The total number of reactions using the associated emoji.

enum (DeletionType)

Indicates who deleted the message.

string

Required. Resource name of the message that is quoted.

Format:spaces/{space}/messages/{message}

string (Timestamp format)

Required. The timestamp when the quoted message was created or when the quoted message was last updated.

If the message was edited, use this field,lastUpdateTime. If the message was never edited, usecreateTime.

IflastUpdateTime doesn't match the latest version of the quoted message, the request fails.

string

Output only. The URL that hosts the GIF image.

object (ButtonList)

A list of buttons.