Namespace Google.Apps.Chat.V1

Classes

AccessoryWidget

One or more interactive widgets that appear at the bottom of a message. For details, see Add interactive widgets at the bottom of a message.

ActionResponse

Parameters that a Chat app can use to configure how its response is posted.

ActionResponse.Types

Container for nested types declared in the ActionResponse message type.

ActionResponse.Types.SelectionItems

List of widget autocomplete results.

ActionResponse.Types.UpdatedWidget

For selectionInput widgets, returns autocomplete suggestions for a multiselect menu.

ActionStatus

Represents the status for a request to either invoke or submit a dialog.

Annotation

Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see Format text messages.

Example plain-text message body:

Hello @FooBot how are you!"

The corresponding annotations metadata:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]

Attachment.Types

Container for nested types declared in the Attachment message type.

AttachmentName

Resource name for the Attachment resource.

CardWithId

A card in a Google Chat message.

Only Chat apps can create cards. If your Chat app authenticates as a user, the message can't contain cards.

Card builder

ChatService

Enables developers to build Chat apps and integrations on Google Chat Platform.

ChatService.ChatServiceBase

Base class for server-side implementations of ChatService

ChatServiceClient

ChatService client wrapper, for convenient use.

ChatServiceClientBuilder

Builder class for ChatServiceClient to provide simple configuration of credentials, endpoint etc.

ChatServiceClientImpl

ChatService client wrapper implementation, for convenient use.

ChatServiceSettings

Settings for ChatServiceClient instances.

CompleteImportSpaceRequest

Request message for completing the import process for a space.

CompleteImportSpaceResponse

Response message for completing the import process for a space.

ContextualAddOnMarkup

The markup for developers to specify the contents of a contextual AddOn.

ContextualAddOnMarkup.Types

Container for nested types declared in the ContextualAddOnMarkup message type.

ContextualAddOnMarkup.Types.Card

A card is a UI element that can contain UI widgets such as text and images.

ContextualAddOnMarkup.Types.Card.Types

Container for nested types declared in the Card message type.

ContextualAddOnMarkup.Types.Card.Types.CardAction

A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser.

Not supported by Google Chat apps.

ContextualAddOnMarkup.Types.Card.Types.CardHeader

ContextualAddOnMarkup.Types.Card.Types.CardHeader.Types

Container for nested types declared in the CardHeader message type.

ContextualAddOnMarkup.Types.Card.Types.Section

A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).

CreateCustomEmojiRequest

A request to create a custom emoji.

CreateMembershipRequest

Request message for creating a membership.

CreateMessageRequest

Creates a message.

CreateMessageRequest.Types

Container for nested types declared in the CreateMessageRequest message type.

CreateReactionRequest

Creates a reaction to a message.

CreateSpaceRequest

A request to create a named space with no members.

CustomEmoji

Represents a custom emoji.

CustomEmoji.Types

Container for nested types declared in the CustomEmoji message type.

CustomEmoji.Types.CustomEmojiPayload

Payload data for the custom emoji.

CustomEmojiMetadata

Annotation metadata for custom emoji.

CustomEmojiName

Resource name for the CustomEmoji resource.

DeleteCustomEmojiRequest

Request for deleting a custom emoji.

DeleteMembershipRequest

Request to delete a membership in a space.

DeleteMessageRequest

Request to delete a message.

DeleteReactionRequest

Deletes a reaction to a message.

DeleteSpaceRequest

Request for deleting a space.

DeletionMetadata

Information about a deleted message. A message is deleted when delete_time is set.

DeletionMetadata.Types

Container for nested types declared in the DeletionMetadata message type.

Dialog

Wrapper around the card body of the dialog.

DialogAction

Contains a dialog and request status code.

DriveDataRef

A reference to the data of a drive attachment.

DriveLinkData

Data for Google Drive links.

Emoji

An emoji that is used as a reaction to a message.

EmojiReactionSummary

The number of people who reacted to a message with a specific emoji.

FindDirectMessageRequest

A request to get direct message space based on the user resource.

GetAttachmentRequest

Request to get an attachment.

GetCustomEmojiRequest

A request to return a single custom emoji.

GetMembershipRequest

Request to get a membership of a space.

GetMessageRequest

Request to get a message.

GetSpaceEventRequest

Request message for getting a space event.

GetSpaceNotificationSettingRequest

Request message to get space notification setting. Only supports getting notification setting for the calling user.

GetSpaceReadStateRequest

Request message for GetSpaceReadState API.

GetSpaceRequest

A request to return a single space.

GetThreadReadStateRequest

Request message for GetThreadReadStateRequest API.

Group

A Google Group in Google Chat.

ListCustomEmojisRequest

A request to return a list of custom emojis.

ListCustomEmojisResponse

A response to list custom emojis.

ListMembershipsRequest

Request message for listing memberships.

ListMembershipsResponse

Response to list memberships of the space.

ListMessagesRequest

Lists messages in the specified space, that the user is a member of.

ListMessagesResponse

Response message for listing messages.

ListReactionsRequest

Lists reactions to a message.

ListReactionsResponse

Response to a list reactions request.

ListSpaceEventsRequest

Request message for listing space events.

ListSpaceEventsResponse

Response message for listing space events.

ListSpacesRequest

A request to list the spaces the caller is a member of.

ListSpacesResponse

The response for a list spaces request.

MatchedUrl

A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see Preview links.

