|
1241 | 1241 | } |
1242 | 1242 | } |
1243 | 1243 | }, |
1244 | | - "revision": "20240707", |
| 1244 | + "revision": "20240709", |
1245 | 1245 | "rootUrl": "https://chat.googleapis.com/", |
1246 | 1246 | "schemas": { |
1247 | 1247 | "AccessSettings": { |
|
1850 | 1850 | "type": "object" |
1851 | 1851 | }, |
1852 | 1852 | "DeprecatedEvent": { |
1853 | | - "description": "A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", |
| 1853 | + "description": "A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", |
1854 | 1854 | "id": "DeprecatedEvent", |
1855 | 1855 | "properties": { |
1856 | 1856 | "action": { |
|
1859 | 1859 | }, |
1860 | 1860 | "common": { |
1861 | 1861 | "$ref": "CommonEventObject", |
1862 | | - "description": "Represents informatmessage_visibilityion 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/workspace/chat/dialogs), like data entered on a card." |
| 1862 | + "description": "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/workspace/chat/dialogs), like data entered on a card." |
1863 | 1863 | }, |
1864 | 1864 | "configCompleteRedirectUrl": { |
1865 | 1865 | "description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", |
|
1896 | 1896 | }, |
1897 | 1897 | "space": { |
1898 | 1898 | "$ref": "Space", |
1899 | | - "description": "The space in which the interaction event occurred." |
| 1899 | + "description": "The space in which the user interacted with the Chat app." |
1900 | 1900 | }, |
1901 | 1901 | "threadKey": { |
1902 | 1902 | "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.", |
|
1907 | 1907 | "type": "string" |
1908 | 1908 | }, |
1909 | 1909 | "type": { |
1910 | | - "description": "The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events).", |
| 1910 | + "description": "The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.", |
1911 | 1911 | "enum": [ |
1912 | 1912 | "UNSPECIFIED", |
1913 | 1913 | "MESSAGE", |
|
1918 | 1918 | ], |
1919 | 1919 | "enumDescriptions": [ |
1920 | 1920 | "Default value for the enum. DO NOT USE.", |
1921 | | - "A user sends the Chat app a message, or invokes the Chat app in a space.", |
1922 | | - "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization.", |
1923 | | - "A user removes the Chat app from a space.", |
1924 | | - "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. If a user interacts with a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", |
| 1921 | + "A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its slash commands. * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", |
| 1922 | + "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).", |
| 1923 | + "A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.", |
| 1924 | + "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", |
1925 | 1925 | "A user updates a widget in a card message or dialog." |
1926 | 1926 | ], |
1927 | 1927 | "type": "string" |
1928 | 1928 | }, |
1929 | 1929 | "user": { |
1930 | 1930 | "$ref": "User", |
1931 | | - "description": "The user that triggered the interaction event." |
| 1931 | + "description": "The user that interacted with the Chat app." |
1932 | 1932 | } |
1933 | 1933 | }, |
1934 | 1934 | "type": "object" |
|
4098 | 4098 | "type": "string" |
4099 | 4099 | }, |
4100 | 4100 | "externalUserAllowed": { |
4101 | | - "description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.", |
| 4101 | + "description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.", |
4102 | 4102 | "type": "boolean" |
4103 | 4103 | }, |
4104 | 4104 | "importMode": { |
|
0 commit comments