@google-apps/chat 0.2.0 → 0.3.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.
@@ -38,15 +38,15 @@ option ruby_package = "Google::Apps::Card::V1";
38
38
  // To learn how
39
39
  // to build cards, see the following documentation:
40
40
  //
41
- // * For Google Chat apps, see [Design dynamic, interactive, and consistent UIs
42
- // with cards](https://developers.google.com/chat/ui).
41
+ // * For Google Chat apps, see [Design the components of a card or
42
+ // dialog](https://developers.google.com/workspace/chat/design-components-card-dialog).
43
43
  // * For Google Workspace Add-ons, see [Card-based
44
44
  // interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards).
45
45
  //
46
46
  // **Example: Card message for a Google Chat app**
47
47
  //
48
48
  // ![Example contact
49
- // card](https://developers.google.com/chat/images/card_api_reference.png)
49
+ // card](https://developers.google.com/workspace/chat/images/card_api_reference.png)
50
50
  //
51
51
  // To create the sample card message in Google Chat, use the following JSON:
52
52
  //
@@ -57,82 +57,82 @@ option ruby_package = "Google::Apps::Card::V1";
57
57
  // "cardId": "unique-card-id",
58
58
  // "card": {
59
59
  // "header": {
60
- // "title": "Sasha",
61
- // "subtitle": "Software Engineer",
62
- // "imageUrl":
63
- // "https://developers.google.com/chat/images/quickstart-app-avatar.png",
64
- // "imageType": "CIRCLE",
65
- // "imageAltText": "Avatar for Sasha",
66
- // },
67
- // "sections": [
68
- // {
69
- // "header": "Contact Info",
70
- // "collapsible": true,
71
- // "uncollapsibleWidgetsCount": 1,
72
- // "widgets": [
73
- // {
74
- // "decoratedText": {
75
- // "startIcon": {
76
- // "knownIcon": "EMAIL",
77
- // },
78
- // "text": "sasha@example.com",
79
- // }
80
- // },
81
- // {
82
- // "decoratedText": {
83
- // "startIcon": {
84
- // "knownIcon": "PERSON",
85
- // },
86
- // "text": "<font color=\"#80e27e\">Online</font>",
87
- // },
88
- // },
89
- // {
90
- // "decoratedText": {
91
- // "startIcon": {
92
- // "knownIcon": "PHONE",
93
- // },
94
- // "text": "+1 (555) 555-1234",
95
- // }
96
- // },
97
- // {
98
- // "buttonList": {
99
- // "buttons": [
100
- // {
101
- // "text": "Share",
102
- // "onClick": {
60
+ // "title": "Sasha",
61
+ // "subtitle": "Software Engineer",
62
+ // "imageUrl":
63
+ // "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
64
+ // "imageType": "CIRCLE",
65
+ // "imageAltText": "Avatar for Sasha"
66
+ // },
67
+ // "sections": [
68
+ // {
69
+ // "header": "Contact Info",
70
+ // "collapsible": true,
71
+ // "uncollapsibleWidgetsCount": 1,
72
+ // "widgets": [
73
+ // {
74
+ // "decoratedText": {
75
+ // "startIcon": {
76
+ // "knownIcon": "EMAIL"
77
+ // },
78
+ // "text": "sasha@example.com"
79
+ // }
80
+ // },
81
+ // {
82
+ // "decoratedText": {
83
+ // "startIcon": {
84
+ // "knownIcon": "PERSON"
85
+ // },
86
+ // "text": "<font color=\"#80e27e\">Online</font>"
87
+ // }
88
+ // },
89
+ // {
90
+ // "decoratedText": {
91
+ // "startIcon": {
92
+ // "knownIcon": "PHONE"
93
+ // },
94
+ // "text": "+1 (555) 555-1234"
95
+ // }
96
+ // },
97
+ // {
98
+ // "buttonList": {
99
+ // "buttons": [
100
+ // {
101
+ // "text": "Share",
102
+ // "onClick": {
103
103
  // "openLink": {
104
- // "url": "https://example.com/share",
105
- // }
106
- // }
107
- // },
108
- // {
109
- // "text": "Edit",
110
- // "onClick": {
111
- // "action": {
112
- // "function": "goToView",
113
- // "parameters": [
114
- // {
115
- // "key": "viewType",
116
- // "value": "EDIT",
117
- // }
118
- // ],
119
- // }
120
- // }
121
- // },
122
- // ],
123
- // }
124
- // },
125
- // ],
126
- // },
127
- // ],
128
- // },
104
+ // "url": "https://example.com/share"
105
+ // }
106
+ // }
107
+ // },
108
+ // {
109
+ // "text": "Edit",
110
+ // "onClick": {
111
+ // "action": {
112
+ // "function": "goToView",
113
+ // "parameters": [
114
+ // {
115
+ // "key": "viewType",
116
+ // "value": "EDIT"
117
+ // }
118
+ // ]
119
+ // }
120
+ // }
121
+ // }
122
+ // ]
123
+ // }
124
+ // }
125
+ // ]
126
+ // }
127
+ // ]
128
+ // }
129
129
  // }
