google-cloud-gsuite_add_ons-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +144 -0
  6. data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/client.rb +1208 -0
  7. data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/credentials.rb +47 -0
  8. data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons/paths.rb +95 -0
  9. data/lib/google/cloud/gsuite_add_ons/v1/gsuite_add_ons.rb +76 -0
  10. data/lib/google/cloud/gsuite_add_ons/v1/version.rb +28 -0
  11. data/lib/google/cloud/gsuite_add_ons/v1.rb +40 -0
  12. data/lib/google/cloud/gsuiteaddons/v1/gsuiteaddons_pb.rb +107 -0
  13. data/lib/google/cloud/gsuiteaddons/v1/gsuiteaddons_services_pb.rb +92 -0
  14. data/lib/google-cloud-gsuite_add_ons-v1.rb +21 -0
  15. data/proto_docs/README.md +4 -0
  16. data/proto_docs/google/api/client.rb +318 -0
  17. data/proto_docs/google/api/field_behavior.rb +71 -0
  18. data/proto_docs/google/api/launch_stage.rb +71 -0
  19. data/proto_docs/google/api/resource.rb +222 -0
  20. data/proto_docs/google/apps/script/type/addon_widget_set.rb +62 -0
  21. data/proto_docs/google/apps/script/type/calendar/calendar_addon_manifest.rb +114 -0
  22. data/proto_docs/google/apps/script/type/docs/docs_addon_manifest.rb +51 -0
  23. data/proto_docs/google/apps/script/type/drive/drive_addon_manifest.rb +53 -0
  24. data/proto_docs/google/apps/script/type/extension_point.rb +80 -0
  25. data/proto_docs/google/apps/script/type/gmail/gmail_addon_manifest.rb +134 -0
  26. data/proto_docs/google/apps/script/type/script_manifest.rb +112 -0
  27. data/proto_docs/google/apps/script/type/sheets/sheets_addon_manifest.rb +51 -0
  28. data/proto_docs/google/apps/script/type/slides/slides_addon_manifest.rb +51 -0
  29. data/proto_docs/google/cloud/gsuiteaddons/v1/gsuiteaddons.rb +245 -0
  30. data/proto_docs/google/protobuf/duration.rb +98 -0
  31. data/proto_docs/google/protobuf/empty.rb +34 -0
  32. data/proto_docs/google/protobuf/struct.rb +96 -0
  33. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  34. metadata +243 -0
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ # The widget subset used by an add-on.
25
+ # @!attribute [rw] used_widgets
26
+ # @return [::Array<::Google::Apps::Script::Type::AddOnWidgetSet::WidgetType>]
27
+ # The list of widgets used in an add-on.
28
+ class AddOnWidgetSet
29
+ include ::Google::Protobuf::MessageExts
30
+ extend ::Google::Protobuf::MessageExts::ClassMethods
31
+
32
+ # The Widget type. DEFAULT is the basic widget set.
33
+ module WidgetType
34
+ # The default widget set.
35
+ WIDGET_TYPE_UNSPECIFIED = 0
36
+
37
+ # The date picker.
38
+ DATE_PICKER = 1
39
+
40
+ # Styled buttons include filled buttons and disabled buttons.
41
+ STYLED_BUTTONS = 2
42
+
43
+ # Persistent forms allow persisting form values during actions.
44
+ PERSISTENT_FORMS = 3
45
+
46
+ # Fixed footer in card.
47
+ FIXED_FOOTER = 4
48
+
49
+ # Update the subject and recipients of a draft.
50
+ UPDATE_SUBJECT_AND_RECIPIENTS = 5
51
+
52
+ # The grid widget.
53
+ GRID_WIDGET = 6
54
+
55
+ # A Gmail add-on action that applies to the addon compose UI.
56
+ ADDON_COMPOSE_UI_ACTION = 7
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,114 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ module Calendar
25
+ # Calendar add-on manifest.
26
+ # @!attribute [rw] homepage_trigger
27
+ # @return [::Google::Apps::Script::Type::HomepageExtensionPoint]
28
+ # Defines an endpoint that will be executed contexts that don't
29
+ # match a declared contextual trigger. Any cards generated by this function
30
+ # will always be available to the user, but may be eclipsed by contextual
31
+ # content when this add-on declares more targeted triggers.
32
+ #
33
+ # If present, this overrides the configuration from
34
+ # `addOns.common.homepageTrigger`.
35
+ # @!attribute [rw] conference_solution
36
+ # @return [::Array<::Google::Apps::Script::Type::Calendar::ConferenceSolution>]
37
+ # Defines conference solutions provided by this add-on.
38
+ # @!attribute [rw] create_settings_url_function
39
+ # @return [::String]
40
+ # An endpoint to execute that creates a URL to the add-on's settings page.
41
+ # @!attribute [rw] event_open_trigger
42
+ # @return [::Google::Apps::Script::Type::Calendar::CalendarExtensionPoint]
43
+ # An endpoint to trigger when an event is opened (viewed/edited).
44
+ # @!attribute [rw] event_update_trigger
45
+ # @return [::Google::Apps::Script::Type::Calendar::CalendarExtensionPoint]
46
+ # An endpoint to trigger when the open event is updated.
47
+ # @!attribute [rw] current_event_access
48
+ # @return [::Google::Apps::Script::Type::Calendar::CalendarAddOnManifest::EventAccess]
49
+ # Define the level of data access when an event addon is triggered.
50
+ class CalendarAddOnManifest
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+
54
+ # An enum defining the level of data access event triggers require.
55
+ module EventAccess
56
+ # Default value when nothing is set for EventAccess.
57
+ UNSPECIFIED = 0
58
+
59
+ # METADATA gives event triggers the permission to access the metadata of
60
+ # events such as event id and calendar id.
61
+ METADATA = 1
62
+
63
+ # READ gives event triggers access to all provided event fields including
64
+ # the metadata, attendees, and conference data.
65
+ READ = 3
66
+
67
+ # WRITE gives event triggers access to the metadata of events and the
68
+ # ability to perform all actions, including adding attendees and setting
69
+ # conference data.
70
+ WRITE = 4
71
+
72
+ # READ_WRITE gives event triggers access to all provided event fields
73
+ # including the metadata, attendees, and conference data and the ability to
74
+ # perform all actions.
75
+ READ_WRITE = 5
76
+ end
77
+ end
78
+
79
+ # Defines conference related values.
80
+ # @!attribute [rw] on_create_function
81
+ # @return [::String]
82
+ # Required. The endpoint to call when ConferenceData should be created.
83
+ # @!attribute [rw] id
84
+ # @return [::String]
85
+ # Required. IDs should be unique across ConferenceSolutions within one
86
+ # add-on, but this is not strictly enforced. It is up to the add-on developer
87
+ # to assign them uniquely, otherwise the wrong ConferenceSolution may be
88
+ # used when the add-on is triggered. While the developer may change the
89
+ # display name of an add-on, the ID should not be changed.
90
+ # @!attribute [rw] name
91
+ # @return [::String]
92
+ # Required. The display name of the ConferenceSolution.
93
+ # @!attribute [rw] logo_url
94
+ # @return [::String]
95
+ # Required. The URL for the logo image of the ConferenceSolution.
96
+ class ConferenceSolution
97
+ include ::Google::Protobuf::MessageExts
98
+ extend ::Google::Protobuf::MessageExts::ClassMethods
99
+ end
100
+
101
+ # Common format for declaring a calendar add-on's triggers.
102
+ # @!attribute [rw] run_function
103
+ # @return [::String]
104
+ # Required. The endpoint to execute when this extension point is
105
+ # activated.
106
+ class CalendarExtensionPoint
107
+ include ::Google::Protobuf::MessageExts
108
+ extend ::Google::Protobuf::MessageExts::ClassMethods
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
114
+ end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ module Docs
25
+ # Docs add-on manifest.
26
+ # @!attribute [rw] homepage_trigger
27
+ # @return [::Google::Apps::Script::Type::HomepageExtensionPoint]
28
+ # If present, this overrides the configuration from
29
+ # `addOns.common.homepageTrigger`.
30
+ # @!attribute [rw] on_file_scope_granted_trigger
31
+ # @return [::Google::Apps::Script::Type::Docs::DocsExtensionPoint]
32
+ # Endpoint to execute when file scope authorization is granted
33
+ # for this document/user pair.
34
+ class DocsAddOnManifest
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+
39
+ # Common format for declaring a Docs add-on's triggers.
40
+ # @!attribute [rw] run_function
41
+ # @return [::String]
42
+ # Required. The endpoint to execute when this extension point is activated.
43
+ class DocsExtensionPoint
44
+ include ::Google::Protobuf::MessageExts
45
+ extend ::Google::Protobuf::MessageExts::ClassMethods
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ module Drive
25
+ # Drive add-on manifest.
26
+ # @!attribute [rw] homepage_trigger
27
+ # @return [::Google::Apps::Script::Type::HomepageExtensionPoint]
28
+ # If present, this overrides the configuration from
29
+ # `addOns.common.homepageTrigger`.
30
+ # @!attribute [rw] on_items_selected_trigger
31
+ # @return [::Google::Apps::Script::Type::Drive::DriveExtensionPoint]
32
+ # Corresponds to behvior that should execute when items are selected
33
+ # in relevant Drive view (e.g. the My Drive Doclist).
34
+ class DriveAddOnManifest
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+
39
+ # A generic extension point with common features, e.g. something that simply
40
+ # needs a corresponding run function to work.
41
+ # @!attribute [rw] run_function
42
+ # @return [::String]
43
+ # Required. The endpoint to execute when this extension point is
44
+ # activated.
45
+ class DriveExtensionPoint
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,80 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ # Common format for declaring a menu item, or button, that appears within a
25
+ # host app.
26
+ # @!attribute [rw] run_function
27
+ # @return [::String]
28
+ # Required. The endpoint to execute when this extension point is
29
+ # activated.
30
+ # @!attribute [rw] label
31
+ # @return [::String]
32
+ # Required. User-visible text describing the action taken by activating this
33
+ # extension point. For example, "Insert invoice".
34
+ # @!attribute [rw] logo_url
35
+ # @return [::String]
36
+ # The URL for the logo image shown in the add-on toolbar.
37
+ #
38
+ # If not set, defaults to the add-on's primary logo URL.
39
+ class MenuItemExtensionPoint
40
+ include ::Google::Protobuf::MessageExts
41
+ extend ::Google::Protobuf::MessageExts::ClassMethods
42
+ end
43
+
44
+ # Common format for declaring an add-on's home-page view.
45
+ # @!attribute [rw] run_function
46
+ # @return [::String]
47
+ # Required. The endpoint to execute when this extension point is
48
+ # activated.
49
+ # @!attribute [rw] enabled
50
+ # @return [::Google::Protobuf::BoolValue]
51
+ # Optional. If set to `false`, disable the home-page view in this context.
52
+ #
53
+ # Defaults to `true` if unset.
54
+ #
55
+ # If an add-ons custom home-page view is disabled, an autogenerated overview
56
+ # card will be provided for users instead.
57
+ class HomepageExtensionPoint
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # Format for declaring a universal action menu item extension point.
63
+ # @!attribute [rw] label
64
+ # @return [::String]
65
+ # Required. User-visible text describing the action taken by activating this
66
+ # extension point, for example, "Add a new contact".
67
+ # @!attribute [rw] open_link
68
+ # @return [::String]
69
+ # URL to be opened by the UniversalAction.
70
+ # @!attribute [rw] run_function
71
+ # @return [::String]
72
+ # Endpoint to be run by the UniversalAction.
73
+ class UniversalActionExtensionPoint
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+ end
78
+ end
79
+ end
80
+ end
@@ -0,0 +1,134 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ module Gmail
25
+ # Properties customizing the appearance and execution of a Gmail add-on.
26
+ # @!attribute [rw] homepage_trigger
27
+ # @return [::Google::Apps::Script::Type::HomepageExtensionPoint]
28
+ # Defines an endpoint that will be executed in contexts that don't
29
+ # match a declared contextual trigger. Any cards generated by this function
30
+ # will always be available to the user, but may be eclipsed by contextual
31
+ # content when this add-on declares more targeted triggers.
32
+ #
33
+ # If present, this overrides the configuration from
34
+ # `addOns.common.homepageTrigger`.
35
+ # @!attribute [rw] contextual_triggers
36
+ # @return [::Array<::Google::Apps::Script::Type::Gmail::ContextualTrigger>]
37
+ # Defines the set of conditions that trigger the add-on.
38
+ # @!attribute [rw] universal_actions
39
+ # @return [::Array<::Google::Apps::Script::Type::Gmail::UniversalAction>]
40
+ # Defines set of [universal
41
+ # actions](/gmail/add-ons/how-tos/universal-actions) for the add-on. The user
42
+ # triggers universal actions from the add-on toolbar menu.
43
+ # @!attribute [rw] compose_trigger
44
+ # @return [::Google::Apps::Script::Type::Gmail::ComposeTrigger]
45
+ # Defines the compose time trigger for a compose time add-on. This is the
46
+ # trigger that causes an add-on to take action when the user is composing an
47
+ # email.
48
+ # All compose time addons are required to have the
49
+ # gmail.addons.current.action.compose scope even though it might not edit the
50
+ # draft.
51
+ # @!attribute [rw] authorization_check_function
52
+ # @return [::String]
53
+ # The name of an endpoint that verifies that the add-on has
54
+ # all the required third-party authorizations, by probing the third-party
55
+ # APIs. If the probe fails, the function should throw an exception to
56
+ # initiate the authorization flow. This function is called before each
57
+ # invocation of the add-on, in order to ensure a smooth user experience.
58
+ class GmailAddOnManifest
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
+ end
62
+
63
+ # An action that is always available in the add-on toolbar menu regardless of
64
+ # message context.
65
+ # @!attribute [rw] text
66
+ # @return [::String]
67
+ # Required. User-visible text describing the action, for example, "Add a new
68
+ # contact."
69
+ # @!attribute [rw] open_link
70
+ # @return [::String]
71
+ # A link that is opened by Gmail when the user triggers the action.
72
+ # @!attribute [rw] run_function
73
+ # @return [::String]
74
+ # An endpoint that is called when the user triggers the
75
+ # action. See the [universal actions
76
+ # guide](/gmail/add-ons/how-tos/universal-actions) for details.
77
+ class UniversalAction
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+ end
81
+
82
+ # A trigger that activates when user is composing an email.
83
+ # @!attribute [rw] actions
84
+ # @return [::Array<::Google::Apps::Script::Type::MenuItemExtensionPoint>]
85
+ # Defines the set of actions for compose time add-on. These are actions
86
+ # that user can trigger on a compose time addon.
87
+ # @!attribute [rw] draft_access
88
+ # @return [::Google::Apps::Script::Type::Gmail::ComposeTrigger::DraftAccess]
89
+ # Define the level of data access when a compose time addon is triggered.
90
+ class ComposeTrigger
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
+
94
+ # An enum defining the level of data access this compose trigger requires.
95
+ module DraftAccess
96
+ # Default value when nothing is set for DraftAccess.
97
+ UNSPECIFIED = 0
98
+
99
+ # NONE means compose trigger won't be able to access any data of the draft
100
+ # when a compose addon is triggered.
101
+ NONE = 1
102
+
103
+ # METADATA gives compose trigger the permission to access the metadata of
104
+ # the draft when a compose addon is triggered. This includes the audience
105
+ # list (To/cc list) of a draft message.
106
+ METADATA = 2
107
+ end
108
+ end
109
+
110
+ # Defines a trigger that fires when the open email meets a specific criteria.
111
+ # When the trigger fires, it executes a specific endpoint, usually
112
+ # in order to create new cards and update the UI.
113
+ # @!attribute [rw] unconditional
114
+ # @return [::Google::Apps::Script::Type::Gmail::UnconditionalTrigger]
115
+ # UnconditionalTriggers are executed when any mail message is opened.
116
+ # @!attribute [rw] on_trigger_function
117
+ # @return [::String]
118
+ # Required. The name of the endpoint to call when a message matches the
119
+ # trigger.
120
+ class ContextualTrigger
121
+ include ::Google::Protobuf::MessageExts
122
+ extend ::Google::Protobuf::MessageExts::ClassMethods
123
+ end
124
+
125
+ # A trigger that fires when any email message is opened.
126
+ class UnconditionalTrigger
127
+ include ::Google::Protobuf::MessageExts
128
+ extend ::Google::Protobuf::MessageExts::ClassMethods
129
+ end
130
+ end
131
+ end
132
+ end
133
+ end
134
+ end
@@ -0,0 +1,112 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ # Add-on configuration that is shared across all add-on host applications.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The display name of the add-on.
28
+ # @!attribute [rw] logo_url
29
+ # @return [::String]
30
+ # Required. The URL for the logo image shown in the add-on toolbar.
31
+ # @!attribute [rw] layout_properties
32
+ # @return [::Google::Apps::Script::Type::LayoutProperties]
33
+ # Common layout properties for the add-on cards.
34
+ # @!attribute [rw] add_on_widget_set
35
+ # @return [::Google::Apps::Script::Type::AddOnWidgetSet]
36
+ # The widgets used in the add-on. If this field is not specified,
37
+ # it indicates that default set is used.
38
+ # @!attribute [rw] use_locale_from_app
39
+ # @return [::Boolean]
40
+ # Whether to pass locale information from host app.
41
+ # @!attribute [rw] homepage_trigger
42
+ # @return [::Google::Apps::Script::Type::HomepageExtensionPoint]
43
+ # Defines an endpoint that will be executed in any context, in
44
+ # any host. Any cards generated by this function will always be available to
45
+ # the user, but may be eclipsed by contextual content when this add-on
46
+ # declares more targeted triggers.
47
+ # @!attribute [rw] universal_actions
48
+ # @return [::Array<::Google::Apps::Script::Type::UniversalActionExtensionPoint>]
49
+ # Defines a list of extension points in the universal action menu which
50
+ # serves as a setting menu for the add-on. The extension point can be
51
+ # link URL to open or an endpoint to execute as a form
52
+ # submission.
53
+ # @!attribute [rw] open_link_url_prefixes
54
+ # @return [::Google::Protobuf::ListValue]
55
+ # An OpenLink action
56
+ # can only use a URL with an HTTPS, MAILTO or TEL scheme. For HTTPS links,
57
+ # the URL must also
58
+ # [match](/gmail/add-ons/concepts/manifests#whitelisting_urls) one of the
59
+ # prefixes specified in this whitelist. If the prefix omits the scheme, HTTPS
60
+ # is assumed. Notice that HTTP links are automatically rewritten to HTTPS
61
+ # links.
62
+ class CommonAddOnManifest
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # Card layout properties shared across all add-on host applications.
68
+ # @!attribute [rw] primary_color
69
+ # @return [::String]
70
+ # The primary color of the add-on. It sets the color of toolbar. If no
71
+ # primary color is set explicitly, the default value provided by the
72
+ # framework is used.
73
+ # @!attribute [rw] secondary_color
74
+ # @return [::String]
75
+ # The secondary color of the add-on. It sets the color of buttons.
76
+ # If primary color is set but no secondary color is set, the
77
+ # secondary color is the same as the primary color. If neither primary
78
+ # color nor secondary color is set, the default value provided by the
79
+ # framework is used.
80
+ class LayoutProperties
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # Options for sending requests to add-on HTTP endpoints
86
+ # @!attribute [rw] authorization_header
87
+ # @return [::Google::Apps::Script::Type::HttpAuthorizationHeader]
88
+ # Configuration for the token sent in the HTTP Authorization header
89
+ class HttpOptions
90
+ include ::Google::Protobuf::MessageExts
91
+ extend ::Google::Protobuf::MessageExts::ClassMethods
92
+ end
93
+
94
+ # Authorization header sent in add-on HTTP requests
95
+ module HttpAuthorizationHeader
96
+ # Default value, equivalent to `SYSTEM_ID_TOKEN`
97
+ HTTP_AUTHORIZATION_HEADER_UNSPECIFIED = 0
98
+
99
+ # Send an ID token for the project-specific Google Workspace Add-ons system
100
+ # service account (default)
101
+ SYSTEM_ID_TOKEN = 1
102
+
103
+ # Send an ID token for the end user
104
+ USER_ID_TOKEN = 2
105
+
106
+ # Do not send an Authentication header
107
+ NONE = 3
108
+ end
109
+ end
110
+ end
111
+ end
112
+ end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Apps
22
+ module Script
23
+ module Type
24
+ module Sheets
25
+ # Sheets add-on manifest.
26
+ # @!attribute [rw] homepage_trigger
27
+ # @return [::Google::Apps::Script::Type::HomepageExtensionPoint]
28
+ # If present, this overrides the configuration from
29
+ # `addOns.common.homepageTrigger`.
30
+ # @!attribute [rw] on_file_scope_granted_trigger
31
+ # @return [::Google::Apps::Script::Type::Sheets::SheetsExtensionPoint]
32
+ # Endpoint to execute when file scope authorization is granted
33
+ # for this document/user pair.
34
+ class SheetsAddOnManifest
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+
39
+ # Common format for declaring a Sheets add-on's triggers.
40
+ # @!attribute [rw] run_function
41
+ # @return [::String]
42
+ # Required. The endpoint to execute when this extension point is activated.
43
+ class SheetsExtensionPoint
44
+ include ::Google::Protobuf::MessageExts
45
+ extend ::Google::Protobuf::MessageExts::ClassMethods
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end