|
955 | 955 | } |
956 | 956 | } |
957 | 957 | }, |
958 | | - "revision": "20230806", |
| 958 | + "revision": "20230816", |
959 | 959 | "rootUrl": "https://chat.googleapis.com/", |
960 | 960 | "schemas": { |
961 | 961 | "ActionParameter": { |
|
1496 | 1496 | "type": "object" |
1497 | 1497 | }, |
1498 | 1498 | "DeprecatedEvent": { |
1499 | | - "description": "Google Chat events. To learn how to use events, see [Receive and respond to Google Chat events](https://developers.google.com/chat/api/guides/message-formats).", |
| 1499 | + "description": "Google Chat app interaction events. To learn about interaction events, see [Receive and respond to Google Chat app interaction events](https://developers.google.com/chat/api/guides/message-formats).", |
1500 | 1500 | "id": "DeprecatedEvent", |
1501 | 1501 | "properties": { |
1502 | 1502 | "action": { |
|
1512 | 1512 | "type": "string" |
1513 | 1513 | }, |
1514 | 1514 | "dialogEventType": { |
1515 | | - "description": "The type of [dialog](https://developers.google.com/chat/how-tos/dialogs) event received.", |
| 1515 | + "description": "The type of [dialog](https://developers.google.com/chat/how-tos/dialogs) interaction event received.", |
1516 | 1516 | "enum": [ |
1517 | 1517 | "TYPE_UNSPECIFIED", |
1518 | 1518 | "REQUEST_DIALOG", |
1519 | 1519 | "SUBMIT_DIALOG", |
1520 | 1520 | "CANCEL_DIALOG" |
1521 | 1521 | ], |
1522 | 1522 | "enumDescriptions": [ |
1523 | | - "This could be used when the corresponding event is not dialog related. For example an @mention.", |
| 1523 | + "This could be used when the corresponding interaction event is not dialog related. For example an @mention.", |
1524 | 1524 | "Any user action that opens a [dialog](https://developers.google.com/chat/how-tos/dialogs).", |
1525 | | - "A card click event from a [dialog](https://developers.google.com/chat/how-tos/dialogs).", |
| 1525 | + "A card click interaction event from a [dialog](https://developers.google.com/chat/how-tos/dialogs).", |
1526 | 1526 | "The [dialog](https://developers.google.com/chat/how-tos/dialogs) was cancelled." |
1527 | 1527 | ], |
1528 | 1528 | "type": "string" |
1529 | 1529 | }, |
1530 | 1530 | "eventTime": { |
1531 | | - "description": "The timestamp indicating when the event occurred.", |
| 1531 | + "description": "The timestamp indicating when the interaction event occurred.", |
1532 | 1532 | "format": "google-datetime", |
1533 | 1533 | "type": "string" |
1534 | 1534 | }, |
1535 | 1535 | "isDialogEvent": { |
1536 | | - "description": "True when the event is related to [dialogs](https://developers.google.com/chat/how-tos/dialogs).", |
| 1536 | + "description": "True when the interaction event is related to [dialogs](https://developers.google.com/chat/how-tos/dialogs).", |
1537 | 1537 | "type": "boolean" |
1538 | 1538 | }, |
1539 | 1539 | "message": { |
1540 | 1540 | "$ref": "Message", |
1541 | | - "description": "The message that triggered the event, if applicable." |
| 1541 | + "description": "The message that triggered the interaction event, if applicable." |
1542 | 1542 | }, |
1543 | 1543 | "space": { |
1544 | 1544 | "$ref": "Space", |
1545 | | - "description": "The space in which the event occurred." |
| 1545 | + "description": "The space in which the interaction event occurred." |
1546 | 1546 | }, |
1547 | 1547 | "threadKey": { |
1548 | | - "description": "The Chat app-defined key for the thread related to the event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.", |
| 1548 | + "description": "The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.", |
1549 | 1549 | "type": "string" |
1550 | 1550 | }, |
1551 | 1551 | "token": { |
1552 | 1552 | "description": "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).", |
1553 | 1553 | "type": "string" |
1554 | 1554 | }, |
1555 | 1555 | "type": { |
1556 | | - "description": "The type of the event.", |
| 1556 | + "description": "The type of the interaction event.", |
1557 | 1557 | "enum": [ |
1558 | 1558 | "UNSPECIFIED", |
1559 | 1559 | "MESSAGE", |
|
1572 | 1572 | }, |
1573 | 1573 | "user": { |
1574 | 1574 | "$ref": "User", |
1575 | | - "description": "The user that triggered the event." |
| 1575 | + "description": "The user that triggered the interaction event." |
1576 | 1576 | } |
1577 | 1577 | }, |
1578 | 1578 | "type": "object" |
|
1807 | 1807 | "type": "object" |
1808 | 1808 | }, |
1809 | 1809 | "GoogleAppsCardV1Card": { |
1810 | | - "description": "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, and 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 information. For more examples, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui).  ``` { \"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\", } ], } } }, ], } }, ], }, ], }, } ], } ```", |
| 1810 | + "description": "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). Only Google Chat apps can create card messages in Google Chat. If your Chat app uses [user authentication](https://developers.google.com/chat/api/guides/auth/users) to send messages on behalf of users, the messages can't contain cards. The following example JSON creates a \"contact card\" that features: - A header with the contact's name, job title, and 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 information. For more examples, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui).  ``` { \"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\", } ], } } }, ], } }, ], }, ], }, } ], } ```", |
1811 | 1811 | "id": "GoogleAppsCardV1Card", |
1812 | 1812 | "properties": { |
1813 | 1813 | "cardActions": { |
|
2288 | 2288 | }, |
2289 | 2289 | "card": { |
2290 | 2290 | "$ref": "GoogleAppsCardV1Card", |
2291 | | - "description": "A new card is pushed to the card stack after clicking if specified. Supported by Google Workspace Add-ons, but not Chat apps." |
| 2291 | + "description": "A new card is pushed to the card stack after clicking if specified. Supported by Google Workspace Add-ons, but not Google Chat apps." |
2292 | 2292 | }, |
2293 | 2293 | "openDynamicLinkAction": { |
2294 | 2294 | "$ref": "GoogleAppsCardV1Action", |
|
2543 | 2543 | "properties": { |
2544 | 2544 | "autoCompleteAction": { |
2545 | 2545 | "$ref": "GoogleAppsCardV1Action", |
2546 | | - "description": "Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. Supported by Google Workspace Add-ons, but not Chat apps." |
| 2546 | + "description": "Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. Supported by Google Workspace Add-ons, but not Google Chat apps." |
2547 | 2547 | }, |
2548 | 2548 | "hintText": { |
2549 | 2549 | "description": "Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional.", |
|
0 commit comments