130
- // ],
130
+ // ]
131
131
  // }
132
132
  // ```
133
133
  message Card {
134
- // Represents a card header. For an example in Google Chat apps, see [Card
135
- // header](https://developers.google.com/chat/ui/widgets/card-header).
134
+ // Represents a card header. For an example in Google Chat apps, see [Add a
135
+ // header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header).
136
136
  //
137
137
  // [Google Workspace Add-ons and Chat
138
138
  // apps](https://developers.google.com/workspace/extend):
@@ -170,7 +170,7 @@ message Card {
170
170
  // Supports simple HTML formatted text. For more information
171
171
  // about formatting text, see
172
172
  // [Formatting text in Google Chat
173
- // apps](https://developers.google.com/chat/format-messages#card-formatting)
173
+ // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
174
174
  // and
175
175
  // [Formatting
176
176
  // text in Google Workspace
@@ -238,11 +238,11 @@ message Card {
238
238
  // `secondaryButton` causes an error.
239
239
  //
240
240
  // For Chat apps, you can use fixed footers in
241
- // [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not
241
+ // [dialogs](https://developers.google.com/workspace/chat/dialogs), but not
242
242
  // [card
243
- // messages](https://developers.google.com/chat/api/guides/v1/messages/create#create).
244
- // For an example in Google Chat apps, see [Card
245
- // footer](https://developers.google.com/chat/ui/widgets/card-fixed-footer).
243
+ // messages](https://developers.google.com/workspace/chat/create-messages#create).
244
+ // For an example in Google Chat apps, see [Add a persistent
245
+ // footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer).
246
246
  //
247
247
  // [Google Workspace Add-ons and Chat
248
248
  // apps](https://developers.google.com/workspace/extend):
@@ -283,8 +283,8 @@ message Card {
283
283
 
284
284
  // Contains a collection of widgets. Each section has its own, optional
285
285
  // header. Sections are visually separated by a line divider. For an example
286
- // in Google Chat apps, see [Card
287
- // section](https://developers.google.com/chat/ui/widgets/card-section).
286
+ // in Google Chat apps, see [Define a section of a
287
+ // card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
288
288
  repeated Section sections = 2;
289
289
 
290
290
  // The divider style between sections.
@@ -338,9 +338,9 @@ message Card {
338
338
  // Setting `fixedFooter` without specifying a `primaryButton` or a
339
339
  // `secondaryButton` causes an error. For Chat apps, you can use fixed footers
340
340
  // in
341
- // [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not
341
+ // [dialogs](https://developers.google.com/workspace/chat/dialogs), but not
342
342
  // [card
343
- // messages](https://developers.google.com/chat/api/guides/v1/messages/create#create).
343
+ // messages](https://developers.google.com/workspace/chat/create-messages#create).
344
344
  //
345
345
  // [Google Workspace Add-ons and Chat
346
346
  // apps](https://developers.google.com/workspace/extend):
@@ -383,7 +383,7 @@ message Widget {
383
383
 
384
384
  // Specifies whether widgets align to the left, right, or center of a column.
385
385
  //
386
- // [Google Chat apps](https://developers.google.com/chat):
386
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
387
387
  enum HorizontalAlignment {
388
388
  // Don't use. Unspecified.
389
389
  HORIZONTAL_ALIGNMENT_UNSPECIFIED = 0;
@@ -408,7 +408,7 @@ message Widget {
408
408
  // Displays a text paragraph. Supports simple HTML formatted text. For more
409
409
  // information about formatting text, see
410
410
  // [Formatting text in Google Chat
411
- // apps](https://developers.google.com/chat/format-messages#card-formatting)
411
+ // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
412
412
  // and
413
413
  // [Formatting
414
414
  // text in Google Workspace
@@ -428,7 +428,7 @@ message Widget {
428
428
  // ```
429
429
  // "image": {
430
430
  // "imageUrl":
431
- // "https://developers.google.com/chat/images/quickstart-app-avatar.png",
431
+ // "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
432
432
  // "altText": "Chat app avatar"
433
433
  // }
434
434
  // ```
@@ -680,12 +680,12 @@ message Widget {
680
680
  }
681
681
 
682
682
  // A paragraph of text that supports formatting. For an example in
683
- // Google Chat apps, see [Text
684
- // paragraph](https://developers.google.com/chat/ui/widgets/text-paragraph).
683
+ // Google Chat apps, see [Add a paragraph of formatted
684
+ // text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text).
685
685
  // For more information
686
686
  // about formatting text, see
687
687
  // [Formatting text in Google Chat
688
- // apps](https://developers.google.com/chat/format-messages#card-formatting)
688
+ // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
689
689
  // and
690
690
  // [Formatting
691
691
  // text in Google Workspace
@@ -699,7 +699,8 @@ message TextParagraph {
699
699
  }
700
700
 
701
701
  // An image that is specified by a URL and can have an `onClick` action. For an
702
- // example, see [Image](https://developers.google.com/chat/ui/widgets/image).
702
+ // example, see [Add an
703
+ // image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image).
703
704
  //
704
705
  // [Google Workspace Add-ons and Chat
705
706
  // apps](https://developers.google.com/workspace/extend):
@@ -709,7 +710,7 @@ message Image {
709
710
  // For example:
710
711
  //
711
712
  // ```
712
- // https://developers.google.com/chat/images/quickstart-app-avatar.png
713
+ // https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
713
714
  // ```
714
715
  string image_url = 1;
715
716
 
@@ -722,7 +723,8 @@ message Image {
722
723
 
723
724
  // Displays a divider between widgets as a horizontal line. For an example in
724
725
  // Google Chat apps, see
725
- // [Divider](https://developers.google.com/chat/ui/widgets/divider).
726
+ // [Add a horizontal divider between
727
+ // widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets).
726
728
  //
727
729
  // [Google Workspace Add-ons and Chat
728
730
  // apps](https://developers.google.com/workspace/extend):
@@ -737,8 +739,8 @@ message Divider {}
737
739
  // A widget that displays text with optional decorations such as a label above
738
740
  // or below the text, an icon in front of the text, a selection widget, or a
739
741
  // button after the text. For an example in
740
- // Google Chat apps, see [Decorated
741
- // text](https://developers.google.com/chat/ui/widgets/decorated-text).
742
+ // Google Chat apps, see [Display text with decorative
743
+ // text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements).
742
744
  //
743
745
  // [Google Workspace Add-ons and Chat
744
746
  // apps](https://developers.google.com/workspace/extend):
@@ -768,13 +770,13 @@ message DecoratedText {
768
770
  // The name by which the switch widget is identified in a form input event.
769
771
  //
770
772
  // For details about working with form inputs, see [Receive form
771
- // data](https://developers.google.com/chat/ui/read-form-data).
773
+ // data](https://developers.google.com/workspace/chat/read-form-data).
772
774
  string name = 1;
773
775
 
774
776
  // The value entered by a user, returned as part of a form input event.
775
777
  //
776
778
  // For details about working with form inputs, see [Receive form
777
- // data](https://developers.google.com/chat/ui/read-form-data).
779
+ // data](https://developers.google.com/workspace/chat/read-form-data).
778
780
  string value = 2;
779
781
 
780
782
  // When `true`, the switch is selected.
@@ -805,7 +807,7 @@ message DecoratedText {
805
807
  // Supports simple formatting. For more information
806
808
  // about formatting text, see
807
809
  // [Formatting text in Google Chat
808
- // apps](https://developers.google.com/chat/format-messages#card-formatting)
810
+ // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
809
811
  // and
810
812
  // [Formatting
811
813
  // text in Google Workspace
@@ -837,21 +839,22 @@ message DecoratedText {
837
839
  // An icon displayed after the text.
838
840
  //
839
841
  // Supports
840
- // [built-in](https://developers.google.com/chat/format-messages#builtinicons)
842
+ // [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
841
843
  // and
842
- // [custom](https://developers.google.com/chat/format-messages#customicons)
844
+ // [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
843
845
  // icons.
844
846
  Icon end_icon = 11;
845
847
  }
846
848
  }
847
849
 
848
850
  // A field in which users can enter text. Supports suggestions and on-change
849
- // actions. For an example in Google Chat apps, see [Text
850
- // input](https://developers.google.com/chat/ui/widgets/text-input).
851
+ // actions. For an example in Google Chat apps, see [Add a field in which a user
852
+ // can enter
853
+ // text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text).
851
854
  //
852
855
  // Chat apps receive and can process the value of entered text during form input
853
856
  // events. For details about working with form inputs, see [Receive form
854
- // data](https://developers.google.com/chat/ui/read-form-data).
857
+ // data](https://developers.google.com/workspace/chat/read-form-data).
855
858
  //
856
859
  // When you need to collect undefined or abstract data from users,
857
860
  // use a text input. To collect defined or enumerated data from users, use the
@@ -878,7 +881,7 @@ message TextInput {
878
881
  // The name by which the text input is identified in a form input event.
879
882
  //
880
883
  // For details about working with form inputs, see [Receive form
881
- // data](https://developers.google.com/chat/ui/read-form-data).
884
+ // data](https://developers.google.com/workspace/chat/read-form-data).
882
885
  string name = 1;
883
886
 
884
887
  // The text that appears above the text input field in the user interface.
@@ -899,7 +902,7 @@ message TextInput {
899
902
  // The value entered by a user, returned as part of a form input event.
900
903
  //
901
904
  // For details about working with form inputs, see [Receive form
902
- // data](https://developers.google.com/chat/ui/read-form-data).
905
+ // data](https://developers.google.com/workspace/chat/read-form-data).
903
906
  string value = 4;
904
907
 
905
908
  // How a text input field appears in the user interface.
@@ -910,7 +913,7 @@ message TextInput {
910
913
  // user adding to the field or deleting text.
911
914
  //
912
915
  // Examples of actions to take include running a custom function or opening
913
- // a [dialog](https://developers.google.com/chat/how-tos/dialogs)
916
+ // a [dialog](https://developers.google.com/workspace/chat/dialogs)
914
917
  // in Google Chat.
915
918
  Action on_change_action = 6;
916
919
 
@@ -951,7 +954,7 @@ message TextInput {
951
954
  // Use this text to prompt users to enter a value. For example, `Enter a
952
955
  // number from 0 to 100`.
953
956
  //
954
- // [Google Chat apps](https://developers.google.com/chat):
957
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
955
958
  string placeholder_text = 12;
956
959
  }
957
960
 
@@ -993,7 +996,8 @@ message Suggestions {
993
996
 
994
997
  // A list of buttons layed out horizontally. For an example in
995
998
  // Google Chat apps, see
996
- // [Button list](https://developers.google.com/chat/ui/widgets/button-list).
999
+ // [Add a
1000
+ // button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).
997
1001
  //
998
1002
  // [Google Workspace Add-ons and Chat
999
1003
  // apps](https://developers.google.com/workspace/extend):
@@ -1005,12 +1009,12 @@ message ButtonList {
1005
1009
  // A widget that creates one or more UI items that users can select.
1006
1010
  // For example, a dropdown menu or checkboxes. You can use this widget to
1007
1011
  // collect data that can be predicted or enumerated. For an example in Google
1008
- // Chat apps, see [Selection
1009
- // input](https://developers.google.com/chat/ui/widgets/selection-input).
1012
+ // Chat apps, see [Add selectable UI
1013
+ // elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements).
1010
1014
  //
1011
1015
  // Chat apps can process the value of items that users select or input. For
1012
1016
  // details about working with form inputs, see [Receive form
1013
- // data](https://developers.google.com/chat/ui/read-form-data).
1017
+ // data](https://developers.google.com/workspace/chat/read-form-data).
1014
1018
  //
1015
1019
  // To collect undefined or abstract data from users, use
1016
1020
  // the [TextInput][google.apps.card.v1.TextInput] widget.
@@ -1055,14 +1059,14 @@ message SelectionInput {
1055
1059
  // * External data: Items are populated from an external data
1056
1060
  // source outside of Google Workspace.
1057
1061
  //
1058
- // For examples of how to implement multiselect menus, see the
1059
- // [`SelectionInput` widget
1060
- // page](https://developers.google.com/chat/ui/widgets/selection-input#multiselect-menu).
1062
+ // For examples of how to implement multiselect menus, see
1063
+ // [Add a multiselect
1064
+ // menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu).
1061
1065
  //
1062
1066
  // [Google Workspace Add-ons and Chat
1063
1067
  // apps](https://developers.google.com/workspace/extend):
1064
- // multiselect for Google Workspace Add-ons are in
1065
- // [Developer Preview](https://developers.google.com/workspace/preview).
1068
+ // Multiselect for Google Workspace Add-ons are in
1069
+ // Developer Preview.
1066
1070
  MULTI_SELECT = 4;
1067
1071
  }
1068
1072
 
@@ -1079,7 +1083,7 @@ message SelectionInput {
1079
1083
  // input value.
1080
1084
  //
1081
1085
  // For details about working with form inputs, see [Receive form
1082
- // data](https://developers.google.com/chat/ui/read-form-data).
1086
+ // data](https://developers.google.com/workspace/chat/read-form-data).
1083
1087
  string value = 2;
1084
1088
 
1085
1089
  // Whether the item is selected by default. If the selection input only
@@ -1090,7 +1094,7 @@ message SelectionInput {
1090
1094
  // For multiselect menus, the URL for the icon displayed next to
1091
1095
  // the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS`
1092
1096
  // URL. For example,
1093
- // `https://developers.google.com/chat/images/quickstart-app-avatar.png`.
1097
+ // `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`.
1094
1098
  string start_icon_uri = 4;
1095
1099
 
1096
1100
  // For multiselect menus, a text description or label that's
@@ -1103,13 +1107,13 @@ message SelectionInput {
1103
1107
  // multiselect menu, a data source from Google Workspace. Used to populate
1104
1108
  // items in a multiselect menu.
1105
1109
  //
1106
- // [Google Chat apps](https://developers.google.com/chat):
1110
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1107
1111
  message PlatformDataSource {
1108
1112
  // A data source shared by all [Google Workspace
1109
1113
  // applications]
1110
- // (https://developers.google.com/chat/api/reference/rest/v1/HostApp).
1114
+ // (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp).
1111
1115
  //
1112
- // [Google Chat apps](https://developers.google.com/chat):
1116
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1113
1117
  enum CommonDataSource {
1114
1118
  // Default value. Don't use.
1115
1119
  UNKNOWN = 0;
@@ -1130,7 +1134,7 @@ message SelectionInput {
1130
1134
  // The name that identifies the selection input in a form input event.
1131
1135
  //
1132
1136
  // For details about working with form inputs, see [Receive form
1133
- // data](https://developers.google.com/chat/ui/read-form-data).
1137
+ // data](https://developers.google.com/workspace/chat/read-form-data).
1134
1138
  string name = 1;
1135
1139
 
1136
1140
  // The text that appears above the selection input field in the user
@@ -1155,7 +1159,7 @@ message SelectionInput {
1155
1159
  // specified, you must specify a separate button that submits the form.
1156
1160
  //
1157
1161
  // For details about working with form inputs, see [Receive form
1158
- // data](https://developers.google.com/chat/ui/read-form-data).
1162
+ // data](https://developers.google.com/workspace/chat/read-form-data).
1159
1163
  Action on_change_action = 5;
1160
1164
 
1161
1165
  // For multiselect menus, the maximum number of items that a user can select.
@@ -1163,7 +1167,7 @@ message SelectionInput {
1163
1167
  int32 multi_select_max_selected_items = 6;
1164
1168
 
1165
1169
  // For multiselect menus, the number of text characters that a user inputs
1166
- // before the Chat app queries autocomplete and displays suggested items
1170
+ // before the app queries autocomplete and displays suggested items
1167
1171
  // in the menu.
1168
1172
  //
1169
1173
  // If unspecified, defaults to 0 characters for static data sources and 3
@@ -1173,7 +1177,7 @@ message SelectionInput {
1173
1177
  // For a multiselect menu, the data source that populates
1174
1178
  // selection items.
1175
1179
  //
1176
- // [Google Chat apps](https://developers.google.com/chat):
1180
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1177
1181
  oneof multi_select_data_source {
1178
1182
  // An external data source, such as a relational data base.
1179
1183
  Action external_data_source = 8;
@@ -1184,8 +1188,8 @@ message SelectionInput {
1184
1188
  }
1185
1189
 
1186
1190
  // Lets users input a date, a time, or both a date and a time. For an example in
1187
- // Google Chat apps, see [Date time
1188
- // picker](https://developers.google.com/chat/ui/widgets/date-time-picker).
1191
+ // Google Chat apps, see [Let a user pick a date and
1192
+ // time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time).
1189
1193
  //
1190
1194
  // Users can input text or use the picker to select dates and times. If users
1191
1195
  // input an invalid date or time, the picker shows an error that prompts users
@@ -1213,7 +1217,7 @@ message DateTimePicker {
1213
1217
  // The name by which the `DateTimePicker` is identified in a form input event.
1214
1218
  //
1215
1219
  // For details about working with form inputs, see [Receive form
1216
- // data](https://developers.google.com/chat/ui/read-form-data).
1220
+ // data](https://developers.google.com/workspace/chat/read-form-data).
1217
1221
  string name = 1;
1218
1222
 
1219
1223
  // The text that prompts users to input a date, a time, or a date and time.
@@ -1249,7 +1253,8 @@ message DateTimePicker {
1249
1253
 
1250
1254
  // A text, icon, or text and icon button that users can click. For an example in
1251
1255
  // Google Chat apps, see
1252
- // [Button list](https://developers.google.com/chat/ui/widgets/button-list).
1256
+ // [Add a
1257
+ // button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).
1253
1258
  //
1254
1259
  // To make an image a clickable button, specify an
1255
1260
  // [`Image`][google.apps.card.v1.Image] (not an
@@ -1313,17 +1318,18 @@ message Button {
1313
1318
  // Set descriptive text that lets users know what the button does. For
1314
1319
  // example, if a button opens a hyperlink, you might write: "Opens a new
1315
1320
  // browser tab and navigates to the Google Chat developer documentation at
1316
- // https://developers.google.com/chat".
1321
+ // https://developers.google.com/workspace/chat".
1317
1322
  string alt_text = 6;
1318
1323
  }
1319
1324
 
1320
1325
  // An icon displayed in a widget on a card. For an example in Google Chat apps,
1321
- // see [Icon](https://developers.google.com/chat/ui/widgets/icon).
1326
+ // see [Add an
1327
+ // icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon).
1322
1328
  //
1323
1329
  // Supports
1324
- // [built-in](https://developers.google.com/chat/format-messages#builtinicons)
1330
+ // [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
1325
1331
  // and
1326
- // [custom](https://developers.google.com/chat/format-messages#customicons)
1332
+ // [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
1327
1333
  // icons.
1328
1334
  //
1329
1335
  // [Google Workspace Add-ons and Chat
@@ -1337,7 +1343,7 @@ message Icon {
1337
1343
  // For a bus, specify `BUS`.
1338
1344
  //
1339
1345
  // For a full list of supported icons, see [built-in
1340
- // icons](https://developers.google.com/chat/format-messages#builtinicons).
1346
+ // icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
1341
1347
  string known_icon = 1;
1342
1348
 
1343
1349
  // Display a custom icon hosted at an HTTPS URL.
@@ -1346,11 +1352,26 @@ message Icon {
1346
1352
  //
1347
1353
  // ```
1348
1354
  // "iconUrl":
1349
- // "https://developers.google.com/chat/images/quickstart-app-avatar.png"
1355
+ // "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"
1350
1356
  // ```
1351
1357
  //
1352
1358
  // Supported file types include `.png` and `.jpg`.
1353
1359
  string icon_url = 2;
1360
+
1361
+ // Display one of the [Google Material
1362
+ // Icons](https://fonts.google.com/icons).
1363
+ //
1364
+ // For example, to display a [checkbox
1365
+ // icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048),
1366
+ // use
1367
+ // ```
1368
+ // "material_icon": {
1369
+ // "name": "check_box"
1370
+ // }
1371
+ // ```
1372
+ //
1373
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1374
+ MaterialIcon material_icon = 5;
1354
1375
  }
1355
1376
 
1356
1377
  // Optional. A description of the icon used for accessibility.
@@ -1358,7 +1379,7 @@ message Icon {
1358
1379
  // you should set a helpful description for what the icon displays, and if
1359
1380
  // applicable, what it does. For example, `A user's account portrait`, or
1360
1381
  // `Opens a new browser tab and navigates to the Google Chat developer
1361
- // documentation at https://developers.google.com/chat`.
1382
+ // documentation at https://developers.google.com/workspace/chat`.
1362
1383
  //
1363
1384
  // If the icon is set in a [`Button`][google.apps.card.v1.Button], the
1364
1385
  // `altText` appears as helper text when the user hovers over the button.
@@ -1371,6 +1392,57 @@ message Icon {
1371
1392
  Widget.ImageType image_type = 4;
1372
1393
  }
1373
1394
 
1395
+ // A [Google Material Icon](https://fonts.google.com/icons), which includes over
1396
+ // 2500+ options.
1397
+ //
1398
+ // For example, to display a [checkbox
1399
+ // icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048)
1400
+ // with customized weight and grade, write the following:
1401
+ //
1402
+ // ```
1403
+ // {
1404
+ // "name": "check_box",
1405
+ // "fill": true,
1406
+ // "weight": 300,
1407
+ // "grade": -25
1408
+ // }
1409
+ // ```
1410
+ //
1411
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1412
+ message MaterialIcon {
1413
+ // The icon name defined in the [Google Material
1414
+ // Icon](https://fonts.google.com/icons), for example, `check_box`. Any
1415
+ // invalid names are abandoned and replaced with empty string and
1416
+ // results in the icon failing to render.
1417
+ string name = 1;
1418
+
1419
+ // Whether the icon renders as filled. Default value is false.
1420
+ //
1421
+ // To preview different icon settings, go to
1422
+ // [Google Font Icons](https://fonts.google.com/icons) and adjust the
1423
+ // settings under **Customize**.
1424
+ bool fill = 2;
1425
+
1426
+ // The stroke weight of the icon. Choose from {100, 200, 300, 400,
1427
+ // 500, 600, 700}. If absent, default value is 400. If any other value is
1428
+ // specified, the default value is used.
1429
+ //
1430
+ // To preview different icon settings, go to
1431
+ // [Google Font Icons](https://fonts.google.com/icons) and adjust the
1432
+ // settings under **Customize**.
1433
+ int32 weight = 3;
1434
+
1435
+ // Weight and grade affect a symbol’s thickness. Adjustments to grade are more
1436
+ // granular than adjustments to weight and have a small impact on the size of
1437
+ // the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If
1438
+ // any other value is specified, the default value is used.
1439
+ //
1440
+ // To preview different icon settings, go to
1441
+ // [Google Font Icons](https://fonts.google.com/icons) and adjust the
1442
+ // settings under **Customize**.
1443
+ int32 grade = 4;
1444
+ }
1445
+
1374
1446
  // Represents the crop style applied to an image.
1375
1447
  //
1376
1448
  // [Google Workspace Add-ons and
@@ -1475,7 +1547,8 @@ message ImageComponent {
1475
1547
  // Displays a grid with a collection of items. Items can only include text or
1476
1548
  // images. For responsive columns, or to include more than text or images, use
1477
1549
  // [`Columns`][google.apps.card.v1.Columns]. For an example in Google Chat apps,
1478
- // see [Grid](https://developers.google.com/chat/ui/widgets/grid).
1550
+ // see [Display a Grid with a collection of
1551
+ // items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items).
1479
1552
  //
1480
1553
  // A grid supports any number of columns and items. The number of rows is
1481
1554
  // determined by items divided by columns. A grid with
@@ -1580,7 +1653,8 @@ message Grid {
1580
1653
  // The `Columns` widget displays up to 2 columns in a card or dialog. You can
1581
1654
  // add widgets to each column; the widgets appear in the order that they are
1582
1655
  // specified. For an example in Google Chat apps, see
1583
- // [Columns](https://developers.google.com/chat/ui/widgets/columns).
1656
+ // [Display cards and dialogs in
1657
+ // columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns).
1584
1658
  //
1585
1659
  // The height of each column is determined by the taller column. For example, if
1586
1660
  // the first column is taller than the second column, both columns have the
@@ -1605,17 +1679,23 @@ message Grid {
1605
1679
  // [Google Workspace Add-ons and Chat
1606
1680
  // apps](https://developers.google.com/workspace/extend):
1607
1681
  // Columns for Google Workspace Add-ons are in
1608
- // [Developer Preview](https://developers.google.com/workspace/preview).
1682
+ // Developer Preview.
1609
1683
  message Columns {
1610
1684
  // A column.
1611
1685
  //
1612
- // [Google Chat apps](https://developers.google.com/chat):
1686
+ // [Google Workspace Add-ons and Chat
1687
+ // apps](https://developers.google.com/workspace/extend):
1688
+ // Columns for Google Workspace Add-ons are in
1689
+ // Developer Preview.
1613
1690
  message Column {
1614
1691
  // Specifies how a column fills the width of the card. The width of each
1615
1692
  // column depends on both the `HorizontalSizeStyle` and the width of the
1616
1693
  // widgets within the column.
1617
1694
  //
1618
- // [Google Chat apps](https://developers.google.com/chat):
1695
+ // [Google Workspace Add-ons and Chat
1696
+ // apps](https://developers.google.com/workspace/extend):
1697
+ // Columns for Google Workspace Add-ons are in
1698
+ // Developer Preview.
1619
1699
  enum HorizontalSizeStyle {
1620
1700
  // Don't use. Unspecified.
1621
1701
  HORIZONTAL_SIZE_STYLE_UNSPECIFIED = 0;
@@ -1633,7 +1713,10 @@ message Columns {
1633
1713
  // Specifies whether widgets align to the top, bottom, or center of a
1634
1714
  // column.
1635
1715
  //
1636
- // [Google Chat apps](https://developers.google.com/chat):
1716
+ // [Google Workspace Add-ons and Chat
1717
+ // apps](https://developers.google.com/workspace/extend):
1718
+ // Columns for Google Workspace Add-ons are in
1719
+ // Developer Preview.
1637
1720
  enum VerticalAlignment {
1638
1721
  // Don't use. Unspecified.
1639
1722
  VERTICAL_ALIGNMENT_UNSPECIFIED = 0;
@@ -1650,7 +1733,10 @@ message Columns {
1650
1733
 
1651
1734
  // The supported widgets that you can include in a column.
1652
1735
  //
1653
- // [Google Chat apps](https://developers.google.com/chat):
1736
+ // [Google Workspace Add-ons and Chat
1737
+ // apps](https://developers.google.com/workspace/extend):
1738
+ // Columns for Google Workspace Add-ons are in
1739
+ // Developer Preview.
1654
1740
  message Widgets {
1655
1741
  oneof data {
1656
1742
  // [TextParagraph][google.apps.card.v1.TextParagraph] widget.
@@ -1677,8 +1763,6 @@ message Columns {
1677
1763
  }
1678
1764
 
1679
1765
  // Specifies how a column fills the width of the card.
1680
- //
1681
- // [Google Chat apps](https://developers.google.com/chat):
1682
1766
  HorizontalSizeStyle horizontal_size_style = 1;
1683
1767
 
1684
1768
  // Specifies whether widgets align to the left, right, or center of a
@@ -1687,8 +1771,6 @@ message Columns {
1687
1771
 
1688
1772
  // Specifies whether widgets align to the top, bottom, or center of a
1689
1773
  // column.
1690
- //
1691
- // [Google Chat apps](https://developers.google.com/chat):
1692
1774
  VerticalAlignment vertical_alignment = 3;
1693
1775
 
1694
1776
  // An array of widgets included in a column. Widgets appear in the order
@@ -1805,7 +1887,7 @@ message Action {
1805
1887
  // snooze type and snooze time in the list of string parameters.
1806
1888
  //
1807
1889
  // To learn more, see
1808
- // [`CommonEventObject`](https://developers.google.com/chat/api/reference/rest/v1/Event#commoneventobject).
1890
+ // [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
1809
1891
  //
1810
1892
  // [Google Workspace Add-ons and Chat
1811
1893
  // apps](https://developers.google.com/workspace/extend):
@@ -1831,7 +1913,7 @@ message Action {
1831
1913
  }
1832
1914
 
1833
1915
  // Optional. Required when opening a
1834
- // [dialog](https://developers.google.com/chat/how-tos/dialogs).
1916
+ // [dialog](https://developers.google.com/workspace/chat/dialogs).
1835
1917
  //
1836
1918
  // What to do in response to an interaction with a user, such as a user
1837
1919
  // clicking a button in a card message.
@@ -1841,17 +1923,17 @@ message Action {
1841
1923
  //
1842
1924
  // By specifying an `interaction`, the app can respond in special interactive
1843
1925
  // ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
1844
- // open a [dialog](https://developers.google.com/chat/how-tos/dialogs).
1926
+ // open a [dialog](https://developers.google.com/workspace/chat/dialogs).
1845
1927
  //
1846
1928
  // When specified, a loading indicator isn't shown. If specified for
1847
1929
  // an add-on, the entire card is stripped and nothing is shown in the client.
1848
1930
  //
1849
- // [Google Chat apps](https://developers.google.com/chat):
1931
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1850
1932
  enum Interaction {
1851
1933
  // Default value. The `action` executes as normal.
1852
1934
  INTERACTION_UNSPECIFIED = 0;
1853
1935
 
1854
- // Opens a [dialog](https://developers.google.com/chat/how-tos/dialogs), a
1936
+ // Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
1855
1937
  // windowed, card-based interface that Chat apps use to interact with users.
1856
1938
  //
1857
1939
  // Only supported by Chat apps in response to button-clicks on card
@@ -1859,15 +1941,15 @@ message Action {
1859
1941
  // an add-on, the entire card is stripped and nothing is shown in the
1860
1942
  // client.
1861
1943
  //
1862
- // [Google Chat apps](https://developers.google.com/chat):
1944
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1863
1945
  OPEN_DIALOG = 1;
1864
1946
  }
1865
1947
 
1866
1948
  // A custom function to invoke when the containing element is
1867
1949
  // clicked or othrwise activated.
1868
1950
  //
1869
- // For example usage, see [Create interactive
1870
- // cards](https://developers.google.com/chat/how-tos/cards-onclick).
1951
+ // For example usage, see [Read form
1952
+ // data](https://developers.google.com/workspace/chat/read-form-data).
1871
1953
  string function = 1;
1872
1954
 
1873
1955
  // List of action parameters.
@@ -1884,11 +1966,11 @@ message Action {
1884
1966
  // user make changes while the action is being processed, set
1885
1967
  // [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
1886
1968
  // to `NONE`. For [card
1887
- // messages](https://developers.google.com/chat/api/guides/v1/messages/create#create)
1969
+ // messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create)
1888
1970
  // in Chat apps, you must also set the action's
1889
- // [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype)
1971
+ // [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype)
1890
1972
  // to `UPDATE_MESSAGE` and use the same
1891
- // [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId)
1973
+ // [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId)
1892
1974
  // from the card that contained the action.
1893
1975
  //
1894
1976
  // If `false`, the form values are cleared when the action is triggered.
@@ -1899,7 +1981,7 @@ message Action {
1899
1981
  bool persist_values = 4;
1900
1982
 
1901
1983
  // Optional. Required when opening a
1902
- // [dialog](https://developers.google.com/chat/how-tos/dialogs).
1984
+ // [dialog](https://developers.google.com/workspace/chat/dialogs).
1903
1985
  //
1904
1986
  // What to do in response to an interaction with a user, such as a user
1905
1987
  // clicking a button in a card message.
@@ -1909,10 +1991,10 @@ message Action {
1909
1991
  //
1910
1992
  // By specifying an `interaction`, the app can respond in special interactive
1911
1993
  // ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
1912
- // open a [dialog](https://developers.google.com/chat/how-tos/dialogs). When
1994
+ // open a [dialog](https://developers.google.com/workspace/chat/dialogs). When
1913
1995
  // specified, a loading indicator isn't shown. If specified for
1914
1996
  // an add-on, the entire card is stripped and nothing is shown in the client.
1915
1997
  //
1916
- // [Google Chat apps](https://developers.google.com/chat):
1998
+ // [Google Chat apps](https://developers.google.com/workspace/chat):
1917
1999
  Interaction interaction = 5;
1918
2000
  }