Membership

Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.

Membership.Types

Container for nested types declared in the Membership message type.

MembershipBatchCreatedEventData

Event payload for multiple new memberships.

Event type: google.workspace.chat.membership.v1.batchCreated

MembershipBatchDeletedEventData

Event payload for multiple deleted memberships.

Event type: google.workspace.chat.membership.v1.batchDeleted

MembershipBatchUpdatedEventData

Event payload for multiple updated memberships.

Event type: google.workspace.chat.membership.v1.batchUpdated

MembershipCreatedEventData

Event payload for a new membership.

Event type: google.workspace.chat.membership.v1.created.

MembershipDeletedEventData

Event payload for a deleted membership.

Event type: google.workspace.chat.membership.v1.deleted

MembershipName

Resource name for the Membership resource.

MembershipUpdatedEventData

Event payload for an updated membership.

Event type: google.workspace.chat.membership.v1.updated

Message

A message in a Google Chat space.

MessageBatchCreatedEventData

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

MessageBatchDeletedEventData

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

MessageBatchUpdatedEventData

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

MessageCreatedEventData

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

MessageDeletedEventData

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

MessageName

Resource name for the Message resource.

MessageUpdatedEventData

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

QuotedMessageMetadata

Information about a quoted message.

QuotedMessageMetadataName

Resource name for the QuotedMessageMetadata resource.

Reaction

A reaction to a message.

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

ReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

ReactionDeletedEventData

Event payload for a deleted reaction.

Type: google.workspace.chat.reaction.v1.deleted

ReactionName

Resource name for the Reaction resource.

RichLinkMetadata

A rich link to a resource.

RichLinkMetadata.Types

Container for nested types declared in the RichLinkMetadata message type.

SearchSpacesRequest

Request to search for a list of spaces based on a query.

SearchSpacesResponse

Response with a list of spaces corresponding to the search spaces request.

SetUpSpaceRequest

Request to create a space and add specified users to it.

SlashCommand

A slash command in Google Chat.

SlashCommandMetadata

Annotation metadata for slash commands (/).

SlashCommandMetadata.Types

Container for nested types declared in the SlashCommandMetadata message type.

Space

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

Space.Types

Container for nested types declared in the Space message type.

Space.Types.AccessSettings

Represents the access setting of the space.

Space.Types.AccessSettings.Types

Container for nested types declared in the AccessSettings message type.

Space.Types.MembershipCount

Represents the count of memberships of a space, grouped into categories.

Space.Types.PermissionSetting

Represents a space permission setting.

Space.Types.PermissionSettings

Permission settings that you can specify when updating an existing named space.

To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request.

Space.Types.SpaceDetails

Details about the space including description and rules.

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

SpaceEvent

An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat.

SpaceEventName

Resource name for the SpaceEvent resource.

SpaceName

Resource name for the Space resource.

SpaceNotificationSetting

The notification setting of a user in a space.

SpaceNotificationSetting.Types

Container for nested types declared in the SpaceNotificationSetting message type.

SpaceNotificationSettingName

Resource name for the SpaceNotificationSetting resource.

SpaceReadState

A user's read state within a space, used to identify read and unread messages.

SpaceReadStateName

Resource name for the SpaceReadState resource.

SpaceUpdatedEventData

Event payload for an updated space.

Event type: google.workspace.chat.space.v1.updated

Thread

A thread in a Google Chat space. For example usage, see Start or reply to a message thread.

If you specify a thread when creating a message, you can set the messageReplyOption field to determine what happens if no matching thread is found.

ThreadName

Resource name for the Thread resource.

ThreadReadState

A user's read state within a thread, used to identify read and unread messages.

ThreadReadStateName

Resource name for the ThreadReadState resource.

UpdateMembershipRequest

Request message for updating a membership.

UpdateMessageRequest

Request to update a message.

UpdateSpaceNotificationSettingRequest

Request to update the space notification settings. Only supports updating notification setting for the calling user.

UpdateSpaceReadStateRequest

Request message for UpdateSpaceReadState API.

UpdateSpaceRequest

A request to update a single space.

UploadAttachmentRequest

Request to upload an attachment.

UploadAttachmentResponse

Response of uploading an attachment.

User

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user, the output for a User resource only populates the user's name and type.

User.Types

Container for nested types declared in the User message type.

UserMentionMetadata

Annotation metadata for user mentions (@).

UserMentionMetadata.Types

Container for nested types declared in the UserMentionMetadata message type.

WidgetMarkup

A widget is a UI element that presents text and images.

WidgetMarkup.Types

Container for nested types declared in the WidgetMarkup message type.

WidgetMarkup.Types.Button

A button. Can be a text button or an image button.

WidgetMarkup.Types.FormAction

A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.

WidgetMarkup.Types.FormAction.Types

Container for nested types declared in the FormAction message type.

WidgetMarkup.Types.FormAction.Types.ActionParameter

List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters.

WidgetMarkup.Types.Image

An image that's specified by a URL and can have an onclick action.

WidgetMarkup.Types.ImageButton

An image button with an onclick action.

WidgetMarkup.Types.KeyValue

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

WidgetMarkup.Types.OnClick

An onclick action (for example, open a link).

WidgetMarkup.Types.OpenLink

A link that opens a new window.

WidgetMarkup.Types.TextButton

A button with text and onclick action.

WidgetMarkup.Types.TextParagraph

A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.