REST Resource: spaces.messages.attachments

  • An Attachment resource represents a file attached to a Google Chat message, containing metadata such as file name, content type, and source.

  • Attachment includes URLs for thumbnail preview and user download, but Chat apps should utilize the data_ref field for accessing content.

  • The data_ref field can point to either uploaded content within Chat (AttachmentDataRef) or a Google Drive file (DriveDataRef).

  • AttachmentDataRef is used by Chat apps to create/update messages with attachments or to download attachment data via the media API.

  • Developers can use the get method to retrieve metadata for a specific message attachment.

Resource: Attachment

An attachment in Google Chat.

JSON representation 
{
  "name": string,
  "contentName": string,
  "contentType": string,
  "thumbnailUri": string,
  "downloadUri": string,
  "source": enum (Source),

  // Union field data_ref can be only one of the following:
  "attachmentDataRef": {
    object (AttachmentDataRef)
  },
  "driveDataRef": {
    object (DriveDataRef)
  }
  // End of list of possible types for union field data_ref.
}
Fields
name

string

Optional. Resource name of the attachment, in the form spaces/{space}/messages/{message}/attachments/{attachment}.
contentName

string

Output only. The original file name for the content, not the full path.
contentType

string

Output only. The content type (MIME type) of the file.
thumbnailUri

string

Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.
downloadUri

string

Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content.
source

enum (Source)

Output only. The source of the attachment.
Union field data_ref. The data reference to the attachment. data_ref can be only one of the following:
attachmentDataRef

object (AttachmentDataRef)

Optional. A reference to the attachment data. This field is used to create or update messages with attachments, or with the media API to download the attachment data.
driveDataRef

object (DriveDataRef)

Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.

AttachmentDataRef

A reference to the attachment data.

JSON representation 
{
  "resourceName": string,
  "attachmentUploadToken": string
}
Fields
resourceName

string

Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.
attachmentUploadToken

string

Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments.

Source

The source of the attachment.

Enums
SOURCE_UNSPECIFIED Reserved.
DRIVE_FILE The file is a Google Drive file.
UPLOADED_CONTENT The file is uploaded to Chat.

Methods

get

 Gets the metadata of a message attachment.