Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit e6bf0b1

Browse files
committedFeb 18, 2025
feat(chat): update the api
#### chat:v1 The following keys were added: - schemas.AppCommandMetadata (Total Keys: 5) - schemas.DeprecatedEvent.properties.appCommandMetadata.$ref (Total Keys: 1) - schemas.DeprecatedEvent.properties.thread.$ref (Total Keys: 1)
1 parent c9d74be commit e6bf0b1

File tree

1 file changed

+48
-10
lines changed

1 file changed

+48
-10
lines changed
 

‎googleapiclient/discovery_cache/documents/chat.v1.json

+48-10
Original file line numberDiff line numberDiff line change
@@ -1344,7 +1344,7 @@
13441344
}
13451345
}
13461346
},
1347-
"revision": "20250130",
1347+
"revision": "20250209",
13481348
"rootUrl": "https://chat.googleapis.com/",
13491349
"schemas": {
13501350
"AccessSettings": {
@@ -1544,6 +1544,32 @@
15441544
},
15451545
"type": "object"
15461546
},
1547+
"AppCommandMetadata": {
1548+
"description": "Metadata associated with app commands. App commands are a way for users to invoke and interact with a Chat app. These can be slash commands typed in the compose box, or items directly selected from the integration menu. For more information, see [Respond to quick commands](https://developers.google.com/workspace/chat/quick-commands).",
1549+
"id": "AppCommandMetadata",
1550+
"properties": {
1551+
"appCommandId": {
1552+
"description": "The command ID for the given app interaction.",
1553+
"format": "int32",
1554+
"type": "integer"
1555+
},
1556+
"appCommandType": {
1557+
"description": "The type of the app command.",
1558+
"enum": [
1559+
"APP_COMMAND_TYPE_UNSPECIFIED",
1560+
"SLASH_COMMAND",
1561+
"QUICK_COMMAND"
1562+
],
1563+
"enumDescriptions": [
1564+
"Default value. Unspecified.",
1565+
"A slash command sent in a message.",
1566+
"A quick command that is invoked by the user. This can result from an action taken in the integration menu."
1567+
],
1568+
"type": "string"
1569+
}
1570+
},
1571+
"type": "object"
1572+
},
15471573
"AttachedGif": {
15481574
"description": "A GIF image that's specified by a URL.",
15491575
"id": "AttachedGif",
@@ -1845,7 +1871,7 @@
18451871
"The add-on launches from Google Sheets.",
18461872
"The add-on launches from Google Slides.",
18471873
"The add-on launches from Google Drawings.",
1848-
"A Google Chat app. Not used for Google Workspace Add-ons."
1874+
"A Google Chat app. Not used for Google Workspace add-ons."
18491875
],
18501876
"type": "string"
18511877
},
@@ -1972,16 +1998,18 @@
19721998
"ADMIN",
19731999
"APP_MESSAGE_EXPIRY",
19742000
"CREATOR_VIA_APP",
1975-
"SPACE_OWNER_VIA_APP"
2001+
"SPACE_OWNER_VIA_APP",
2002+
"SPACE_MEMBER"
19762003
],
19772004
"enumDescriptions": [
19782005
"This value is unused.",
19792006
"User deleted their own message.",
1980-
"The space owner deleted the message.",
1981-
"A Google Workspace admin deleted the message.",
2007+
"A space manager deleted the message.",
2008+
"A Google Workspace administrator deleted the message. Administrators can delete any message in the space, including messages sent by any space member or Chat app.",
19822009
"A Chat app deleted its own message when it expired.",
1983-
"A Chat app deleted the message on behalf of the user.",
1984-
"A Chat app deleted the message on behalf of the space owner."
2010+
"A Chat app deleted the message on behalf of the creator (using user authentication).",
2011+
"A Chat app deleted the message on behalf of a space manager (using user authentication).",
2012+
"A member of the space deleted the message. Users can delete messages sent by apps."
19852013
],
19862014
"type": "string"
19872015
}
@@ -1996,12 +2024,16 @@
19962024
"$ref": "FormAction",
19972025
"description": "For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data)."
19982026
},
2027+
"appCommandMetadata": {
2028+
"$ref": "AppCommandMetadata",
2029+
"description": "Populated for app commands, including slash commands and quick commands."
2030+
},
19992031
"common": {
20002032
"$ref": "CommonEventObject",
20012033
"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."
20022034
},
20032035
"configCompleteRedirectUrl": {
2004-
"description": "This URL is populated for `MESSAGE` and `ADDED_TO_SPACE` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools). In [Developer Preview](https://developers.google.com/workspace/preview), this URL is also populated for `APP_COMMAND` interaction events.",
2036+
"description": "This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).",
20052037
"type": "string"
20062038
},
20072039
"dialogEventType": {
@@ -2037,6 +2069,10 @@
20372069
"$ref": "Space",
20382070
"description": "The space in which the user interacted with the Chat app."
20392071
},
2072+
"thread": {
2073+
"$ref": "Thread",
2074+
"description": "The thread in which the user interacted with the Chat app. This could be in a new thread created by a newly sent message. This field is populated if the interaction event is associated with a specific message or thread."
2075+
},
20402076
"threadKey": {
20412077
"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.",
20422078
"type": "string"
@@ -2053,15 +2089,17 @@
20532089
"ADDED_TO_SPACE",
20542090
"REMOVED_FROM_SPACE",
20552091
"CARD_CLICKED",
2056-
"WIDGET_UPDATED"
2092+
"WIDGET_UPDATED",
2093+
"APP_COMMAND"
20572094
],
20582095
"enumDescriptions": [
20592096
"Default value for the enum. DO NOT USE.",
20602097
"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.",
20612098
"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).",
20622099
"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.",
20632100
"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).",
2064-
"A user updates a widget in a card message or dialog."
2101+
"A user updates a widget in a card message or dialog.",
2102+
"A user invokes a command of the app."
20652103
],
20662104
"type": "string"
20672105
},

0 commit comments

Comments
 (0)
Please sign in to comment.