google-apis-chat_v1 0.90.0 → 0.92.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/chat_v1/classes.rb +536 -434
- data/lib/google/apis/chat_v1/gem_version.rb +2 -2
- data/lib/google/apis/chat_v1/representations.rb +28 -0
- data/lib/google/apis/chat_v1/service.rb +396 -221
- data/lib/google/apis/chat_v1.rb +6 -0
- metadata +3 -3
@@ -29,9 +29,9 @@ module Google
|
|
29
29
|
include Google::Apis::Core::Hashable
|
30
30
|
|
31
31
|
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
32
|
-
# see [
|
33
|
-
# Google Workspace Add-ons and Chat apps]
|
34
|
-
# workspace/extend):
|
32
|
+
# see [Add a button](https://developers.google.com/workspace/chat/design-
|
33
|
+
# interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps]
|
34
|
+
# (https://developers.google.com/workspace/extend):
|
35
35
|
# Corresponds to the JSON property `buttonList`
|
36
36
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
37
37
|
attr_accessor :button_list
|
@@ -78,7 +78,7 @@ module Google
|
|
78
78
|
class ActionResponse
|
79
79
|
include Google::Apis::Core::Hashable
|
80
80
|
|
81
|
-
# Contains a [dialog](https://developers.google.com/chat/
|
81
|
+
# Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and
|
82
82
|
# request status code.
|
83
83
|
# Corresponds to the JSON property `dialogAction`
|
84
84
|
# @return [Google::Apis::ChatV1::DialogAction]
|
@@ -115,7 +115,7 @@ module Google
|
|
115
115
|
end
|
116
116
|
|
117
117
|
# Represents the status for a request to either invoke or submit a [dialog](
|
118
|
-
# https://developers.google.com/chat/
|
118
|
+
# https://developers.google.com/workspace/chat/dialogs).
|
119
119
|
class ActionStatus
|
120
120
|
include Google::Apis::Core::Hashable
|
121
121
|
|
@@ -143,11 +143,12 @@ module Google
|
|
143
143
|
|
144
144
|
# Output only. Annotations associated with the plain-text body of the message.
|
145
145
|
# To add basic formatting to a text message, see [Format text messages](https://
|
146
|
-
# developers.google.com/chat/format-messages). Example plain-text
|
147
|
-
#
|
148
|
-
# "annotations":[` "type":"USER_MENTION", "startIndex":
|
149
|
-
# userMention": ` "user": ` "name":"users/`user`", "displayName":
|
150
|
-
# avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" `, "type":"MENTION"
|
146
|
+
# developers.google.com/workspace/chat/format-messages). Example plain-text
|
147
|
+
# message body: ``` Hello @FooBot how are you!" ``` The corresponding
|
148
|
+
# annotations metadata: ``` "annotations":[` "type":"USER_MENTION", "startIndex":
|
149
|
+
# 6, "length":7, "userMention": ` "user": ` "name":"users/`user`", "displayName":
|
150
|
+
# "FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" `, "type":"MENTION"
|
151
|
+
# ` `] ```
|
151
152
|
class Annotation
|
152
153
|
include Google::Apis::Core::Hashable
|
153
154
|
|
@@ -221,8 +222,7 @@ module Google
|
|
221
222
|
class Attachment
|
222
223
|
include Google::Apis::Core::Hashable
|
223
224
|
|
224
|
-
# A reference to the attachment data.
|
225
|
-
# download the attachment data.
|
225
|
+
# A reference to the attachment data.
|
226
226
|
# Corresponds to the JSON property `attachmentDataRef`
|
227
227
|
# @return [Google::Apis::ChatV1::AttachmentDataRef]
|
228
228
|
attr_accessor :attachment_data_ref
|
@@ -284,7 +284,7 @@ module Google
|
|
284
284
|
end
|
285
285
|
end
|
286
286
|
|
287
|
-
#
|
287
|
+
# A reference to the attachment data.
|
288
288
|
class AttachmentDataRef
|
289
289
|
include Google::Apis::Core::Hashable
|
290
290
|
|
@@ -440,11 +440,11 @@ module Google
|
|
440
440
|
end
|
441
441
|
end
|
442
442
|
|
443
|
-
# A [card](https://developers.google.com/chat/api/reference/rest/v1/
|
444
|
-
# Google Chat message. Only Chat apps can create cards. If your Chat
|
445
|
-
# authenticates as a user](https://developers.google.com/chat/
|
446
|
-
#
|
447
|
-
# google.com/uikit/builder)
|
443
|
+
# A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/
|
444
|
+
# cards) in a Google Chat message. Only Chat apps can create cards. If your Chat
|
445
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
446
|
+
# authenticate-authorize-chat-user), the message can't contain cards. [Card
|
447
|
+
# builder](https://addons.gsuite.google.com/uikit/builder)
|
448
448
|
class CardWithId
|
449
449
|
include Google::Apis::Core::Hashable
|
450
450
|
|
@@ -453,25 +453,25 @@ module Google
|
|
453
453
|
# rich media like images. Use cards to present detailed information, gather
|
454
454
|
# information from users, and guide users to take a next step. [Card builder](
|
455
455
|
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
456
|
-
# see the following documentation: * For Google Chat apps, see [Design
|
457
|
-
#
|
458
|
-
#
|
459
|
-
# developers.google.com/apps-script/add-ons/concepts/
|
460
|
-
# message for a Google Chat app** ![Example contact card]
|
461
|
-
# google.com/chat/images/card_api_reference.png)
|
462
|
-
# message in Google Chat, use the following JSON: ``` `
|
463
|
-
# "unique-card-id", "card": ` "header": ` "title": "
|
464
|
-
# Software Engineer", "imageUrl": "https://developers.
|
465
|
-
# quickstart-app-avatar.png", "imageType": "
|
466
|
-
# Sasha" `, "sections": [ ` "header": "
|
467
|
-
#
|
468
|
-
# "
|
469
|
-
# "
|
470
|
-
# : ` "
|
471
|
-
#
|
472
|
-
#
|
473
|
-
# "
|
474
|
-
# ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
456
|
+
# see the following documentation: * For Google Chat apps, see [Design the
|
457
|
+
# components of a card or dialog](https://developers.google.com/workspace/chat/
|
458
|
+
# design-components-card-dialog). * For Google Workspace Add-ons, see [Card-
|
459
|
+
# based interfaces](https://developers.google.com/apps-script/add-ons/concepts/
|
460
|
+
# cards). **Example: Card message for a Google Chat app** ![Example contact card]
|
461
|
+
# (https://developers.google.com/workspace/chat/images/card_api_reference.png)
|
462
|
+
# To create the sample card message in Google Chat, use the following JSON: ``` `
|
463
|
+
# "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "
|
464
|
+
# Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.
|
465
|
+
# google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "
|
466
|
+
# CIRCLE", "imageAltText": "Avatar for Sasha" `, "sections": [ ` "header": "
|
467
|
+
# Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets":
|
468
|
+
# [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL" `, "text": "sasha@
|
469
|
+
# example.com" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON" `,
|
470
|
+
# "text": "Online" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PHONE"
|
471
|
+
# `, "text": "+1 (555) 555-1234" ` `, ` "buttonList": ` "buttons": [ ` "text": "
|
472
|
+
# Share", "onClick": ` "openLink": ` "url": "https://example.com/share" ` ` `, `
|
473
|
+
# "text": "Edit", "onClick": ` "action": ` "function": "goToView", "parameters":
|
474
|
+
# [ ` "key": "viewType", "value": "EDIT" ` ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
475
475
|
# Corresponds to the JSON property `card`
|
476
476
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
477
477
|
attr_accessor :card
|
@@ -728,7 +728,7 @@ module Google
|
|
728
728
|
end
|
729
729
|
end
|
730
730
|
|
731
|
-
#
|
731
|
+
# Response message for completing the import process for a space.
|
732
732
|
class CompleteImportSpaceResponse
|
733
733
|
include Google::Apis::Core::Hashable
|
734
734
|
|
@@ -752,7 +752,7 @@ module Google
|
|
752
752
|
class CustomEmoji
|
753
753
|
include Google::Apis::Core::Hashable
|
754
754
|
|
755
|
-
# Unique key for the custom emoji resource.
|
755
|
+
# Output only. Unique key for the custom emoji resource.
|
756
756
|
# Corresponds to the JSON property `uid`
|
757
757
|
# @return [String]
|
758
758
|
attr_accessor :uid
|
@@ -868,12 +868,12 @@ module Google
|
|
868
868
|
# The URL the Chat app should redirect the user to after they have completed an
|
869
869
|
# authorization or configuration flow outside of Google Chat. For more
|
870
870
|
# information, see [Connect a Chat app with other services & tools](https://
|
871
|
-
# developers.google.com/chat/
|
871
|
+
# developers.google.com/workspace/chat/connect-web-services-tools).
|
872
872
|
# Corresponds to the JSON property `configCompleteRedirectUrl`
|
873
873
|
# @return [String]
|
874
874
|
attr_accessor :config_complete_redirect_url
|
875
875
|
|
876
|
-
# The type of [dialog](https://developers.google.com/chat/
|
876
|
+
# The type of [dialog](https://developers.google.com/workspace/chat/dialogs)
|
877
877
|
# interaction event received.
|
878
878
|
# Corresponds to the JSON property `dialogEventType`
|
879
879
|
# @return [String]
|
@@ -884,8 +884,9 @@ module Google
|
|
884
884
|
# @return [String]
|
885
885
|
attr_accessor :event_time
|
886
886
|
|
887
|
-
# For `CARD_CLICKED` interaction events, whether the user
|
888
|
-
# dialog](https://developers.
|
887
|
+
# For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is
|
888
|
+
# interacting with or about to interact with a [dialog](https://developers.
|
889
|
+
# google.com/workspace/chat/dialogs).
|
889
890
|
# Corresponds to the JSON property `isDialogEvent`
|
890
891
|
# @return [Boolean]
|
891
892
|
attr_accessor :is_dialog_event
|
@@ -927,9 +928,9 @@ module Google
|
|
927
928
|
attr_accessor :type
|
928
929
|
|
929
930
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
930
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
931
|
-
#
|
932
|
-
# and `type`.
|
931
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
932
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
933
|
+
# populates the user's `name` and `type`.
|
933
934
|
# Corresponds to the JSON property `user`
|
934
935
|
# @return [Google::Apis::ChatV1::User]
|
935
936
|
attr_accessor :user
|
@@ -964,25 +965,25 @@ module Google
|
|
964
965
|
# rich media like images. Use cards to present detailed information, gather
|
965
966
|
# information from users, and guide users to take a next step. [Card builder](
|
966
967
|
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
967
|
-
# see the following documentation: * For Google Chat apps, see [Design
|
968
|
-
#
|
969
|
-
#
|
970
|
-
# developers.google.com/apps-script/add-ons/concepts/
|
971
|
-
# message for a Google Chat app** ![Example contact card]
|
972
|
-
# google.com/chat/images/card_api_reference.png)
|
973
|
-
# message in Google Chat, use the following JSON: ``` `
|
974
|
-
# "unique-card-id", "card": ` "header": ` "title": "
|
975
|
-
# Software Engineer", "imageUrl": "https://developers.
|
976
|
-
# quickstart-app-avatar.png", "imageType": "
|
977
|
-
# Sasha" `, "sections": [ ` "header": "
|
978
|
-
#
|
979
|
-
# "
|
980
|
-
# "
|
981
|
-
# : ` "
|
982
|
-
#
|
983
|
-
#
|
984
|
-
# "
|
985
|
-
# ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
968
|
+
# see the following documentation: * For Google Chat apps, see [Design the
|
969
|
+
# components of a card or dialog](https://developers.google.com/workspace/chat/
|
970
|
+
# design-components-card-dialog). * For Google Workspace Add-ons, see [Card-
|
971
|
+
# based interfaces](https://developers.google.com/apps-script/add-ons/concepts/
|
972
|
+
# cards). **Example: Card message for a Google Chat app** ![Example contact card]
|
973
|
+
# (https://developers.google.com/workspace/chat/images/card_api_reference.png)
|
974
|
+
# To create the sample card message in Google Chat, use the following JSON: ``` `
|
975
|
+
# "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "
|
976
|
+
# Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.
|
977
|
+
# google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "
|
978
|
+
# CIRCLE", "imageAltText": "Avatar for Sasha" `, "sections": [ ` "header": "
|
979
|
+
# Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets":
|
980
|
+
# [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL" `, "text": "sasha@
|
981
|
+
# example.com" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON" `,
|
982
|
+
# "text": "Online" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PHONE"
|
983
|
+
# `, "text": "+1 (555) 555-1234" ` `, ` "buttonList": ` "buttons": [ ` "text": "
|
984
|
+
# Share", "onClick": ` "openLink": ` "url": "https://example.com/share" ` ` `, `
|
985
|
+
# "text": "Edit", "onClick": ` "action": ` "function": "goToView", "parameters":
|
986
|
+
# [ ` "key": "viewType", "value": "EDIT" ` ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
986
987
|
# Corresponds to the JSON property `body`
|
987
988
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
988
989
|
attr_accessor :body
|
@@ -997,13 +998,13 @@ module Google
|
|
997
998
|
end
|
998
999
|
end
|
999
1000
|
|
1000
|
-
# Contains a [dialog](https://developers.google.com/chat/
|
1001
|
+
# Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and
|
1001
1002
|
# request status code.
|
1002
1003
|
class DialogAction
|
1003
1004
|
include Google::Apis::Core::Hashable
|
1004
1005
|
|
1005
1006
|
# Represents the status for a request to either invoke or submit a [dialog](
|
1006
|
-
# https://developers.google.com/chat/
|
1007
|
+
# https://developers.google.com/workspace/chat/dialogs).
|
1007
1008
|
# Corresponds to the JSON property `actionStatus`
|
1008
1009
|
# @return [Google::Apis::ChatV1::ActionStatus]
|
1009
1010
|
attr_accessor :action_status
|
@@ -1170,20 +1171,20 @@ module Google
|
|
1170
1171
|
class GoogleAppsCardV1Action
|
1171
1172
|
include Google::Apis::Core::Hashable
|
1172
1173
|
|
1173
|
-
# A custom function to invoke when the containing element is clicked or
|
1174
|
-
# activated. For example usage, see [
|
1175
|
-
# developers.google.com/chat/
|
1174
|
+
# A custom function to invoke when the containing element is clicked or
|
1175
|
+
# otherwise activated. For example usage, see [Read form data](https://
|
1176
|
+
# developers.google.com/workspace/chat/read-form-data).
|
1176
1177
|
# Corresponds to the JSON property `function`
|
1177
1178
|
# @return [String]
|
1178
1179
|
attr_accessor :function
|
1179
1180
|
|
1180
|
-
# Optional. Required when opening a [dialog](https://developers.google.com/
|
1181
|
-
#
|
1182
|
-
# as a user clicking a button in a card message. If unspecified, the app
|
1181
|
+
# Optional. Required when opening a [dialog](https://developers.google.com/
|
1182
|
+
# workspace/chat/dialogs). What to do in response to an interaction with a user,
|
1183
|
+
# such as a user clicking a button in a card message. If unspecified, the app
|
1183
1184
|
# responds by executing an `action`—like opening a link or running a function—as
|
1184
1185
|
# normal. By specifying an `interaction`, the app can respond in special
|
1185
1186
|
# interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the
|
1186
|
-
# app can open a [dialog](https://developers.google.com/chat/
|
1187
|
+
# app can open a [dialog](https://developers.google.com/workspace/chat/dialogs).
|
1187
1188
|
# When specified, a loading indicator isn't shown. If specified for an add-on,
|
1188
1189
|
# the entire card is stripped and nothing is shown in the client. [Google Chat
|
1189
1190
|
# apps](https://developers.google.com/workspace/chat):
|
@@ -1207,15 +1208,16 @@ module Google
|
|
1207
1208
|
# the user make changes while the action is being processed, set [`LoadIndicator`
|
1208
1209
|
# ](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.
|
1209
1210
|
# card.v1#loadindicator) to `NONE`. For [card messages](https://developers.
|
1210
|
-
# google.com/chat/api/guides/v1/messages/create#create) in Chat apps,
|
1211
|
-
# also set the action's [`ResponseType`](https://developers.google.com/
|
1212
|
-
# reference/rest/v1/spaces.messages#responsetype) to `
|
1213
|
-
# the same [`card_id`](https://developers.google.com/
|
1214
|
-
# spaces.messages#CardWithId) from the card
|
1215
|
-
#
|
1216
|
-
# user from making changes while the action
|
1217
|
-
# LoadIndicator`](https://developers.google.com/
|
1218
|
-
# google.apps.card.v1#loadindicator) to `SPINNER
|
1211
|
+
# google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps,
|
1212
|
+
# you must also set the action's [`ResponseType`](https://developers.google.com/
|
1213
|
+
# workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `
|
1214
|
+
# UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/
|
1215
|
+
# workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card
|
1216
|
+
# that contained the action. If `false`, the form values are cleared when the
|
1217
|
+
# action is triggered. To prevent the user from making changes while the action
|
1218
|
+
# is being processed, set [`LoadIndicator`](https://developers.google.com/
|
1219
|
+
# workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`
|
1220
|
+
# .
|
1219
1221
|
# Corresponds to the JSON property `persistValues`
|
1220
1222
|
# @return [Boolean]
|
1221
1223
|
attr_accessor :persist_values
|
@@ -1239,9 +1241,9 @@ module Google
|
|
1239
1241
|
# example, consider three snooze buttons: snooze now, snooze one day, or snooze
|
1240
1242
|
# next week. You might use `action method = snooze()`, passing the snooze type
|
1241
1243
|
# and snooze time in the list of string parameters. To learn more, see [`
|
1242
|
-
# CommonEventObject`](https://developers.google.com/chat/api/reference/
|
1243
|
-
# Event#commoneventobject). [Google Workspace Add-ons and Chat apps](
|
1244
|
-
# developers.google.com/workspace/extend):
|
1244
|
+
# CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/
|
1245
|
+
# rest/v1/Event#commoneventobject). [Google Workspace Add-ons and Chat apps](
|
1246
|
+
# https://developers.google.com/workspace/extend):
|
1245
1247
|
class GoogleAppsCardV1ActionParameter
|
1246
1248
|
include Google::Apis::Core::Hashable
|
1247
1249
|
|
@@ -1344,17 +1346,19 @@ module Google
|
|
1344
1346
|
end
|
1345
1347
|
|
1346
1348
|
# A text, icon, or text and icon button that users can click. For an example in
|
1347
|
-
# Google Chat apps, see [
|
1348
|
-
#
|
1349
|
-
# not an `ImageComponent`) and set an `
|
1350
|
-
# ons and Chat apps](https://developers.
|
1349
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1350
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1351
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1352
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1353
|
+
# google.com/workspace/extend):
|
1351
1354
|
class GoogleAppsCardV1Button
|
1352
1355
|
include Google::Apis::Core::Hashable
|
1353
1356
|
|
1354
1357
|
# The alternative text that's used for accessibility. Set descriptive text that
|
1355
1358
|
# lets users know what the button does. For example, if a button opens a
|
1356
1359
|
# hyperlink, you might write: "Opens a new browser tab and navigates to the
|
1357
|
-
# Google Chat developer documentation at https://developers.google.com/
|
1360
|
+
# Google Chat developer documentation at https://developers.google.com/workspace/
|
1361
|
+
# chat".
|
1358
1362
|
# Corresponds to the JSON property `altText`
|
1359
1363
|
# @return [String]
|
1360
1364
|
attr_accessor :alt_text
|
@@ -1416,11 +1420,12 @@ module Google
|
|
1416
1420
|
alias_method :disabled?, :disabled
|
1417
1421
|
|
1418
1422
|
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
1419
|
-
# see [
|
1420
|
-
# built-in](https://developers.google.com/
|
1421
|
-
#
|
1422
|
-
#
|
1423
|
-
# workspace/
|
1423
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1424
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1425
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1426
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1427
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1428
|
+
# extend):
|
1424
1429
|
# Corresponds to the JSON property `icon`
|
1425
1430
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1426
1431
|
attr_accessor :icon
|
@@ -1453,9 +1458,9 @@ module Google
|
|
1453
1458
|
end
|
1454
1459
|
|
1455
1460
|
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
1456
|
-
# see [
|
1457
|
-
# Google Workspace Add-ons and Chat apps]
|
1458
|
-
# workspace/extend):
|
1461
|
+
# see [Add a button](https://developers.google.com/workspace/chat/design-
|
1462
|
+
# interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps]
|
1463
|
+
# (https://developers.google.com/workspace/extend):
|
1459
1464
|
class GoogleAppsCardV1ButtonList
|
1460
1465
|
include Google::Apis::Core::Hashable
|
1461
1466
|
|
@@ -1479,25 +1484,25 @@ module Google
|
|
1479
1484
|
# rich media like images. Use cards to present detailed information, gather
|
1480
1485
|
# information from users, and guide users to take a next step. [Card builder](
|
1481
1486
|
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
1482
|
-
# see the following documentation: * For Google Chat apps, see [Design
|
1483
|
-
#
|
1484
|
-
#
|
1485
|
-
# developers.google.com/apps-script/add-ons/concepts/
|
1486
|
-
# message for a Google Chat app** ![Example contact card]
|
1487
|
-
# google.com/chat/images/card_api_reference.png)
|
1488
|
-
# message in Google Chat, use the following JSON: ``` `
|
1489
|
-
# "unique-card-id", "card": ` "header": ` "title": "
|
1490
|
-
# Software Engineer", "imageUrl": "https://developers.
|
1491
|
-
# quickstart-app-avatar.png", "imageType": "
|
1492
|
-
# Sasha" `, "sections": [ ` "header": "
|
1493
|
-
#
|
1494
|
-
# "
|
1495
|
-
# "
|
1496
|
-
# : ` "
|
1497
|
-
#
|
1498
|
-
#
|
1499
|
-
# "
|
1500
|
-
# ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
1487
|
+
# see the following documentation: * For Google Chat apps, see [Design the
|
1488
|
+
# components of a card or dialog](https://developers.google.com/workspace/chat/
|
1489
|
+
# design-components-card-dialog). * For Google Workspace Add-ons, see [Card-
|
1490
|
+
# based interfaces](https://developers.google.com/apps-script/add-ons/concepts/
|
1491
|
+
# cards). **Example: Card message for a Google Chat app** ![Example contact card]
|
1492
|
+
# (https://developers.google.com/workspace/chat/images/card_api_reference.png)
|
1493
|
+
# To create the sample card message in Google Chat, use the following JSON: ``` `
|
1494
|
+
# "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "
|
1495
|
+
# Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.
|
1496
|
+
# google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "
|
1497
|
+
# CIRCLE", "imageAltText": "Avatar for Sasha" `, "sections": [ ` "header": "
|
1498
|
+
# Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets":
|
1499
|
+
# [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL" `, "text": "sasha@
|
1500
|
+
# example.com" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON" `,
|
1501
|
+
# "text": "Online" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PHONE"
|
1502
|
+
# `, "text": "+1 (555) 555-1234" ` `, ` "buttonList": ` "buttons": [ ` "text": "
|
1503
|
+
# Share", "onClick": ` "openLink": ` "url": "https://example.com/share" ` ` `, `
|
1504
|
+
# "text": "Edit", "onClick": ` "action": ` "function": "goToView", "parameters":
|
1505
|
+
# [ ` "key": "viewType", "value": "EDIT" ` ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
1501
1506
|
class GoogleAppsCardV1Card
|
1502
1507
|
include Google::Apis::Core::Hashable
|
1503
1508
|
|
@@ -1523,18 +1528,20 @@ module Google
|
|
1523
1528
|
# A persistent (sticky) footer that that appears at the bottom of the card.
|
1524
1529
|
# Setting `fixedFooter` without specifying a `primaryButton` or a `
|
1525
1530
|
# secondaryButton` causes an error. For Chat apps, you can use fixed footers in [
|
1526
|
-
# dialogs](https://developers.google.com/chat/
|
1527
|
-
# messages](https://developers.google.com/chat/
|
1528
|
-
#
|
1529
|
-
# developers.google.com/chat/
|
1530
|
-
# Add-ons and Chat apps](https://
|
1531
|
+
# dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card
|
1532
|
+
# messages](https://developers.google.com/workspace/chat/create-messages#create).
|
1533
|
+
# For an example in Google Chat apps, see [Add a persistent footer](https://
|
1534
|
+
# developers.google.com/workspace/chat/design-components-card-dialog#
|
1535
|
+
# add_a_persistent_footer). [Google Workspace Add-ons and Chat apps](https://
|
1536
|
+
# developers.google.com/workspace/extend):
|
1531
1537
|
# Corresponds to the JSON property `fixedFooter`
|
1532
1538
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardFixedFooter]
|
1533
1539
|
attr_accessor :fixed_footer
|
1534
1540
|
|
1535
|
-
# Represents a card header. For an example in Google Chat apps, see [
|
1536
|
-
# (https://developers.google.com/chat/
|
1537
|
-
# Add-ons and Chat apps](https://
|
1541
|
+
# Represents a card header. For an example in Google Chat apps, see [Add a
|
1542
|
+
# header](https://developers.google.com/workspace/chat/design-components-card-
|
1543
|
+
# dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://
|
1544
|
+
# developers.google.com/workspace/extend):
|
1538
1545
|
# Corresponds to the JSON property `header`
|
1539
1546
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
1540
1547
|
attr_accessor :header
|
@@ -1545,9 +1552,10 @@ module Google
|
|
1545
1552
|
# @return [String]
|
1546
1553
|
attr_accessor :name
|
1547
1554
|
|
1548
|
-
# Represents a card header. For an example in Google Chat apps, see [
|
1549
|
-
# (https://developers.google.com/chat/
|
1550
|
-
# Add-ons and Chat apps](https://
|
1555
|
+
# Represents a card header. For an example in Google Chat apps, see [Add a
|
1556
|
+
# header](https://developers.google.com/workspace/chat/design-components-card-
|
1557
|
+
# dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://
|
1558
|
+
# developers.google.com/workspace/extend):
|
1551
1559
|
# Corresponds to the JSON property `peekCardHeader`
|
1552
1560
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
1553
1561
|
attr_accessor :peek_card_header
|
@@ -1559,8 +1567,8 @@ module Google
|
|
1559
1567
|
|
1560
1568
|
# Contains a collection of widgets. Each section has its own, optional header.
|
1561
1569
|
# Sections are visually separated by a line divider. For an example in Google
|
1562
|
-
# Chat apps, see [
|
1563
|
-
# card-
|
1570
|
+
# Chat apps, see [Define a section of a card](https://developers.google.com/
|
1571
|
+
# workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
|
1564
1572
|
# Corresponds to the JSON property `sections`
|
1565
1573
|
# @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1Section>]
|
1566
1574
|
attr_accessor :sections
|
@@ -1615,28 +1623,31 @@ module Google
|
|
1615
1623
|
# A persistent (sticky) footer that that appears at the bottom of the card.
|
1616
1624
|
# Setting `fixedFooter` without specifying a `primaryButton` or a `
|
1617
1625
|
# secondaryButton` causes an error. For Chat apps, you can use fixed footers in [
|
1618
|
-
# dialogs](https://developers.google.com/chat/
|
1619
|
-
# messages](https://developers.google.com/chat/
|
1620
|
-
#
|
1621
|
-
# developers.google.com/chat/
|
1622
|
-
# Add-ons and Chat apps](https://
|
1626
|
+
# dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card
|
1627
|
+
# messages](https://developers.google.com/workspace/chat/create-messages#create).
|
1628
|
+
# For an example in Google Chat apps, see [Add a persistent footer](https://
|
1629
|
+
# developers.google.com/workspace/chat/design-components-card-dialog#
|
1630
|
+
# add_a_persistent_footer). [Google Workspace Add-ons and Chat apps](https://
|
1631
|
+
# developers.google.com/workspace/extend):
|
1623
1632
|
class GoogleAppsCardV1CardFixedFooter
|
1624
1633
|
include Google::Apis::Core::Hashable
|
1625
1634
|
|
1626
1635
|
# A text, icon, or text and icon button that users can click. For an example in
|
1627
|
-
# Google Chat apps, see [
|
1628
|
-
#
|
1629
|
-
# not an `ImageComponent`) and set an `
|
1630
|
-
# ons and Chat apps](https://developers.
|
1636
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1637
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1638
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1639
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1640
|
+
# google.com/workspace/extend):
|
1631
1641
|
# Corresponds to the JSON property `primaryButton`
|
1632
1642
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
1633
1643
|
attr_accessor :primary_button
|
1634
1644
|
|
1635
1645
|
# A text, icon, or text and icon button that users can click. For an example in
|
1636
|
-
# Google Chat apps, see [
|
1637
|
-
#
|
1638
|
-
# not an `ImageComponent`) and set an `
|
1639
|
-
# ons and Chat apps](https://developers.
|
1646
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1647
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1648
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1649
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1650
|
+
# google.com/workspace/extend):
|
1640
1651
|
# Corresponds to the JSON property `secondaryButton`
|
1641
1652
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
1642
1653
|
attr_accessor :secondary_button
|
@@ -1652,9 +1663,10 @@ module Google
|
|
1652
1663
|
end
|
1653
1664
|
end
|
1654
1665
|
|
1655
|
-
# Represents a card header. For an example in Google Chat apps, see [
|
1656
|
-
# (https://developers.google.com/chat/
|
1657
|
-
# Add-ons and Chat apps](https://
|
1666
|
+
# Represents a card header. For an example in Google Chat apps, see [Add a
|
1667
|
+
# header](https://developers.google.com/workspace/chat/design-components-card-
|
1668
|
+
# dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://
|
1669
|
+
# developers.google.com/workspace/extend):
|
1658
1670
|
class GoogleAppsCardV1CardHeader
|
1659
1671
|
include Google::Apis::Core::Hashable
|
1660
1672
|
|
@@ -1743,8 +1755,9 @@ module Google
|
|
1743
1755
|
|
1744
1756
|
# The `Columns` widget displays up to 2 columns in a card or dialog. You can add
|
1745
1757
|
# widgets to each column; the widgets appear in the order that they are
|
1746
|
-
# specified. For an example in Google Chat apps, see [
|
1747
|
-
# developers.google.com/chat/
|
1758
|
+
# specified. For an example in Google Chat apps, see [Display cards and dialogs
|
1759
|
+
# in columns](https://developers.google.com/workspace/chat/format-structure-card-
|
1760
|
+
# dialog#display_cards_and_dialogs_in_columns). The height of each column is
|
1748
1761
|
# determined by the taller column. For example, if the first column is taller
|
1749
1762
|
# than the second column, both columns have the height of the first column.
|
1750
1763
|
# Because each column can contain a different number of widgets, you can't
|
@@ -1778,11 +1791,13 @@ module Google
|
|
1778
1791
|
end
|
1779
1792
|
|
1780
1793
|
# Lets users input a date, a time, or both a date and a time. For an example in
|
1781
|
-
# Google Chat apps, see [
|
1782
|
-
#
|
1783
|
-
#
|
1784
|
-
#
|
1785
|
-
#
|
1794
|
+
# Google Chat apps, see [Let a user pick a date and time](https://developers.
|
1795
|
+
# google.com/workspace/chat/design-interactive-card-dialog#
|
1796
|
+
# let_a_user_pick_a_date_and_time). Users can input text or use the picker to
|
1797
|
+
# select dates and times. If users input an invalid date or time, the picker
|
1798
|
+
# shows an error that prompts users to input the information correctly. [Google
|
1799
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1800
|
+
# extend):
|
1786
1801
|
class GoogleAppsCardV1DateTimePicker
|
1787
1802
|
include Google::Apis::Core::Hashable
|
1788
1803
|
|
@@ -1795,7 +1810,7 @@ module Google
|
|
1795
1810
|
|
1796
1811
|
# The name by which the `DateTimePicker` is identified in a form input event.
|
1797
1812
|
# For details about working with form inputs, see [Receive form data](https://
|
1798
|
-
# developers.google.com/chat/
|
1813
|
+
# developers.google.com/workspace/chat/read-form-data).
|
1799
1814
|
# Corresponds to the JSON property `name`
|
1800
1815
|
# @return [String]
|
1801
1816
|
attr_accessor :name
|
@@ -1849,9 +1864,10 @@ module Google
|
|
1849
1864
|
|
1850
1865
|
# A widget that displays text with optional decorations such as a label above or
|
1851
1866
|
# below the text, an icon in front of the text, a selection widget, or a button
|
1852
|
-
# after the text. For an example in Google Chat apps, see [
|
1853
|
-
#
|
1854
|
-
#
|
1867
|
+
# after the text. For an example in Google Chat apps, see [Display text with
|
1868
|
+
# decorative text](https://developers.google.com/workspace/chat/add-text-image-
|
1869
|
+
# card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons
|
1870
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
1855
1871
|
class GoogleAppsCardV1DecoratedText
|
1856
1872
|
include Google::Apis::Core::Hashable
|
1857
1873
|
|
@@ -1861,30 +1877,33 @@ module Google
|
|
1861
1877
|
attr_accessor :bottom_label
|
1862
1878
|
|
1863
1879
|
# A text, icon, or text and icon button that users can click. For an example in
|
1864
|
-
# Google Chat apps, see [
|
1865
|
-
#
|
1866
|
-
# not an `ImageComponent`) and set an `
|
1867
|
-
# ons and Chat apps](https://developers.
|
1880
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1881
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1882
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1883
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1884
|
+
# google.com/workspace/extend):
|
1868
1885
|
# Corresponds to the JSON property `button`
|
1869
1886
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
1870
1887
|
attr_accessor :button
|
1871
1888
|
|
1872
1889
|
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
1873
|
-
# see [
|
1874
|
-
# built-in](https://developers.google.com/
|
1875
|
-
#
|
1876
|
-
#
|
1877
|
-
# workspace/
|
1890
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1891
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1892
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1893
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1894
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1895
|
+
# extend):
|
1878
1896
|
# Corresponds to the JSON property `endIcon`
|
1879
1897
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1880
1898
|
attr_accessor :end_icon
|
1881
1899
|
|
1882
1900
|
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
1883
|
-
# see [
|
1884
|
-
# built-in](https://developers.google.com/
|
1885
|
-
#
|
1886
|
-
#
|
1887
|
-
# workspace/
|
1901
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1902
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1903
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1904
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1905
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1906
|
+
# extend):
|
1888
1907
|
# Corresponds to the JSON property `icon`
|
1889
1908
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1890
1909
|
attr_accessor :icon
|
@@ -1897,11 +1916,12 @@ module Google
|
|
1897
1916
|
attr_accessor :on_click
|
1898
1917
|
|
1899
1918
|
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
1900
|
-
# see [
|
1901
|
-
# built-in](https://developers.google.com/
|
1902
|
-
#
|
1903
|
-
#
|
1904
|
-
# workspace/
|
1919
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1920
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1921
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1922
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1923
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1924
|
+
# extend):
|
1905
1925
|
# Corresponds to the JSON property `startIcon`
|
1906
1926
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1907
1927
|
attr_accessor :start_icon
|
@@ -1915,9 +1935,9 @@ module Google
|
|
1915
1935
|
|
1916
1936
|
# Required. The primary text. Supports simple formatting. For more information
|
1917
1937
|
# about formatting text, see [Formatting text in Google Chat apps](https://
|
1918
|
-
# developers.google.com/chat/format-messages#card-formatting) and [
|
1919
|
-
# text in Google Workspace Add-ons](https://developers.google.com/
|
1920
|
-
# add-ons/concepts/widgets#text_formatting).
|
1938
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
1939
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
1940
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
1921
1941
|
# Corresponds to the JSON property `text`
|
1922
1942
|
# @return [String]
|
1923
1943
|
attr_accessor :text
|
@@ -1955,10 +1975,11 @@ module Google
|
|
1955
1975
|
end
|
1956
1976
|
|
1957
1977
|
# Displays a divider between widgets as a horizontal line. For an example in
|
1958
|
-
# Google Chat apps, see [
|
1959
|
-
#
|
1960
|
-
#
|
1961
|
-
#
|
1978
|
+
# Google Chat apps, see [Add a horizontal divider between widgets](https://
|
1979
|
+
# developers.google.com/workspace/chat/format-structure-card-dialog#
|
1980
|
+
# add_a_horizontal_divider_between_widgets). [Google Workspace Add-ons and Chat
|
1981
|
+
# apps](https://developers.google.com/workspace/extend): For example, the
|
1982
|
+
# following JSON creates a divider: ``` "divider": `` ```
|
1962
1983
|
class GoogleAppsCardV1Divider
|
1963
1984
|
include Google::Apis::Core::Hashable
|
1964
1985
|
|
@@ -1973,18 +1994,19 @@ module Google
|
|
1973
1994
|
|
1974
1995
|
# Displays a grid with a collection of items. Items can only include text or
|
1975
1996
|
# images. For responsive columns, or to include more than text or images, use `
|
1976
|
-
# Columns`. For an example in Google Chat apps, see [Grid
|
1977
|
-
# google.com/chat/
|
1978
|
-
#
|
1979
|
-
#
|
1980
|
-
#
|
1981
|
-
#
|
1982
|
-
#
|
1983
|
-
#
|
1984
|
-
#
|
1985
|
-
#
|
1986
|
-
#
|
1987
|
-
#
|
1997
|
+
# Columns`. For an example in Google Chat apps, see [Display a Grid with a
|
1998
|
+
# collection of items](https://developers.google.com/workspace/chat/format-
|
1999
|
+
# structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid
|
2000
|
+
# supports any number of columns and items. The number of rows is determined by
|
2001
|
+
# items divided by columns. A grid with 10 items and 2 columns has 5 rows. A
|
2002
|
+
# grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and
|
2003
|
+
# Chat apps](https://developers.google.com/workspace/extend): For example, the
|
2004
|
+
# following JSON creates a 2 column grid with a single item: ``` "grid": ` "
|
2005
|
+
# title": "A fine collection of items", "columnCount": 2, "borderStyle": ` "type"
|
2006
|
+
# : "STROKE", "cornerRadius": 4 `, "items": [ ` "image": ` "imageUri": "https://
|
2007
|
+
# www.example.com/image.png", "cropStyle": ` "type": "SQUARE" `, "borderStyle": `
|
2008
|
+
# "type": "STROKE" ` `, "title": "An item", "textAlignment": "CENTER" ` ], "
|
2009
|
+
# onClick": ` "openLink": ` "url": "https://www.example.com" ` ` ` ```
|
1988
2010
|
class GoogleAppsCardV1Grid
|
1989
2011
|
include Google::Apis::Core::Hashable
|
1990
2012
|
|
@@ -2081,11 +2103,12 @@ module Google
|
|
2081
2103
|
end
|
2082
2104
|
|
2083
2105
|
# An icon displayed in a widget on a card. For an example in Google Chat apps,
|
2084
|
-
# see [
|
2085
|
-
# built-in](https://developers.google.com/
|
2086
|
-
#
|
2087
|
-
#
|
2088
|
-
# workspace/
|
2106
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
2107
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
2108
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
2109
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
2110
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
2111
|
+
# extend):
|
2089
2112
|
class GoogleAppsCardV1Icon
|
2090
2113
|
include Google::Apis::Core::Hashable
|
2091
2114
|
|
@@ -2094,16 +2117,16 @@ module Google
|
|
2094
2117
|
# helpful description for what the icon displays, and if applicable, what it
|
2095
2118
|
# does. For example, `A user's account portrait`, or `Opens a new browser tab
|
2096
2119
|
# and navigates to the Google Chat developer documentation at https://developers.
|
2097
|
-
# google.com/chat`. If the icon is set in a `Button`, the `altText`
|
2098
|
-
# helper text when the user hovers over the button. However, if the
|
2099
|
-
# sets `text`, the icon's `altText` is ignored.
|
2120
|
+
# google.com/workspace/chat`. If the icon is set in a `Button`, the `altText`
|
2121
|
+
# appears as helper text when the user hovers over the button. However, if the
|
2122
|
+
# button also sets `text`, the icon's `altText` is ignored.
|
2100
2123
|
# Corresponds to the JSON property `altText`
|
2101
2124
|
# @return [String]
|
2102
2125
|
attr_accessor :alt_text
|
2103
2126
|
|
2104
2127
|
# Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "
|
2105
|
-
# https://developers.google.com/chat/images/quickstart-app-avatar.png"
|
2106
|
-
# Supported file types include `.png` and `.jpg`.
|
2128
|
+
# https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"
|
2129
|
+
# ``` Supported file types include `.png` and `.jpg`.
|
2107
2130
|
# Corresponds to the JSON property `iconUrl`
|
2108
2131
|
# @return [String]
|
2109
2132
|
attr_accessor :icon_url
|
@@ -2117,7 +2140,7 @@ module Google
|
|
2117
2140
|
# Display one of the built-in icons provided by Google Workspace. For example,
|
2118
2141
|
# to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For
|
2119
2142
|
# a full list of supported icons, see [built-in icons](https://developers.google.
|
2120
|
-
# com/chat/format-messages#builtinicons).
|
2143
|
+
# com/workspace/chat/format-messages#builtinicons).
|
2121
2144
|
# Corresponds to the JSON property `knownIcon`
|
2122
2145
|
# @return [String]
|
2123
2146
|
attr_accessor :known_icon
|
@@ -2147,9 +2170,9 @@ module Google
|
|
2147
2170
|
end
|
2148
2171
|
|
2149
2172
|
# An image that is specified by a URL and can have an `onClick` action. For an
|
2150
|
-
# example, see [
|
2151
|
-
# Google Workspace Add-ons and Chat apps](
|
2152
|
-
# workspace/extend):
|
2173
|
+
# example, see [Add an image](https://developers.google.com/workspace/chat/add-
|
2174
|
+
# text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](
|
2175
|
+
# https://developers.google.com/workspace/extend):
|
2153
2176
|
class GoogleAppsCardV1Image
|
2154
2177
|
include Google::Apis::Core::Hashable
|
2155
2178
|
|
@@ -2159,7 +2182,7 @@ module Google
|
|
2159
2182
|
attr_accessor :alt_text
|
2160
2183
|
|
2161
2184
|
# The HTTPS URL that hosts the image. For example: ``` https://developers.google.
|
2162
|
-
# com/chat/images/quickstart-app-avatar.png ```
|
2185
|
+
# com/workspace/chat/images/quickstart-app-avatar.png ```
|
2163
2186
|
# Corresponds to the JSON property `imageUrl`
|
2164
2187
|
# @return [String]
|
2165
2188
|
attr_accessor :image_url
|
@@ -2330,25 +2353,25 @@ module Google
|
|
2330
2353
|
# rich media like images. Use cards to present detailed information, gather
|
2331
2354
|
# information from users, and guide users to take a next step. [Card builder](
|
2332
2355
|
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
2333
|
-
# see the following documentation: * For Google Chat apps, see [Design
|
2334
|
-
#
|
2335
|
-
#
|
2336
|
-
# developers.google.com/apps-script/add-ons/concepts/
|
2337
|
-
# message for a Google Chat app** ![Example contact card]
|
2338
|
-
# google.com/chat/images/card_api_reference.png)
|
2339
|
-
# message in Google Chat, use the following JSON: ``` `
|
2340
|
-
# "unique-card-id", "card": ` "header": ` "title": "
|
2341
|
-
# Software Engineer", "imageUrl": "https://developers.
|
2342
|
-
# quickstart-app-avatar.png", "imageType": "
|
2343
|
-
# Sasha" `, "sections": [ ` "header": "
|
2344
|
-
#
|
2345
|
-
# "
|
2346
|
-
# "
|
2347
|
-
# : ` "
|
2348
|
-
#
|
2349
|
-
#
|
2350
|
-
# "
|
2351
|
-
# ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
2356
|
+
# see the following documentation: * For Google Chat apps, see [Design the
|
2357
|
+
# components of a card or dialog](https://developers.google.com/workspace/chat/
|
2358
|
+
# design-components-card-dialog). * For Google Workspace Add-ons, see [Card-
|
2359
|
+
# based interfaces](https://developers.google.com/apps-script/add-ons/concepts/
|
2360
|
+
# cards). **Example: Card message for a Google Chat app** ![Example contact card]
|
2361
|
+
# (https://developers.google.com/workspace/chat/images/card_api_reference.png)
|
2362
|
+
# To create the sample card message in Google Chat, use the following JSON: ``` `
|
2363
|
+
# "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "
|
2364
|
+
# Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.
|
2365
|
+
# google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "
|
2366
|
+
# CIRCLE", "imageAltText": "Avatar for Sasha" `, "sections": [ ` "header": "
|
2367
|
+
# Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets":
|
2368
|
+
# [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL" `, "text": "sasha@
|
2369
|
+
# example.com" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON" `,
|
2370
|
+
# "text": "Online" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PHONE"
|
2371
|
+
# `, "text": "+1 (555) 555-1234" ` `, ` "buttonList": ` "buttons": [ ` "text": "
|
2372
|
+
# Share", "onClick": ` "openLink": ` "url": "https://example.com/share" ` ` `, `
|
2373
|
+
# "text": "Edit", "onClick": ` "action": ` "function": "goToView", "parameters":
|
2374
|
+
# [ ` "key": "viewType", "value": "EDIT" ` ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
2352
2375
|
# Corresponds to the JSON property `card`
|
2353
2376
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
2354
2377
|
attr_accessor :card
|
@@ -2464,9 +2487,9 @@ module Google
|
|
2464
2487
|
|
2465
2488
|
# Text that appears at the top of a section. Supports simple HTML formatted text.
|
2466
2489
|
# For more information about formatting text, see [Formatting text in Google
|
2467
|
-
# Chat apps](https://developers.google.com/chat/format-messages#card-
|
2468
|
-
# and [Formatting text in Google Workspace Add-ons](https://
|
2469
|
-
# com/apps-script/add-ons/concepts/widgets#text_formatting).
|
2490
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
2491
|
+
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
2492
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
2470
2493
|
# Corresponds to the JSON property `header`
|
2471
2494
|
# @return [String]
|
2472
2495
|
attr_accessor :header
|
@@ -2501,13 +2524,14 @@ module Google
|
|
2501
2524
|
|
2502
2525
|
# A widget that creates one or more UI items that users can select. For example,
|
2503
2526
|
# a dropdown menu or checkboxes. You can use this widget to collect data that
|
2504
|
-
# can be predicted or enumerated. For an example in Google Chat apps, see [
|
2505
|
-
#
|
2506
|
-
# . Chat apps can process the value of items that
|
2507
|
-
# details about working with form inputs, see [
|
2508
|
-
# developers.google.com/chat/
|
2509
|
-
# abstract data from users, use the TextInput widget. [
|
2510
|
-
# and Chat apps](https://developers.google.com/
|
2527
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [Add
|
2528
|
+
# selectable UI elements](/workspace/chat/design-interactive-card-dialog#
|
2529
|
+
# add_selectable_ui_elements). Chat apps can process the value of items that
|
2530
|
+
# users select or input. For details about working with form inputs, see [
|
2531
|
+
# Receive form data](https://developers.google.com/workspace/chat/read-form-data)
|
2532
|
+
# . To collect undefined or abstract data from users, use the TextInput widget. [
|
2533
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
2534
|
+
# workspace/extend):
|
2511
2535
|
class GoogleAppsCardV1SelectionInput
|
2512
2536
|
include Google::Apis::Core::Hashable
|
2513
2537
|
|
@@ -2549,7 +2573,7 @@ module Google
|
|
2549
2573
|
|
2550
2574
|
# The name that identifies the selection input in a form input event. For
|
2551
2575
|
# details about working with form inputs, see [Receive form data](https://
|
2552
|
-
# developers.google.com/chat/
|
2576
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2553
2577
|
# Corresponds to the JSON property `name`
|
2554
2578
|
# @return [String]
|
2555
2579
|
attr_accessor :name
|
@@ -2617,7 +2641,7 @@ module Google
|
|
2617
2641
|
|
2618
2642
|
# For multiselect menus, the URL for the icon displayed next to the item's `text`
|
2619
2643
|
# field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `
|
2620
|
-
# https://developers.google.com/chat/images/quickstart-app-avatar.png`.
|
2644
|
+
# https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`.
|
2621
2645
|
# Corresponds to the JSON property `startIconUri`
|
2622
2646
|
# @return [String]
|
2623
2647
|
attr_accessor :start_icon_uri
|
@@ -2629,7 +2653,7 @@ module Google
|
|
2629
2653
|
|
2630
2654
|
# The value associated with this item. The client should use this as a form
|
2631
2655
|
# input value. For details about working with form inputs, see [Receive form
|
2632
|
-
# data](https://developers.google.com/chat/
|
2656
|
+
# data](https://developers.google.com/workspace/chat/read-form-data).
|
2633
2657
|
# Corresponds to the JSON property `value`
|
2634
2658
|
# @return [String]
|
2635
2659
|
attr_accessor :value
|
@@ -2714,7 +2738,7 @@ module Google
|
|
2714
2738
|
|
2715
2739
|
# The name by which the switch widget is identified in a form input event. For
|
2716
2740
|
# details about working with form inputs, see [Receive form data](https://
|
2717
|
-
# developers.google.com/chat/
|
2741
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2718
2742
|
# Corresponds to the JSON property `name`
|
2719
2743
|
# @return [String]
|
2720
2744
|
attr_accessor :name
|
@@ -2735,7 +2759,7 @@ module Google
|
|
2735
2759
|
|
2736
2760
|
# The value entered by a user, returned as part of a form input event. For
|
2737
2761
|
# details about working with form inputs, see [Receive form data](https://
|
2738
|
-
# developers.google.com/chat/
|
2762
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2739
2763
|
# Corresponds to the JSON property `value`
|
2740
2764
|
# @return [String]
|
2741
2765
|
attr_accessor :value
|
@@ -2755,14 +2779,15 @@ module Google
|
|
2755
2779
|
end
|
2756
2780
|
|
2757
2781
|
# A field in which users can enter text. Supports suggestions and on-change
|
2758
|
-
# actions. For an example in Google Chat apps, see [
|
2759
|
-
# developers.google.com/chat/
|
2760
|
-
#
|
2761
|
-
#
|
2762
|
-
#
|
2763
|
-
# data
|
2764
|
-
# users, use
|
2765
|
-
#
|
2782
|
+
# actions. For an example in Google Chat apps, see [Add a field in which a user
|
2783
|
+
# can enter text](https://developers.google.com/workspace/chat/design-
|
2784
|
+
# interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps
|
2785
|
+
# receive and can process the value of entered text during form input events.
|
2786
|
+
# For details about working with form inputs, see [Receive form data](https://
|
2787
|
+
# developers.google.com/workspace/chat/read-form-data). When you need to collect
|
2788
|
+
# undefined or abstract data from users, use a text input. To collect defined or
|
2789
|
+
# enumerated data from users, use the SelectionInput widget. [Google Workspace
|
2790
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
2766
2791
|
class GoogleAppsCardV1TextInput
|
2767
2792
|
include Google::Apis::Core::Hashable
|
2768
2793
|
|
@@ -2807,7 +2832,7 @@ module Google
|
|
2807
2832
|
|
2808
2833
|
# The name by which the text input is identified in a form input event. For
|
2809
2834
|
# details about working with form inputs, see [Receive form data](https://
|
2810
|
-
# developers.google.com/chat/
|
2835
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2811
2836
|
# Corresponds to the JSON property `name`
|
2812
2837
|
# @return [String]
|
2813
2838
|
attr_accessor :name
|
@@ -2835,7 +2860,7 @@ module Google
|
|
2835
2860
|
|
2836
2861
|
# The value entered by a user, returned as part of a form input event. For
|
2837
2862
|
# details about working with form inputs, see [Receive form data](https://
|
2838
|
-
# developers.google.com/chat/
|
2863
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2839
2864
|
# Corresponds to the JSON property `value`
|
2840
2865
|
# @return [String]
|
2841
2866
|
attr_accessor :value
|
@@ -2859,9 +2884,10 @@ module Google
|
|
2859
2884
|
end
|
2860
2885
|
|
2861
2886
|
# A paragraph of text that supports formatting. For an example in Google Chat
|
2862
|
-
# apps, see [
|
2863
|
-
#
|
2864
|
-
# in Google
|
2887
|
+
# apps, see [Add a paragraph of formatted text](https://developers.google.com/
|
2888
|
+
# workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
|
2889
|
+
# For more information about formatting text, see [Formatting text in Google
|
2890
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
2865
2891
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
2866
2892
|
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
2867
2893
|
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
@@ -2890,17 +2916,18 @@ module Google
|
|
2890
2916
|
include Google::Apis::Core::Hashable
|
2891
2917
|
|
2892
2918
|
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
2893
|
-
# see [
|
2894
|
-
# Google Workspace Add-ons and Chat apps]
|
2895
|
-
# workspace/extend):
|
2919
|
+
# see [Add a button](https://developers.google.com/workspace/chat/design-
|
2920
|
+
# interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps]
|
2921
|
+
# (https://developers.google.com/workspace/extend):
|
2896
2922
|
# Corresponds to the JSON property `buttonList`
|
2897
2923
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
2898
2924
|
attr_accessor :button_list
|
2899
2925
|
|
2900
2926
|
# The `Columns` widget displays up to 2 columns in a card or dialog. You can add
|
2901
2927
|
# widgets to each column; the widgets appear in the order that they are
|
2902
|
-
# specified. For an example in Google Chat apps, see [
|
2903
|
-
# developers.google.com/chat/
|
2928
|
+
# specified. For an example in Google Chat apps, see [Display cards and dialogs
|
2929
|
+
# in columns](https://developers.google.com/workspace/chat/format-structure-card-
|
2930
|
+
# dialog#display_cards_and_dialogs_in_columns). The height of each column is
|
2904
2931
|
# determined by the taller column. For example, if the first column is taller
|
2905
2932
|
# than the second column, both columns have the height of the first column.
|
2906
2933
|
# Because each column can contain a different number of widgets, you can't
|
@@ -2920,47 +2947,52 @@ module Google
|
|
2920
2947
|
attr_accessor :columns
|
2921
2948
|
|
2922
2949
|
# Lets users input a date, a time, or both a date and a time. For an example in
|
2923
|
-
# Google Chat apps, see [
|
2924
|
-
#
|
2925
|
-
#
|
2926
|
-
#
|
2927
|
-
#
|
2950
|
+
# Google Chat apps, see [Let a user pick a date and time](https://developers.
|
2951
|
+
# google.com/workspace/chat/design-interactive-card-dialog#
|
2952
|
+
# let_a_user_pick_a_date_and_time). Users can input text or use the picker to
|
2953
|
+
# select dates and times. If users input an invalid date or time, the picker
|
2954
|
+
# shows an error that prompts users to input the information correctly. [Google
|
2955
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
2956
|
+
# extend):
|
2928
2957
|
# Corresponds to the JSON property `dateTimePicker`
|
2929
2958
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
2930
2959
|
attr_accessor :date_time_picker
|
2931
2960
|
|
2932
2961
|
# A widget that displays text with optional decorations such as a label above or
|
2933
2962
|
# below the text, an icon in front of the text, a selection widget, or a button
|
2934
|
-
# after the text. For an example in Google Chat apps, see [
|
2935
|
-
#
|
2936
|
-
#
|
2963
|
+
# after the text. For an example in Google Chat apps, see [Display text with
|
2964
|
+
# decorative text](https://developers.google.com/workspace/chat/add-text-image-
|
2965
|
+
# card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons
|
2966
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
2937
2967
|
# Corresponds to the JSON property `decoratedText`
|
2938
2968
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
2939
2969
|
attr_accessor :decorated_text
|
2940
2970
|
|
2941
2971
|
# Displays a divider between widgets as a horizontal line. For an example in
|
2942
|
-
# Google Chat apps, see [
|
2943
|
-
#
|
2944
|
-
#
|
2945
|
-
#
|
2972
|
+
# Google Chat apps, see [Add a horizontal divider between widgets](https://
|
2973
|
+
# developers.google.com/workspace/chat/format-structure-card-dialog#
|
2974
|
+
# add_a_horizontal_divider_between_widgets). [Google Workspace Add-ons and Chat
|
2975
|
+
# apps](https://developers.google.com/workspace/extend): For example, the
|
2976
|
+
# following JSON creates a divider: ``` "divider": `` ```
|
2946
2977
|
# Corresponds to the JSON property `divider`
|
2947
2978
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Divider]
|
2948
2979
|
attr_accessor :divider
|
2949
2980
|
|
2950
2981
|
# Displays a grid with a collection of items. Items can only include text or
|
2951
2982
|
# images. For responsive columns, or to include more than text or images, use `
|
2952
|
-
# Columns`. For an example in Google Chat apps, see [Grid
|
2953
|
-
# google.com/chat/
|
2954
|
-
#
|
2955
|
-
#
|
2956
|
-
#
|
2957
|
-
#
|
2958
|
-
#
|
2959
|
-
#
|
2960
|
-
#
|
2961
|
-
#
|
2962
|
-
#
|
2963
|
-
#
|
2983
|
+
# Columns`. For an example in Google Chat apps, see [Display a Grid with a
|
2984
|
+
# collection of items](https://developers.google.com/workspace/chat/format-
|
2985
|
+
# structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid
|
2986
|
+
# supports any number of columns and items. The number of rows is determined by
|
2987
|
+
# items divided by columns. A grid with 10 items and 2 columns has 5 rows. A
|
2988
|
+
# grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and
|
2989
|
+
# Chat apps](https://developers.google.com/workspace/extend): For example, the
|
2990
|
+
# following JSON creates a 2 column grid with a single item: ``` "grid": ` "
|
2991
|
+
# title": "A fine collection of items", "columnCount": 2, "borderStyle": ` "type"
|
2992
|
+
# : "STROKE", "cornerRadius": 4 `, "items": [ ` "image": ` "imageUri": "https://
|
2993
|
+
# www.example.com/image.png", "cropStyle": ` "type": "SQUARE" `, "borderStyle": `
|
2994
|
+
# "type": "STROKE" ` `, "title": "An item", "textAlignment": "CENTER" ` ], "
|
2995
|
+
# onClick": ` "openLink": ` "url": "https://www.example.com" ` ` ` ```
|
2964
2996
|
# Corresponds to the JSON property `grid`
|
2965
2997
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Grid]
|
2966
2998
|
attr_accessor :grid
|
@@ -2971,43 +3003,46 @@ module Google
|
|
2971
3003
|
attr_accessor :horizontal_alignment
|
2972
3004
|
|
2973
3005
|
# An image that is specified by a URL and can have an `onClick` action. For an
|
2974
|
-
# example, see [
|
2975
|
-
# Google Workspace Add-ons and Chat apps](
|
2976
|
-
# workspace/extend):
|
3006
|
+
# example, see [Add an image](https://developers.google.com/workspace/chat/add-
|
3007
|
+
# text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](
|
3008
|
+
# https://developers.google.com/workspace/extend):
|
2977
3009
|
# Corresponds to the JSON property `image`
|
2978
3010
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
2979
3011
|
attr_accessor :image
|
2980
3012
|
|
2981
3013
|
# A widget that creates one or more UI items that users can select. For example,
|
2982
3014
|
# a dropdown menu or checkboxes. You can use this widget to collect data that
|
2983
|
-
# can be predicted or enumerated. For an example in Google Chat apps, see [
|
2984
|
-
#
|
2985
|
-
# . Chat apps can process the value of items that
|
2986
|
-
# details about working with form inputs, see [
|
2987
|
-
# developers.google.com/chat/
|
2988
|
-
# abstract data from users, use the TextInput widget. [
|
2989
|
-
# and Chat apps](https://developers.google.com/
|
3015
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [Add
|
3016
|
+
# selectable UI elements](/workspace/chat/design-interactive-card-dialog#
|
3017
|
+
# add_selectable_ui_elements). Chat apps can process the value of items that
|
3018
|
+
# users select or input. For details about working with form inputs, see [
|
3019
|
+
# Receive form data](https://developers.google.com/workspace/chat/read-form-data)
|
3020
|
+
# . To collect undefined or abstract data from users, use the TextInput widget. [
|
3021
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
3022
|
+
# workspace/extend):
|
2990
3023
|
# Corresponds to the JSON property `selectionInput`
|
2991
3024
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
2992
3025
|
attr_accessor :selection_input
|
2993
3026
|
|
2994
3027
|
# A field in which users can enter text. Supports suggestions and on-change
|
2995
|
-
# actions. For an example in Google Chat apps, see [
|
2996
|
-
# developers.google.com/chat/
|
2997
|
-
#
|
2998
|
-
#
|
2999
|
-
#
|
3000
|
-
# data
|
3001
|
-
# users, use
|
3002
|
-
#
|
3028
|
+
# actions. For an example in Google Chat apps, see [Add a field in which a user
|
3029
|
+
# can enter text](https://developers.google.com/workspace/chat/design-
|
3030
|
+
# interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps
|
3031
|
+
# receive and can process the value of entered text during form input events.
|
3032
|
+
# For details about working with form inputs, see [Receive form data](https://
|
3033
|
+
# developers.google.com/workspace/chat/read-form-data). When you need to collect
|
3034
|
+
# undefined or abstract data from users, use a text input. To collect defined or
|
3035
|
+
# enumerated data from users, use the SelectionInput widget. [Google Workspace
|
3036
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
3003
3037
|
# Corresponds to the JSON property `textInput`
|
3004
3038
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
3005
3039
|
attr_accessor :text_input
|
3006
3040
|
|
3007
3041
|
# A paragraph of text that supports formatting. For an example in Google Chat
|
3008
|
-
# apps, see [
|
3009
|
-
#
|
3010
|
-
# in Google
|
3042
|
+
# apps, see [Add a paragraph of formatted text](https://developers.google.com/
|
3043
|
+
# workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
|
3044
|
+
# For more information about formatting text, see [Formatting text in Google
|
3045
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
3011
3046
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
3012
3047
|
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
3013
3048
|
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
@@ -3043,70 +3078,76 @@ module Google
|
|
3043
3078
|
include Google::Apis::Core::Hashable
|
3044
3079
|
|
3045
3080
|
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
3046
|
-
# see [
|
3047
|
-
# Google Workspace Add-ons and Chat apps]
|
3048
|
-
# workspace/extend):
|
3081
|
+
# see [Add a button](https://developers.google.com/workspace/chat/design-
|
3082
|
+
# interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps]
|
3083
|
+
# (https://developers.google.com/workspace/extend):
|
3049
3084
|
# Corresponds to the JSON property `buttonList`
|
3050
3085
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
3051
3086
|
attr_accessor :button_list
|
3052
3087
|
|
3053
3088
|
# Lets users input a date, a time, or both a date and a time. For an example in
|
3054
|
-
# Google Chat apps, see [
|
3055
|
-
#
|
3056
|
-
#
|
3057
|
-
#
|
3058
|
-
#
|
3089
|
+
# Google Chat apps, see [Let a user pick a date and time](https://developers.
|
3090
|
+
# google.com/workspace/chat/design-interactive-card-dialog#
|
3091
|
+
# let_a_user_pick_a_date_and_time). Users can input text or use the picker to
|
3092
|
+
# select dates and times. If users input an invalid date or time, the picker
|
3093
|
+
# shows an error that prompts users to input the information correctly. [Google
|
3094
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
3095
|
+
# extend):
|
3059
3096
|
# Corresponds to the JSON property `dateTimePicker`
|
3060
3097
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
3061
3098
|
attr_accessor :date_time_picker
|
3062
3099
|
|
3063
3100
|
# A widget that displays text with optional decorations such as a label above or
|
3064
3101
|
# below the text, an icon in front of the text, a selection widget, or a button
|
3065
|
-
# after the text. For an example in Google Chat apps, see [
|
3066
|
-
#
|
3067
|
-
#
|
3102
|
+
# after the text. For an example in Google Chat apps, see [Display text with
|
3103
|
+
# decorative text](https://developers.google.com/workspace/chat/add-text-image-
|
3104
|
+
# card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons
|
3105
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
3068
3106
|
# Corresponds to the JSON property `decoratedText`
|
3069
3107
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
3070
3108
|
attr_accessor :decorated_text
|
3071
3109
|
|
3072
3110
|
# An image that is specified by a URL and can have an `onClick` action. For an
|
3073
|
-
# example, see [
|
3074
|
-
# Google Workspace Add-ons and Chat apps](
|
3075
|
-
# workspace/extend):
|
3111
|
+
# example, see [Add an image](https://developers.google.com/workspace/chat/add-
|
3112
|
+
# text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](
|
3113
|
+
# https://developers.google.com/workspace/extend):
|
3076
3114
|
# Corresponds to the JSON property `image`
|
3077
3115
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
3078
3116
|
attr_accessor :image
|
3079
3117
|
|
3080
3118
|
# A widget that creates one or more UI items that users can select. For example,
|
3081
3119
|
# a dropdown menu or checkboxes. You can use this widget to collect data that
|
3082
|
-
# can be predicted or enumerated. For an example in Google Chat apps, see [
|
3083
|
-
#
|
3084
|
-
# . Chat apps can process the value of items that
|
3085
|
-
# details about working with form inputs, see [
|
3086
|
-
# developers.google.com/chat/
|
3087
|
-
# abstract data from users, use the TextInput widget. [
|
3088
|
-
# and Chat apps](https://developers.google.com/
|
3120
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [Add
|
3121
|
+
# selectable UI elements](/workspace/chat/design-interactive-card-dialog#
|
3122
|
+
# add_selectable_ui_elements). Chat apps can process the value of items that
|
3123
|
+
# users select or input. For details about working with form inputs, see [
|
3124
|
+
# Receive form data](https://developers.google.com/workspace/chat/read-form-data)
|
3125
|
+
# . To collect undefined or abstract data from users, use the TextInput widget. [
|
3126
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
3127
|
+
# workspace/extend):
|
3089
3128
|
# Corresponds to the JSON property `selectionInput`
|
3090
3129
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
3091
3130
|
attr_accessor :selection_input
|
3092
3131
|
|
3093
3132
|
# A field in which users can enter text. Supports suggestions and on-change
|
3094
|
-
# actions. For an example in Google Chat apps, see [
|
3095
|
-
# developers.google.com/chat/
|
3096
|
-
#
|
3097
|
-
#
|
3098
|
-
#
|
3099
|
-
# data
|
3100
|
-
# users, use
|
3101
|
-
#
|
3133
|
+
# actions. For an example in Google Chat apps, see [Add a field in which a user
|
3134
|
+
# can enter text](https://developers.google.com/workspace/chat/design-
|
3135
|
+
# interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps
|
3136
|
+
# receive and can process the value of entered text during form input events.
|
3137
|
+
# For details about working with form inputs, see [Receive form data](https://
|
3138
|
+
# developers.google.com/workspace/chat/read-form-data). When you need to collect
|
3139
|
+
# undefined or abstract data from users, use a text input. To collect defined or
|
3140
|
+
# enumerated data from users, use the SelectionInput widget. [Google Workspace
|
3141
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
3102
3142
|
# Corresponds to the JSON property `textInput`
|
3103
3143
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
3104
3144
|
attr_accessor :text_input
|
3105
3145
|
|
3106
3146
|
# A paragraph of text that supports formatting. For an example in Google Chat
|
3107
|
-
# apps, see [
|
3108
|
-
#
|
3109
|
-
# in Google
|
3147
|
+
# apps, see [Add a paragraph of formatted text](https://developers.google.com/
|
3148
|
+
# workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
|
3149
|
+
# For more information about formatting text, see [Formatting text in Google
|
3150
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
3110
3151
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
3111
3152
|
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
3112
3153
|
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
@@ -3297,9 +3338,9 @@ module Google
|
|
3297
3338
|
|
3298
3339
|
# The text of the bottom label. Formatted text supported. For more information
|
3299
3340
|
# about formatting text, see [Formatting text in Google Chat apps](https://
|
3300
|
-
# developers.google.com/chat/format-messages#card-formatting) and [
|
3301
|
-
# text in Google Workspace Add-ons](https://developers.google.com/
|
3302
|
-
# add-ons/concepts/widgets#text_formatting).
|
3341
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
3342
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
3343
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
3303
3344
|
# Corresponds to the JSON property `bottomLabel`
|
3304
3345
|
# @return [String]
|
3305
3346
|
attr_accessor :bottom_label
|
@@ -3311,9 +3352,9 @@ module Google
|
|
3311
3352
|
|
3312
3353
|
# The text of the content. Formatted text supported and always required. For
|
3313
3354
|
# more information about formatting text, see [Formatting text in Google Chat
|
3314
|
-
# apps](https://developers.google.com/chat/format-messages#card-
|
3315
|
-
# Formatting text in Google Workspace Add-ons](https://
|
3316
|
-
# apps-script/add-ons/concepts/widgets#text_formatting).
|
3355
|
+
# apps](https://developers.google.com/workspace/chat/format-messages#card-
|
3356
|
+
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
3357
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
3317
3358
|
# Corresponds to the JSON property `content`
|
3318
3359
|
# @return [String]
|
3319
3360
|
attr_accessor :content
|
@@ -3342,9 +3383,9 @@ module Google
|
|
3342
3383
|
|
3343
3384
|
# The text of the top label. Formatted text supported. For more information
|
3344
3385
|
# about formatting text, see [Formatting text in Google Chat apps](https://
|
3345
|
-
# developers.google.com/chat/format-messages#card-formatting) and [
|
3346
|
-
# text in Google Workspace Add-ons](https://developers.google.com/
|
3347
|
-
# add-ons/concepts/widgets#text_formatting).
|
3386
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
3387
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
3388
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
3348
3389
|
# Corresponds to the JSON property `topLabel`
|
3349
3390
|
# @return [String]
|
3350
3391
|
attr_accessor :top_label
|
@@ -3366,7 +3407,7 @@ module Google
|
|
3366
3407
|
end
|
3367
3408
|
end
|
3368
3409
|
|
3369
|
-
#
|
3410
|
+
# Response to list memberships of the space.
|
3370
3411
|
class ListMembershipsResponse
|
3371
3412
|
include Google::Apis::Core::Hashable
|
3372
3413
|
|
@@ -3392,7 +3433,7 @@ module Google
|
|
3392
3433
|
end
|
3393
3434
|
end
|
3394
3435
|
|
3395
|
-
#
|
3436
|
+
# Response message for listing messages.
|
3396
3437
|
class ListMessagesResponse
|
3397
3438
|
include Google::Apis::Core::Hashable
|
3398
3439
|
|
@@ -3418,7 +3459,7 @@ module Google
|
|
3418
3459
|
end
|
3419
3460
|
end
|
3420
3461
|
|
3421
|
-
#
|
3462
|
+
# Response to a list reactions request.
|
3422
3463
|
class ListReactionsResponse
|
3423
3464
|
include Google::Apis::Core::Hashable
|
3424
3465
|
|
@@ -3470,7 +3511,7 @@ module Google
|
|
3470
3511
|
end
|
3471
3512
|
end
|
3472
3513
|
|
3473
|
-
#
|
3514
|
+
# The response for a list spaces request.
|
3474
3515
|
class ListSpacesResponse
|
3475
3516
|
include Google::Apis::Core::Hashable
|
3476
3517
|
|
@@ -3561,9 +3602,9 @@ module Google
|
|
3561
3602
|
attr_accessor :group_member
|
3562
3603
|
|
3563
3604
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
3564
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
3565
|
-
#
|
3566
|
-
# and `type`.
|
3605
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
3606
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
3607
|
+
# populates the user's `name` and `type`.
|
3567
3608
|
# Corresponds to the JSON property `member`
|
3568
3609
|
# @return [Google::Apis::ChatV1::User]
|
3569
3610
|
attr_accessor :member
|
@@ -3575,8 +3616,8 @@ module Google
|
|
3575
3616
|
attr_accessor :name
|
3576
3617
|
|
3577
3618
|
# Optional. User's role within a Chat space, which determines their permitted
|
3578
|
-
# actions in the space.
|
3579
|
-
#
|
3619
|
+
# actions in the space. This field can only be used as input in `
|
3620
|
+
# UpdateMembership`.
|
3580
3621
|
# Corresponds to the JSON property `role`
|
3581
3622
|
# @return [String]
|
3582
3623
|
attr_accessor :role
|
@@ -3735,7 +3776,7 @@ module Google
|
|
3735
3776
|
# Add interactive widgets at the bottom of a message](https://developers.google.
|
3736
3777
|
# com/workspace/chat/create-messages#add-accessory-widgets). Creating a message
|
3737
3778
|
# with accessory widgets requires [app authentication] (https://developers.
|
3738
|
-
# google.com/chat/
|
3779
|
+
# google.com/workspace/chat/authenticate-authorize-chat-app).
|
3739
3780
|
# Corresponds to the JSON property `accessoryWidgets`
|
3740
3781
|
# @return [Array<Google::Apis::ChatV1::AccessoryWidget>]
|
3741
3782
|
attr_accessor :accessory_widgets
|
@@ -3774,22 +3815,23 @@ module Google
|
|
3774
3815
|
# @return [Array<Google::Apis::ChatV1::Card>]
|
3775
3816
|
attr_accessor :cards
|
3776
3817
|
|
3777
|
-
# An array of [cards](https://developers.google.com/chat/api/reference/
|
3778
|
-
# cards). Only Chat apps can create cards. If your Chat app [
|
3779
|
-
# user](https://developers.google.com/chat/
|
3780
|
-
# can't contain cards. To learn
|
3781
|
-
#
|
3782
|
-
# com/chat/
|
3818
|
+
# An array of [cards](https://developers.google.com/workspace/chat/api/reference/
|
3819
|
+
# rest/v1/cards). Only Chat apps can create cards. If your Chat app [
|
3820
|
+
# authenticates as a user](https://developers.google.com/workspace/chat/
|
3821
|
+
# authenticate-authorize-chat-user), the messages can't contain cards. To learn
|
3822
|
+
# about cards and how to create them, see [Send card messages](https://
|
3823
|
+
# developers.google.com/workspace/chat/create-messages#create). [Card builder](
|
3824
|
+
# https://addons.gsuite.google.com/uikit/builder)
|
3783
3825
|
# Corresponds to the JSON property `cardsV2`
|
3784
3826
|
# @return [Array<Google::Apis::ChatV1::CardWithId>]
|
3785
3827
|
attr_accessor :cards_v2
|
3786
3828
|
|
3787
3829
|
# Optional. A custom ID for the message. You can use field to identify a message,
|
3788
3830
|
# or to get, delete, or update a message. To set a custom ID, specify the [`
|
3789
|
-
# messageId`](https://developers.google.com/chat/api/reference/rest/v1/
|
3790
|
-
# messages/create#body.QUERY_PARAMETERS.message_id) field when you create
|
3791
|
-
# message. For details, see [Name a message](https://developers.google.com/
|
3792
|
-
#
|
3831
|
+
# messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/
|
3832
|
+
# spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create
|
3833
|
+
# the message. For details, see [Name a message](https://developers.google.com/
|
3834
|
+
# workspace/chat/create-messages#name_a_created_message).
|
3793
3835
|
# Corresponds to the JSON property `clientAssignedMessageId`
|
3794
3836
|
# @return [String]
|
3795
3837
|
attr_accessor :client_assigned_message_id
|
@@ -3828,16 +3870,17 @@ module Google
|
|
3828
3870
|
|
3829
3871
|
# Output only. Contains the message `text` with markups added to communicate
|
3830
3872
|
# formatting. This field might not capture all formatting visible in the UI, but
|
3831
|
-
# includes the following: * [Markup syntax](https://developers.google.com/
|
3832
|
-
# format-messages) for bold, italic, strikethrough, monospace,
|
3833
|
-
# and bulleted list. * [User mentions](https://developers.
|
3834
|
-
# messages#messages-@mention) using the format
|
3835
|
-
# format `<`url`|`rendered_text`>` where the
|
3836
|
-
# second is the rendered text—for example, ``. *
|
3837
|
-
#
|
3838
|
-
# such as `U+1F600` for a grinning face emoji.
|
3839
|
-
# text formatting sent in a message](https://
|
3840
|
-
# messages#
|
3873
|
+
# includes the following: * [Markup syntax](https://developers.google.com/
|
3874
|
+
# workspace/chat/format-messages) for bold, italic, strikethrough, monospace,
|
3875
|
+
# monospace block, and bulleted list. * [User mentions](https://developers.
|
3876
|
+
# google.com/workspace/chat/format-messages#messages-@mention) using the format `
|
3877
|
+
# `. * Custom hyperlinks using the format `<`url`|`rendered_text`>` where the
|
3878
|
+
# first string is the URL and the second is the rendered text—for example, ``. *
|
3879
|
+
# Custom emoji using the format `:`emoji_name`:`—for example, `:smile:`. This
|
3880
|
+
# doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji.
|
3881
|
+
# For more information, see [View text formatting sent in a message](https://
|
3882
|
+
# developers.google.com/workspace/chat/format-messages#
|
3883
|
+
# view_text_formatting_sent_in_a_message)
|
3841
3884
|
# Corresponds to the JSON property `formattedText`
|
3842
3885
|
# @return [String]
|
3843
3886
|
attr_accessor :formatted_text
|
@@ -3862,16 +3905,16 @@ module Google
|
|
3862
3905
|
# create a message, you can use this ID to specify the message in a request by
|
3863
3906
|
# replacing ``message`` with the value from the `clientAssignedMessageId` field.
|
3864
3907
|
# For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details,
|
3865
|
-
# see [Name a message](https://developers.google.com/chat/
|
3866
|
-
#
|
3908
|
+
# see [Name a message](https://developers.google.com/workspace/chat/create-
|
3909
|
+
# messages#name_a_created_message).
|
3867
3910
|
# Corresponds to the JSON property `name`
|
3868
3911
|
# @return [String]
|
3869
3912
|
attr_accessor :name
|
3870
3913
|
|
3871
3914
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
3872
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
3873
|
-
#
|
3874
|
-
# and `type`.
|
3915
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
3916
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
3917
|
+
# populates the user's `name` and `type`.
|
3875
3918
|
# Corresponds to the JSON property `privateMessageViewer`
|
3876
3919
|
# @return [Google::Apis::ChatV1::User]
|
3877
3920
|
attr_accessor :private_message_viewer
|
@@ -3882,14 +3925,14 @@ module Google
|
|
3882
3925
|
attr_accessor :quoted_message_metadata
|
3883
3926
|
|
3884
3927
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
3885
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
3886
|
-
#
|
3887
|
-
# and `type`.
|
3928
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
3929
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
3930
|
+
# populates the user's `name` and `type`.
|
3888
3931
|
# Corresponds to the JSON property `sender`
|
3889
3932
|
# @return [Google::Apis::ChatV1::User]
|
3890
3933
|
attr_accessor :sender
|
3891
3934
|
|
3892
|
-
# A [slash command](https://developers.google.com/chat/
|
3935
|
+
# A [slash command](https://developers.google.com/workspace/chat/slash-commands)
|
3893
3936
|
# in Google Chat.
|
3894
3937
|
# Corresponds to the JSON property `slashCommand`
|
3895
3938
|
# @return [Google::Apis::ChatV1::SlashCommand]
|
@@ -3902,20 +3945,21 @@ module Google
|
|
3902
3945
|
attr_accessor :space
|
3903
3946
|
|
3904
3947
|
# Plain-text body of the message. The first link to an image, video, or web page
|
3905
|
-
# generates a [preview chip](https://developers.google.com/chat/
|
3906
|
-
# links). You can also [@mention a Google Chat user](https://developers.
|
3907
|
-
# com/chat/format-messages#messages-@mention), or everyone in
|
3908
|
-
# learn about creating text messages, see [Send a text message](
|
3909
|
-
# developers.google.com/chat/
|
3948
|
+
# generates a [preview chip](https://developers.google.com/workspace/chat/
|
3949
|
+
# preview-links). You can also [@mention a Google Chat user](https://developers.
|
3950
|
+
# google.com/workspace/chat/format-messages#messages-@mention), or everyone in
|
3951
|
+
# the space. To learn about creating text messages, see [Send a text message](
|
3952
|
+
# https://developers.google.com/workspace/chat/create-messages#create-text-
|
3953
|
+
# messages).
|
3910
3954
|
# Corresponds to the JSON property `text`
|
3911
3955
|
# @return [String]
|
3912
3956
|
attr_accessor :text
|
3913
3957
|
|
3914
3958
|
# A thread in a Google Chat space. For example usage, see [Start or reply to a
|
3915
|
-
# message thread](https://developers.google.com/chat/
|
3916
|
-
# create
|
3917
|
-
#
|
3918
|
-
# reference/rest/v1/spaces.messages/create#messagereplyoption) field to
|
3959
|
+
# message thread](https://developers.google.com/workspace/chat/create-messages#
|
3960
|
+
# create-message-thread). If you specify a thread when creating a message, you
|
3961
|
+
# can set the [`messageReplyOption`](https://developers.google.com/workspace/
|
3962
|
+
# chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to
|
3919
3963
|
# determine what happens if no matching thread is found.
|
3920
3964
|
# Corresponds to the JSON property `thread`
|
3921
3965
|
# @return [Google::Apis::ChatV1::Thread]
|
@@ -4173,9 +4217,9 @@ module Google
|
|
4173
4217
|
attr_accessor :name
|
4174
4218
|
|
4175
4219
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
4176
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
4177
|
-
#
|
4178
|
-
# and `type`.
|
4220
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
4221
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
4222
|
+
# populates the user's `name` and `type`.
|
4179
4223
|
# Corresponds to the JSON property `user`
|
4180
4224
|
# @return [Google::Apis::ChatV1::User]
|
4181
4225
|
attr_accessor :user
|
@@ -4312,9 +4356,9 @@ module Google
|
|
4312
4356
|
|
4313
4357
|
# The header of the section. Formatted text is supported. For more information
|
4314
4358
|
# about formatting text, see [Formatting text in Google Chat apps](https://
|
4315
|
-
# developers.google.com/chat/format-messages#card-formatting) and [
|
4316
|
-
# text in Google Workspace Add-ons](https://developers.google.com/
|
4317
|
-
# add-ons/concepts/widgets#text_formatting).
|
4359
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
4360
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
4361
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
4318
4362
|
# Corresponds to the JSON property `header`
|
4319
4363
|
# @return [String]
|
4320
4364
|
attr_accessor :header
|
@@ -4354,7 +4398,7 @@ module Google
|
|
4354
4398
|
end
|
4355
4399
|
end
|
4356
4400
|
|
4357
|
-
#
|
4401
|
+
# Request to create a space and add specified users to it.
|
4358
4402
|
class SetUpSpaceRequest
|
4359
4403
|
include Google::Apis::Core::Hashable
|
4360
4404
|
|
@@ -4404,7 +4448,7 @@ module Google
|
|
4404
4448
|
end
|
4405
4449
|
end
|
4406
4450
|
|
4407
|
-
# A [slash command](https://developers.google.com/chat/
|
4451
|
+
# A [slash command](https://developers.google.com/workspace/chat/slash-commands)
|
4408
4452
|
# in Google Chat.
|
4409
4453
|
class SlashCommand
|
4410
4454
|
include Google::Apis::Core::Hashable
|
@@ -4429,9 +4473,9 @@ module Google
|
|
4429
4473
|
include Google::Apis::Core::Hashable
|
4430
4474
|
|
4431
4475
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
4432
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
4433
|
-
#
|
4434
|
-
# and `type`.
|
4476
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
4477
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
4478
|
+
# populates the user's `name` and `type`.
|
4435
4479
|
# Corresponds to the JSON property `bot`
|
4436
4480
|
# @return [Google::Apis::ChatV1::User]
|
4437
4481
|
attr_accessor :bot
|
@@ -4496,11 +4540,11 @@ module Google
|
|
4496
4540
|
attr_accessor :create_time
|
4497
4541
|
|
4498
4542
|
# The space's display name. Required when [creating a space](https://developers.
|
4499
|
-
# google.com/chat/api/reference/rest/v1/spaces/create). If you receive
|
4500
|
-
# message `ALREADY_EXISTS` when creating a space or updating the `
|
4501
|
-
# try a different `displayName`. An existing space within the
|
4502
|
-
# organization might already use this display name. For direct
|
4503
|
-
# field might be empty. Supports up to 128 characters.
|
4543
|
+
# google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive
|
4544
|
+
# the error message `ALREADY_EXISTS` when creating a space or updating the `
|
4545
|
+
# displayName`, try a different `displayName`. An existing space within the
|
4546
|
+
# Google Workspace organization might already use this display name. For direct
|
4547
|
+
# messages, this field might be empty. Supports up to 128 characters.
|
4504
4548
|
# Corresponds to the JSON property `displayName`
|
4505
4549
|
# @return [String]
|
4506
4550
|
attr_accessor :display_name
|
@@ -4511,8 +4555,11 @@ module Google
|
|
4511
4555
|
# consumer account (unmanaged user account). By default, a space created by a
|
4512
4556
|
# consumer account permits any Google Chat user. * The space is used to [import
|
4513
4557
|
# data to Google Chat] (https://developers.google.com/chat/api/guides/import-
|
4514
|
-
# data-overview)
|
4515
|
-
# Google Workspace organization.
|
4558
|
+
# data-overview) because import mode spaces must only permit members from the
|
4559
|
+
# same Google Workspace organization. However, as part of the [Google Workspace
|
4560
|
+
# Developer Preview Program](https://developers.google.com/workspace/preview),
|
4561
|
+
# import mode spaces can permit any Google Chat user so this field can then be
|
4562
|
+
# set for import mode spaces. For existing spaces, this field is output only.
|
4516
4563
|
# Corresponds to the JSON property `externalUserAllowed`
|
4517
4564
|
# @return [Boolean]
|
4518
4565
|
attr_accessor :external_user_allowed
|
@@ -4850,6 +4897,34 @@ module Google
|
|
4850
4897
|
end
|
4851
4898
|
end
|
4852
4899
|
|
4900
|
+
# A user's read state within a space, used to identify read and unread messages.
|
4901
|
+
class SpaceReadState
|
4902
|
+
include Google::Apis::Core::Hashable
|
4903
|
+
|
4904
|
+
# Optional. The time when the user's space read state was updated. Usually this
|
4905
|
+
# corresponds with either the timestamp of the last read message, or a timestamp
|
4906
|
+
# specified by the user to mark the last read position in a space.
|
4907
|
+
# Corresponds to the JSON property `lastReadTime`
|
4908
|
+
# @return [String]
|
4909
|
+
attr_accessor :last_read_time
|
4910
|
+
|
4911
|
+
# Resource name of the space read state. Format: `users/`user`/spaces/`space`/
|
4912
|
+
# spaceReadState`
|
4913
|
+
# Corresponds to the JSON property `name`
|
4914
|
+
# @return [String]
|
4915
|
+
attr_accessor :name
|
4916
|
+
|
4917
|
+
def initialize(**args)
|
4918
|
+
update!(**args)
|
4919
|
+
end
|
4920
|
+
|
4921
|
+
# Update properties of this object
|
4922
|
+
def update!(**args)
|
4923
|
+
@last_read_time = args[:last_read_time] if args.key?(:last_read_time)
|
4924
|
+
@name = args[:name] if args.key?(:name)
|
4925
|
+
end
|
4926
|
+
end
|
4927
|
+
|
4853
4928
|
# Event payload for an updated space. Event type: `google.workspace.chat.space.
|
4854
4929
|
# v1.updated`
|
4855
4930
|
class SpaceUpdatedEventData
|
@@ -4958,9 +5033,9 @@ module Google
|
|
4958
5033
|
|
4959
5034
|
# A paragraph of text. Formatted text supported. For more information about
|
4960
5035
|
# formatting text, see [Formatting text in Google Chat apps](https://developers.
|
4961
|
-
# google.com/chat/format-messages#card-formatting) and [Formatting
|
4962
|
-
# Google Workspace Add-ons](https://developers.google.com/apps-script/
|
4963
|
-
# concepts/widgets#text_formatting).
|
5036
|
+
# google.com/workspace/chat/format-messages#card-formatting) and [Formatting
|
5037
|
+
# text in Google Workspace Add-ons](https://developers.google.com/apps-script/
|
5038
|
+
# add-ons/concepts/widgets#text_formatting).
|
4964
5039
|
class TextParagraph
|
4965
5040
|
include Google::Apis::Core::Hashable
|
4966
5041
|
|
@@ -4980,10 +5055,10 @@ module Google
|
|
4980
5055
|
end
|
4981
5056
|
|
4982
5057
|
# A thread in a Google Chat space. For example usage, see [Start or reply to a
|
4983
|
-
# message thread](https://developers.google.com/chat/
|
4984
|
-
# create
|
4985
|
-
#
|
4986
|
-
# reference/rest/v1/spaces.messages/create#messagereplyoption) field to
|
5058
|
+
# message thread](https://developers.google.com/workspace/chat/create-messages#
|
5059
|
+
# create-message-thread). If you specify a thread when creating a message, you
|
5060
|
+
# can set the [`messageReplyOption`](https://developers.google.com/workspace/
|
5061
|
+
# chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to
|
4987
5062
|
# determine what happens if no matching thread is found.
|
4988
5063
|
class Thread
|
4989
5064
|
include Google::Apis::Core::Hashable
|
@@ -5015,6 +5090,33 @@ module Google
|
|
5015
5090
|
end
|
5016
5091
|
end
|
5017
5092
|
|
5093
|
+
# A user's read state within a thread, used to identify read and unread messages.
|
5094
|
+
class ThreadReadState
|
5095
|
+
include Google::Apis::Core::Hashable
|
5096
|
+
|
5097
|
+
# The time when the user's thread read state was updated. Usually this
|
5098
|
+
# corresponds with the timestamp of the last read message in a thread.
|
5099
|
+
# Corresponds to the JSON property `lastReadTime`
|
5100
|
+
# @return [String]
|
5101
|
+
attr_accessor :last_read_time
|
5102
|
+
|
5103
|
+
# Resource name of the thread read state. Format: `users/`user`/spaces/`space`/
|
5104
|
+
# threads/`thread`/threadReadState`
|
5105
|
+
# Corresponds to the JSON property `name`
|
5106
|
+
# @return [String]
|
5107
|
+
attr_accessor :name
|
5108
|
+
|
5109
|
+
def initialize(**args)
|
5110
|
+
update!(**args)
|
5111
|
+
end
|
5112
|
+
|
5113
|
+
# Update properties of this object
|
5114
|
+
def update!(**args)
|
5115
|
+
@last_read_time = args[:last_read_time] if args.key?(:last_read_time)
|
5116
|
+
@name = args[:name] if args.key?(:name)
|
5117
|
+
end
|
5118
|
+
end
|
5119
|
+
|
5018
5120
|
# Time input values.
|
5019
5121
|
class TimeInput
|
5020
5122
|
include Google::Apis::Core::Hashable
|
@@ -5098,7 +5200,7 @@ module Google
|
|
5098
5200
|
end
|
5099
5201
|
end
|
5100
5202
|
|
5101
|
-
#
|
5203
|
+
# Request to upload an attachment.
|
5102
5204
|
class UploadAttachmentRequest
|
5103
5205
|
include Google::Apis::Core::Hashable
|
5104
5206
|
|
@@ -5117,11 +5219,11 @@ module Google
|
|
5117
5219
|
end
|
5118
5220
|
end
|
5119
5221
|
|
5120
|
-
#
|
5222
|
+
# Response of uploading an attachment.
|
5121
5223
|
class UploadAttachmentResponse
|
5122
5224
|
include Google::Apis::Core::Hashable
|
5123
5225
|
|
5124
|
-
#
|
5226
|
+
# A reference to the attachment data.
|
5125
5227
|
# Corresponds to the JSON property `attachmentDataRef`
|
5126
5228
|
# @return [Google::Apis::ChatV1::AttachmentDataRef]
|
5127
5229
|
attr_accessor :attachment_data_ref
|
@@ -5137,9 +5239,9 @@ module Google
|
|
5137
5239
|
end
|
5138
5240
|
|
5139
5241
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
5140
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
5141
|
-
#
|
5142
|
-
# and `type`.
|
5242
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
5243
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
5244
|
+
# populates the user's `name` and `type`.
|
5143
5245
|
class User
|
5144
5246
|
include Google::Apis::Core::Hashable
|
5145
5247
|
|
@@ -5204,9 +5306,9 @@ module Google
|
|
5204
5306
|
attr_accessor :type
|
5205
5307
|
|
5206
5308
|
# A user in Google Chat. When returned as an output from a request, if your Chat
|
5207
|
-
# app [authenticates as a user](https://developers.google.com/chat/
|
5208
|
-
#
|
5209
|
-
# and `type`.
|
5309
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
5310
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
5311
|
+
# populates the user's `name` and `type`.
|
5210
5312
|
# Corresponds to the JSON property `user`
|
5211
5313
|
# @return [Google::Apis::ChatV1::User]
|
5212
5314
|
attr_accessor :user
|
@@ -5245,9 +5347,9 @@ module Google
|
|
5245
5347
|
|
5246
5348
|
# A paragraph of text. Formatted text supported. For more information about
|
5247
5349
|
# formatting text, see [Formatting text in Google Chat apps](https://developers.
|
5248
|
-
# google.com/chat/format-messages#card-formatting) and [Formatting
|
5249
|
-
# Google Workspace Add-ons](https://developers.google.com/apps-script/
|
5250
|
-
# concepts/widgets#text_formatting).
|
5350
|
+
# google.com/workspace/chat/format-messages#card-formatting) and [Formatting
|
5351
|
+
# text in Google Workspace Add-ons](https://developers.google.com/apps-script/
|
5352
|
+
# add-ons/concepts/widgets#text_formatting).
|
5251
5353
|
# Corresponds to the JSON property `textParagraph`
|
5252
5354
|
# @return [Google::Apis::ChatV1::TextParagraph]
|
5253
5355
|
attr_accessor :text_paragraph
|