google-apis-chat_v1 0.90.0 → 0.91.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 +4 -0
- data/lib/google/apis/chat_v1/classes.rb +478 -432
- data/lib/google/apis/chat_v1/gem_version.rb +2 -2
- data/lib/google/apis/chat_v1/service.rb +272 -221
- 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
|
|
@@ -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]
|
@@ -885,7 +885,7 @@ module Google
|
|
885
885
|
attr_accessor :event_time
|
886
886
|
|
887
887
|
# For `CARD_CLICKED` interaction events, whether the user interacted with a [
|
888
|
-
# dialog](https://developers.google.com/chat/
|
888
|
+
# dialog](https://developers.google.com/workspace/chat/dialogs).
|
889
889
|
# Corresponds to the JSON property `isDialogEvent`
|
890
890
|
# @return [Boolean]
|
891
891
|
attr_accessor :is_dialog_event
|
@@ -927,9 +927,9 @@ module Google
|
|
927
927
|
attr_accessor :type
|
928
928
|
|
929
929
|
# 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`.
|
930
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
931
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
932
|
+
# populates the user's `name` and `type`.
|
933
933
|
# Corresponds to the JSON property `user`
|
934
934
|
# @return [Google::Apis::ChatV1::User]
|
935
935
|
attr_accessor :user
|
@@ -964,25 +964,25 @@ module Google
|
|
964
964
|
# rich media like images. Use cards to present detailed information, gather
|
965
965
|
# information from users, and guide users to take a next step. [Card builder](
|
966
966
|
# 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
|
-
# ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
967
|
+
# see the following documentation: * For Google Chat apps, see [Design the
|
968
|
+
# components of a card or dialog](https://developers.google.com/workspace/chat/
|
969
|
+
# design-components-card-dialog). * For Google Workspace Add-ons, see [Card-
|
970
|
+
# based interfaces](https://developers.google.com/apps-script/add-ons/concepts/
|
971
|
+
# cards). **Example: Card message for a Google Chat app** ![Example contact card]
|
972
|
+
# (https://developers.google.com/workspace/chat/images/card_api_reference.png)
|
973
|
+
# To create the sample card message in Google Chat, use the following JSON: ``` `
|
974
|
+
# "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "
|
975
|
+
# Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.
|
976
|
+
# google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "
|
977
|
+
# CIRCLE", "imageAltText": "Avatar for Sasha" `, "sections": [ ` "header": "
|
978
|
+
# Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets":
|
979
|
+
# [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL" `, "text": "sasha@
|
980
|
+
# example.com" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON" `,
|
981
|
+
# "text": "Online" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PHONE"
|
982
|
+
# `, "text": "+1 (555) 555-1234" ` `, ` "buttonList": ` "buttons": [ ` "text": "
|
983
|
+
# Share", "onClick": ` "openLink": ` "url": "https://example.com/share" ` ` `, `
|
984
|
+
# "text": "Edit", "onClick": ` "action": ` "function": "goToView", "parameters":
|
985
|
+
# [ ` "key": "viewType", "value": "EDIT" ` ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
986
986
|
# Corresponds to the JSON property `body`
|
987
987
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
988
988
|
attr_accessor :body
|
@@ -997,13 +997,13 @@ module Google
|
|
997
997
|
end
|
998
998
|
end
|
999
999
|
|
1000
|
-
# Contains a [dialog](https://developers.google.com/chat/
|
1000
|
+
# Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and
|
1001
1001
|
# request status code.
|
1002
1002
|
class DialogAction
|
1003
1003
|
include Google::Apis::Core::Hashable
|
1004
1004
|
|
1005
1005
|
# Represents the status for a request to either invoke or submit a [dialog](
|
1006
|
-
# https://developers.google.com/chat/
|
1006
|
+
# https://developers.google.com/workspace/chat/dialogs).
|
1007
1007
|
# Corresponds to the JSON property `actionStatus`
|
1008
1008
|
# @return [Google::Apis::ChatV1::ActionStatus]
|
1009
1009
|
attr_accessor :action_status
|
@@ -1170,20 +1170,20 @@ module Google
|
|
1170
1170
|
class GoogleAppsCardV1Action
|
1171
1171
|
include Google::Apis::Core::Hashable
|
1172
1172
|
|
1173
|
-
# A custom function to invoke when the containing element is clicked or
|
1174
|
-
# activated. For example usage, see [
|
1175
|
-
# developers.google.com/chat/
|
1173
|
+
# A custom function to invoke when the containing element is clicked or
|
1174
|
+
# otherwise activated. For example usage, see [Read form data](https://
|
1175
|
+
# developers.google.com/workspace/chat/read-form-data).
|
1176
1176
|
# Corresponds to the JSON property `function`
|
1177
1177
|
# @return [String]
|
1178
1178
|
attr_accessor :function
|
1179
1179
|
|
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
|
1180
|
+
# Optional. Required when opening a [dialog](https://developers.google.com/
|
1181
|
+
# workspace/chat/dialogs). What to do in response to an interaction with a user,
|
1182
|
+
# such as a user clicking a button in a card message. If unspecified, the app
|
1183
1183
|
# responds by executing an `action`—like opening a link or running a function—as
|
1184
1184
|
# normal. By specifying an `interaction`, the app can respond in special
|
1185
1185
|
# interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the
|
1186
|
-
# app can open a [dialog](https://developers.google.com/chat/
|
1186
|
+
# app can open a [dialog](https://developers.google.com/workspace/chat/dialogs).
|
1187
1187
|
# When specified, a loading indicator isn't shown. If specified for an add-on,
|
1188
1188
|
# the entire card is stripped and nothing is shown in the client. [Google Chat
|
1189
1189
|
# apps](https://developers.google.com/workspace/chat):
|
@@ -1207,15 +1207,16 @@ module Google
|
|
1207
1207
|
# the user make changes while the action is being processed, set [`LoadIndicator`
|
1208
1208
|
# ](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.
|
1209
1209
|
# 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
|
1210
|
+
# google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps,
|
1211
|
+
# you must also set the action's [`ResponseType`](https://developers.google.com/
|
1212
|
+
# workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `
|
1213
|
+
# UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/
|
1214
|
+
# workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card
|
1215
|
+
# that contained the action. If `false`, the form values are cleared when the
|
1216
|
+
# action is triggered. To prevent the user from making changes while the action
|
1217
|
+
# is being processed, set [`LoadIndicator`](https://developers.google.com/
|
1218
|
+
# workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`
|
1219
|
+
# .
|
1219
1220
|
# Corresponds to the JSON property `persistValues`
|
1220
1221
|
# @return [Boolean]
|
1221
1222
|
attr_accessor :persist_values
|
@@ -1239,9 +1240,9 @@ module Google
|
|
1239
1240
|
# example, consider three snooze buttons: snooze now, snooze one day, or snooze
|
1240
1241
|
# next week. You might use `action method = snooze()`, passing the snooze type
|
1241
1242
|
# 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):
|
1243
|
+
# CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/
|
1244
|
+
# rest/v1/Event#commoneventobject). [Google Workspace Add-ons and Chat apps](
|
1245
|
+
# https://developers.google.com/workspace/extend):
|
1245
1246
|
class GoogleAppsCardV1ActionParameter
|
1246
1247
|
include Google::Apis::Core::Hashable
|
1247
1248
|
|
@@ -1344,17 +1345,19 @@ module Google
|
|
1344
1345
|
end
|
1345
1346
|
|
1346
1347
|
# 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.
|
1348
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1349
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1350
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1351
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1352
|
+
# google.com/workspace/extend):
|
1351
1353
|
class GoogleAppsCardV1Button
|
1352
1354
|
include Google::Apis::Core::Hashable
|
1353
1355
|
|
1354
1356
|
# The alternative text that's used for accessibility. Set descriptive text that
|
1355
1357
|
# lets users know what the button does. For example, if a button opens a
|
1356
1358
|
# hyperlink, you might write: "Opens a new browser tab and navigates to the
|
1357
|
-
# Google Chat developer documentation at https://developers.google.com/
|
1359
|
+
# Google Chat developer documentation at https://developers.google.com/workspace/
|
1360
|
+
# chat".
|
1358
1361
|
# Corresponds to the JSON property `altText`
|
1359
1362
|
# @return [String]
|
1360
1363
|
attr_accessor :alt_text
|
@@ -1416,11 +1419,12 @@ module Google
|
|
1416
1419
|
alias_method :disabled?, :disabled
|
1417
1420
|
|
1418
1421
|
# 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/
|
1422
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1423
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1424
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1425
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1426
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1427
|
+
# extend):
|
1424
1428
|
# Corresponds to the JSON property `icon`
|
1425
1429
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1426
1430
|
attr_accessor :icon
|
@@ -1453,9 +1457,9 @@ module Google
|
|
1453
1457
|
end
|
1454
1458
|
|
1455
1459
|
# 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):
|
1460
|
+
# see [Add a button](https://developers.google.com/workspace/chat/design-
|
1461
|
+
# interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps]
|
1462
|
+
# (https://developers.google.com/workspace/extend):
|
1459
1463
|
class GoogleAppsCardV1ButtonList
|
1460
1464
|
include Google::Apis::Core::Hashable
|
1461
1465
|
|
@@ -1479,25 +1483,25 @@ module Google
|
|
1479
1483
|
# rich media like images. Use cards to present detailed information, gather
|
1480
1484
|
# information from users, and guide users to take a next step. [Card builder](
|
1481
1485
|
# 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
|
-
# ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
1486
|
+
# see the following documentation: * For Google Chat apps, see [Design the
|
1487
|
+
# components of a card or dialog](https://developers.google.com/workspace/chat/
|
1488
|
+
# design-components-card-dialog). * For Google Workspace Add-ons, see [Card-
|
1489
|
+
# based interfaces](https://developers.google.com/apps-script/add-ons/concepts/
|
1490
|
+
# cards). **Example: Card message for a Google Chat app** ![Example contact card]
|
1491
|
+
# (https://developers.google.com/workspace/chat/images/card_api_reference.png)
|
1492
|
+
# To create the sample card message in Google Chat, use the following JSON: ``` `
|
1493
|
+
# "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "
|
1494
|
+
# Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.
|
1495
|
+
# google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "
|
1496
|
+
# CIRCLE", "imageAltText": "Avatar for Sasha" `, "sections": [ ` "header": "
|
1497
|
+
# Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets":
|
1498
|
+
# [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL" `, "text": "sasha@
|
1499
|
+
# example.com" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON" `,
|
1500
|
+
# "text": "Online" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PHONE"
|
1501
|
+
# `, "text": "+1 (555) 555-1234" ` `, ` "buttonList": ` "buttons": [ ` "text": "
|
1502
|
+
# Share", "onClick": ` "openLink": ` "url": "https://example.com/share" ` ` `, `
|
1503
|
+
# "text": "Edit", "onClick": ` "action": ` "function": "goToView", "parameters":
|
1504
|
+
# [ ` "key": "viewType", "value": "EDIT" ` ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
1501
1505
|
class GoogleAppsCardV1Card
|
1502
1506
|
include Google::Apis::Core::Hashable
|
1503
1507
|
|
@@ -1523,18 +1527,20 @@ module Google
|
|
1523
1527
|
# A persistent (sticky) footer that that appears at the bottom of the card.
|
1524
1528
|
# Setting `fixedFooter` without specifying a `primaryButton` or a `
|
1525
1529
|
# 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://
|
1530
|
+
# dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card
|
1531
|
+
# messages](https://developers.google.com/workspace/chat/create-messages#create).
|
1532
|
+
# For an example in Google Chat apps, see [Add a persistent footer](https://
|
1533
|
+
# developers.google.com/workspace/chat/design-components-card-dialog#
|
1534
|
+
# add_a_persistent_footer). [Google Workspace Add-ons and Chat apps](https://
|
1535
|
+
# developers.google.com/workspace/extend):
|
1531
1536
|
# Corresponds to the JSON property `fixedFooter`
|
1532
1537
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardFixedFooter]
|
1533
1538
|
attr_accessor :fixed_footer
|
1534
1539
|
|
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://
|
1540
|
+
# Represents a card header. For an example in Google Chat apps, see [Add a
|
1541
|
+
# header](https://developers.google.com/workspace/chat/design-components-card-
|
1542
|
+
# dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://
|
1543
|
+
# developers.google.com/workspace/extend):
|
1538
1544
|
# Corresponds to the JSON property `header`
|
1539
1545
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
1540
1546
|
attr_accessor :header
|
@@ -1545,9 +1551,10 @@ module Google
|
|
1545
1551
|
# @return [String]
|
1546
1552
|
attr_accessor :name
|
1547
1553
|
|
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://
|
1554
|
+
# Represents a card header. For an example in Google Chat apps, see [Add a
|
1555
|
+
# header](https://developers.google.com/workspace/chat/design-components-card-
|
1556
|
+
# dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://
|
1557
|
+
# developers.google.com/workspace/extend):
|
1551
1558
|
# Corresponds to the JSON property `peekCardHeader`
|
1552
1559
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
1553
1560
|
attr_accessor :peek_card_header
|
@@ -1559,8 +1566,8 @@ module Google
|
|
1559
1566
|
|
1560
1567
|
# Contains a collection of widgets. Each section has its own, optional header.
|
1561
1568
|
# Sections are visually separated by a line divider. For an example in Google
|
1562
|
-
# Chat apps, see [
|
1563
|
-
# card-
|
1569
|
+
# Chat apps, see [Define a section of a card](https://developers.google.com/
|
1570
|
+
# workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
|
1564
1571
|
# Corresponds to the JSON property `sections`
|
1565
1572
|
# @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1Section>]
|
1566
1573
|
attr_accessor :sections
|
@@ -1615,28 +1622,31 @@ module Google
|
|
1615
1622
|
# A persistent (sticky) footer that that appears at the bottom of the card.
|
1616
1623
|
# Setting `fixedFooter` without specifying a `primaryButton` or a `
|
1617
1624
|
# 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://
|
1625
|
+
# dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card
|
1626
|
+
# messages](https://developers.google.com/workspace/chat/create-messages#create).
|
1627
|
+
# For an example in Google Chat apps, see [Add a persistent footer](https://
|
1628
|
+
# developers.google.com/workspace/chat/design-components-card-dialog#
|
1629
|
+
# add_a_persistent_footer). [Google Workspace Add-ons and Chat apps](https://
|
1630
|
+
# developers.google.com/workspace/extend):
|
1623
1631
|
class GoogleAppsCardV1CardFixedFooter
|
1624
1632
|
include Google::Apis::Core::Hashable
|
1625
1633
|
|
1626
1634
|
# 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.
|
1635
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1636
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1637
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1638
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1639
|
+
# google.com/workspace/extend):
|
1631
1640
|
# Corresponds to the JSON property `primaryButton`
|
1632
1641
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
1633
1642
|
attr_accessor :primary_button
|
1634
1643
|
|
1635
1644
|
# 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.
|
1645
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1646
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1647
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1648
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1649
|
+
# google.com/workspace/extend):
|
1640
1650
|
# Corresponds to the JSON property `secondaryButton`
|
1641
1651
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
1642
1652
|
attr_accessor :secondary_button
|
@@ -1652,9 +1662,10 @@ module Google
|
|
1652
1662
|
end
|
1653
1663
|
end
|
1654
1664
|
|
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://
|
1665
|
+
# Represents a card header. For an example in Google Chat apps, see [Add a
|
1666
|
+
# header](https://developers.google.com/workspace/chat/design-components-card-
|
1667
|
+
# dialog#add_a_header). [Google Workspace Add-ons and Chat apps](https://
|
1668
|
+
# developers.google.com/workspace/extend):
|
1658
1669
|
class GoogleAppsCardV1CardHeader
|
1659
1670
|
include Google::Apis::Core::Hashable
|
1660
1671
|
|
@@ -1743,8 +1754,9 @@ module Google
|
|
1743
1754
|
|
1744
1755
|
# The `Columns` widget displays up to 2 columns in a card or dialog. You can add
|
1745
1756
|
# 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/
|
1757
|
+
# specified. For an example in Google Chat apps, see [Display cards and dialogs
|
1758
|
+
# in columns](https://developers.google.com/workspace/chat/format-structure-card-
|
1759
|
+
# dialog#display_cards_and_dialogs_in_columns). The height of each column is
|
1748
1760
|
# determined by the taller column. For example, if the first column is taller
|
1749
1761
|
# than the second column, both columns have the height of the first column.
|
1750
1762
|
# Because each column can contain a different number of widgets, you can't
|
@@ -1778,11 +1790,13 @@ module Google
|
|
1778
1790
|
end
|
1779
1791
|
|
1780
1792
|
# 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
|
-
#
|
1793
|
+
# Google Chat apps, see [Let a user pick a date and time](https://developers.
|
1794
|
+
# google.com/workspace/chat/design-interactive-card-dialog#
|
1795
|
+
# let_a_user_pick_a_date_and_time). Users can input text or use the picker to
|
1796
|
+
# select dates and times. If users input an invalid date or time, the picker
|
1797
|
+
# shows an error that prompts users to input the information correctly. [Google
|
1798
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1799
|
+
# extend):
|
1786
1800
|
class GoogleAppsCardV1DateTimePicker
|
1787
1801
|
include Google::Apis::Core::Hashable
|
1788
1802
|
|
@@ -1795,7 +1809,7 @@ module Google
|
|
1795
1809
|
|
1796
1810
|
# The name by which the `DateTimePicker` is identified in a form input event.
|
1797
1811
|
# For details about working with form inputs, see [Receive form data](https://
|
1798
|
-
# developers.google.com/chat/
|
1812
|
+
# developers.google.com/workspace/chat/read-form-data).
|
1799
1813
|
# Corresponds to the JSON property `name`
|
1800
1814
|
# @return [String]
|
1801
1815
|
attr_accessor :name
|
@@ -1849,9 +1863,10 @@ module Google
|
|
1849
1863
|
|
1850
1864
|
# A widget that displays text with optional decorations such as a label above or
|
1851
1865
|
# 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
|
-
#
|
1866
|
+
# after the text. For an example in Google Chat apps, see [Display text with
|
1867
|
+
# decorative text](https://developers.google.com/workspace/chat/add-text-image-
|
1868
|
+
# card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons
|
1869
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
1855
1870
|
class GoogleAppsCardV1DecoratedText
|
1856
1871
|
include Google::Apis::Core::Hashable
|
1857
1872
|
|
@@ -1861,30 +1876,33 @@ module Google
|
|
1861
1876
|
attr_accessor :bottom_label
|
1862
1877
|
|
1863
1878
|
# 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.
|
1879
|
+
# Google Chat apps, see [Add a button](https://developers.google.com/workspace/
|
1880
|
+
# chat/design-interactive-card-dialog#add_a_button). To make an image a
|
1881
|
+
# clickable button, specify an `Image` (not an `ImageComponent`) and set an `
|
1882
|
+
# onClick` action. [Google Workspace Add-ons and Chat apps](https://developers.
|
1883
|
+
# google.com/workspace/extend):
|
1868
1884
|
# Corresponds to the JSON property `button`
|
1869
1885
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
1870
1886
|
attr_accessor :button
|
1871
1887
|
|
1872
1888
|
# 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/
|
1889
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1890
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1891
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1892
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1893
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1894
|
+
# extend):
|
1878
1895
|
# Corresponds to the JSON property `endIcon`
|
1879
1896
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1880
1897
|
attr_accessor :end_icon
|
1881
1898
|
|
1882
1899
|
# 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/
|
1900
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1901
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1902
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1903
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1904
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1905
|
+
# extend):
|
1888
1906
|
# Corresponds to the JSON property `icon`
|
1889
1907
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1890
1908
|
attr_accessor :icon
|
@@ -1897,11 +1915,12 @@ module Google
|
|
1897
1915
|
attr_accessor :on_click
|
1898
1916
|
|
1899
1917
|
# 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/
|
1918
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
1919
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
1920
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
1921
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
1922
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
1923
|
+
# extend):
|
1905
1924
|
# Corresponds to the JSON property `startIcon`
|
1906
1925
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
1907
1926
|
attr_accessor :start_icon
|
@@ -1915,9 +1934,9 @@ module Google
|
|
1915
1934
|
|
1916
1935
|
# Required. The primary text. Supports simple formatting. For more information
|
1917
1936
|
# 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).
|
1937
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
1938
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
1939
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
1921
1940
|
# Corresponds to the JSON property `text`
|
1922
1941
|
# @return [String]
|
1923
1942
|
attr_accessor :text
|
@@ -1955,10 +1974,11 @@ module Google
|
|
1955
1974
|
end
|
1956
1975
|
|
1957
1976
|
# Displays a divider between widgets as a horizontal line. For an example in
|
1958
|
-
# Google Chat apps, see [
|
1959
|
-
#
|
1960
|
-
#
|
1961
|
-
#
|
1977
|
+
# Google Chat apps, see [Add a horizontal divider between widgets](https://
|
1978
|
+
# developers.google.com/workspace/chat/format-structure-card-dialog#
|
1979
|
+
# add_a_horizontal_divider_between_widgets). [Google Workspace Add-ons and Chat
|
1980
|
+
# apps](https://developers.google.com/workspace/extend): For example, the
|
1981
|
+
# following JSON creates a divider: ``` "divider": `` ```
|
1962
1982
|
class GoogleAppsCardV1Divider
|
1963
1983
|
include Google::Apis::Core::Hashable
|
1964
1984
|
|
@@ -1973,18 +1993,19 @@ module Google
|
|
1973
1993
|
|
1974
1994
|
# Displays a grid with a collection of items. Items can only include text or
|
1975
1995
|
# 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
|
-
#
|
1996
|
+
# Columns`. For an example in Google Chat apps, see [Display a Grid with a
|
1997
|
+
# collection of items](https://developers.google.com/workspace/chat/format-
|
1998
|
+
# structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid
|
1999
|
+
# supports any number of columns and items. The number of rows is determined by
|
2000
|
+
# items divided by columns. A grid with 10 items and 2 columns has 5 rows. A
|
2001
|
+
# grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and
|
2002
|
+
# Chat apps](https://developers.google.com/workspace/extend): For example, the
|
2003
|
+
# following JSON creates a 2 column grid with a single item: ``` "grid": ` "
|
2004
|
+
# title": "A fine collection of items", "columnCount": 2, "borderStyle": ` "type"
|
2005
|
+
# : "STROKE", "cornerRadius": 4 `, "items": [ ` "image": ` "imageUri": "https://
|
2006
|
+
# www.example.com/image.png", "cropStyle": ` "type": "SQUARE" `, "borderStyle": `
|
2007
|
+
# "type": "STROKE" ` `, "title": "An item", "textAlignment": "CENTER" ` ], "
|
2008
|
+
# onClick": ` "openLink": ` "url": "https://www.example.com" ` ` ` ```
|
1988
2009
|
class GoogleAppsCardV1Grid
|
1989
2010
|
include Google::Apis::Core::Hashable
|
1990
2011
|
|
@@ -2081,11 +2102,12 @@ module Google
|
|
2081
2102
|
end
|
2082
2103
|
|
2083
2104
|
# 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/
|
2105
|
+
# see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-
|
2106
|
+
# card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/
|
2107
|
+
# workspace/chat/format-messages#builtinicons) and [custom](https://developers.
|
2108
|
+
# google.com/workspace/chat/format-messages#customicons) icons. [Google
|
2109
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
2110
|
+
# extend):
|
2089
2111
|
class GoogleAppsCardV1Icon
|
2090
2112
|
include Google::Apis::Core::Hashable
|
2091
2113
|
|
@@ -2094,16 +2116,16 @@ module Google
|
|
2094
2116
|
# helpful description for what the icon displays, and if applicable, what it
|
2095
2117
|
# does. For example, `A user's account portrait`, or `Opens a new browser tab
|
2096
2118
|
# 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.
|
2119
|
+
# google.com/workspace/chat`. If the icon is set in a `Button`, the `altText`
|
2120
|
+
# appears as helper text when the user hovers over the button. However, if the
|
2121
|
+
# button also sets `text`, the icon's `altText` is ignored.
|
2100
2122
|
# Corresponds to the JSON property `altText`
|
2101
2123
|
# @return [String]
|
2102
2124
|
attr_accessor :alt_text
|
2103
2125
|
|
2104
2126
|
# 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`.
|
2127
|
+
# https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"
|
2128
|
+
# ``` Supported file types include `.png` and `.jpg`.
|
2107
2129
|
# Corresponds to the JSON property `iconUrl`
|
2108
2130
|
# @return [String]
|
2109
2131
|
attr_accessor :icon_url
|
@@ -2117,7 +2139,7 @@ module Google
|
|
2117
2139
|
# Display one of the built-in icons provided by Google Workspace. For example,
|
2118
2140
|
# to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For
|
2119
2141
|
# a full list of supported icons, see [built-in icons](https://developers.google.
|
2120
|
-
# com/chat/format-messages#builtinicons).
|
2142
|
+
# com/workspace/chat/format-messages#builtinicons).
|
2121
2143
|
# Corresponds to the JSON property `knownIcon`
|
2122
2144
|
# @return [String]
|
2123
2145
|
attr_accessor :known_icon
|
@@ -2147,9 +2169,9 @@ module Google
|
|
2147
2169
|
end
|
2148
2170
|
|
2149
2171
|
# 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):
|
2172
|
+
# example, see [Add an image](https://developers.google.com/workspace/chat/add-
|
2173
|
+
# text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](
|
2174
|
+
# https://developers.google.com/workspace/extend):
|
2153
2175
|
class GoogleAppsCardV1Image
|
2154
2176
|
include Google::Apis::Core::Hashable
|
2155
2177
|
|
@@ -2159,7 +2181,7 @@ module Google
|
|
2159
2181
|
attr_accessor :alt_text
|
2160
2182
|
|
2161
2183
|
# The HTTPS URL that hosts the image. For example: ``` https://developers.google.
|
2162
|
-
# com/chat/images/quickstart-app-avatar.png ```
|
2184
|
+
# com/workspace/chat/images/quickstart-app-avatar.png ```
|
2163
2185
|
# Corresponds to the JSON property `imageUrl`
|
2164
2186
|
# @return [String]
|
2165
2187
|
attr_accessor :image_url
|
@@ -2330,25 +2352,25 @@ module Google
|
|
2330
2352
|
# rich media like images. Use cards to present detailed information, gather
|
2331
2353
|
# information from users, and guide users to take a next step. [Card builder](
|
2332
2354
|
# 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
|
-
# ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
2355
|
+
# see the following documentation: * For Google Chat apps, see [Design the
|
2356
|
+
# components of a card or dialog](https://developers.google.com/workspace/chat/
|
2357
|
+
# design-components-card-dialog). * For Google Workspace Add-ons, see [Card-
|
2358
|
+
# based interfaces](https://developers.google.com/apps-script/add-ons/concepts/
|
2359
|
+
# cards). **Example: Card message for a Google Chat app** ![Example contact card]
|
2360
|
+
# (https://developers.google.com/workspace/chat/images/card_api_reference.png)
|
2361
|
+
# To create the sample card message in Google Chat, use the following JSON: ``` `
|
2362
|
+
# "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "
|
2363
|
+
# Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.
|
2364
|
+
# google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "
|
2365
|
+
# CIRCLE", "imageAltText": "Avatar for Sasha" `, "sections": [ ` "header": "
|
2366
|
+
# Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets":
|
2367
|
+
# [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL" `, "text": "sasha@
|
2368
|
+
# example.com" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON" `,
|
2369
|
+
# "text": "Online" ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PHONE"
|
2370
|
+
# `, "text": "+1 (555) 555-1234" ` `, ` "buttonList": ` "buttons": [ ` "text": "
|
2371
|
+
# Share", "onClick": ` "openLink": ` "url": "https://example.com/share" ` ` `, `
|
2372
|
+
# "text": "Edit", "onClick": ` "action": ` "function": "goToView", "parameters":
|
2373
|
+
# [ ` "key": "viewType", "value": "EDIT" ` ] ` ` ` ] ` ` ] ` ] ` ` ] ` ```
|
2352
2374
|
# Corresponds to the JSON property `card`
|
2353
2375
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
2354
2376
|
attr_accessor :card
|
@@ -2464,9 +2486,9 @@ module Google
|
|
2464
2486
|
|
2465
2487
|
# Text that appears at the top of a section. Supports simple HTML formatted text.
|
2466
2488
|
# 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).
|
2489
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
2490
|
+
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
2491
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
2470
2492
|
# Corresponds to the JSON property `header`
|
2471
2493
|
# @return [String]
|
2472
2494
|
attr_accessor :header
|
@@ -2501,13 +2523,14 @@ module Google
|
|
2501
2523
|
|
2502
2524
|
# A widget that creates one or more UI items that users can select. For example,
|
2503
2525
|
# 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/
|
2526
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [Add
|
2527
|
+
# selectable UI elements](/workspace/chat/design-interactive-card-dialog#
|
2528
|
+
# add_selectable_ui_elements). Chat apps can process the value of items that
|
2529
|
+
# users select or input. For details about working with form inputs, see [
|
2530
|
+
# Receive form data](https://developers.google.com/workspace/chat/read-form-data)
|
2531
|
+
# . To collect undefined or abstract data from users, use the TextInput widget. [
|
2532
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
2533
|
+
# workspace/extend):
|
2511
2534
|
class GoogleAppsCardV1SelectionInput
|
2512
2535
|
include Google::Apis::Core::Hashable
|
2513
2536
|
|
@@ -2549,7 +2572,7 @@ module Google
|
|
2549
2572
|
|
2550
2573
|
# The name that identifies the selection input in a form input event. For
|
2551
2574
|
# details about working with form inputs, see [Receive form data](https://
|
2552
|
-
# developers.google.com/chat/
|
2575
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2553
2576
|
# Corresponds to the JSON property `name`
|
2554
2577
|
# @return [String]
|
2555
2578
|
attr_accessor :name
|
@@ -2617,7 +2640,7 @@ module Google
|
|
2617
2640
|
|
2618
2641
|
# For multiselect menus, the URL for the icon displayed next to the item's `text`
|
2619
2642
|
# field. Supports PNG and JPEG files. Must be an `HTTPS` URL. For example, `
|
2620
|
-
# https://developers.google.com/chat/images/quickstart-app-avatar.png`.
|
2643
|
+
# https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`.
|
2621
2644
|
# Corresponds to the JSON property `startIconUri`
|
2622
2645
|
# @return [String]
|
2623
2646
|
attr_accessor :start_icon_uri
|
@@ -2629,7 +2652,7 @@ module Google
|
|
2629
2652
|
|
2630
2653
|
# The value associated with this item. The client should use this as a form
|
2631
2654
|
# input value. For details about working with form inputs, see [Receive form
|
2632
|
-
# data](https://developers.google.com/chat/
|
2655
|
+
# data](https://developers.google.com/workspace/chat/read-form-data).
|
2633
2656
|
# Corresponds to the JSON property `value`
|
2634
2657
|
# @return [String]
|
2635
2658
|
attr_accessor :value
|
@@ -2714,7 +2737,7 @@ module Google
|
|
2714
2737
|
|
2715
2738
|
# The name by which the switch widget is identified in a form input event. For
|
2716
2739
|
# details about working with form inputs, see [Receive form data](https://
|
2717
|
-
# developers.google.com/chat/
|
2740
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2718
2741
|
# Corresponds to the JSON property `name`
|
2719
2742
|
# @return [String]
|
2720
2743
|
attr_accessor :name
|
@@ -2735,7 +2758,7 @@ module Google
|
|
2735
2758
|
|
2736
2759
|
# The value entered by a user, returned as part of a form input event. For
|
2737
2760
|
# details about working with form inputs, see [Receive form data](https://
|
2738
|
-
# developers.google.com/chat/
|
2761
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2739
2762
|
# Corresponds to the JSON property `value`
|
2740
2763
|
# @return [String]
|
2741
2764
|
attr_accessor :value
|
@@ -2755,14 +2778,15 @@ module Google
|
|
2755
2778
|
end
|
2756
2779
|
|
2757
2780
|
# 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
|
-
#
|
2781
|
+
# actions. For an example in Google Chat apps, see [Add a field in which a user
|
2782
|
+
# can enter text](https://developers.google.com/workspace/chat/design-
|
2783
|
+
# interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps
|
2784
|
+
# receive and can process the value of entered text during form input events.
|
2785
|
+
# For details about working with form inputs, see [Receive form data](https://
|
2786
|
+
# developers.google.com/workspace/chat/read-form-data). When you need to collect
|
2787
|
+
# undefined or abstract data from users, use a text input. To collect defined or
|
2788
|
+
# enumerated data from users, use the SelectionInput widget. [Google Workspace
|
2789
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
2766
2790
|
class GoogleAppsCardV1TextInput
|
2767
2791
|
include Google::Apis::Core::Hashable
|
2768
2792
|
|
@@ -2807,7 +2831,7 @@ module Google
|
|
2807
2831
|
|
2808
2832
|
# The name by which the text input is identified in a form input event. For
|
2809
2833
|
# details about working with form inputs, see [Receive form data](https://
|
2810
|
-
# developers.google.com/chat/
|
2834
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2811
2835
|
# Corresponds to the JSON property `name`
|
2812
2836
|
# @return [String]
|
2813
2837
|
attr_accessor :name
|
@@ -2835,7 +2859,7 @@ module Google
|
|
2835
2859
|
|
2836
2860
|
# The value entered by a user, returned as part of a form input event. For
|
2837
2861
|
# details about working with form inputs, see [Receive form data](https://
|
2838
|
-
# developers.google.com/chat/
|
2862
|
+
# developers.google.com/workspace/chat/read-form-data).
|
2839
2863
|
# Corresponds to the JSON property `value`
|
2840
2864
|
# @return [String]
|
2841
2865
|
attr_accessor :value
|
@@ -2859,9 +2883,10 @@ module Google
|
|
2859
2883
|
end
|
2860
2884
|
|
2861
2885
|
# A paragraph of text that supports formatting. For an example in Google Chat
|
2862
|
-
# apps, see [
|
2863
|
-
#
|
2864
|
-
# in Google
|
2886
|
+
# apps, see [Add a paragraph of formatted text](https://developers.google.com/
|
2887
|
+
# workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
|
2888
|
+
# For more information about formatting text, see [Formatting text in Google
|
2889
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
2865
2890
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
2866
2891
|
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
2867
2892
|
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
@@ -2890,17 +2915,18 @@ module Google
|
|
2890
2915
|
include Google::Apis::Core::Hashable
|
2891
2916
|
|
2892
2917
|
# 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):
|
2918
|
+
# see [Add a button](https://developers.google.com/workspace/chat/design-
|
2919
|
+
# interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps]
|
2920
|
+
# (https://developers.google.com/workspace/extend):
|
2896
2921
|
# Corresponds to the JSON property `buttonList`
|
2897
2922
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
2898
2923
|
attr_accessor :button_list
|
2899
2924
|
|
2900
2925
|
# The `Columns` widget displays up to 2 columns in a card or dialog. You can add
|
2901
2926
|
# 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/
|
2927
|
+
# specified. For an example in Google Chat apps, see [Display cards and dialogs
|
2928
|
+
# in columns](https://developers.google.com/workspace/chat/format-structure-card-
|
2929
|
+
# dialog#display_cards_and_dialogs_in_columns). The height of each column is
|
2904
2930
|
# determined by the taller column. For example, if the first column is taller
|
2905
2931
|
# than the second column, both columns have the height of the first column.
|
2906
2932
|
# Because each column can contain a different number of widgets, you can't
|
@@ -2920,47 +2946,52 @@ module Google
|
|
2920
2946
|
attr_accessor :columns
|
2921
2947
|
|
2922
2948
|
# 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
|
-
#
|
2949
|
+
# Google Chat apps, see [Let a user pick a date and time](https://developers.
|
2950
|
+
# google.com/workspace/chat/design-interactive-card-dialog#
|
2951
|
+
# let_a_user_pick_a_date_and_time). Users can input text or use the picker to
|
2952
|
+
# select dates and times. If users input an invalid date or time, the picker
|
2953
|
+
# shows an error that prompts users to input the information correctly. [Google
|
2954
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
2955
|
+
# extend):
|
2928
2956
|
# Corresponds to the JSON property `dateTimePicker`
|
2929
2957
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
2930
2958
|
attr_accessor :date_time_picker
|
2931
2959
|
|
2932
2960
|
# A widget that displays text with optional decorations such as a label above or
|
2933
2961
|
# 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
|
-
#
|
2962
|
+
# after the text. For an example in Google Chat apps, see [Display text with
|
2963
|
+
# decorative text](https://developers.google.com/workspace/chat/add-text-image-
|
2964
|
+
# card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons
|
2965
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
2937
2966
|
# Corresponds to the JSON property `decoratedText`
|
2938
2967
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
2939
2968
|
attr_accessor :decorated_text
|
2940
2969
|
|
2941
2970
|
# Displays a divider between widgets as a horizontal line. For an example in
|
2942
|
-
# Google Chat apps, see [
|
2943
|
-
#
|
2944
|
-
#
|
2945
|
-
#
|
2971
|
+
# Google Chat apps, see [Add a horizontal divider between widgets](https://
|
2972
|
+
# developers.google.com/workspace/chat/format-structure-card-dialog#
|
2973
|
+
# add_a_horizontal_divider_between_widgets). [Google Workspace Add-ons and Chat
|
2974
|
+
# apps](https://developers.google.com/workspace/extend): For example, the
|
2975
|
+
# following JSON creates a divider: ``` "divider": `` ```
|
2946
2976
|
# Corresponds to the JSON property `divider`
|
2947
2977
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Divider]
|
2948
2978
|
attr_accessor :divider
|
2949
2979
|
|
2950
2980
|
# Displays a grid with a collection of items. Items can only include text or
|
2951
2981
|
# 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
|
-
#
|
2982
|
+
# Columns`. For an example in Google Chat apps, see [Display a Grid with a
|
2983
|
+
# collection of items](https://developers.google.com/workspace/chat/format-
|
2984
|
+
# structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid
|
2985
|
+
# supports any number of columns and items. The number of rows is determined by
|
2986
|
+
# items divided by columns. A grid with 10 items and 2 columns has 5 rows. A
|
2987
|
+
# grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and
|
2988
|
+
# Chat apps](https://developers.google.com/workspace/extend): For example, the
|
2989
|
+
# following JSON creates a 2 column grid with a single item: ``` "grid": ` "
|
2990
|
+
# title": "A fine collection of items", "columnCount": 2, "borderStyle": ` "type"
|
2991
|
+
# : "STROKE", "cornerRadius": 4 `, "items": [ ` "image": ` "imageUri": "https://
|
2992
|
+
# www.example.com/image.png", "cropStyle": ` "type": "SQUARE" `, "borderStyle": `
|
2993
|
+
# "type": "STROKE" ` `, "title": "An item", "textAlignment": "CENTER" ` ], "
|
2994
|
+
# onClick": ` "openLink": ` "url": "https://www.example.com" ` ` ` ```
|
2964
2995
|
# Corresponds to the JSON property `grid`
|
2965
2996
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Grid]
|
2966
2997
|
attr_accessor :grid
|
@@ -2971,43 +3002,46 @@ module Google
|
|
2971
3002
|
attr_accessor :horizontal_alignment
|
2972
3003
|
|
2973
3004
|
# 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):
|
3005
|
+
# example, see [Add an image](https://developers.google.com/workspace/chat/add-
|
3006
|
+
# text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](
|
3007
|
+
# https://developers.google.com/workspace/extend):
|
2977
3008
|
# Corresponds to the JSON property `image`
|
2978
3009
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
2979
3010
|
attr_accessor :image
|
2980
3011
|
|
2981
3012
|
# A widget that creates one or more UI items that users can select. For example,
|
2982
3013
|
# 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/
|
3014
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [Add
|
3015
|
+
# selectable UI elements](/workspace/chat/design-interactive-card-dialog#
|
3016
|
+
# add_selectable_ui_elements). Chat apps can process the value of items that
|
3017
|
+
# users select or input. For details about working with form inputs, see [
|
3018
|
+
# Receive form data](https://developers.google.com/workspace/chat/read-form-data)
|
3019
|
+
# . To collect undefined or abstract data from users, use the TextInput widget. [
|
3020
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
3021
|
+
# workspace/extend):
|
2990
3022
|
# Corresponds to the JSON property `selectionInput`
|
2991
3023
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
2992
3024
|
attr_accessor :selection_input
|
2993
3025
|
|
2994
3026
|
# 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
|
-
#
|
3027
|
+
# actions. For an example in Google Chat apps, see [Add a field in which a user
|
3028
|
+
# can enter text](https://developers.google.com/workspace/chat/design-
|
3029
|
+
# interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps
|
3030
|
+
# receive and can process the value of entered text during form input events.
|
3031
|
+
# For details about working with form inputs, see [Receive form data](https://
|
3032
|
+
# developers.google.com/workspace/chat/read-form-data). When you need to collect
|
3033
|
+
# undefined or abstract data from users, use a text input. To collect defined or
|
3034
|
+
# enumerated data from users, use the SelectionInput widget. [Google Workspace
|
3035
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
3003
3036
|
# Corresponds to the JSON property `textInput`
|
3004
3037
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
3005
3038
|
attr_accessor :text_input
|
3006
3039
|
|
3007
3040
|
# A paragraph of text that supports formatting. For an example in Google Chat
|
3008
|
-
# apps, see [
|
3009
|
-
#
|
3010
|
-
# in Google
|
3041
|
+
# apps, see [Add a paragraph of formatted text](https://developers.google.com/
|
3042
|
+
# workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
|
3043
|
+
# For more information about formatting text, see [Formatting text in Google
|
3044
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
3011
3045
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
3012
3046
|
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
3013
3047
|
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
@@ -3043,70 +3077,76 @@ module Google
|
|
3043
3077
|
include Google::Apis::Core::Hashable
|
3044
3078
|
|
3045
3079
|
# 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):
|
3080
|
+
# see [Add a button](https://developers.google.com/workspace/chat/design-
|
3081
|
+
# interactive-card-dialog#add_a_button). [Google Workspace Add-ons and Chat apps]
|
3082
|
+
# (https://developers.google.com/workspace/extend):
|
3049
3083
|
# Corresponds to the JSON property `buttonList`
|
3050
3084
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
3051
3085
|
attr_accessor :button_list
|
3052
3086
|
|
3053
3087
|
# 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
|
-
#
|
3088
|
+
# Google Chat apps, see [Let a user pick a date and time](https://developers.
|
3089
|
+
# google.com/workspace/chat/design-interactive-card-dialog#
|
3090
|
+
# let_a_user_pick_a_date_and_time). Users can input text or use the picker to
|
3091
|
+
# select dates and times. If users input an invalid date or time, the picker
|
3092
|
+
# shows an error that prompts users to input the information correctly. [Google
|
3093
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
3094
|
+
# extend):
|
3059
3095
|
# Corresponds to the JSON property `dateTimePicker`
|
3060
3096
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
3061
3097
|
attr_accessor :date_time_picker
|
3062
3098
|
|
3063
3099
|
# A widget that displays text with optional decorations such as a label above or
|
3064
3100
|
# 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
|
-
#
|
3101
|
+
# after the text. For an example in Google Chat apps, see [Display text with
|
3102
|
+
# decorative text](https://developers.google.com/workspace/chat/add-text-image-
|
3103
|
+
# card-dialog#display_text_with_decorative_elements). [Google Workspace Add-ons
|
3104
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
3068
3105
|
# Corresponds to the JSON property `decoratedText`
|
3069
3106
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
3070
3107
|
attr_accessor :decorated_text
|
3071
3108
|
|
3072
3109
|
# 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):
|
3110
|
+
# example, see [Add an image](https://developers.google.com/workspace/chat/add-
|
3111
|
+
# text-image-card-dialog#add_an_image). [Google Workspace Add-ons and Chat apps](
|
3112
|
+
# https://developers.google.com/workspace/extend):
|
3076
3113
|
# Corresponds to the JSON property `image`
|
3077
3114
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
3078
3115
|
attr_accessor :image
|
3079
3116
|
|
3080
3117
|
# A widget that creates one or more UI items that users can select. For example,
|
3081
3118
|
# 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/
|
3119
|
+
# can be predicted or enumerated. For an example in Google Chat apps, see [Add
|
3120
|
+
# selectable UI elements](/workspace/chat/design-interactive-card-dialog#
|
3121
|
+
# add_selectable_ui_elements). Chat apps can process the value of items that
|
3122
|
+
# users select or input. For details about working with form inputs, see [
|
3123
|
+
# Receive form data](https://developers.google.com/workspace/chat/read-form-data)
|
3124
|
+
# . To collect undefined or abstract data from users, use the TextInput widget. [
|
3125
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
3126
|
+
# workspace/extend):
|
3089
3127
|
# Corresponds to the JSON property `selectionInput`
|
3090
3128
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
3091
3129
|
attr_accessor :selection_input
|
3092
3130
|
|
3093
3131
|
# 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
|
-
#
|
3132
|
+
# actions. For an example in Google Chat apps, see [Add a field in which a user
|
3133
|
+
# can enter text](https://developers.google.com/workspace/chat/design-
|
3134
|
+
# interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps
|
3135
|
+
# receive and can process the value of entered text during form input events.
|
3136
|
+
# For details about working with form inputs, see [Receive form data](https://
|
3137
|
+
# developers.google.com/workspace/chat/read-form-data). When you need to collect
|
3138
|
+
# undefined or abstract data from users, use a text input. To collect defined or
|
3139
|
+
# enumerated data from users, use the SelectionInput widget. [Google Workspace
|
3140
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
3102
3141
|
# Corresponds to the JSON property `textInput`
|
3103
3142
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
3104
3143
|
attr_accessor :text_input
|
3105
3144
|
|
3106
3145
|
# A paragraph of text that supports formatting. For an example in Google Chat
|
3107
|
-
# apps, see [
|
3108
|
-
#
|
3109
|
-
# in Google
|
3146
|
+
# apps, see [Add a paragraph of formatted text](https://developers.google.com/
|
3147
|
+
# workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
|
3148
|
+
# For more information about formatting text, see [Formatting text in Google
|
3149
|
+
# Chat apps](https://developers.google.com/workspace/chat/format-messages#card-
|
3110
3150
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
3111
3151
|
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
3112
3152
|
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
@@ -3297,9 +3337,9 @@ module Google
|
|
3297
3337
|
|
3298
3338
|
# The text of the bottom label. Formatted text supported. For more information
|
3299
3339
|
# 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).
|
3340
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
3341
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
3342
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
3303
3343
|
# Corresponds to the JSON property `bottomLabel`
|
3304
3344
|
# @return [String]
|
3305
3345
|
attr_accessor :bottom_label
|
@@ -3311,9 +3351,9 @@ module Google
|
|
3311
3351
|
|
3312
3352
|
# The text of the content. Formatted text supported and always required. For
|
3313
3353
|
# 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).
|
3354
|
+
# apps](https://developers.google.com/workspace/chat/format-messages#card-
|
3355
|
+
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
3356
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
3317
3357
|
# Corresponds to the JSON property `content`
|
3318
3358
|
# @return [String]
|
3319
3359
|
attr_accessor :content
|
@@ -3342,9 +3382,9 @@ module Google
|
|
3342
3382
|
|
3343
3383
|
# The text of the top label. Formatted text supported. For more information
|
3344
3384
|
# 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).
|
3385
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
3386
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
3387
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
3348
3388
|
# Corresponds to the JSON property `topLabel`
|
3349
3389
|
# @return [String]
|
3350
3390
|
attr_accessor :top_label
|
@@ -3366,7 +3406,7 @@ module Google
|
|
3366
3406
|
end
|
3367
3407
|
end
|
3368
3408
|
|
3369
|
-
#
|
3409
|
+
# Response to list memberships of the space.
|
3370
3410
|
class ListMembershipsResponse
|
3371
3411
|
include Google::Apis::Core::Hashable
|
3372
3412
|
|
@@ -3392,7 +3432,7 @@ module Google
|
|
3392
3432
|
end
|
3393
3433
|
end
|
3394
3434
|
|
3395
|
-
#
|
3435
|
+
# Response message for listing messages.
|
3396
3436
|
class ListMessagesResponse
|
3397
3437
|
include Google::Apis::Core::Hashable
|
3398
3438
|
|
@@ -3418,7 +3458,7 @@ module Google
|
|
3418
3458
|
end
|
3419
3459
|
end
|
3420
3460
|
|
3421
|
-
#
|
3461
|
+
# Response to a list reactions request.
|
3422
3462
|
class ListReactionsResponse
|
3423
3463
|
include Google::Apis::Core::Hashable
|
3424
3464
|
|
@@ -3470,7 +3510,7 @@ module Google
|
|
3470
3510
|
end
|
3471
3511
|
end
|
3472
3512
|
|
3473
|
-
#
|
3513
|
+
# The response for a list spaces request.
|
3474
3514
|
class ListSpacesResponse
|
3475
3515
|
include Google::Apis::Core::Hashable
|
3476
3516
|
|
@@ -3561,9 +3601,9 @@ module Google
|
|
3561
3601
|
attr_accessor :group_member
|
3562
3602
|
|
3563
3603
|
# 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`.
|
3604
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
3605
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
3606
|
+
# populates the user's `name` and `type`.
|
3567
3607
|
# Corresponds to the JSON property `member`
|
3568
3608
|
# @return [Google::Apis::ChatV1::User]
|
3569
3609
|
attr_accessor :member
|
@@ -3575,8 +3615,8 @@ module Google
|
|
3575
3615
|
attr_accessor :name
|
3576
3616
|
|
3577
3617
|
# Optional. User's role within a Chat space, which determines their permitted
|
3578
|
-
# actions in the space.
|
3579
|
-
#
|
3618
|
+
# actions in the space. This field can only be used as input in `
|
3619
|
+
# UpdateMembership`.
|
3580
3620
|
# Corresponds to the JSON property `role`
|
3581
3621
|
# @return [String]
|
3582
3622
|
attr_accessor :role
|
@@ -3735,7 +3775,7 @@ module Google
|
|
3735
3775
|
# Add interactive widgets at the bottom of a message](https://developers.google.
|
3736
3776
|
# com/workspace/chat/create-messages#add-accessory-widgets). Creating a message
|
3737
3777
|
# with accessory widgets requires [app authentication] (https://developers.
|
3738
|
-
# google.com/chat/
|
3778
|
+
# google.com/workspace/chat/authenticate-authorize-chat-app).
|
3739
3779
|
# Corresponds to the JSON property `accessoryWidgets`
|
3740
3780
|
# @return [Array<Google::Apis::ChatV1::AccessoryWidget>]
|
3741
3781
|
attr_accessor :accessory_widgets
|
@@ -3774,22 +3814,23 @@ module Google
|
|
3774
3814
|
# @return [Array<Google::Apis::ChatV1::Card>]
|
3775
3815
|
attr_accessor :cards
|
3776
3816
|
|
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/
|
3817
|
+
# An array of [cards](https://developers.google.com/workspace/chat/api/reference/
|
3818
|
+
# rest/v1/cards). Only Chat apps can create cards. If your Chat app [
|
3819
|
+
# authenticates as a user](https://developers.google.com/workspace/chat/
|
3820
|
+
# authenticate-authorize-chat-user), the messages can't contain cards. To learn
|
3821
|
+
# about cards and how to create them, see [Send card messages](https://
|
3822
|
+
# developers.google.com/workspace/chat/create-messages#create). [Card builder](
|
3823
|
+
# https://addons.gsuite.google.com/uikit/builder)
|
3783
3824
|
# Corresponds to the JSON property `cardsV2`
|
3784
3825
|
# @return [Array<Google::Apis::ChatV1::CardWithId>]
|
3785
3826
|
attr_accessor :cards_v2
|
3786
3827
|
|
3787
3828
|
# Optional. A custom ID for the message. You can use field to identify a message,
|
3788
3829
|
# 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
|
-
#
|
3830
|
+
# messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/
|
3831
|
+
# spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create
|
3832
|
+
# the message. For details, see [Name a message](https://developers.google.com/
|
3833
|
+
# workspace/chat/create-messages#name_a_created_message).
|
3793
3834
|
# Corresponds to the JSON property `clientAssignedMessageId`
|
3794
3835
|
# @return [String]
|
3795
3836
|
attr_accessor :client_assigned_message_id
|
@@ -3828,16 +3869,17 @@ module Google
|
|
3828
3869
|
|
3829
3870
|
# Output only. Contains the message `text` with markups added to communicate
|
3830
3871
|
# 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#
|
3872
|
+
# includes the following: * [Markup syntax](https://developers.google.com/
|
3873
|
+
# workspace/chat/format-messages) for bold, italic, strikethrough, monospace,
|
3874
|
+
# monospace block, and bulleted list. * [User mentions](https://developers.
|
3875
|
+
# google.com/workspace/chat/format-messages#messages-@mention) using the format `
|
3876
|
+
# `. * Custom hyperlinks using the format `<`url`|`rendered_text`>` where the
|
3877
|
+
# first string is the URL and the second is the rendered text—for example, ``. *
|
3878
|
+
# Custom emoji using the format `:`emoji_name`:`—for example, `:smile:`. This
|
3879
|
+
# doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji.
|
3880
|
+
# For more information, see [View text formatting sent in a message](https://
|
3881
|
+
# developers.google.com/workspace/chat/format-messages#
|
3882
|
+
# view_text_formatting_sent_in_a_message)
|
3841
3883
|
# Corresponds to the JSON property `formattedText`
|
3842
3884
|
# @return [String]
|
3843
3885
|
attr_accessor :formatted_text
|
@@ -3862,16 +3904,16 @@ module Google
|
|
3862
3904
|
# create a message, you can use this ID to specify the message in a request by
|
3863
3905
|
# replacing ``message`` with the value from the `clientAssignedMessageId` field.
|
3864
3906
|
# For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details,
|
3865
|
-
# see [Name a message](https://developers.google.com/chat/
|
3866
|
-
#
|
3907
|
+
# see [Name a message](https://developers.google.com/workspace/chat/create-
|
3908
|
+
# messages#name_a_created_message).
|
3867
3909
|
# Corresponds to the JSON property `name`
|
3868
3910
|
# @return [String]
|
3869
3911
|
attr_accessor :name
|
3870
3912
|
|
3871
3913
|
# 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`.
|
3914
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
3915
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
3916
|
+
# populates the user's `name` and `type`.
|
3875
3917
|
# Corresponds to the JSON property `privateMessageViewer`
|
3876
3918
|
# @return [Google::Apis::ChatV1::User]
|
3877
3919
|
attr_accessor :private_message_viewer
|
@@ -3882,14 +3924,14 @@ module Google
|
|
3882
3924
|
attr_accessor :quoted_message_metadata
|
3883
3925
|
|
3884
3926
|
# 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`.
|
3927
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
3928
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
3929
|
+
# populates the user's `name` and `type`.
|
3888
3930
|
# Corresponds to the JSON property `sender`
|
3889
3931
|
# @return [Google::Apis::ChatV1::User]
|
3890
3932
|
attr_accessor :sender
|
3891
3933
|
|
3892
|
-
# A [slash command](https://developers.google.com/chat/
|
3934
|
+
# A [slash command](https://developers.google.com/workspace/chat/slash-commands)
|
3893
3935
|
# in Google Chat.
|
3894
3936
|
# Corresponds to the JSON property `slashCommand`
|
3895
3937
|
# @return [Google::Apis::ChatV1::SlashCommand]
|
@@ -3902,20 +3944,21 @@ module Google
|
|
3902
3944
|
attr_accessor :space
|
3903
3945
|
|
3904
3946
|
# 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/
|
3947
|
+
# generates a [preview chip](https://developers.google.com/workspace/chat/
|
3948
|
+
# preview-links). You can also [@mention a Google Chat user](https://developers.
|
3949
|
+
# google.com/workspace/chat/format-messages#messages-@mention), or everyone in
|
3950
|
+
# the space. To learn about creating text messages, see [Send a text message](
|
3951
|
+
# https://developers.google.com/workspace/chat/create-messages#create-text-
|
3952
|
+
# messages).
|
3910
3953
|
# Corresponds to the JSON property `text`
|
3911
3954
|
# @return [String]
|
3912
3955
|
attr_accessor :text
|
3913
3956
|
|
3914
3957
|
# 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
|
3958
|
+
# message thread](https://developers.google.com/workspace/chat/create-messages#
|
3959
|
+
# create-message-thread). If you specify a thread when creating a message, you
|
3960
|
+
# can set the [`messageReplyOption`](https://developers.google.com/workspace/
|
3961
|
+
# chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to
|
3919
3962
|
# determine what happens if no matching thread is found.
|
3920
3963
|
# Corresponds to the JSON property `thread`
|
3921
3964
|
# @return [Google::Apis::ChatV1::Thread]
|
@@ -4173,9 +4216,9 @@ module Google
|
|
4173
4216
|
attr_accessor :name
|
4174
4217
|
|
4175
4218
|
# 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`.
|
4219
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
4220
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
4221
|
+
# populates the user's `name` and `type`.
|
4179
4222
|
# Corresponds to the JSON property `user`
|
4180
4223
|
# @return [Google::Apis::ChatV1::User]
|
4181
4224
|
attr_accessor :user
|
@@ -4312,9 +4355,9 @@ module Google
|
|
4312
4355
|
|
4313
4356
|
# The header of the section. Formatted text is supported. For more information
|
4314
4357
|
# 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).
|
4358
|
+
# developers.google.com/workspace/chat/format-messages#card-formatting) and [
|
4359
|
+
# Formatting text in Google Workspace Add-ons](https://developers.google.com/
|
4360
|
+
# apps-script/add-ons/concepts/widgets#text_formatting).
|
4318
4361
|
# Corresponds to the JSON property `header`
|
4319
4362
|
# @return [String]
|
4320
4363
|
attr_accessor :header
|
@@ -4354,7 +4397,7 @@ module Google
|
|
4354
4397
|
end
|
4355
4398
|
end
|
4356
4399
|
|
4357
|
-
#
|
4400
|
+
# Request to create a space and add specified users to it.
|
4358
4401
|
class SetUpSpaceRequest
|
4359
4402
|
include Google::Apis::Core::Hashable
|
4360
4403
|
|
@@ -4404,7 +4447,7 @@ module Google
|
|
4404
4447
|
end
|
4405
4448
|
end
|
4406
4449
|
|
4407
|
-
# A [slash command](https://developers.google.com/chat/
|
4450
|
+
# A [slash command](https://developers.google.com/workspace/chat/slash-commands)
|
4408
4451
|
# in Google Chat.
|
4409
4452
|
class SlashCommand
|
4410
4453
|
include Google::Apis::Core::Hashable
|
@@ -4429,9 +4472,9 @@ module Google
|
|
4429
4472
|
include Google::Apis::Core::Hashable
|
4430
4473
|
|
4431
4474
|
# 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`.
|
4475
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
4476
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
4477
|
+
# populates the user's `name` and `type`.
|
4435
4478
|
# Corresponds to the JSON property `bot`
|
4436
4479
|
# @return [Google::Apis::ChatV1::User]
|
4437
4480
|
attr_accessor :bot
|
@@ -4496,11 +4539,11 @@ module Google
|
|
4496
4539
|
attr_accessor :create_time
|
4497
4540
|
|
4498
4541
|
# 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.
|
4542
|
+
# google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive
|
4543
|
+
# the error message `ALREADY_EXISTS` when creating a space or updating the `
|
4544
|
+
# displayName`, try a different `displayName`. An existing space within the
|
4545
|
+
# Google Workspace organization might already use this display name. For direct
|
4546
|
+
# messages, this field might be empty. Supports up to 128 characters.
|
4504
4547
|
# Corresponds to the JSON property `displayName`
|
4505
4548
|
# @return [String]
|
4506
4549
|
attr_accessor :display_name
|
@@ -4511,8 +4554,11 @@ module Google
|
|
4511
4554
|
# consumer account (unmanaged user account). By default, a space created by a
|
4512
4555
|
# consumer account permits any Google Chat user. * The space is used to [import
|
4513
4556
|
# data to Google Chat] (https://developers.google.com/chat/api/guides/import-
|
4514
|
-
# data-overview)
|
4515
|
-
# Google Workspace organization.
|
4557
|
+
# data-overview) because import mode spaces must only permit members from the
|
4558
|
+
# same Google Workspace organization. However, as part of the [Google Workspace
|
4559
|
+
# Developer Preview Program](https://developers.google.com/workspace/preview),
|
4560
|
+
# import mode spaces can permit any Google Chat user so this field can then be
|
4561
|
+
# set for import mode spaces. For existing spaces, this field is output only.
|
4516
4562
|
# Corresponds to the JSON property `externalUserAllowed`
|
4517
4563
|
# @return [Boolean]
|
4518
4564
|
attr_accessor :external_user_allowed
|
@@ -4958,9 +5004,9 @@ module Google
|
|
4958
5004
|
|
4959
5005
|
# A paragraph of text. Formatted text supported. For more information about
|
4960
5006
|
# 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).
|
5007
|
+
# google.com/workspace/chat/format-messages#card-formatting) and [Formatting
|
5008
|
+
# text in Google Workspace Add-ons](https://developers.google.com/apps-script/
|
5009
|
+
# add-ons/concepts/widgets#text_formatting).
|
4964
5010
|
class TextParagraph
|
4965
5011
|
include Google::Apis::Core::Hashable
|
4966
5012
|
|
@@ -4980,10 +5026,10 @@ module Google
|
|
4980
5026
|
end
|
4981
5027
|
|
4982
5028
|
# 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
|
5029
|
+
# message thread](https://developers.google.com/workspace/chat/create-messages#
|
5030
|
+
# create-message-thread). If you specify a thread when creating a message, you
|
5031
|
+
# can set the [`messageReplyOption`](https://developers.google.com/workspace/
|
5032
|
+
# chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to
|
4987
5033
|
# determine what happens if no matching thread is found.
|
4988
5034
|
class Thread
|
4989
5035
|
include Google::Apis::Core::Hashable
|
@@ -5098,7 +5144,7 @@ module Google
|
|
5098
5144
|
end
|
5099
5145
|
end
|
5100
5146
|
|
5101
|
-
#
|
5147
|
+
# Request to upload an attachment.
|
5102
5148
|
class UploadAttachmentRequest
|
5103
5149
|
include Google::Apis::Core::Hashable
|
5104
5150
|
|
@@ -5117,11 +5163,11 @@ module Google
|
|
5117
5163
|
end
|
5118
5164
|
end
|
5119
5165
|
|
5120
|
-
#
|
5166
|
+
# Response of uploading an attachment.
|
5121
5167
|
class UploadAttachmentResponse
|
5122
5168
|
include Google::Apis::Core::Hashable
|
5123
5169
|
|
5124
|
-
#
|
5170
|
+
# A reference to the attachment data.
|
5125
5171
|
# Corresponds to the JSON property `attachmentDataRef`
|
5126
5172
|
# @return [Google::Apis::ChatV1::AttachmentDataRef]
|
5127
5173
|
attr_accessor :attachment_data_ref
|
@@ -5137,9 +5183,9 @@ module Google
|
|
5137
5183
|
end
|
5138
5184
|
|
5139
5185
|
# 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`.
|
5186
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
5187
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
5188
|
+
# populates the user's `name` and `type`.
|
5143
5189
|
class User
|
5144
5190
|
include Google::Apis::Core::Hashable
|
5145
5191
|
|
@@ -5204,9 +5250,9 @@ module Google
|
|
5204
5250
|
attr_accessor :type
|
5205
5251
|
|
5206
5252
|
# 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`.
|
5253
|
+
# app [authenticates as a user](https://developers.google.com/workspace/chat/
|
5254
|
+
# authenticate-authorize-chat-user), the output for a `User` resource only
|
5255
|
+
# populates the user's `name` and `type`.
|
5210
5256
|
# Corresponds to the JSON property `user`
|
5211
5257
|
# @return [Google::Apis::ChatV1::User]
|
5212
5258
|
attr_accessor :user
|
@@ -5245,9 +5291,9 @@ module Google
|
|
5245
5291
|
|
5246
5292
|
# A paragraph of text. Formatted text supported. For more information about
|
5247
5293
|
# 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).
|
5294
|
+
# google.com/workspace/chat/format-messages#card-formatting) and [Formatting
|
5295
|
+
# text in Google Workspace Add-ons](https://developers.google.com/apps-script/
|
5296
|
+
# add-ons/concepts/widgets#text_formatting).
|
5251
5297
|
# Corresponds to the JSON property `textParagraph`
|
5252
5298
|
# @return [Google::Apis::ChatV1::TextParagraph]
|
5253
5299
|
attr_accessor :text_paragraph
|