Skip to main content

@swamp/gcp/chat

v2026.04.23.1

Google Cloud chat infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudchatcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/chat

users_sections_items.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
getGet a items
ArgumentTypeDescription
identifierstringThe name of the items
syncSync items state from GCP
movemove
ArgumentTypeDescription
targetSection?any
users_sections.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
displayName?stringOptional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`.
name?stringIdentifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`
type?enumRequired. The type of the section.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a sections
getGet a sections
ArgumentTypeDescription
identifierstringThe name of the sections
updateUpdate sections attributes
deleteDelete the sections
ArgumentTypeDescription
identifierstringThe name of the sections
syncSync sections state from GCP
positionposition
ArgumentTypeDescription
relativePosition?any
sortOrder?any
spaces.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accessSettings?objectOutput only. Indicates the access state of the space.
customer?stringOptional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.
displayName?stringOptional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
importMode?booleanOptional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
membershipCount?objectOutput only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.
name?stringIdentifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.
permissionSettings?objectOptional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
predefinedPermissionSettings?enumOptional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
singleUserBotDm?booleanOptional. Whether the space is a DM between a Chat app and a single human.
spaceDetails?objectOptional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.
spaceHistoryState?enumOptional. The message history state for messages and threads in this space.
requestId?stringOptional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.
createCreate a spaces
getGet a spaces
ArgumentTypeDescription
identifierstringThe name of the spaces
updateUpdate spaces attributes
deleteDelete the spaces
ArgumentTypeDescription
identifierstringThe name of the spaces
syncSync spaces state from GCP
complete_importcomplete import
find_direct_messagefind direct message
find_group_chatsfind group chats
searchsearch
setupsetup
ArgumentTypeDescription
memberships?any
requestId?any
space?any
spaces_messages_reactions.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
emoji?objectOptional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
name?stringIdentifier. The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`
user?objectOutput only. The user's display name.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a reactions
getGet a reactions
ArgumentTypeDescription
identifierstringThe name of the reactions
deleteDelete the reactions
ArgumentTypeDescription
identifierstringThe name of the reactions
syncSync reactions state from GCP
spaces_spaceevents.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
getGet a spaceEvents
ArgumentTypeDescription
identifierstringThe name of the spaceEvents
syncSync spaceEvents state from GCP
users_spaces_spacenotificationsetting.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
muteSetting?enumThe space notification mute setting.
name?stringIdentifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.
notificationSetting?enumThe notification setting.
getGet a spaceNotificationSetting
ArgumentTypeDescription
identifierstringThe name of the spaceNotificationSetting
updateUpdate spaceNotificationSetting attributes
syncSync spaceNotificationSetting state from GCP
spaces_messages_attachments.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a attachments
ArgumentTypeDescription
identifierstringThe name of the attachments
syncSync attachments state from GCP
spaces_messages.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
accessoryWidgets?arrayThe alternative text that\'s used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".
actionResponse?objectThe status code.
attachment?arrayOptional. 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.
cardsV2?arrayThe label that displays as the action menu item.
clientAssignedMessageId?stringOptional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
deletionMetadata?objectIndicates who deleted the message.
fallbackText?stringOptional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
matchedUrl?objectOutput only. The URL that was matched.
name?stringIdentifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
privateMessageViewer?objectOutput only. The user's display name.
quotedMessageMetadata?objectOutput only. The resource name of the source space. Format: spaces/{space}
sender?objectOutput only. The user's display name.
slashCommand?objectThe ID of the slash command.
space?objectOutput only. Indicates the access state of the space.
text?stringOptional. Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a message](https://developers.google.com/workspace/chat/create-messages).
thread?objectIdentifier. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`
messageId?stringOptional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).
messageReplyOption?stringOptional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
requestId?stringOptional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a messages
getGet a messages
ArgumentTypeDescription
identifierstringThe name of the messages
updateUpdate messages attributes
deleteDelete the messages
ArgumentTypeDescription
identifierstringThe name of the messages
syncSync messages state from GCP
spaces_members.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
groupMember?objectResource name for a Google Group. Represents a [group](https://cloud.google.com/identity/docs/reference/rest/v1/groups) in Cloud Identity Groups API. Format: groups/{group}
member?objectOutput only. The user's display name.
name?stringIdentifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
role?enumOptional. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership`.
useAdminAccess?stringOptional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a members
getGet a members
ArgumentTypeDescription
identifierstringThe name of the members
updateUpdate members attributes
deleteDelete the members
ArgumentTypeDescription
identifierstringThe name of the members
syncSync members state from GCP
customemojis.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
name?stringIdentifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`
payload?objectRequired. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.
createCreate a customEmojis
getGet a customEmojis
ArgumentTypeDescription
identifierstringThe name of the customEmojis
deleteDelete the customEmojis
ArgumentTypeDescription
identifierstringThe name of the customEmojis
syncSync customEmojis state from GCP