google-apis-chat_v1 0.80.0 → 0.82.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/lib/google/apis/chat_v1/classes.rb +418 -248
- data/lib/google/apis/chat_v1/gem_version.rb +3 -3
- data/lib/google/apis/chat_v1/representations.rb +31 -0
- data/lib/google/apis/chat_v1/service.rb +92 -33
- metadata +6 -6
|
@@ -413,33 +413,35 @@ module Google
|
|
|
413
413
|
# A [card](https://developers.google.com/chat/api/reference/rest/v1/cards) in a
|
|
414
414
|
# Google Chat message. Only Chat apps can create cards. If your Chat app [
|
|
415
415
|
# authenticates as a user](https://developers.google.com/chat/api/guides/auth/
|
|
416
|
-
# users), the message can't contain cards.
|
|
416
|
+
# users), the message can't contain cards. [Card builder](https://addons.gsuite.
|
|
417
|
+
# google.com/uikit/builder)
|
|
417
418
|
class CardWithId
|
|
418
419
|
include Google::Apis::Core::Hashable
|
|
419
420
|
|
|
420
421
|
# A card interface displayed in a Google Chat message or Google Workspace Add-on.
|
|
421
422
|
# Cards support a defined layout, interactive UI elements like buttons, and
|
|
422
423
|
# rich media like images. Use cards to present detailed information, gather
|
|
423
|
-
# information from users, and guide users to take a next step.
|
|
424
|
-
#
|
|
425
|
-
#
|
|
426
|
-
# google.com/chat/
|
|
427
|
-
# interfaces](https://
|
|
428
|
-
# **Example: Card
|
|
429
|
-
#
|
|
430
|
-
#
|
|
431
|
-
#
|
|
432
|
-
#
|
|
433
|
-
#
|
|
434
|
-
# "
|
|
435
|
-
#
|
|
436
|
-
#
|
|
437
|
-
#
|
|
438
|
-
#
|
|
439
|
-
#
|
|
440
|
-
#
|
|
441
|
-
# "
|
|
442
|
-
#
|
|
424
|
+
# information from users, and guide users to take a next step. [Card builder](
|
|
425
|
+
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
|
426
|
+
# see the following documentation: * For Google Chat apps, see [Design dynamic,
|
|
427
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
428
|
+
# ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://
|
|
429
|
+
# developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card
|
|
430
|
+
# message for a Google Chat app**  To create the sample card
|
|
432
|
+
# message in Google Chat, use the following JSON: ``` ` "cardsV2": [ ` "cardId":
|
|
433
|
+
# "unique-card-id", "card": ` "header": ` "title": "Sasha", "subtitle": "
|
|
434
|
+
# Software Engineer", "imageUrl": "https://developers.google.com/chat/images/
|
|
435
|
+
# quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for
|
|
436
|
+
# Sasha", `, "sections": [ ` "header": "Contact Info", "collapsible": true, "
|
|
437
|
+
# uncollapsibleWidgetsCount": 1, "widgets": [ ` "decoratedText": ` "startIcon": `
|
|
438
|
+
# "knownIcon": "EMAIL", `, "text": "sasha@example.com", ` `, ` "decoratedText":
|
|
439
|
+
# ` "startIcon": ` "knownIcon": "PERSON", `, "text": "Online", `, `, ` "
|
|
440
|
+
# decoratedText": ` "startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555)
|
|
441
|
+
# 555-1234", ` `, ` "buttonList": ` "buttons": [ ` "text": "Share", "onClick": `
|
|
442
|
+
# "openLink": ` "url": "https://example.com/share", ` ` `, ` "text": "Edit", "
|
|
443
|
+
# onClick": ` "action": ` "function": "goToView", "parameters": [ ` "key": "
|
|
444
|
+
# viewType", "value": "EDIT", ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
443
445
|
# Corresponds to the JSON property `card`
|
|
444
446
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
|
445
447
|
attr_accessor :card
|
|
@@ -501,15 +503,16 @@ module Google
|
|
|
501
503
|
end
|
|
502
504
|
end
|
|
503
505
|
|
|
504
|
-
#
|
|
505
|
-
#
|
|
506
|
-
#
|
|
507
|
-
#
|
|
506
|
+
# For a `SelectionInput` widget that uses a multiselect menu, a data source from
|
|
507
|
+
# Google Chat. The data source populates selection items for the multiselect
|
|
508
|
+
# menu. For example, a user can select Google Chat spaces that they're a member
|
|
509
|
+
# of. [Google Chat apps](https://developers.google.com/chat):
|
|
508
510
|
class ChatClientDataSourceMarkup
|
|
509
511
|
include Google::Apis::Core::Hashable
|
|
510
512
|
|
|
511
513
|
# A data source that populates Google Chat spaces as selection items for a
|
|
512
|
-
# multiselect menu. Only populates spaces that the user is a member of.
|
|
514
|
+
# multiselect menu. Only populates spaces that the user is a member of. [Google
|
|
515
|
+
# Chat apps](https://developers.google.com/chat):
|
|
513
516
|
# Corresponds to the JSON property `spaceDataSource`
|
|
514
517
|
# @return [Google::Apis::ChatV1::SpaceDataSource]
|
|
515
518
|
attr_accessor :space_data_source
|
|
@@ -686,6 +689,39 @@ module Google
|
|
|
686
689
|
end
|
|
687
690
|
end
|
|
688
691
|
|
|
692
|
+
# Request message for completing the import process for a space.
|
|
693
|
+
class CompleteImportSpaceRequest
|
|
694
|
+
include Google::Apis::Core::Hashable
|
|
695
|
+
|
|
696
|
+
def initialize(**args)
|
|
697
|
+
update!(**args)
|
|
698
|
+
end
|
|
699
|
+
|
|
700
|
+
# Update properties of this object
|
|
701
|
+
def update!(**args)
|
|
702
|
+
end
|
|
703
|
+
end
|
|
704
|
+
|
|
705
|
+
#
|
|
706
|
+
class CompleteImportSpaceResponse
|
|
707
|
+
include Google::Apis::Core::Hashable
|
|
708
|
+
|
|
709
|
+
# A space in Google Chat. Spaces are conversations between two or more users or
|
|
710
|
+
# 1:1 messages between a user and a Chat app.
|
|
711
|
+
# Corresponds to the JSON property `space`
|
|
712
|
+
# @return [Google::Apis::ChatV1::Space]
|
|
713
|
+
attr_accessor :space
|
|
714
|
+
|
|
715
|
+
def initialize(**args)
|
|
716
|
+
update!(**args)
|
|
717
|
+
end
|
|
718
|
+
|
|
719
|
+
# Update properties of this object
|
|
720
|
+
def update!(**args)
|
|
721
|
+
@space = args[:space] if args.key?(:space)
|
|
722
|
+
end
|
|
723
|
+
end
|
|
724
|
+
|
|
689
725
|
# Represents a custom emoji.
|
|
690
726
|
class CustomEmoji
|
|
691
727
|
include Google::Apis::Core::Hashable
|
|
@@ -898,26 +934,27 @@ module Google
|
|
|
898
934
|
# A card interface displayed in a Google Chat message or Google Workspace Add-on.
|
|
899
935
|
# Cards support a defined layout, interactive UI elements like buttons, and
|
|
900
936
|
# rich media like images. Use cards to present detailed information, gather
|
|
901
|
-
# information from users, and guide users to take a next step.
|
|
902
|
-
#
|
|
903
|
-
#
|
|
904
|
-
# google.com/chat/
|
|
905
|
-
# interfaces](https://
|
|
906
|
-
# **Example: Card
|
|
907
|
-
#
|
|
908
|
-
#
|
|
909
|
-
#
|
|
910
|
-
#
|
|
911
|
-
#
|
|
912
|
-
# "
|
|
913
|
-
#
|
|
914
|
-
#
|
|
915
|
-
#
|
|
916
|
-
#
|
|
917
|
-
#
|
|
918
|
-
#
|
|
919
|
-
# "
|
|
920
|
-
#
|
|
937
|
+
# information from users, and guide users to take a next step. [Card builder](
|
|
938
|
+
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
|
939
|
+
# see the following documentation: * For Google Chat apps, see [Design dynamic,
|
|
940
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
941
|
+
# ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://
|
|
942
|
+
# developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card
|
|
943
|
+
# message for a Google Chat app**  To create the sample card
|
|
945
|
+
# message in Google Chat, use the following JSON: ``` ` "cardsV2": [ ` "cardId":
|
|
946
|
+
# "unique-card-id", "card": ` "header": ` "title": "Sasha", "subtitle": "
|
|
947
|
+
# Software Engineer", "imageUrl": "https://developers.google.com/chat/images/
|
|
948
|
+
# quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for
|
|
949
|
+
# Sasha", `, "sections": [ ` "header": "Contact Info", "collapsible": true, "
|
|
950
|
+
# uncollapsibleWidgetsCount": 1, "widgets": [ ` "decoratedText": ` "startIcon": `
|
|
951
|
+
# "knownIcon": "EMAIL", `, "text": "sasha@example.com", ` `, ` "decoratedText":
|
|
952
|
+
# ` "startIcon": ` "knownIcon": "PERSON", `, "text": "Online", `, `, ` "
|
|
953
|
+
# decoratedText": ` "startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555)
|
|
954
|
+
# 555-1234", ` `, ` "buttonList": ` "buttons": [ ` "text": "Share", "onClick": `
|
|
955
|
+
# "openLink": ` "url": "https://example.com/share", ` ` `, ` "text": "Edit", "
|
|
956
|
+
# onClick": ` "action": ` "function": "goToView", "parameters": [ ` "key": "
|
|
957
|
+
# viewType", "value": "EDIT", ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
921
958
|
# Corresponds to the JSON property `body`
|
|
922
959
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
|
923
960
|
attr_accessor :body
|
|
@@ -1075,7 +1112,8 @@ module Google
|
|
|
1075
1112
|
|
|
1076
1113
|
# An action that describes the behavior when the form is submitted. For example,
|
|
1077
1114
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
1078
|
-
# triggered, the form values are sent to the server.
|
|
1115
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
1116
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
1079
1117
|
class GoogleAppsCardV1Action
|
|
1080
1118
|
include Google::Apis::Core::Hashable
|
|
1081
1119
|
|
|
@@ -1093,9 +1131,9 @@ module Google
|
|
|
1093
1131
|
# normal. By specifying an `interaction`, the app can respond in special
|
|
1094
1132
|
# interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the
|
|
1095
1133
|
# app can open a [dialog](https://developers.google.com/chat/how-tos/dialogs).
|
|
1096
|
-
# When specified, a loading indicator isn't shown.
|
|
1097
|
-
#
|
|
1098
|
-
#
|
|
1134
|
+
# When specified, a loading indicator isn't shown. If specified for an add-on,
|
|
1135
|
+
# the entire card is stripped and nothing is shown in the client. [Google Chat
|
|
1136
|
+
# apps](https://developers.google.com/chat):
|
|
1099
1137
|
# Corresponds to the JSON property `interaction`
|
|
1100
1138
|
# @return [String]
|
|
1101
1139
|
attr_accessor :interaction
|
|
@@ -1149,7 +1187,8 @@ module Google
|
|
|
1149
1187
|
# next week. You might use `action method = snooze()`, passing the snooze type
|
|
1150
1188
|
# and snooze time in the list of string parameters. To learn more, see [`
|
|
1151
1189
|
# CommonEventObject`](https://developers.google.com/chat/api/reference/rest/v1/
|
|
1152
|
-
# Event#commoneventobject).
|
|
1190
|
+
# Event#commoneventobject). [Google Workspace Add-ons and Chat apps](https://
|
|
1191
|
+
# developers.google.com/workspace/extend):
|
|
1153
1192
|
class GoogleAppsCardV1ActionParameter
|
|
1154
1193
|
include Google::Apis::Core::Hashable
|
|
1155
1194
|
|
|
@@ -1175,7 +1214,8 @@ module Google
|
|
|
1175
1214
|
end
|
|
1176
1215
|
|
|
1177
1216
|
# The style options for the border of a card or widget, including the border
|
|
1178
|
-
# type and color.
|
|
1217
|
+
# type and color. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
1218
|
+
# google.com/workspace/extend):
|
|
1179
1219
|
class GoogleAppsCardV1BorderStyle
|
|
1180
1220
|
include Google::Apis::Core::Hashable
|
|
1181
1221
|
|
|
@@ -1253,7 +1293,8 @@ module Google
|
|
|
1253
1293
|
# A text, icon, or text and icon button that users can click. For an example in
|
|
1254
1294
|
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1255
1295
|
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1256
|
-
# not an `ImageComponent`) and set an `onClick` action.
|
|
1296
|
+
# not an `ImageComponent`) and set an `onClick` action. [Google Workspace Add-
|
|
1297
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1257
1298
|
class GoogleAppsCardV1Button
|
|
1258
1299
|
include Google::Apis::Core::Hashable
|
|
1259
1300
|
|
|
@@ -1325,12 +1366,15 @@ module Google
|
|
|
1325
1366
|
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1326
1367
|
# built-in](https://developers.google.com/chat/format-messages#builtinicons) and
|
|
1327
1368
|
# [custom](https://developers.google.com/chat/format-messages#customicons) icons.
|
|
1369
|
+
# [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
1370
|
+
# workspace/extend):
|
|
1328
1371
|
# Corresponds to the JSON property `icon`
|
|
1329
1372
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1330
1373
|
attr_accessor :icon
|
|
1331
1374
|
|
|
1332
1375
|
# Represents how to respond when users click an interactive element on a card,
|
|
1333
|
-
# such as a button.
|
|
1376
|
+
# such as a button. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
1377
|
+
# google.com/workspace/extend):
|
|
1334
1378
|
# Corresponds to the JSON property `onClick`
|
|
1335
1379
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
|
|
1336
1380
|
attr_accessor :on_click
|
|
@@ -1356,7 +1400,9 @@ module Google
|
|
|
1356
1400
|
end
|
|
1357
1401
|
|
|
1358
1402
|
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
|
1359
|
-
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list).
|
|
1403
|
+
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [
|
|
1404
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
1405
|
+
# workspace/extend):
|
|
1360
1406
|
class GoogleAppsCardV1ButtonList
|
|
1361
1407
|
include Google::Apis::Core::Hashable
|
|
1362
1408
|
|
|
@@ -1378,31 +1424,32 @@ module Google
|
|
|
1378
1424
|
# A card interface displayed in a Google Chat message or Google Workspace Add-on.
|
|
1379
1425
|
# Cards support a defined layout, interactive UI elements like buttons, and
|
|
1380
1426
|
# rich media like images. Use cards to present detailed information, gather
|
|
1381
|
-
# information from users, and guide users to take a next step.
|
|
1382
|
-
#
|
|
1383
|
-
#
|
|
1384
|
-
# google.com/chat/
|
|
1385
|
-
# interfaces](https://
|
|
1386
|
-
# **Example: Card
|
|
1387
|
-
#
|
|
1388
|
-
#
|
|
1389
|
-
#
|
|
1390
|
-
#
|
|
1391
|
-
#
|
|
1392
|
-
# "
|
|
1393
|
-
#
|
|
1394
|
-
#
|
|
1395
|
-
#
|
|
1396
|
-
#
|
|
1397
|
-
#
|
|
1398
|
-
#
|
|
1399
|
-
# "
|
|
1400
|
-
#
|
|
1427
|
+
# information from users, and guide users to take a next step. [Card builder](
|
|
1428
|
+
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
|
1429
|
+
# see the following documentation: * For Google Chat apps, see [Design dynamic,
|
|
1430
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
1431
|
+
# ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://
|
|
1432
|
+
# developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card
|
|
1433
|
+
# message for a Google Chat app**  To create the sample card
|
|
1435
|
+
# message in Google Chat, use the following JSON: ``` ` "cardsV2": [ ` "cardId":
|
|
1436
|
+
# "unique-card-id", "card": ` "header": ` "title": "Sasha", "subtitle": "
|
|
1437
|
+
# Software Engineer", "imageUrl": "https://developers.google.com/chat/images/
|
|
1438
|
+
# quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for
|
|
1439
|
+
# Sasha", `, "sections": [ ` "header": "Contact Info", "collapsible": true, "
|
|
1440
|
+
# uncollapsibleWidgetsCount": 1, "widgets": [ ` "decoratedText": ` "startIcon": `
|
|
1441
|
+
# "knownIcon": "EMAIL", `, "text": "sasha@example.com", ` `, ` "decoratedText":
|
|
1442
|
+
# ` "startIcon": ` "knownIcon": "PERSON", `, "text": "Online", `, `, ` "
|
|
1443
|
+
# decoratedText": ` "startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555)
|
|
1444
|
+
# 555-1234", ` `, ` "buttonList": ` "buttons": [ ` "text": "Share", "onClick": `
|
|
1445
|
+
# "openLink": ` "url": "https://example.com/share", ` ` `, ` "text": "Edit", "
|
|
1446
|
+
# onClick": ` "action": ` "function": "goToView", "parameters": [ ` "key": "
|
|
1447
|
+
# viewType", "value": "EDIT", ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
1401
1448
|
class GoogleAppsCardV1Card
|
|
1402
1449
|
include Google::Apis::Core::Hashable
|
|
1403
1450
|
|
|
1404
|
-
# The card's actions. Actions are added to the card's toolbar menu.
|
|
1405
|
-
#
|
|
1451
|
+
# The card's actions. Actions are added to the card's toolbar menu. [Google
|
|
1452
|
+
# Workspace Add-ons](https://developers.google.com/workspace/add-ons): For
|
|
1406
1453
|
# example, the following JSON constructs a card action menu with `Settings` and `
|
|
1407
1454
|
# Send Feedback` options: ``` "card_actions": [ ` "actionLabel": "Settings", "
|
|
1408
1455
|
# onClick": ` "action": ` "functionName": "goToView", "parameters": [ ` "key": "
|
|
@@ -1413,38 +1460,41 @@ module Google
|
|
|
1413
1460
|
# @return [Array<Google::Apis::ChatV1::GoogleAppsCardV1CardAction>]
|
|
1414
1461
|
attr_accessor :card_actions
|
|
1415
1462
|
|
|
1416
|
-
# In Google Workspace
|
|
1417
|
-
# peekCardHeader`.
|
|
1463
|
+
# In Google Workspace Add-ons, sets the display properties of the `
|
|
1464
|
+
# peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/
|
|
1465
|
+
# workspace/add-ons):
|
|
1418
1466
|
# Corresponds to the JSON property `displayStyle`
|
|
1419
1467
|
# @return [String]
|
|
1420
1468
|
attr_accessor :display_style
|
|
1421
1469
|
|
|
1422
|
-
# A persistent (sticky) footer that that appears at the bottom of the card.
|
|
1423
|
-
#
|
|
1424
|
-
#
|
|
1425
|
-
#
|
|
1426
|
-
#
|
|
1427
|
-
#
|
|
1428
|
-
#
|
|
1429
|
-
#
|
|
1470
|
+
# A persistent (sticky) footer that that appears at the bottom of the card.
|
|
1471
|
+
# Setting `fixedFooter` without specifying a `primaryButton` or a `
|
|
1472
|
+
# secondaryButton` causes an error. For Chat apps, you can use fixed footers in [
|
|
1473
|
+
# dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card
|
|
1474
|
+
# messages](https://developers.google.com/chat/api/guides/v1/messages/create#
|
|
1475
|
+
# create). For an example in Google Chat apps, see [Card footer](https://
|
|
1476
|
+
# developers.google.com/chat/ui/widgets/card-fixed-footer). [Google Workspace
|
|
1477
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1430
1478
|
# Corresponds to the JSON property `fixedFooter`
|
|
1431
1479
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardFixedFooter]
|
|
1432
1480
|
attr_accessor :fixed_footer
|
|
1433
1481
|
|
|
1434
1482
|
# Represents a card header. For an example in Google Chat apps, see [Card header]
|
|
1435
|
-
# (https://developers.google.com/chat/ui/widgets/card-header).
|
|
1483
|
+
# (https://developers.google.com/chat/ui/widgets/card-header). [Google Workspace
|
|
1484
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1436
1485
|
# Corresponds to the JSON property `header`
|
|
1437
1486
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
|
1438
1487
|
attr_accessor :header
|
|
1439
1488
|
|
|
1440
|
-
# Name of the card. Used as a card identifier in card navigation.
|
|
1441
|
-
#
|
|
1489
|
+
# Name of the card. Used as a card identifier in card navigation. [Google
|
|
1490
|
+
# Workspace Add-ons](https://developers.google.com/workspace/add-ons):
|
|
1442
1491
|
# Corresponds to the JSON property `name`
|
|
1443
1492
|
# @return [String]
|
|
1444
1493
|
attr_accessor :name
|
|
1445
1494
|
|
|
1446
1495
|
# Represents a card header. For an example in Google Chat apps, see [Card header]
|
|
1447
|
-
# (https://developers.google.com/chat/ui/widgets/card-header).
|
|
1496
|
+
# (https://developers.google.com/chat/ui/widgets/card-header). [Google Workspace
|
|
1497
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1448
1498
|
# Corresponds to the JSON property `peekCardHeader`
|
|
1449
1499
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1CardHeader]
|
|
1450
1500
|
attr_accessor :peek_card_header
|
|
@@ -1481,7 +1531,8 @@ module Google
|
|
|
1481
1531
|
|
|
1482
1532
|
# A card action is the action associated with the card. For example, an invoice
|
|
1483
1533
|
# card might include actions such as delete invoice, email invoice, or open the
|
|
1484
|
-
# invoice in a browser.
|
|
1534
|
+
# invoice in a browser. [Google Workspace Add-ons](https://developers.google.com/
|
|
1535
|
+
# workspace/add-ons):
|
|
1485
1536
|
class GoogleAppsCardV1CardAction
|
|
1486
1537
|
include Google::Apis::Core::Hashable
|
|
1487
1538
|
|
|
@@ -1491,7 +1542,8 @@ module Google
|
|
|
1491
1542
|
attr_accessor :action_label
|
|
1492
1543
|
|
|
1493
1544
|
# Represents how to respond when users click an interactive element on a card,
|
|
1494
|
-
# such as a button.
|
|
1545
|
+
# such as a button. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
1546
|
+
# google.com/workspace/extend):
|
|
1495
1547
|
# Corresponds to the JSON property `onClick`
|
|
1496
1548
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
|
|
1497
1549
|
attr_accessor :on_click
|
|
@@ -1507,21 +1559,22 @@ module Google
|
|
|
1507
1559
|
end
|
|
1508
1560
|
end
|
|
1509
1561
|
|
|
1510
|
-
# A persistent (sticky) footer that that appears at the bottom of the card.
|
|
1511
|
-
#
|
|
1512
|
-
#
|
|
1513
|
-
#
|
|
1514
|
-
#
|
|
1515
|
-
#
|
|
1516
|
-
#
|
|
1517
|
-
#
|
|
1562
|
+
# A persistent (sticky) footer that that appears at the bottom of the card.
|
|
1563
|
+
# Setting `fixedFooter` without specifying a `primaryButton` or a `
|
|
1564
|
+
# secondaryButton` causes an error. For Chat apps, you can use fixed footers in [
|
|
1565
|
+
# dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card
|
|
1566
|
+
# messages](https://developers.google.com/chat/api/guides/v1/messages/create#
|
|
1567
|
+
# create). For an example in Google Chat apps, see [Card footer](https://
|
|
1568
|
+
# developers.google.com/chat/ui/widgets/card-fixed-footer). [Google Workspace
|
|
1569
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1518
1570
|
class GoogleAppsCardV1CardFixedFooter
|
|
1519
1571
|
include Google::Apis::Core::Hashable
|
|
1520
1572
|
|
|
1521
1573
|
# A text, icon, or text and icon button that users can click. For an example in
|
|
1522
1574
|
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1523
1575
|
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1524
|
-
# not an `ImageComponent`) and set an `onClick` action.
|
|
1576
|
+
# not an `ImageComponent`) and set an `onClick` action. [Google Workspace Add-
|
|
1577
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1525
1578
|
# Corresponds to the JSON property `primaryButton`
|
|
1526
1579
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
|
1527
1580
|
attr_accessor :primary_button
|
|
@@ -1529,7 +1582,8 @@ module Google
|
|
|
1529
1582
|
# A text, icon, or text and icon button that users can click. For an example in
|
|
1530
1583
|
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1531
1584
|
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1532
|
-
# not an `ImageComponent`) and set an `onClick` action.
|
|
1585
|
+
# not an `ImageComponent`) and set an `onClick` action. [Google Workspace Add-
|
|
1586
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1533
1587
|
# Corresponds to the JSON property `secondaryButton`
|
|
1534
1588
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
|
1535
1589
|
attr_accessor :secondary_button
|
|
@@ -1546,7 +1600,8 @@ module Google
|
|
|
1546
1600
|
end
|
|
1547
1601
|
|
|
1548
1602
|
# Represents a card header. For an example in Google Chat apps, see [Card header]
|
|
1549
|
-
# (https://developers.google.com/chat/ui/widgets/card-header).
|
|
1603
|
+
# (https://developers.google.com/chat/ui/widgets/card-header). [Google Workspace
|
|
1604
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1550
1605
|
class GoogleAppsCardV1CardHeader
|
|
1551
1606
|
include Google::Apis::Core::Hashable
|
|
1552
1607
|
|
|
@@ -1555,7 +1610,8 @@ module Google
|
|
|
1555
1610
|
# @return [String]
|
|
1556
1611
|
attr_accessor :image_alt_text
|
|
1557
1612
|
|
|
1558
|
-
# The shape used to crop the image.
|
|
1613
|
+
# The shape used to crop the image. [Google Workspace Add-ons and Chat apps](
|
|
1614
|
+
# https://developers.google.com/workspace/extend):
|
|
1559
1615
|
# Corresponds to the JSON property `imageType`
|
|
1560
1616
|
# @return [String]
|
|
1561
1617
|
attr_accessor :image_type
|
|
@@ -1592,7 +1648,7 @@ module Google
|
|
|
1592
1648
|
end
|
|
1593
1649
|
end
|
|
1594
1650
|
|
|
1595
|
-
# A column.
|
|
1651
|
+
# A column. [Google Chat apps](https://developers.google.com/chat):
|
|
1596
1652
|
class GoogleAppsCardV1Column
|
|
1597
1653
|
include Google::Apis::Core::Hashable
|
|
1598
1654
|
|
|
@@ -1601,12 +1657,14 @@ module Google
|
|
|
1601
1657
|
# @return [String]
|
|
1602
1658
|
attr_accessor :horizontal_alignment
|
|
1603
1659
|
|
|
1604
|
-
# Specifies how a column fills the width of the card.
|
|
1660
|
+
# Specifies how a column fills the width of the card. [Google Chat apps](https://
|
|
1661
|
+
# developers.google.com/chat):
|
|
1605
1662
|
# Corresponds to the JSON property `horizontalSizeStyle`
|
|
1606
1663
|
# @return [String]
|
|
1607
1664
|
attr_accessor :horizontal_size_style
|
|
1608
1665
|
|
|
1609
|
-
# Specifies whether widgets align to the top, bottom, or center of a column.
|
|
1666
|
+
# Specifies whether widgets align to the top, bottom, or center of a column. [
|
|
1667
|
+
# Google Chat apps](https://developers.google.com/chat):
|
|
1610
1668
|
# Corresponds to the JSON property `verticalAlignment`
|
|
1611
1669
|
# @return [String]
|
|
1612
1670
|
attr_accessor :vertical_alignment
|
|
@@ -1645,7 +1703,7 @@ module Google
|
|
|
1645
1703
|
# column wraps if the screen width is less than or equal to 300 pt. * On Android
|
|
1646
1704
|
# devices, the second column wraps if the screen width is less than or equal to
|
|
1647
1705
|
# 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget.
|
|
1648
|
-
#
|
|
1706
|
+
# [Google Chat apps](https://developers.google.com/chat):
|
|
1649
1707
|
class GoogleAppsCardV1Columns
|
|
1650
1708
|
include Google::Apis::Core::Hashable
|
|
1651
1709
|
|
|
@@ -1668,7 +1726,8 @@ module Google
|
|
|
1668
1726
|
# Google Chat apps, see [Date time picker](https://developers.google.com/chat/ui/
|
|
1669
1727
|
# widgets/date-time-picker). Users can input text or use the picker to select
|
|
1670
1728
|
# dates and times. If users input an invalid date or time, the picker shows an
|
|
1671
|
-
# error that prompts users to input the information correctly.
|
|
1729
|
+
# error that prompts users to input the information correctly. [Google Workspace
|
|
1730
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1672
1731
|
class GoogleAppsCardV1DateTimePicker
|
|
1673
1732
|
include Google::Apis::Core::Hashable
|
|
1674
1733
|
|
|
@@ -1688,7 +1747,8 @@ module Google
|
|
|
1688
1747
|
|
|
1689
1748
|
# An action that describes the behavior when the form is submitted. For example,
|
|
1690
1749
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
1691
|
-
# triggered, the form values are sent to the server.
|
|
1750
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
1751
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
1692
1752
|
# Corresponds to the JSON property `onChangeAction`
|
|
1693
1753
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
1694
1754
|
attr_accessor :on_change_action
|
|
@@ -1735,7 +1795,8 @@ module Google
|
|
|
1735
1795
|
# A widget that displays text with optional decorations such as a label above or
|
|
1736
1796
|
# below the text, an icon in front of the text, a selection widget, or a button
|
|
1737
1797
|
# after the text. For an example in Google Chat apps, see [Decorated text](https:
|
|
1738
|
-
# //developers.google.com/chat/ui/widgets/decorated-text).
|
|
1798
|
+
# //developers.google.com/chat/ui/widgets/decorated-text). [Google Workspace Add-
|
|
1799
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1739
1800
|
class GoogleAppsCardV1DecoratedText
|
|
1740
1801
|
include Google::Apis::Core::Hashable
|
|
1741
1802
|
|
|
@@ -1747,7 +1808,8 @@ module Google
|
|
|
1747
1808
|
# A text, icon, or text and icon button that users can click. For an example in
|
|
1748
1809
|
# Google Chat apps, see [Button list](https://developers.google.com/chat/ui/
|
|
1749
1810
|
# widgets/button-list). To make an image a clickable button, specify an `Image` (
|
|
1750
|
-
# not an `ImageComponent`) and set an `onClick` action.
|
|
1811
|
+
# not an `ImageComponent`) and set an `onClick` action. [Google Workspace Add-
|
|
1812
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
1751
1813
|
# Corresponds to the JSON property `button`
|
|
1752
1814
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Button]
|
|
1753
1815
|
attr_accessor :button
|
|
@@ -1756,6 +1818,8 @@ module Google
|
|
|
1756
1818
|
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1757
1819
|
# built-in](https://developers.google.com/chat/format-messages#builtinicons) and
|
|
1758
1820
|
# [custom](https://developers.google.com/chat/format-messages#customicons) icons.
|
|
1821
|
+
# [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
1822
|
+
# workspace/extend):
|
|
1759
1823
|
# Corresponds to the JSON property `endIcon`
|
|
1760
1824
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1761
1825
|
attr_accessor :end_icon
|
|
@@ -1764,12 +1828,15 @@ module Google
|
|
|
1764
1828
|
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1765
1829
|
# built-in](https://developers.google.com/chat/format-messages#builtinicons) and
|
|
1766
1830
|
# [custom](https://developers.google.com/chat/format-messages#customicons) icons.
|
|
1831
|
+
# [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
1832
|
+
# workspace/extend):
|
|
1767
1833
|
# Corresponds to the JSON property `icon`
|
|
1768
1834
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1769
1835
|
attr_accessor :icon
|
|
1770
1836
|
|
|
1771
1837
|
# Represents how to respond when users click an interactive element on a card,
|
|
1772
|
-
# such as a button.
|
|
1838
|
+
# such as a button. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
1839
|
+
# google.com/workspace/extend):
|
|
1773
1840
|
# Corresponds to the JSON property `onClick`
|
|
1774
1841
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
|
|
1775
1842
|
attr_accessor :on_click
|
|
@@ -1778,12 +1845,15 @@ module Google
|
|
|
1778
1845
|
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1779
1846
|
# built-in](https://developers.google.com/chat/format-messages#builtinicons) and
|
|
1780
1847
|
# [custom](https://developers.google.com/chat/format-messages#customicons) icons.
|
|
1848
|
+
# [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
1849
|
+
# workspace/extend):
|
|
1781
1850
|
# Corresponds to the JSON property `startIcon`
|
|
1782
1851
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Icon]
|
|
1783
1852
|
attr_accessor :start_icon
|
|
1784
1853
|
|
|
1785
|
-
# Either a toggle-style switch or a checkbox inside a `decoratedText` widget.
|
|
1786
|
-
#
|
|
1854
|
+
# Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [
|
|
1855
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
1856
|
+
# workspace/extend): Only supported in the `decoratedText` widget.
|
|
1787
1857
|
# Corresponds to the JSON property `switchControl`
|
|
1788
1858
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SwitchControl]
|
|
1789
1859
|
attr_accessor :switch_control
|
|
@@ -1831,8 +1901,9 @@ module Google
|
|
|
1831
1901
|
|
|
1832
1902
|
# Displays a divider between widgets as a horizontal line. For an example in
|
|
1833
1903
|
# Google Chat apps, see [Divider](https://developers.google.com/chat/ui/widgets/
|
|
1834
|
-
# divider).
|
|
1835
|
-
# ```
|
|
1904
|
+
# divider). [Google Workspace Add-ons and Chat apps](https://developers.google.
|
|
1905
|
+
# com/workspace/extend): For example, the following JSON creates a divider: ``` "
|
|
1906
|
+
# divider": `` ```
|
|
1836
1907
|
class GoogleAppsCardV1Divider
|
|
1837
1908
|
include Google::Apis::Core::Hashable
|
|
1838
1909
|
|
|
@@ -1851,18 +1922,20 @@ module Google
|
|
|
1851
1922
|
# google.com/chat/ui/widgets/grid). A grid supports any number of columns and
|
|
1852
1923
|
# items. The number of rows is determined by items divided by columns. A grid
|
|
1853
1924
|
# with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has
|
|
1854
|
-
# 6 rows.
|
|
1855
|
-
#
|
|
1856
|
-
#
|
|
1857
|
-
# "
|
|
1858
|
-
#
|
|
1859
|
-
#
|
|
1860
|
-
#
|
|
1925
|
+
# 6 rows. [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
1926
|
+
# workspace/extend): For example, the following JSON creates a 2 column grid
|
|
1927
|
+
# with a single item: ``` "grid": ` "title": "A fine collection of items", "
|
|
1928
|
+
# columnCount": 2, "borderStyle": ` "type": "STROKE", "cornerRadius": 4 `, "
|
|
1929
|
+
# items": [ ` "image": ` "imageUri": "https://www.example.com/image.png", "
|
|
1930
|
+
# cropStyle": ` "type": "SQUARE" `, "borderStyle": ` "type": "STROKE" ` `, "
|
|
1931
|
+
# title": "An item", "textAlignment": "CENTER" ` ], "onClick": ` "openLink": ` "
|
|
1932
|
+
# url": "https://www.example.com" ` ` ` ```
|
|
1861
1933
|
class GoogleAppsCardV1Grid
|
|
1862
1934
|
include Google::Apis::Core::Hashable
|
|
1863
1935
|
|
|
1864
1936
|
# The style options for the border of a card or widget, including the border
|
|
1865
|
-
# type and color.
|
|
1937
|
+
# type and color. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
1938
|
+
# google.com/workspace/extend):
|
|
1866
1939
|
# Corresponds to the JSON property `borderStyle`
|
|
1867
1940
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1BorderStyle]
|
|
1868
1941
|
attr_accessor :border_style
|
|
@@ -1880,7 +1953,8 @@ module Google
|
|
|
1880
1953
|
attr_accessor :items
|
|
1881
1954
|
|
|
1882
1955
|
# Represents how to respond when users click an interactive element on a card,
|
|
1883
|
-
# such as a button.
|
|
1956
|
+
# such as a button. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
1957
|
+
# google.com/workspace/extend):
|
|
1884
1958
|
# Corresponds to the JSON property `onClick`
|
|
1885
1959
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
|
|
1886
1960
|
attr_accessor :on_click
|
|
@@ -1905,7 +1979,8 @@ module Google
|
|
|
1905
1979
|
end
|
|
1906
1980
|
|
|
1907
1981
|
# Represents an item in a grid layout. Items can contain text, an image, or both
|
|
1908
|
-
# text and an image.
|
|
1982
|
+
# text and an image. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
1983
|
+
# google.com/workspace/extend):
|
|
1909
1984
|
class GoogleAppsCardV1GridItem
|
|
1910
1985
|
include Google::Apis::Core::Hashable
|
|
1911
1986
|
|
|
@@ -1915,7 +1990,8 @@ module Google
|
|
|
1915
1990
|
# @return [String]
|
|
1916
1991
|
attr_accessor :id
|
|
1917
1992
|
|
|
1918
|
-
# Represents an image.
|
|
1993
|
+
# Represents an image. [Google Workspace Add-ons and Chat apps](https://
|
|
1994
|
+
# developers.google.com/workspace/extend):
|
|
1919
1995
|
# Corresponds to the JSON property `image`
|
|
1920
1996
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ImageComponent]
|
|
1921
1997
|
attr_accessor :image
|
|
@@ -1953,6 +2029,8 @@ module Google
|
|
|
1953
2029
|
# see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [
|
|
1954
2030
|
# built-in](https://developers.google.com/chat/format-messages#builtinicons) and
|
|
1955
2031
|
# [custom](https://developers.google.com/chat/format-messages#customicons) icons.
|
|
2032
|
+
# [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2033
|
+
# workspace/extend):
|
|
1956
2034
|
class GoogleAppsCardV1Icon
|
|
1957
2035
|
include Google::Apis::Core::Hashable
|
|
1958
2036
|
|
|
@@ -2003,7 +2081,9 @@ module Google
|
|
|
2003
2081
|
end
|
|
2004
2082
|
|
|
2005
2083
|
# An image that is specified by a URL and can have an `onClick` action. For an
|
|
2006
|
-
# example, see [Image](https://developers.google.com/chat/ui/widgets/image).
|
|
2084
|
+
# example, see [Image](https://developers.google.com/chat/ui/widgets/image). [
|
|
2085
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2086
|
+
# workspace/extend):
|
|
2007
2087
|
class GoogleAppsCardV1Image
|
|
2008
2088
|
include Google::Apis::Core::Hashable
|
|
2009
2089
|
|
|
@@ -2019,7 +2099,8 @@ module Google
|
|
|
2019
2099
|
attr_accessor :image_url
|
|
2020
2100
|
|
|
2021
2101
|
# Represents how to respond when users click an interactive element on a card,
|
|
2022
|
-
# such as a button.
|
|
2102
|
+
# such as a button. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
2103
|
+
# google.com/workspace/extend):
|
|
2023
2104
|
# Corresponds to the JSON property `onClick`
|
|
2024
2105
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1OnClick]
|
|
2025
2106
|
attr_accessor :on_click
|
|
@@ -2036,7 +2117,8 @@ module Google
|
|
|
2036
2117
|
end
|
|
2037
2118
|
end
|
|
2038
2119
|
|
|
2039
|
-
# Represents an image.
|
|
2120
|
+
# Represents an image. [Google Workspace Add-ons and Chat apps](https://
|
|
2121
|
+
# developers.google.com/workspace/extend):
|
|
2040
2122
|
class GoogleAppsCardV1ImageComponent
|
|
2041
2123
|
include Google::Apis::Core::Hashable
|
|
2042
2124
|
|
|
@@ -2046,14 +2128,16 @@ module Google
|
|
|
2046
2128
|
attr_accessor :alt_text
|
|
2047
2129
|
|
|
2048
2130
|
# The style options for the border of a card or widget, including the border
|
|
2049
|
-
# type and color.
|
|
2131
|
+
# type and color. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
2132
|
+
# google.com/workspace/extend):
|
|
2050
2133
|
# Corresponds to the JSON property `borderStyle`
|
|
2051
2134
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1BorderStyle]
|
|
2052
2135
|
attr_accessor :border_style
|
|
2053
2136
|
|
|
2054
|
-
# Represents the crop style applied to an image.
|
|
2055
|
-
#
|
|
2056
|
-
#
|
|
2137
|
+
# Represents the crop style applied to an image. [Google Workspace Add-ons and
|
|
2138
|
+
# Chat apps](https://developers.google.com/workspace/extend): For example, here'
|
|
2139
|
+
# s how to apply a 16:9 aspect ratio: ``` cropStyle ` "type": "RECTANGLE_CUSTOM",
|
|
2140
|
+
# "aspectRatio": 16/9 ` ```
|
|
2057
2141
|
# Corresponds to the JSON property `cropStyle`
|
|
2058
2142
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ImageCropStyle]
|
|
2059
2143
|
attr_accessor :crop_style
|
|
@@ -2076,9 +2160,10 @@ module Google
|
|
|
2076
2160
|
end
|
|
2077
2161
|
end
|
|
2078
2162
|
|
|
2079
|
-
# Represents the crop style applied to an image.
|
|
2080
|
-
#
|
|
2081
|
-
#
|
|
2163
|
+
# Represents the crop style applied to an image. [Google Workspace Add-ons and
|
|
2164
|
+
# Chat apps](https://developers.google.com/workspace/extend): For example, here'
|
|
2165
|
+
# s how to apply a 16:9 aspect ratio: ``` cropStyle ` "type": "RECTANGLE_CUSTOM",
|
|
2166
|
+
# "aspectRatio": 16/9 ` ```
|
|
2082
2167
|
class GoogleAppsCardV1ImageCropStyle
|
|
2083
2168
|
include Google::Apis::Core::Hashable
|
|
2084
2169
|
|
|
@@ -2106,13 +2191,15 @@ module Google
|
|
|
2106
2191
|
end
|
|
2107
2192
|
|
|
2108
2193
|
# Represents how to respond when users click an interactive element on a card,
|
|
2109
|
-
# such as a button.
|
|
2194
|
+
# such as a button. [Google Workspace Add-ons and Chat apps](https://developers.
|
|
2195
|
+
# google.com/workspace/extend):
|
|
2110
2196
|
class GoogleAppsCardV1OnClick
|
|
2111
2197
|
include Google::Apis::Core::Hashable
|
|
2112
2198
|
|
|
2113
2199
|
# An action that describes the behavior when the form is submitted. For example,
|
|
2114
2200
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
2115
|
-
# triggered, the form values are sent to the server.
|
|
2201
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
2202
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2116
2203
|
# Corresponds to the JSON property `action`
|
|
2117
2204
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
2118
2205
|
attr_accessor :action
|
|
@@ -2120,38 +2207,41 @@ module Google
|
|
|
2120
2207
|
# A card interface displayed in a Google Chat message or Google Workspace Add-on.
|
|
2121
2208
|
# Cards support a defined layout, interactive UI elements like buttons, and
|
|
2122
2209
|
# rich media like images. Use cards to present detailed information, gather
|
|
2123
|
-
# information from users, and guide users to take a next step.
|
|
2124
|
-
#
|
|
2125
|
-
#
|
|
2126
|
-
# google.com/chat/
|
|
2127
|
-
# interfaces](https://
|
|
2128
|
-
# **Example: Card
|
|
2129
|
-
#
|
|
2130
|
-
#
|
|
2131
|
-
#
|
|
2132
|
-
#
|
|
2133
|
-
#
|
|
2134
|
-
# "
|
|
2135
|
-
#
|
|
2136
|
-
#
|
|
2137
|
-
#
|
|
2138
|
-
#
|
|
2139
|
-
#
|
|
2140
|
-
#
|
|
2141
|
-
# "
|
|
2142
|
-
#
|
|
2210
|
+
# information from users, and guide users to take a next step. [Card builder](
|
|
2211
|
+
# https://addons.gsuite.google.com/uikit/builder) To learn how to build cards,
|
|
2212
|
+
# see the following documentation: * For Google Chat apps, see [Design dynamic,
|
|
2213
|
+
# interactive, and consistent UIs with cards](https://developers.google.com/chat/
|
|
2214
|
+
# ui). * For Google Workspace Add-ons, see [Card-based interfaces](https://
|
|
2215
|
+
# developers.google.com/apps-script/add-ons/concepts/cards). **Example: Card
|
|
2216
|
+
# message for a Google Chat app**  To create the sample card
|
|
2218
|
+
# message in Google Chat, use the following JSON: ``` ` "cardsV2": [ ` "cardId":
|
|
2219
|
+
# "unique-card-id", "card": ` "header": ` "title": "Sasha", "subtitle": "
|
|
2220
|
+
# Software Engineer", "imageUrl": "https://developers.google.com/chat/images/
|
|
2221
|
+
# quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for
|
|
2222
|
+
# Sasha", `, "sections": [ ` "header": "Contact Info", "collapsible": true, "
|
|
2223
|
+
# uncollapsibleWidgetsCount": 1, "widgets": [ ` "decoratedText": ` "startIcon": `
|
|
2224
|
+
# "knownIcon": "EMAIL", `, "text": "sasha@example.com", ` `, ` "decoratedText":
|
|
2225
|
+
# ` "startIcon": ` "knownIcon": "PERSON", `, "text": "Online", `, `, ` "
|
|
2226
|
+
# decoratedText": ` "startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555)
|
|
2227
|
+
# 555-1234", ` `, ` "buttonList": ` "buttons": [ ` "text": "Share", "onClick": `
|
|
2228
|
+
# "openLink": ` "url": "https://example.com/share", ` ` `, ` "text": "Edit", "
|
|
2229
|
+
# onClick": ` "action": ` "function": "goToView", "parameters": [ ` "key": "
|
|
2230
|
+
# viewType", "value": "EDIT", ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` ```
|
|
2143
2231
|
# Corresponds to the JSON property `card`
|
|
2144
2232
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Card]
|
|
2145
2233
|
attr_accessor :card
|
|
2146
2234
|
|
|
2147
2235
|
# An action that describes the behavior when the form is submitted. For example,
|
|
2148
2236
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
2149
|
-
# triggered, the form values are sent to the server.
|
|
2237
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
2238
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2150
2239
|
# Corresponds to the JSON property `openDynamicLinkAction`
|
|
2151
2240
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
2152
2241
|
attr_accessor :open_dynamic_link_action
|
|
2153
2242
|
|
|
2154
|
-
# Represents an `onClick` event that opens a hyperlink.
|
|
2243
|
+
# Represents an `onClick` event that opens a hyperlink. [Google Workspace Add-
|
|
2244
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
2155
2245
|
# Corresponds to the JSON property `openLink`
|
|
2156
2246
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1OpenLink]
|
|
2157
2247
|
attr_accessor :open_link
|
|
@@ -2169,17 +2259,20 @@ module Google
|
|
|
2169
2259
|
end
|
|
2170
2260
|
end
|
|
2171
2261
|
|
|
2172
|
-
# Represents an `onClick` event that opens a hyperlink.
|
|
2262
|
+
# Represents an `onClick` event that opens a hyperlink. [Google Workspace Add-
|
|
2263
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
2173
2264
|
class GoogleAppsCardV1OpenLink
|
|
2174
2265
|
include Google::Apis::Core::Hashable
|
|
2175
2266
|
|
|
2176
2267
|
# Whether the client forgets about a link after opening it, or observes it until
|
|
2177
|
-
# the window closes.
|
|
2268
|
+
# the window closes. [Google Workspace Add-ons](https://developers.google.com/
|
|
2269
|
+
# workspace/add-ons):
|
|
2178
2270
|
# Corresponds to the JSON property `onClose`
|
|
2179
2271
|
# @return [String]
|
|
2180
2272
|
attr_accessor :on_close
|
|
2181
2273
|
|
|
2182
|
-
# How to open a link.
|
|
2274
|
+
# How to open a link. [Google Workspace Add-ons](https://developers.google.com/
|
|
2275
|
+
# workspace/add-ons):
|
|
2183
2276
|
# Corresponds to the JSON property `openAs`
|
|
2184
2277
|
# @return [String]
|
|
2185
2278
|
attr_accessor :open_as
|
|
@@ -2201,9 +2294,9 @@ module Google
|
|
|
2201
2294
|
end
|
|
2202
2295
|
end
|
|
2203
2296
|
|
|
2204
|
-
#
|
|
2205
|
-
#
|
|
2206
|
-
#
|
|
2297
|
+
# For a `SelectionInput` widget that uses a multiselect menu, a data source from
|
|
2298
|
+
# Google Workspace. Used to populate items in a multiselect menu. [Google Chat
|
|
2299
|
+
# apps](https://developers.google.com/chat):
|
|
2207
2300
|
class GoogleAppsCardV1PlatformDataSource
|
|
2208
2301
|
include Google::Apis::Core::Hashable
|
|
2209
2302
|
|
|
@@ -2213,9 +2306,9 @@ module Google
|
|
|
2213
2306
|
# @return [String]
|
|
2214
2307
|
attr_accessor :common_data_source
|
|
2215
2308
|
|
|
2216
|
-
#
|
|
2217
|
-
#
|
|
2218
|
-
#
|
|
2309
|
+
# For a `SelectionInput` widget that uses a multiselect menu, a data source from
|
|
2310
|
+
# a Google Workspace application. The data source populates selection items for
|
|
2311
|
+
# the multiselect menu. [Google Chat apps](https://developers.google.com/chat):
|
|
2219
2312
|
# Corresponds to the JSON property `hostAppDataSource`
|
|
2220
2313
|
# @return [Google::Apis::ChatV1::HostAppDataSourceMarkup]
|
|
2221
2314
|
attr_accessor :host_app_data_source
|
|
@@ -2232,7 +2325,8 @@ module Google
|
|
|
2232
2325
|
end
|
|
2233
2326
|
|
|
2234
2327
|
# A section contains a collection of widgets that are rendered vertically in the
|
|
2235
|
-
# order that they're specified.
|
|
2328
|
+
# order that they're specified. [Google Workspace Add-ons and Chat apps](https://
|
|
2329
|
+
# developers.google.com/workspace/extend):
|
|
2236
2330
|
class GoogleAppsCardV1Section
|
|
2237
2331
|
include Google::Apis::Core::Hashable
|
|
2238
2332
|
|
|
@@ -2290,13 +2384,15 @@ module Google
|
|
|
2290
2384
|
# . Chat apps can process the value of items that users select or input. For
|
|
2291
2385
|
# details about working with form inputs, see [Receive form data](https://
|
|
2292
2386
|
# developers.google.com/chat/ui/read-form-data). To collect undefined or
|
|
2293
|
-
# abstract data from users, use the TextInput widget.
|
|
2387
|
+
# abstract data from users, use the TextInput widget. [Google Workspace Add-ons
|
|
2388
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2294
2389
|
class GoogleAppsCardV1SelectionInput
|
|
2295
2390
|
include Google::Apis::Core::Hashable
|
|
2296
2391
|
|
|
2297
2392
|
# An action that describes the behavior when the form is submitted. For example,
|
|
2298
2393
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
2299
|
-
# triggered, the form values are sent to the server.
|
|
2394
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
2395
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2300
2396
|
# Corresponds to the JSON property `externalDataSource`
|
|
2301
2397
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
2302
2398
|
attr_accessor :external_data_source
|
|
@@ -2338,14 +2434,15 @@ module Google
|
|
|
2338
2434
|
|
|
2339
2435
|
# An action that describes the behavior when the form is submitted. For example,
|
|
2340
2436
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
2341
|
-
# triggered, the form values are sent to the server.
|
|
2437
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
2438
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2342
2439
|
# Corresponds to the JSON property `onChangeAction`
|
|
2343
2440
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
2344
2441
|
attr_accessor :on_change_action
|
|
2345
2442
|
|
|
2346
|
-
#
|
|
2347
|
-
#
|
|
2348
|
-
#
|
|
2443
|
+
# For a `SelectionInput` widget that uses a multiselect menu, a data source from
|
|
2444
|
+
# Google Workspace. Used to populate items in a multiselect menu. [Google Chat
|
|
2445
|
+
# apps](https://developers.google.com/chat):
|
|
2349
2446
|
# Corresponds to the JSON property `platformDataSource`
|
|
2350
2447
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1PlatformDataSource]
|
|
2351
2448
|
attr_accessor :platform_data_source
|
|
@@ -2377,7 +2474,8 @@ module Google
|
|
|
2377
2474
|
end
|
|
2378
2475
|
|
|
2379
2476
|
# An item that users can select in a selection input, such as a checkbox or
|
|
2380
|
-
# switch.
|
|
2477
|
+
# switch. [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2478
|
+
# workspace/extend):
|
|
2381
2479
|
class GoogleAppsCardV1SelectionItem
|
|
2382
2480
|
include Google::Apis::Core::Hashable
|
|
2383
2481
|
|
|
@@ -2428,7 +2526,9 @@ module Google
|
|
|
2428
2526
|
end
|
|
2429
2527
|
end
|
|
2430
2528
|
|
|
2431
|
-
# One suggested value that users can enter in a text input field.
|
|
2529
|
+
# One suggested value that users can enter in a text input field. [Google
|
|
2530
|
+
# Workspace Add-ons and Chat apps](https://developers.google.com/workspace/
|
|
2531
|
+
# extend):
|
|
2432
2532
|
class GoogleAppsCardV1SuggestionItem
|
|
2433
2533
|
include Google::Apis::Core::Hashable
|
|
2434
2534
|
|
|
@@ -2457,7 +2557,8 @@ module Google
|
|
|
2457
2557
|
# can make sense of. When referring to JavaScript, some users might enter `
|
|
2458
2558
|
# javascript` and others `java script`. Suggesting `JavaScript` can standardize
|
|
2459
2559
|
# how users interact with your app. When specified, `TextInput.type` is always `
|
|
2460
|
-
# SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`.
|
|
2560
|
+
# SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace Add-ons
|
|
2561
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2461
2562
|
class GoogleAppsCardV1Suggestions
|
|
2462
2563
|
include Google::Apis::Core::Hashable
|
|
2463
2564
|
|
|
@@ -2477,12 +2578,14 @@ module Google
|
|
|
2477
2578
|
end
|
|
2478
2579
|
end
|
|
2479
2580
|
|
|
2480
|
-
# Either a toggle-style switch or a checkbox inside a `decoratedText` widget.
|
|
2481
|
-
#
|
|
2581
|
+
# Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [
|
|
2582
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2583
|
+
# workspace/extend): Only supported in the `decoratedText` widget.
|
|
2482
2584
|
class GoogleAppsCardV1SwitchControl
|
|
2483
2585
|
include Google::Apis::Core::Hashable
|
|
2484
2586
|
|
|
2485
|
-
# How the switch appears in the user interface.
|
|
2587
|
+
# How the switch appears in the user interface. [Google Workspace Add-ons and
|
|
2588
|
+
# Chat apps](https://developers.google.com/workspace/extend):
|
|
2486
2589
|
# Corresponds to the JSON property `controlType`
|
|
2487
2590
|
# @return [String]
|
|
2488
2591
|
attr_accessor :control_type
|
|
@@ -2496,7 +2599,8 @@ module Google
|
|
|
2496
2599
|
|
|
2497
2600
|
# An action that describes the behavior when the form is submitted. For example,
|
|
2498
2601
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
2499
|
-
# triggered, the form values are sent to the server.
|
|
2602
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
2603
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2500
2604
|
# Corresponds to the JSON property `onChangeAction`
|
|
2501
2605
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
2502
2606
|
attr_accessor :on_change_action
|
|
@@ -2535,13 +2639,15 @@ module Google
|
|
|
2535
2639
|
# working with form inputs, see [Receive form data](https://developers.google.
|
|
2536
2640
|
# com/chat/ui/read-form-data). When you need to collect undefined or abstract
|
|
2537
2641
|
# data from users, use a text input. To collect defined or enumerated data from
|
|
2538
|
-
# users, use the SelectionInput widget.
|
|
2642
|
+
# users, use the SelectionInput widget. [Google Workspace Add-ons and Chat apps](
|
|
2643
|
+
# https://developers.google.com/workspace/extend):
|
|
2539
2644
|
class GoogleAppsCardV1TextInput
|
|
2540
2645
|
include Google::Apis::Core::Hashable
|
|
2541
2646
|
|
|
2542
2647
|
# An action that describes the behavior when the form is submitted. For example,
|
|
2543
2648
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
2544
|
-
# triggered, the form values are sent to the server.
|
|
2649
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
2650
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2545
2651
|
# Corresponds to the JSON property `autoCompleteAction`
|
|
2546
2652
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
2547
2653
|
attr_accessor :auto_complete_action
|
|
@@ -2562,7 +2668,8 @@ module Google
|
|
|
2562
2668
|
# can make sense of. When referring to JavaScript, some users might enter `
|
|
2563
2669
|
# javascript` and others `java script`. Suggesting `JavaScript` can standardize
|
|
2564
2670
|
# how users interact with your app. When specified, `TextInput.type` is always `
|
|
2565
|
-
# SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`.
|
|
2671
|
+
# SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace Add-ons
|
|
2672
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2566
2673
|
# Corresponds to the JSON property `initialSuggestions`
|
|
2567
2674
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Suggestions]
|
|
2568
2675
|
attr_accessor :initial_suggestions
|
|
@@ -2585,14 +2692,15 @@ module Google
|
|
|
2585
2692
|
|
|
2586
2693
|
# An action that describes the behavior when the form is submitted. For example,
|
|
2587
2694
|
# you can invoke an Apps Script script to handle the form. If the action is
|
|
2588
|
-
# triggered, the form values are sent to the server.
|
|
2695
|
+
# triggered, the form values are sent to the server. [Google Workspace Add-ons
|
|
2696
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2589
2697
|
# Corresponds to the JSON property `onChangeAction`
|
|
2590
2698
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Action]
|
|
2591
2699
|
attr_accessor :on_change_action
|
|
2592
2700
|
|
|
2593
2701
|
# Text that appears in the text input field when the field is empty. Use this
|
|
2594
2702
|
# text to prompt users to enter a value. For example, `Enter a number from 0 to
|
|
2595
|
-
# 100`.
|
|
2703
|
+
# 100`. [Google Chat apps](https://developers.google.com/chat):
|
|
2596
2704
|
# Corresponds to the JSON property `placeholderText`
|
|
2597
2705
|
# @return [String]
|
|
2598
2706
|
attr_accessor :placeholder_text
|
|
@@ -2633,7 +2741,9 @@ module Google
|
|
|
2633
2741
|
# paragraph). For more information about formatting text, see [Formatting text
|
|
2634
2742
|
# in Google Chat apps](https://developers.google.com/chat/format-messages#card-
|
|
2635
2743
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
|
2636
|
-
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
|
2744
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
|
2745
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2746
|
+
# workspace/extend):
|
|
2637
2747
|
class GoogleAppsCardV1TextParagraph
|
|
2638
2748
|
include Google::Apis::Core::Hashable
|
|
2639
2749
|
|
|
@@ -2658,7 +2768,9 @@ module Google
|
|
|
2658
2768
|
include Google::Apis::Core::Hashable
|
|
2659
2769
|
|
|
2660
2770
|
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
|
2661
|
-
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list).
|
|
2771
|
+
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [
|
|
2772
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2773
|
+
# workspace/extend):
|
|
2662
2774
|
# Corresponds to the JSON property `buttonList`
|
|
2663
2775
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
|
2664
2776
|
attr_accessor :button_list
|
|
@@ -2678,7 +2790,7 @@ module Google
|
|
|
2678
2790
|
# column wraps if the screen width is less than or equal to 300 pt. * On Android
|
|
2679
2791
|
# devices, the second column wraps if the screen width is less than or equal to
|
|
2680
2792
|
# 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget.
|
|
2681
|
-
#
|
|
2793
|
+
# [Google Chat apps](https://developers.google.com/chat):
|
|
2682
2794
|
# Corresponds to the JSON property `columns`
|
|
2683
2795
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Columns]
|
|
2684
2796
|
attr_accessor :columns
|
|
@@ -2687,7 +2799,8 @@ module Google
|
|
|
2687
2799
|
# Google Chat apps, see [Date time picker](https://developers.google.com/chat/ui/
|
|
2688
2800
|
# widgets/date-time-picker). Users can input text or use the picker to select
|
|
2689
2801
|
# dates and times. If users input an invalid date or time, the picker shows an
|
|
2690
|
-
# error that prompts users to input the information correctly.
|
|
2802
|
+
# error that prompts users to input the information correctly. [Google Workspace
|
|
2803
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
2691
2804
|
# Corresponds to the JSON property `dateTimePicker`
|
|
2692
2805
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
|
2693
2806
|
attr_accessor :date_time_picker
|
|
@@ -2695,15 +2808,17 @@ module Google
|
|
|
2695
2808
|
# A widget that displays text with optional decorations such as a label above or
|
|
2696
2809
|
# below the text, an icon in front of the text, a selection widget, or a button
|
|
2697
2810
|
# after the text. For an example in Google Chat apps, see [Decorated text](https:
|
|
2698
|
-
# //developers.google.com/chat/ui/widgets/decorated-text).
|
|
2811
|
+
# //developers.google.com/chat/ui/widgets/decorated-text). [Google Workspace Add-
|
|
2812
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
2699
2813
|
# Corresponds to the JSON property `decoratedText`
|
|
2700
2814
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
|
2701
2815
|
attr_accessor :decorated_text
|
|
2702
2816
|
|
|
2703
2817
|
# Displays a divider between widgets as a horizontal line. For an example in
|
|
2704
2818
|
# Google Chat apps, see [Divider](https://developers.google.com/chat/ui/widgets/
|
|
2705
|
-
# divider).
|
|
2706
|
-
# ```
|
|
2819
|
+
# divider). [Google Workspace Add-ons and Chat apps](https://developers.google.
|
|
2820
|
+
# com/workspace/extend): For example, the following JSON creates a divider: ``` "
|
|
2821
|
+
# divider": `` ```
|
|
2707
2822
|
# Corresponds to the JSON property `divider`
|
|
2708
2823
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Divider]
|
|
2709
2824
|
attr_accessor :divider
|
|
@@ -2714,13 +2829,14 @@ module Google
|
|
|
2714
2829
|
# google.com/chat/ui/widgets/grid). A grid supports any number of columns and
|
|
2715
2830
|
# items. The number of rows is determined by items divided by columns. A grid
|
|
2716
2831
|
# with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has
|
|
2717
|
-
# 6 rows.
|
|
2718
|
-
#
|
|
2719
|
-
#
|
|
2720
|
-
# "
|
|
2721
|
-
#
|
|
2722
|
-
#
|
|
2723
|
-
#
|
|
2832
|
+
# 6 rows. [Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2833
|
+
# workspace/extend): For example, the following JSON creates a 2 column grid
|
|
2834
|
+
# with a single item: ``` "grid": ` "title": "A fine collection of items", "
|
|
2835
|
+
# columnCount": 2, "borderStyle": ` "type": "STROKE", "cornerRadius": 4 `, "
|
|
2836
|
+
# items": [ ` "image": ` "imageUri": "https://www.example.com/image.png", "
|
|
2837
|
+
# cropStyle": ` "type": "SQUARE" `, "borderStyle": ` "type": "STROKE" ` `, "
|
|
2838
|
+
# title": "An item", "textAlignment": "CENTER" ` ], "onClick": ` "openLink": ` "
|
|
2839
|
+
# url": "https://www.example.com" ` ` ` ```
|
|
2724
2840
|
# Corresponds to the JSON property `grid`
|
|
2725
2841
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Grid]
|
|
2726
2842
|
attr_accessor :grid
|
|
@@ -2731,7 +2847,9 @@ module Google
|
|
|
2731
2847
|
attr_accessor :horizontal_alignment
|
|
2732
2848
|
|
|
2733
2849
|
# An image that is specified by a URL and can have an `onClick` action. For an
|
|
2734
|
-
# example, see [Image](https://developers.google.com/chat/ui/widgets/image).
|
|
2850
|
+
# example, see [Image](https://developers.google.com/chat/ui/widgets/image). [
|
|
2851
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2852
|
+
# workspace/extend):
|
|
2735
2853
|
# Corresponds to the JSON property `image`
|
|
2736
2854
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
|
2737
2855
|
attr_accessor :image
|
|
@@ -2743,7 +2861,8 @@ module Google
|
|
|
2743
2861
|
# . Chat apps can process the value of items that users select or input. For
|
|
2744
2862
|
# details about working with form inputs, see [Receive form data](https://
|
|
2745
2863
|
# developers.google.com/chat/ui/read-form-data). To collect undefined or
|
|
2746
|
-
# abstract data from users, use the TextInput widget.
|
|
2864
|
+
# abstract data from users, use the TextInput widget. [Google Workspace Add-ons
|
|
2865
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2747
2866
|
# Corresponds to the JSON property `selectionInput`
|
|
2748
2867
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
|
2749
2868
|
attr_accessor :selection_input
|
|
@@ -2755,7 +2874,8 @@ module Google
|
|
|
2755
2874
|
# working with form inputs, see [Receive form data](https://developers.google.
|
|
2756
2875
|
# com/chat/ui/read-form-data). When you need to collect undefined or abstract
|
|
2757
2876
|
# data from users, use a text input. To collect defined or enumerated data from
|
|
2758
|
-
# users, use the SelectionInput widget.
|
|
2877
|
+
# users, use the SelectionInput widget. [Google Workspace Add-ons and Chat apps](
|
|
2878
|
+
# https://developers.google.com/workspace/extend):
|
|
2759
2879
|
# Corresponds to the JSON property `textInput`
|
|
2760
2880
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
|
2761
2881
|
attr_accessor :text_input
|
|
@@ -2765,7 +2885,9 @@ module Google
|
|
|
2765
2885
|
# paragraph). For more information about formatting text, see [Formatting text
|
|
2766
2886
|
# in Google Chat apps](https://developers.google.com/chat/format-messages#card-
|
|
2767
2887
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
|
2768
|
-
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
|
2888
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
|
2889
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2890
|
+
# workspace/extend):
|
|
2769
2891
|
# Corresponds to the JSON property `textParagraph`
|
|
2770
2892
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextParagraph]
|
|
2771
2893
|
attr_accessor :text_paragraph
|
|
@@ -2790,12 +2912,15 @@ module Google
|
|
|
2790
2912
|
end
|
|
2791
2913
|
end
|
|
2792
2914
|
|
|
2793
|
-
# The supported widgets that you can include in a column.
|
|
2915
|
+
# The supported widgets that you can include in a column. [Google Chat apps](
|
|
2916
|
+
# https://developers.google.com/chat):
|
|
2794
2917
|
class GoogleAppsCardV1Widgets
|
|
2795
2918
|
include Google::Apis::Core::Hashable
|
|
2796
2919
|
|
|
2797
2920
|
# A list of buttons layed out horizontally. For an example in Google Chat apps,
|
|
2798
|
-
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list).
|
|
2921
|
+
# see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [
|
|
2922
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2923
|
+
# workspace/extend):
|
|
2799
2924
|
# Corresponds to the JSON property `buttonList`
|
|
2800
2925
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1ButtonList]
|
|
2801
2926
|
attr_accessor :button_list
|
|
@@ -2804,7 +2929,8 @@ module Google
|
|
|
2804
2929
|
# Google Chat apps, see [Date time picker](https://developers.google.com/chat/ui/
|
|
2805
2930
|
# widgets/date-time-picker). Users can input text or use the picker to select
|
|
2806
2931
|
# dates and times. If users input an invalid date or time, the picker shows an
|
|
2807
|
-
# error that prompts users to input the information correctly.
|
|
2932
|
+
# error that prompts users to input the information correctly. [Google Workspace
|
|
2933
|
+
# Add-ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
2808
2934
|
# Corresponds to the JSON property `dateTimePicker`
|
|
2809
2935
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker]
|
|
2810
2936
|
attr_accessor :date_time_picker
|
|
@@ -2812,13 +2938,16 @@ module Google
|
|
|
2812
2938
|
# A widget that displays text with optional decorations such as a label above or
|
|
2813
2939
|
# below the text, an icon in front of the text, a selection widget, or a button
|
|
2814
2940
|
# after the text. For an example in Google Chat apps, see [Decorated text](https:
|
|
2815
|
-
# //developers.google.com/chat/ui/widgets/decorated-text).
|
|
2941
|
+
# //developers.google.com/chat/ui/widgets/decorated-text). [Google Workspace Add-
|
|
2942
|
+
# ons and Chat apps](https://developers.google.com/workspace/extend):
|
|
2816
2943
|
# Corresponds to the JSON property `decoratedText`
|
|
2817
2944
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText]
|
|
2818
2945
|
attr_accessor :decorated_text
|
|
2819
2946
|
|
|
2820
2947
|
# An image that is specified by a URL and can have an `onClick` action. For an
|
|
2821
|
-
# example, see [Image](https://developers.google.com/chat/ui/widgets/image).
|
|
2948
|
+
# example, see [Image](https://developers.google.com/chat/ui/widgets/image). [
|
|
2949
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2950
|
+
# workspace/extend):
|
|
2822
2951
|
# Corresponds to the JSON property `image`
|
|
2823
2952
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1Image]
|
|
2824
2953
|
attr_accessor :image
|
|
@@ -2830,7 +2959,8 @@ module Google
|
|
|
2830
2959
|
# . Chat apps can process the value of items that users select or input. For
|
|
2831
2960
|
# details about working with form inputs, see [Receive form data](https://
|
|
2832
2961
|
# developers.google.com/chat/ui/read-form-data). To collect undefined or
|
|
2833
|
-
# abstract data from users, use the TextInput widget.
|
|
2962
|
+
# abstract data from users, use the TextInput widget. [Google Workspace Add-ons
|
|
2963
|
+
# and Chat apps](https://developers.google.com/workspace/extend):
|
|
2834
2964
|
# Corresponds to the JSON property `selectionInput`
|
|
2835
2965
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput]
|
|
2836
2966
|
attr_accessor :selection_input
|
|
@@ -2842,7 +2972,8 @@ module Google
|
|
|
2842
2972
|
# working with form inputs, see [Receive form data](https://developers.google.
|
|
2843
2973
|
# com/chat/ui/read-form-data). When you need to collect undefined or abstract
|
|
2844
2974
|
# data from users, use a text input. To collect defined or enumerated data from
|
|
2845
|
-
# users, use the SelectionInput widget.
|
|
2975
|
+
# users, use the SelectionInput widget. [Google Workspace Add-ons and Chat apps](
|
|
2976
|
+
# https://developers.google.com/workspace/extend):
|
|
2846
2977
|
# Corresponds to the JSON property `textInput`
|
|
2847
2978
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextInput]
|
|
2848
2979
|
attr_accessor :text_input
|
|
@@ -2852,7 +2983,9 @@ module Google
|
|
|
2852
2983
|
# paragraph). For more information about formatting text, see [Formatting text
|
|
2853
2984
|
# in Google Chat apps](https://developers.google.com/chat/format-messages#card-
|
|
2854
2985
|
# formatting) and [Formatting text in Google Workspace Add-ons](https://
|
|
2855
|
-
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
|
|
2986
|
+
# developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [
|
|
2987
|
+
# Google Workspace Add-ons and Chat apps](https://developers.google.com/
|
|
2988
|
+
# workspace/extend):
|
|
2856
2989
|
# Corresponds to the JSON property `textParagraph`
|
|
2857
2990
|
# @return [Google::Apis::ChatV1::GoogleAppsCardV1TextParagraph]
|
|
2858
2991
|
attr_accessor :text_paragraph
|
|
@@ -2894,16 +3027,16 @@ module Google
|
|
|
2894
3027
|
end
|
|
2895
3028
|
end
|
|
2896
3029
|
|
|
2897
|
-
#
|
|
2898
|
-
#
|
|
2899
|
-
#
|
|
3030
|
+
# For a `SelectionInput` widget that uses a multiselect menu, a data source from
|
|
3031
|
+
# a Google Workspace application. The data source populates selection items for
|
|
3032
|
+
# the multiselect menu. [Google Chat apps](https://developers.google.com/chat):
|
|
2900
3033
|
class HostAppDataSourceMarkup
|
|
2901
3034
|
include Google::Apis::Core::Hashable
|
|
2902
3035
|
|
|
2903
|
-
#
|
|
2904
|
-
#
|
|
2905
|
-
#
|
|
2906
|
-
#
|
|
3036
|
+
# For a `SelectionInput` widget that uses a multiselect menu, a data source from
|
|
3037
|
+
# Google Chat. The data source populates selection items for the multiselect
|
|
3038
|
+
# menu. For example, a user can select Google Chat spaces that they're a member
|
|
3039
|
+
# of. [Google Chat apps](https://developers.google.com/chat):
|
|
2907
3040
|
# Corresponds to the JSON property `chatDataSource`
|
|
2908
3041
|
# @return [Google::Apis::ChatV1::ChatClientDataSourceMarkup]
|
|
2909
3042
|
attr_accessor :chat_data_source
|
|
@@ -3257,13 +3390,19 @@ module Google
|
|
|
3257
3390
|
include Google::Apis::Core::Hashable
|
|
3258
3391
|
|
|
3259
3392
|
# Optional. Immutable. The creation time of the membership, such as when a
|
|
3260
|
-
# member joined or was invited to join a space.
|
|
3261
|
-
#
|
|
3262
|
-
# when used to import historical memberships in import mode spaces.
|
|
3393
|
+
# member joined or was invited to join a space. This field is output only,
|
|
3394
|
+
# except when used to import historical memberships in import mode spaces.
|
|
3263
3395
|
# Corresponds to the JSON property `createTime`
|
|
3264
3396
|
# @return [String]
|
|
3265
3397
|
attr_accessor :create_time
|
|
3266
3398
|
|
|
3399
|
+
# Optional. Immutable. The deletion time of the membership, such as when a
|
|
3400
|
+
# member left or was removed from a space. This field is output only, except
|
|
3401
|
+
# when used to import historical memberships in import mode spaces.
|
|
3402
|
+
# Corresponds to the JSON property `deleteTime`
|
|
3403
|
+
# @return [String]
|
|
3404
|
+
attr_accessor :delete_time
|
|
3405
|
+
|
|
3267
3406
|
# A Google Group in Google Chat.
|
|
3268
3407
|
# Corresponds to the JSON property `groupMember`
|
|
3269
3408
|
# @return [Google::Apis::ChatV1::Group]
|
|
@@ -3302,6 +3441,7 @@ module Google
|
|
|
3302
3441
|
# Update properties of this object
|
|
3303
3442
|
def update!(**args)
|
|
3304
3443
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
3444
|
+
@delete_time = args[:delete_time] if args.key?(:delete_time)
|
|
3305
3445
|
@group_member = args[:group_member] if args.key?(:group_member)
|
|
3306
3446
|
@member = args[:member] if args.key?(:member)
|
|
3307
3447
|
@name = args[:name] if args.key?(:name)
|
|
@@ -3353,32 +3493,26 @@ module Google
|
|
|
3353
3493
|
# user](https://developers.google.com/chat/api/guides/auth/users), the messages
|
|
3354
3494
|
# can't contain cards. To learn about cards and how to create them, see [Design
|
|
3355
3495
|
# dynamic, interactive, and consistent UIs with cards](https://developers.google.
|
|
3356
|
-
# com/chat/ui).
|
|
3496
|
+
# com/chat/ui). [Card builder](https://addons.gsuite.google.com/uikit/builder)
|
|
3357
3497
|
# Corresponds to the JSON property `cardsV2`
|
|
3358
3498
|
# @return [Array<Google::Apis::ChatV1::CardWithId>]
|
|
3359
3499
|
attr_accessor :cards_v2
|
|
3360
3500
|
|
|
3361
|
-
# A custom
|
|
3362
|
-
#
|
|
3363
|
-
#
|
|
3364
|
-
#
|
|
3365
|
-
#
|
|
3366
|
-
#
|
|
3367
|
-
# Assigning a custom name doesn't replace the generated `name` field, the
|
|
3368
|
-
# message's resource name. Instead, it sets the custom name as the `
|
|
3369
|
-
# clientAssignedMessageId` field, which you can reference while processing later
|
|
3370
|
-
# operations, like updating or deleting the message. For example usage, see [
|
|
3371
|
-
# Name a created message](https://developers.google.com/chat/api/guides/v1/
|
|
3372
|
-
# messages/create#name_a_created_message).
|
|
3501
|
+
# Optional. A custom ID for the message. You can use field to identify a message,
|
|
3502
|
+
# or to get, delete, or update a message. To set a custom ID, specify the [`
|
|
3503
|
+
# messageId`](https://developers.google.com/chat/api/reference/rest/v1/spaces.
|
|
3504
|
+
# messages/create#body.QUERY_PARAMETERS.message_id) field when you create the
|
|
3505
|
+
# message. For details, see [Name a message](https://developers.google.com/chat/
|
|
3506
|
+
# api/guides/v1/messages/create#name_a_created_message).
|
|
3373
3507
|
# Corresponds to the JSON property `clientAssignedMessageId`
|
|
3374
3508
|
# @return [String]
|
|
3375
3509
|
attr_accessor :client_assigned_message_id
|
|
3376
3510
|
|
|
3377
|
-
# For spaces created in Chat, the time at which the message
|
|
3378
|
-
# field is output only, except when used in
|
|
3379
|
-
#
|
|
3380
|
-
#
|
|
3381
|
-
#
|
|
3511
|
+
# Optional. Immutable. For spaces created in Chat, the time at which the message
|
|
3512
|
+
# was created. This field is output only, except when used in import mode spaces.
|
|
3513
|
+
# For import mode spaces, set this field to the historical timestamp at which
|
|
3514
|
+
# the message was created in the source in order to preserve the original
|
|
3515
|
+
# creation time.
|
|
3382
3516
|
# Corresponds to the JSON property `createTime`
|
|
3383
3517
|
# @return [String]
|
|
3384
3518
|
attr_accessor :create_time
|
|
@@ -3435,12 +3569,27 @@ module Google
|
|
|
3435
3569
|
# @return [Google::Apis::ChatV1::MatchedUrl]
|
|
3436
3570
|
attr_accessor :matched_url
|
|
3437
3571
|
|
|
3438
|
-
# Resource name
|
|
3439
|
-
#
|
|
3572
|
+
# Resource name of the message. Format: `spaces/`space`/messages/`message``
|
|
3573
|
+
# Where ``space`` is the ID of the space where the message is posted and ``
|
|
3574
|
+
# message`` is a system-assigned ID for the message. For example, `spaces/
|
|
3575
|
+
# AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you
|
|
3576
|
+
# create a message, you can use this ID to specify the message in a request by
|
|
3577
|
+
# replacing ``message`` with the value from the `clientAssignedMessageId` field.
|
|
3578
|
+
# For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details,
|
|
3579
|
+
# see [Name a message](https://developers.google.com/chat/api/guides/v1/messages/
|
|
3580
|
+
# create#name_a_created_message).
|
|
3440
3581
|
# Corresponds to the JSON property `name`
|
|
3441
3582
|
# @return [String]
|
|
3442
3583
|
attr_accessor :name
|
|
3443
3584
|
|
|
3585
|
+
# A user in Google Chat. When returned as an output from a request, if your Chat
|
|
3586
|
+
# app [authenticates as a user](https://developers.google.com/chat/api/guides/
|
|
3587
|
+
# auth/users), the output for a `User` resource only populates the user's `name`
|
|
3588
|
+
# and `type`.
|
|
3589
|
+
# Corresponds to the JSON property `privateMessageViewer`
|
|
3590
|
+
# @return [Google::Apis::ChatV1::User]
|
|
3591
|
+
attr_accessor :private_message_viewer
|
|
3592
|
+
|
|
3444
3593
|
# Information about a quoted message.
|
|
3445
3594
|
# Corresponds to the JSON property `quotedMessageMetadata`
|
|
3446
3595
|
# @return [Google::Apis::ChatV1::QuotedMessageMetadata]
|
|
@@ -3518,6 +3667,7 @@ module Google
|
|
|
3518
3667
|
@last_update_time = args[:last_update_time] if args.key?(:last_update_time)
|
|
3519
3668
|
@matched_url = args[:matched_url] if args.key?(:matched_url)
|
|
3520
3669
|
@name = args[:name] if args.key?(:name)
|
|
3670
|
+
@private_message_viewer = args[:private_message_viewer] if args.key?(:private_message_viewer)
|
|
3521
3671
|
@quoted_message_metadata = args[:quoted_message_metadata] if args.key?(:quoted_message_metadata)
|
|
3522
3672
|
@sender = args[:sender] if args.key?(:sender)
|
|
3523
3673
|
@slash_command = args[:slash_command] if args.key?(:slash_command)
|
|
@@ -3818,6 +3968,15 @@ module Google
|
|
|
3818
3968
|
attr_accessor :admin_installed
|
|
3819
3969
|
alias_method :admin_installed?, :admin_installed
|
|
3820
3970
|
|
|
3971
|
+
# Optional. Immutable. For spaces created in Chat, the time the space was
|
|
3972
|
+
# created. This field is output only, except when used in import mode spaces.
|
|
3973
|
+
# For import mode spaces, set this field to the historical timestamp at which
|
|
3974
|
+
# the space was created in the source in order to preserve the original creation
|
|
3975
|
+
# time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
|
|
3976
|
+
# Corresponds to the JSON property `createTime`
|
|
3977
|
+
# @return [String]
|
|
3978
|
+
attr_accessor :create_time
|
|
3979
|
+
|
|
3821
3980
|
# The space's display name. Required when [creating a space](https://developers.
|
|
3822
3981
|
# google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error
|
|
3823
3982
|
# message `ALREADY_EXISTS` when creating a space or updating the `displayName`,
|
|
@@ -3841,6 +4000,14 @@ module Google
|
|
|
3841
4000
|
attr_accessor :external_user_allowed
|
|
3842
4001
|
alias_method :external_user_allowed?, :external_user_allowed
|
|
3843
4002
|
|
|
4003
|
+
# Optional. Whether this space is created in `Import Mode` as part of a data
|
|
4004
|
+
# migration into Google Workspace. While spaces are being imported, they aren't
|
|
4005
|
+
# visible to users until the import is complete.
|
|
4006
|
+
# Corresponds to the JSON property `importMode`
|
|
4007
|
+
# @return [Boolean]
|
|
4008
|
+
attr_accessor :import_mode
|
|
4009
|
+
alias_method :import_mode?, :import_mode
|
|
4010
|
+
|
|
3844
4011
|
# Resource name of the space. Format: `spaces/`space``
|
|
3845
4012
|
# Corresponds to the JSON property `name`
|
|
3846
4013
|
# @return [String]
|
|
@@ -3892,8 +4059,10 @@ module Google
|
|
|
3892
4059
|
# Update properties of this object
|
|
3893
4060
|
def update!(**args)
|
|
3894
4061
|
@admin_installed = args[:admin_installed] if args.key?(:admin_installed)
|
|
4062
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
|
3895
4063
|
@display_name = args[:display_name] if args.key?(:display_name)
|
|
3896
4064
|
@external_user_allowed = args[:external_user_allowed] if args.key?(:external_user_allowed)
|
|
4065
|
+
@import_mode = args[:import_mode] if args.key?(:import_mode)
|
|
3897
4066
|
@name = args[:name] if args.key?(:name)
|
|
3898
4067
|
@single_user_bot_dm = args[:single_user_bot_dm] if args.key?(:single_user_bot_dm)
|
|
3899
4068
|
@space_details = args[:space_details] if args.key?(:space_details)
|
|
@@ -3906,7 +4075,8 @@ module Google
|
|
|
3906
4075
|
end
|
|
3907
4076
|
|
|
3908
4077
|
# A data source that populates Google Chat spaces as selection items for a
|
|
3909
|
-
# multiselect menu. Only populates spaces that the user is a member of.
|
|
4078
|
+
# multiselect menu. Only populates spaces that the user is a member of. [Google
|
|
4079
|
+
# Chat apps](https://developers.google.com/chat):
|
|
3910
4080
|
class SpaceDataSource
|
|
3911
4081
|
include Google::Apis::Core::Hashable
|
|
3912
4082
|
|