This guide explains how to use the
get()
method on the Attachment
resource of the
Google Chat API to get metadata about a message attachment. The response is an
instance of the
Attachment
resource.
When the user sends a message to your app, Google Chat dispatches a
MESSAGE
interaction event.
The interaction event received by your app includes a request body, which is the
JSON payload representing the interaction event, including any attachments. The
data in the attachment is different depending on whether the attachment is
uploaded content (a local file) or is a file stored on Drive. The
Media
resource
represents a file uploaded to Google Chat, like images, videos, and documents.
The
Attachment
resource
represents an instance of media—a file—attached to a message. The Attachment
resource includes the metadata about the attachment, such as
where it's saved.
Prerequisites
Node.js
- A Business or Enterprise Google Workspace account with access to Google Chat.
- Set up your environment:
- Create a Google Cloud project.
- Configure the OAuth consent screen.
- Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
- Install the Node.js Cloud Client Library.
-
Create service account credentials. To run the sample in this guide, save the
credentials as a JSON file named
credentials.json
to your local directory.
- Choose an authorization scope that supports app authentication.
Get a message attachment
To asynchronously get metadata about a message attachment in Google Chat, pass the following in your request:
- Specify the
chat.bot
authorization scope. - Call the
GetAttachment()
method, passing thename
of the message attachment.
Here's how to get metadata about a message attachment:
Node.js
To run this sample, replace spaces/SPACE_NAME/messages/
MESSAGE_NAME/attachments/ATTACHMENT_NAME
with the
message attachment name.
The Chat API returns an instance of
Attachment
that details the metadata about the specified message attachment.