googleapis
Version:
Google APIs Client Library for Node.js
1,074 lines • 166 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace chat_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Chat API
*
* Enables apps to fetch information and perform actions in Google Chat. Authentication is a prerequisite for using the Google Chat REST API.
*
* @example
* ```js
* const {google} = require('googleapis');
* const chat = google.chat('v1');
* ```
*/
export class Chat {
context: APIRequestContext;
dms: Resource$Dms;
media: Resource$Media;
rooms: Resource$Rooms;
spaces: Resource$Spaces;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters.
*/
export interface Schema$ActionParameter {
/**
* The name of the parameter for the action script.
*/
key?: string | null;
/**
* The value of the parameter.
*/
value?: string | null;
}
/**
* Parameters that a Chat app can use to configure how it's response is posted.
*/
export interface Schema$ActionResponse {
/**
* Input only. A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`.
*/
dialogAction?: Schema$DialogAction;
/**
* Input only. The type of Chat app response.
*/
type?: string | null;
/**
* Input only. URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
*/
url?: string | null;
}
/**
* Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs).
*/
export interface Schema$ActionStatus {
/**
* The status code.
*/
statusCode?: string | null;
/**
* The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent.
*/
userFacingMessage?: string | null;
}
/**
* Annotations associated with the plain-text body of the message. 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/107946847022116401880", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" \}, "type":"MENTION" \} \}] ```
*/
export interface Schema$Annotation {
/**
* Length of the substring in the plain-text message body this annotation corresponds to.
*/
length?: number | null;
/**
* The metadata for a slash command.
*/
slashCommand?: Schema$SlashCommandMetadata;
/**
* Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
*/
startIndex?: number | null;
/**
* The type of this annotation.
*/
type?: string | null;
/**
* The metadata of user mention.
*/
userMention?: Schema$UserMentionMetadata;
}
/**
* An attachment in Google Chat.
*/
export interface Schema$Attachment {
/**
* A reference to the attachment data. This is used with the media API to download the attachment data.
*/
attachmentDataRef?: Schema$AttachmentDataRef;
/**
* The original file name for the content, not the full path.
*/
contentName?: string | null;
/**
* The content type (MIME type) of the file.
*/
contentType?: string | null;
/**
* Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps should not use this URL to download attachment content.
*/
downloadUri?: string | null;
/**
* A reference to the drive attachment. This is used with the Drive API.
*/
driveDataRef?: Schema$DriveDataRef;
/**
* Resource name of the attachment, in the form "spaces/x/messages/x/attachments/x".
*/
name?: string | null;
/**
* The source of the attachment.
*/
source?: string | null;
/**
* Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps should not use this URL to download attachment content.
*/
thumbnailUri?: string | null;
}
/**
* A reference to the data of an attachment.
*/
export interface Schema$AttachmentDataRef {
/**
* The resource name of the attachment data. This is used with the media API to download the attachment data.
*/
resourceName?: string | null;
}
/**
* A button. Can be a text button or an image button.
*/
export interface Schema$Button {
/**
* A button with image and onclick action.
*/
imageButton?: Schema$ImageButton;
/**
* A button with text and onclick action.
*/
textButton?: Schema$TextButton;
}
/**
* A card is a UI element that can contain UI widgets such as texts, images.
*/
export interface Schema$Card {
/**
* The actions of this card.
*/
cardActions?: Schema$CardAction[];
/**
* The header of the card. A header usually contains a title and an image.
*/
header?: Schema$CardHeader;
/**
* Name of the card.
*/
name?: string | null;
/**
* Sections are separated by a line divider.
*/
sections?: Schema$Section[];
}
/**
* 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.
*/
export interface Schema$CardAction {
/**
* The label used to be displayed in the action menu item.
*/
actionLabel?: string | null;
/**
* The onclick action for this action item.
*/
onClick?: Schema$OnClick;
}
export interface Schema$CardHeader {
/**
* The image's type (e.g. square border or circular border).
*/
imageStyle?: string | null;
/**
* The URL of the image in the card header.
*/
imageUrl?: string | null;
/**
* The subtitle of the card header.
*/
subtitle?: string | null;
/**
* The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each will take up 1 line. If only the title is specified, it will take up both lines.
*/
title?: string | null;
}
/**
* Widgets for Chat apps to specify.
*/
export interface Schema$CardWithId {
/**
* Card proto that allows Chat apps to specify UI elements and editable widgets.
*/
card?: Schema$GoogleAppsCardV1Card;
/**
* Required for `cardsV2` messages. Chat app-specified identifier for this widget. Scoped within a message.
*/
cardId?: string | null;
}
/**
* JSON payload of error messages. If the Cloud Logging API is enabled, these error messages are logged to [Google Cloud Logging](https://cloud.google.com/logging/docs).
*/
export interface Schema$ChatAppLogEntry {
/**
* The deployment that caused the error. For Chat apps built in Apps Script, this is the deployment ID defined by Apps Script.
*/
deployment?: string | null;
/**
* The unencrypted `callback_method` name that was running when the error was encountered.
*/
deploymentFunction?: string | null;
/**
* The error code and message.
*/
error?: Schema$Status;
}
/**
* Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ...
*/
export interface Schema$Color {
/**
* The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
*/
alpha?: number | null;
/**
* The amount of blue in the color as a value in the interval [0, 1].
*/
blue?: number | null;
/**
* The amount of green in the color as a value in the interval [0, 1].
*/
green?: number | null;
/**
* The amount of red in the color as a value in the interval [0, 1].
*/
red?: number | null;
}
/**
* Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes data submitted by users interacting with cards, like data entered in [dialogs](https://developers.google.com/chat/how-tos/dialogs).
*/
export interface Schema$CommonEventObject {
/**
* A map containing the current values of the widgets in a card. The map keys are the string IDs assigned to each widget, and the values represent inputs to the widget. Depending on the input data type, a different object represents each input: For single-value widgets, `StringInput`. For multi-value widgets, an array of `StringInput` objects. For a date-time picker, a `DateTimeInput`. For a date-only picker, a `DateInput`. For a time-only picker, a `TimeInput`. Corresponds with the data entered by a user on a card in a [dialog](https://developers.google.com/chat/how-tos/dialogs).
*/
formInputs?: {
[key: string]: Schema$Inputs;
} | null;
/**
* The hostApp enum which indicates the app the add-on is invoked from. Always `CHAT` for Chat apps.
*/
hostApp?: string | null;
/**
* Name of the invoked function associated with the widget. Only set for Chat apps.
*/
invokedFunction?: string | null;
/**
* Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter) passed to the invoked function. Both keys and values must be strings.
*/
parameters?: {
[key: string]: string;
} | null;
/**
* The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.
*/
platform?: string | null;
/**
* The timezone ID and offset from Coordinated Universal Time (UTC).
*/
timeZone?: Schema$TimeZone;
/**
* The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US". Not supported by Chat apps.
*/
userLocale?: string | null;
}
/**
* Date input values. Not supported by Chat apps.
*/
export interface Schema$DateInput {
/**
* Time since epoch time, in milliseconds.
*/
msSinceEpoch?: string | null;
}
/**
* Date and time input values. Not supported by Chat apps.
*/
export interface Schema$DateTimeInput {
/**
* Whether the `datetime` input includes a calendar date.
*/
hasDate?: boolean | null;
/**
* Whether the `datetime` input includes a timestamp.
*/
hasTime?: boolean | null;
/**
* Time since epoch time, in milliseconds.
*/
msSinceEpoch?: string | null;
}
/**
* Google Chat events.
*/
export interface Schema$DeprecatedEvent {
/**
* The form action data associated with an interactive card that was clicked. Only populated for CARD_CLICKED events. See the [Interactive Cards guide](/chat/how-tos/cards-onclick) for more information.
*/
action?: Schema$FormAction;
/**
* Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/chat/how-tos/dialogs), like data entered on a card.
*/
common?: Schema$CommonEventObject;
/**
* The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. See the [Authorizing access to 3p services guide](/chat/how-tos/auth-3p) for more information.
*/
configCompleteRedirectUrl?: string | null;
/**
* The type of [dialog](https://developers.google.com/chat/how-tos/dialogs) event received.
*/
dialogEventType?: string | null;
/**
* The timestamp indicating when the event occurred.
*/
eventTime?: string | null;
/**
* True when the event is related to [dialogs](https://developers.google.com/chat/how-tos/dialogs).
*/
isDialogEvent?: boolean | null;
/**
* The message that triggered the event, if applicable.
*/
message?: Schema$Message;
/**
* The space in which the event occurred.
*/
space?: Schema$Space;
/**
* The Chat app-defined key for the thread related to the event. See the thread_key field of the `spaces.message.create` request for more information.
*/
threadKey?: string | null;
/**
* A secret value that legacy Chat apps can use to verify if a request is from Google. Google randomly generates the token, and its value remains static. You can obtain, revoke, or regenerate the token from the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat) in the Google Cloud Console. Modern Chat apps don't use this field. It is absent from API responses and the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).
*/
token?: string | null;
/**
* The type of the event.
*/
type?: string | null;
/**
* The user that triggered the event.
*/
user?: Schema$User;
}
/**
* Wrapper around the card body of the dialog.
*/
export interface Schema$Dialog {
/**
* Input only. Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`.
*/
body?: Schema$GoogleAppsCardV1Card;
}
/**
* Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code.
*/
export interface Schema$DialogAction {
/**
* Input only. Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success.
*/
actionStatus?: Schema$ActionStatus;
/**
* Input only. [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request.
*/
dialog?: Schema$Dialog;
}
/**
* A reference to the data of a drive attachment.
*/
export interface Schema$DriveDataRef {
/**
* The id for the drive file, for use with the Drive API.
*/
driveFileId?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.
*/
export interface Schema$FormAction {
/**
* The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. The same method name can be used for several elements that trigger a common behavior if desired.
*/
actionMethodName?: string | null;
/**
* List of action parameters.
*/
parameters?: Schema$ActionParameter[];
}
/**
* An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.
*/
export interface Schema$GoogleAppsCardV1Action {
/**
* Apps Script function to invoke when the containing element is clicked/activated.
*/
function?: string | null;
/**
* Specifies the loading indicator that the action displays while making the call to the action.
*/
loadIndicator?: string | null;
/**
* List of action parameters.
*/
parameters?: Schema$GoogleAppsCardV1ActionParameter[];
/**
* Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. When using [LoadIndicator.NONE](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use [LoadIndicator.SPINNER](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed. Not supported by Google Chat apps.
*/
persistValues?: boolean | null;
}
/**
* List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze 1 day, snooze next week. You might use action method = snooze(), passing the snooze type and snooze time in the list of string parameters.
*/
export interface Schema$GoogleAppsCardV1ActionParameter {
/**
* The name of the parameter for the action script.
*/
key?: string | null;
/**
* The value of the parameter.
*/
value?: string | null;
}
/**
* Represents the complete border style applied to widgets.
*/
export interface Schema$GoogleAppsCardV1BorderStyle {
/**
* The corner radius for the border.
*/
cornerRadius?: number | null;
/**
* The colors to use when the type is `BORDER_TYPE_STROKE`.
*/
strokeColor?: Schema$Color;
/**
* The border type.
*/
type?: string | null;
}
/**
* A button. Can be a text button or an image button.
*/
export interface Schema$GoogleAppsCardV1Button {
/**
* The alternative text used for accessibility. Has no effect when an icon is set; use `icon.alt_text` instead.
*/
altText?: string | null;
/**
* If set, the button is filled with a solid background.
*/
color?: Schema$Color;
/**
* If `true`, the button is displayed in a disabled state and doesn't respond to user actions.
*/
disabled?: boolean | null;
/**
* The icon image.
*/
icon?: Schema$GoogleAppsCardV1Icon;
/**
* The action to perform when the button is clicked.
*/
onClick?: Schema$GoogleAppsCardV1OnClick;
/**
* The text of the button.
*/
text?: string | null;
}
/**
* A list of buttons layed out horizontally.
*/
export interface Schema$GoogleAppsCardV1ButtonList {
/**
* An array of buttons.
*/
buttons?: Schema$GoogleAppsCardV1Button[];
}
/**
* Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. In Google Chat, cards appear in several places: - As stand-alone messages. - Accompanying a text message, just beneath the text message. - As a [dialog](https://developers.google.com/chat/how-tos/dialogs). The following example JSON creates a "contact card" that features: - A header with the contact's name, job title, avatar picture. - A section with the contact information, including formatted text. - Buttons that users can click to share the contact or see more or less info.  ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", \}, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL", \}, "text": "sasha@example.com", \} \}, { "decoratedText": { "startIcon": { "knownIcon": "PERSON", \}, "text": "Online", \}, \}, { "decoratedText": { "startIcon": { "knownIcon": "PHONE", \}, "text": "+1 (555) 555-1234", \} \}, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share", \} \} \}, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT", \} ], \} \} \}, ], \} \}, ], \}, ], \}, \} ], \} ```
*/
export interface Schema$GoogleAppsCardV1Card {
/**
* The card's actions. Actions are added to the card's generated toolbar menu. Not supported by Google Chat apps. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" \} ], "loadIndicator": "LoadIndicator.SPINNER" \} \} \}, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" \} \} \} ] ```
*/
cardActions?: Schema$GoogleAppsCardV1CardAction[];
/**
* The `peekCardHeader` display style for. Not supported by Google Chat apps.
*/
displayStyle?: string | null;
/**
* The fixed footer shown at the bottom of this card.
*/
fixedFooter?: Schema$GoogleAppsCardV1CardFixedFooter;
/**
* The header of the card. A header usually contains a title and an image.
*/
header?: Schema$GoogleAppsCardV1CardHeader;
/**
* Name of the card. Used as a card identifier in card navigation.
*/
name?: string | null;
/**
* When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. Not supported by Google Chat apps.
*/
peekCardHeader?: Schema$GoogleAppsCardV1CardHeader;
/**
* Sections are separated by a line divider.
*/
sections?: Schema$GoogleAppsCardV1Section[];
}
/**
* A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. Not supported by Google Chat apps.
*/
export interface Schema$GoogleAppsCardV1CardAction {
/**
* The label that displays as the action menu item.
*/
actionLabel?: string | null;
/**
* The `onClick` action for this action item.
*/
onClick?: Schema$GoogleAppsCardV1OnClick;
}
/**
* A persistent (sticky) footer that is added to the bottom of the card.
*/
export interface Schema$GoogleAppsCardV1CardFixedFooter {
/**
* The primary button of the fixed footer. The button must be a text button with text and color set.
*/
primaryButton?: Schema$GoogleAppsCardV1Button;
/**
* The secondary button of the fixed footer. The button must be a text button with text and color set. `primaryButton` must be set if `secondaryButton` is set.
*/
secondaryButton?: Schema$GoogleAppsCardV1Button;
}
/**
* Represents a card header.
*/
export interface Schema$GoogleAppsCardV1CardHeader {
/**
* The alternative text of this image which is used for accessibility.
*/
imageAltText?: string | null;
/**
* The image's type.
*/
imageType?: string | null;
/**
* The URL of the image in the card header.
*/
imageUrl?: string | null;
/**
* The subtitle of the card header.
*/
subtitle?: string | null;
/**
* Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.
*/
title?: string | null;
}
/**
* The widget that lets users to specify a date and time. Not supported by Google Chat apps.
*/
export interface Schema$GoogleAppsCardV1DateTimePicker {
/**
* The label for the field that displays to the user.
*/
label?: string | null;
/**
* The name of the text input that's used in `formInput`, and uniquely identifies this input.
*/
name?: string | null;
/**
* Triggered when the user clicks Save or Clear from the date/time picker dialog. This is only triggered if the value changed as a result of the Save/Clear operation.
*/
onChangeAction?: Schema$GoogleAppsCardV1Action;
/**
* The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If not set, it uses the user's time zone setting on the client side.
*/
timezoneOffsetDate?: number | null;
/**
* The type of the date/time picker.
*/
type?: string | null;
/**
* The value to display as the default value before user input or previous user input. It is represented in milliseconds (Epoch time). For `DATE_AND_TIME` type, the full epoch value is used. For `DATE_ONLY` type, only date of the epoch time is used. For `TIME_ONLY` type, only time of the epoch time is used. For example, you can set epoch time to `3 * 60 * 60 * 1000` to represent 3am.
*/
valueMsEpoch?: string | null;
}
/**
* A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget or a button after the text.
*/
export interface Schema$GoogleAppsCardV1DecoratedText {
/**
* The formatted text label that shows below the main text.
*/
bottomLabel?: string | null;
/**
* A button that can be clicked to trigger an action.
*/
button?: Schema$GoogleAppsCardV1Button;
/**
* An icon displayed after the text.
*/
endIcon?: Schema$GoogleAppsCardV1Icon;
/**
* Deprecated in favor of start_icon.
*/
icon?: Schema$GoogleAppsCardV1Icon;
/**
* Only the top and bottom label and content region are clickable.
*/
onClick?: Schema$GoogleAppsCardV1OnClick;
/**
* The icon displayed in front of the text.
*/
startIcon?: Schema$GoogleAppsCardV1Icon;
/**
* A switch widget can be clicked to change its state or trigger an action.
*/
switchControl?: Schema$GoogleAppsCardV1SwitchControl;
/**
* Required. The main widget formatted text. See Text formatting for details.
*/
text?: string | null;
/**
* The formatted text label that shows above the main text.
*/
topLabel?: string | null;
/**
* The wrap text setting. If `true`, the text is wrapped and displayed in multiline. Otherwise, the text is truncated.
*/
wrapText?: boolean | null;
}
/**
* A divider that appears in between widgets.
*/
export interface Schema$GoogleAppsCardV1Divider {
}
/**
* Represents a Grid widget that displays items in a configurable grid layout.
*/
export interface Schema$GoogleAppsCardV1Grid {
/**
* The border style to apply to each grid item.
*/
borderStyle?: Schema$GoogleAppsCardV1BorderStyle;
/**
* The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).
*/
columnCount?: number | null;
/**
* The items to display in the grid.
*/
items?: Schema$GoogleAppsCardV1GridItem[];
/**
* This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
*/
onClick?: Schema$GoogleAppsCardV1OnClick;
/**
* The text that displays in the grid header.
*/
title?: string | null;
}
/**
* Represents a single item in the grid layout.
*/
export interface Schema$GoogleAppsCardV1GridItem {
/**
* A user-specified identifier for this grid item. This identifier is returned in the parent Grid's onClick callback parameters.
*/
id?: string | null;
/**
* The image that displays in the grid item.
*/
image?: Schema$GoogleAppsCardV1ImageComponent;
/**
* The layout to use for the grid item.
*/
layout?: string | null;
/**
* The grid item's subtitle.
*/
subtitle?: string | null;
/**
* The horizontal alignment of the grid item's text.
*/
textAlignment?: string | null;
/**
* The grid item's title.
*/
title?: string | null;
}
export interface Schema$GoogleAppsCardV1Icon {
/**
* The description of the icon, used for accessibility. The default value is provided if you don't specify one.
*/
altText?: string | null;
/**
* The icon specified by a URL.
*/
iconUrl?: string | null;
/**
* The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a standard icon.
*/
imageType?: string | null;
/**
* The icon specified by the string name of a list of known icons.
*/
knownIcon?: string | null;
}
/**
* An image that is specified by a URL and can have an `onClick` action.
*/
export interface Schema$GoogleAppsCardV1Image {
/**
* The alternative text of this image, used for accessibility.
*/
altText?: string | null;
/**
* An image URL.
*/
imageUrl?: string | null;
/**
* The action triggered by an `onClick` event.
*/
onClick?: Schema$GoogleAppsCardV1OnClick;
}
/**
* Represents an image.
*/
export interface Schema$GoogleAppsCardV1ImageComponent {
/**
* The accessibility label for the image.
*/
altText?: string | null;
/**
* The border style to apply to the image.
*/
borderStyle?: Schema$GoogleAppsCardV1BorderStyle;
/**
* The crop style to apply to the image.
*/
cropStyle?: Schema$GoogleAppsCardV1ImageCropStyle;
/**
* The image URL.
*/
imageUri?: string | null;
}
/**
* Represents the crop style applied to an image.
*/
export interface Schema$GoogleAppsCardV1ImageCropStyle {
/**
* The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`.
*/
aspectRatio?: number | null;
/**
* The crop type.
*/
type?: string | null;
}
/**
* Represents the response to an `onClick` event.
*/
export interface Schema$GoogleAppsCardV1OnClick {
/**
* If specified, an action is triggered by this `onClick`.
*/
action?: Schema$GoogleAppsCardV1Action;
/**
* A new card is pushed to the card stack after clicking if specified.
*/
card?: Schema$GoogleAppsCardV1Card;
/**
* An add-on triggers this action when the action needs to open a link. This differs from the `open_link` above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back.
*/
openDynamicLinkAction?: Schema$GoogleAppsCardV1Action;
/**
* If specified, this `onClick` triggers an open link action.
*/
openLink?: Schema$GoogleAppsCardV1OpenLink;
}
/**
* Represents an `onClick` event that opens a hyperlink.
*/
export interface Schema$GoogleAppsCardV1OpenLink {
/**
* Whether the client forgets about a link after opening it, or observes it until the window closes. Not supported by Chat apps.
*/
onClose?: string | null;
/**
* How to open a link. Not supported by Chat apps.
*/
openAs?: string | null;
/**
* The URL to open.
*/
url?: string | null;
}
/**
* 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 is currently no need for layout properties, for example, float.
*/
export interface Schema$GoogleAppsCardV1Section {
/**
* Indicates whether this section is collapsible. If a section is collapsible, the description must be given.
*/
collapsible?: boolean | null;
/**
* The header of the section. Formatted text is supported.
*/
header?: string | null;
/**
* The number of uncollapsible widgets. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed as default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.
*/
uncollapsibleWidgetsCount?: number | null;
/**
* A section must contain at least 1 widget.
*/
widgets?: Schema$GoogleAppsCardV1Widget[];
}
/**
* A widget that creates a UI item with options for users to select. For example, a dropdown menu.
*/
export interface Schema$GoogleAppsCardV1SelectionInput {
/**
* An array of the selected items.
*/
items?: Schema$GoogleAppsCardV1SelectionItem[];
/**
* The label displayed ahead of the switch control.
*/
label?: string | null;
/**
* The name of the text input which is used in `formInput`.
*/
name?: string | null;
/**
* If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button.
*/
onChangeAction?: Schema$GoogleAppsCardV1Action;
/**
* The type of the selection.
*/
type?: string | null;
}
/**
* A selectable item in the switch control.
*/
export interface Schema$GoogleAppsCardV1SelectionItem {
/**
* If more than one item is selected for `RADIO_BUTTON` and `DROPDOWN`, the first selected item is treated as selected and the ones after are ignored.
*/
selected?: boolean | null;
/**
* The text to be displayed.
*/
text?: string | null;
/**
* The value associated with this item. The client should use this as a form input value.
*/
value?: string | null;
}
/**
* A suggestion item.
*/
export interface Schema$GoogleAppsCardV1SuggestionItem {
/**
* The suggested autocomplete result.
*/
text?: string | null;
}
/**
* A container wrapping elements necessary for showing suggestion items used in text input autocomplete.
*/
export interface Schema$GoogleAppsCardV1Suggestions {
/**
* A list of suggestions used for autocomplete recommendations.
*/
items?: Schema$GoogleAppsCardV1SuggestionItem[];
}
/**
* Either a toggle-style switch or a checkbox.
*/
export interface Schema$GoogleAppsCardV1SwitchControl {
/**
* The control type, either switch or checkbox.
*/
controlType?: string | null;
/**
* The name of the switch widget that's used in `formInput`.
*/
name?: string | null;
/**
* The action when the switch state is changed.
*/
onChangeAction?: Schema$GoogleAppsCardV1Action;
/**
* If the switch is selected.
*/
selected?: boolean | null;
/**
* The value is what is passed back in the callback.
*/
value?: string | null;
}
/**
* A text input is a UI item where users can input text. A text input can also have an onChange action and suggestions.
*/
export interface Schema$GoogleAppsCardV1TextInput {
/**
* The refresh function that returns suggestions based on the user's input text. If the callback is not specified, autocomplete is done in client side based on the initial suggestion items.
*/
autoCompleteAction?: Schema$GoogleAppsCardV1Action;
/**
* The hint text.
*/
hintText?: string | null;
/**
* The initial suggestions made before any user input.
*/
initialSuggestions?: Schema$GoogleAppsCardV1Suggestions;
/**
* At least one of label and hintText must be specified.
*/
label?: string | null;
/**
* The name of the text input which is used in `formInput`.
*/
name?: string | null;
/**
* The onChange action, for example, invoke a function.
*/
onChangeAction?: Schema$GoogleAppsCardV1Action;
/**
* The style of the text, for example, a single line or multiple lines.
*/
type?: string | null;
/**
* The default value when there is no input from the user.
*/
value?: string | null;
}
/**
* A paragraph of text that supports formatting. See [Text formatting](https://developers.google.com/workspace/add-ons/concepts/widgets#text_formatting) for details.
*/
export interface Schema$GoogleAppsCardV1TextParagraph {
/**
* The text that's shown in the widget.
*/
text?: string | null;
}
/**
* A widget is a UI element that presents texts, images, etc.
*/
export interface Schema$GoogleAppsCardV1Widget {
/**
* A list of buttons. For example, the following JSON creates two buttons. The first is a filled text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ "button": { "text": "Edit", "Color": { "Red": 255 "Green": 255 "Blue": 255 \} "disabled": true \}, "button": { "icon": { "knownIcon": "INVITE" "altText": "check calendar" \}, "onClick": { "openLink": { "url": "https://example.com/calendar" \} \} \}, ] \} ```
*/
buttonList?: Schema$GoogleAppsCardV1ButtonList;
/**
* Displays a selection/input widget for date/time. For example, the following JSON creates a date/time picker for an appointment time: ``` "date_time_picker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DateTimePickerType.DATE_AND_TIME", "valueMsEpoch": "796435200000" \} ```
*/
dateTimePicker?: Schema$GoogleAppsCardV1DateTimePicker;
/**
* Displays a decorated text item in this widget. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" \}, "topLabel": "Email Address", "content": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchWidget": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "ControlType.CHECKBOX" \} \} ```
*/
decoratedText?: Schema$GoogleAppsCardV1DecoratedText;
/**
* Displays a divider. For example, the following JSON creates a divider: ``` "divider": { \} ```
*/
divider?: Schema$GoogleAppsCardV1Divider;
/**
* Displays a grid with a collection of items. For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "numColumns": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4.0 \}, "items": [ "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" \}, "borderStyle": { "type": "STROKE" \} \}, "title": "An item", "textAlignment": "CENTER" ], "onClick": { "openLink": { "url":"https://www.example.com" \} \} \} ```
*/
grid?: Schema$GoogleAppsCardV1Grid;
/**
* The horizontal alignment of this widget.
*/
horizontalAlignment?: string | null;
/**
* Displays an image in this widget. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://example.com/sasha.png" "altText": "Avatar for Sasha" \} ```
*/
image?: Schema$GoogleAppsCardV1Image;
/**
* Displays a switch control in this widget. For example, the following JSON creates a dropdown selection for size: ``` "switchControl": { "name": "size", "label": "Size" "type": "SelectionType.DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false \}, { "text": "M", "value": "medium", "selected": true \}, { "text": "L", "value": "large", "selected": false \}, { "text": "XL", "value": "extra_large", "selected": false \} ] \} ```
*/
selectionInput?: Schema$GoogleAppsCardV1SelectionInput;
/**
* Displays a text input in this widget. For example, the following JSON creates a text input for mail address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" \} ``` As another example, the following JSON creates a text input for programming language with static suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" \},