|
304 | 304 | ]
|
305 | 305 | },
|
306 | 306 | "get": {
|
307 |
| - "description": "Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User authentication](https://developers.google.com/chat/api/guides/auth/users).", |
| 307 | + "description": "Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).", |
308 | 308 | "flatPath": "v1/spaces/{spacesId}",
|
309 | 309 | "httpMethod": "GET",
|
310 | 310 | "id": "chat.spaces.get",
|
|
474 | 474 | "$ref": "Membership"
|
475 | 475 | },
|
476 | 476 | "scopes": [
|
| 477 | + "https://www.googleapis.com/auth/chat.import", |
477 | 478 | "https://www.googleapis.com/auth/chat.memberships",
|
478 | 479 | "https://www.googleapis.com/auth/chat.memberships.app"
|
479 | 480 | ]
|
|
549 | 550 | },
|
550 | 551 | "scopes": [
|
551 | 552 | "https://www.googleapis.com/auth/chat.bot",
|
| 553 | + "https://www.googleapis.com/auth/chat.import", |
552 | 554 | "https://www.googleapis.com/auth/chat.memberships",
|
553 | 555 | "https://www.googleapis.com/auth/chat.memberships.readonly"
|
554 | 556 | ]
|
|
955 | 957 | }
|
956 | 958 | }
|
957 | 959 | },
|
958 |
| - "revision": "20230914", |
| 960 | + "revision": "20230928", |
959 | 961 | "rootUrl": "https://chat.googleapis.com/",
|
960 | 962 | "schemas": {
|
961 | 963 | "ActionParameter": {
|
|
1062 | 1064 | "type": "object"
|
1063 | 1065 | },
|
1064 | 1066 | "Annotation": {
|
1065 |
| - "description": "Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/chat/api/guides/message-formats/text#format-texts). 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\" } }] ```", |
| 1067 | + "description": "Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/chat/format-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\" } }] ```", |
1066 | 1068 | "id": "Annotation",
|
1067 | 1069 | "properties": {
|
1068 | 1070 | "length": {
|
|
1710 | 1712 | "type": "array"
|
1711 | 1713 | },
|
1712 | 1714 | "persistValues": {
|
1713 |
| - "description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.", |
| 1715 | + "description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.", |
1714 | 1716 | "type": "boolean"
|
1715 | 1717 | }
|
1716 | 1718 | },
|
|
1833 | 1835 | },
|
1834 | 1836 | "fixedFooter": {
|
1835 | 1837 | "$ref": "GoogleAppsCardV1CardFixedFooter",
|
1836 |
| - "description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards)." |
| 1838 | + "description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create)." |
1837 | 1839 | },
|
1838 | 1840 | "header": {
|
1839 | 1841 | "$ref": "GoogleAppsCardV1CardHeader",
|
|
1887 | 1889 | "type": "object"
|
1888 | 1890 | },
|
1889 | 1891 | "GoogleAppsCardV1CardFixedFooter": {
|
1890 |
| - "description": "A persistent (sticky) footer that that appears at the bottom of the card. For an example in Google Chat apps, see [Card footer](https://developers.google.com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards).", |
| 1892 | + "description": "A persistent (sticky) footer that that appears at the bottom of the card. For an example in Google Chat apps, see [Card footer](https://developers.google.com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create).", |
1891 | 1893 | "id": "GoogleAppsCardV1CardFixedFooter",
|
1892 | 1894 | "properties": {
|
1893 | 1895 | "primaryButton": {
|
|
2067 | 2069 | },
|
2068 | 2070 | "endIcon": {
|
2069 | 2071 | "$ref": "GoogleAppsCardV1Icon",
|
2070 |
| - "description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons) icons." |
| 2072 | + "description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons." |
2071 | 2073 | },
|
2072 | 2074 | "icon": {
|
2073 | 2075 | "$ref": "GoogleAppsCardV1Icon",
|
|
2087 | 2089 | "description": "A switch widget that a user can click to change its state and trigger an action."
|
2088 | 2090 | },
|
2089 | 2091 | "text": {
|
2090 |
| - "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 2092 | + "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
2091 | 2093 | "type": "string"
|
2092 | 2094 | },
|
2093 | 2095 | "topLabel": {
|
|
2176 | 2178 | "type": "object"
|
2177 | 2179 | },
|
2178 | 2180 | "GoogleAppsCardV1Icon": {
|
2179 |
| - "description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [built-in](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons) icons.", |
| 2181 | + "description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons.", |
2180 | 2182 | "id": "GoogleAppsCardV1Icon",
|
2181 | 2183 | "properties": {
|
2182 | 2184 | "altText": {
|
|
2200 | 2202 | "type": "string"
|
2201 | 2203 | },
|
2202 | 2204 | "knownIcon": {
|
2203 |
| - "description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons).", |
| 2205 | + "description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/format-messages#builtinicons).", |
2204 | 2206 | "type": "string"
|
2205 | 2207 | }
|
2206 | 2208 | },
|
|
2368 | 2370 | "type": "boolean"
|
2369 | 2371 | },
|
2370 | 2372 | "header": {
|
2371 |
| - "description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 2373 | + "description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
2372 | 2374 | "type": "string"
|
2373 | 2375 | },
|
2374 | 2376 | "uncollapsibleWidgetsCount": {
|
|
2589 | 2591 | "type": "object"
|
2590 | 2592 | },
|
2591 | 2593 | "GoogleAppsCardV1TextParagraph": {
|
2592 |
| - "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-paragraph). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards##card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 2594 | + "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-paragraph). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
2593 | 2595 | "id": "GoogleAppsCardV1TextParagraph",
|
2594 | 2596 | "properties": {
|
2595 | 2597 | "text": {
|
|
2657 | 2659 | },
|
2658 | 2660 | "textParagraph": {
|
2659 | 2661 | "$ref": "GoogleAppsCardV1TextParagraph",
|
2660 |
| - "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" |
| 2662 | + "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" |
2661 | 2663 | }
|
2662 | 2664 | },
|
2663 | 2665 | "type": "object"
|
|
2845 | 2847 | "id": "KeyValue",
|
2846 | 2848 | "properties": {
|
2847 | 2849 | "bottomLabel": {
|
2848 |
| - "description": "The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 2850 | + "description": "The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
2849 | 2851 | "type": "string"
|
2850 | 2852 | },
|
2851 | 2853 | "button": {
|
2852 | 2854 | "$ref": "Button",
|
2853 | 2855 | "description": "A button that can be clicked to trigger an action."
|
2854 | 2856 | },
|
2855 | 2857 | "content": {
|
2856 |
| - "description": "The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 2858 | + "description": "The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
2857 | 2859 | "type": "string"
|
2858 | 2860 | },
|
2859 | 2861 | "contentMultiline": {
|
|
2939 | 2941 | "description": "The `onclick` action. Only the top label, bottom label, and content region are clickable."
|
2940 | 2942 | },
|
2941 | 2943 | "topLabel": {
|
2942 |
| - "description": "The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 2944 | + "description": "The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
2943 | 2945 | "type": "string"
|
2944 | 2946 | }
|
2945 | 2947 | },
|
|
3055 | 3057 | "type": "string"
|
3056 | 3058 | },
|
3057 | 3059 | "role": {
|
3058 |
| - "description": "Output only. User's role within a Chat space, which determines their permitted actions in the space.", |
| 3060 | + "description": "Optional. User's role within a Chat space, which determines their permitted actions in the space. [Developer Preview](https://developers.google.com/workspace/preview): This field can only be used as input in `UpdateMembership`.", |
3059 | 3061 | "enum": [
|
3060 | 3062 | "MEMBERSHIP_ROLE_UNSPECIFIED",
|
3061 | 3063 | "ROLE_MEMBER",
|
|
3066 | 3068 | "A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role.",
|
3067 | 3069 | "A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in SpaceType.SPACE."
|
3068 | 3070 | ],
|
3069 |
| - "readOnly": true, |
3070 | 3071 | "type": "string"
|
3071 | 3072 | },
|
3072 | 3073 | "state": {
|
|
3172 | 3173 | "description": "A plain-text description of the message's cards, used when the actual cards can't be displayed\u2014for example, mobile notifications.",
|
3173 | 3174 | "type": "string"
|
3174 | 3175 | },
|
| 3176 | + "formattedText": { |
| 3177 | + "description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, and monospace block. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text\u2014for example, ``. * Custom emoji using the format `:{emoji_name}:`\u2014for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message)", |
| 3178 | + "readOnly": true, |
| 3179 | + "type": "string" |
| 3180 | + }, |
3175 | 3181 | "lastUpdateTime": {
|
3176 | 3182 | "description": "Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.",
|
3177 | 3183 | "format": "google-datetime",
|
|
3207 | 3213 | "description": "If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [space](https://developers.google.com/chat/api/reference/rest/v1/spaces) `name`."
|
3208 | 3214 | },
|
3209 | 3215 | "text": {
|
3210 |
| - "description": "Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/api/guides/message-formats/text#messages-@mention), or everyone in the space. To learn about creating text messages, see [Create a text message](https://developers.google.com/chat/api/guides/message-formats/text).", |
| 3216 | + "description": "Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/chat/api/guides/v1/messages/create#create-text-messages).", |
3211 | 3217 | "type": "string"
|
3212 | 3218 | },
|
3213 | 3219 | "thread": {
|
|
3291 | 3297 | "id": "Section",
|
3292 | 3298 | "properties": {
|
3293 | 3299 | "header": {
|
3294 |
| - "description": "The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 3300 | + "description": "The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
3295 | 3301 | "type": "string"
|
3296 | 3302 | },
|
3297 | 3303 | "widgets": {
|
|
3559 | 3565 | "type": "object"
|
3560 | 3566 | },
|
3561 | 3567 | "TextParagraph": {
|
3562 |
| - "description": "A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
| 3568 | + "description": "A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", |
3563 | 3569 | "id": "TextParagraph",
|
3564 | 3570 | "properties": {
|
3565 | 3571 | "text": {
|
|
0 commit comments