Reference documentation and code samples for the Google Workspace Add-ons V1 API class Google::Apps::Script::Type::CommonAddOnManifest.
Add-on configuration that is shared across all add-on host applications.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#add_on_widget_set
def add_on_widget_set() -> ::Google::Apps::Script::Type::AddOnWidgetSet
Returns
- (::Google::Apps::Script::Type::AddOnWidgetSet) — The widgets used in the add-on. If this field is not specified, it indicates that default set is used.
#add_on_widget_set=
def add_on_widget_set=(value) -> ::Google::Apps::Script::Type::AddOnWidgetSet
Parameter
- value (::Google::Apps::Script::Type::AddOnWidgetSet) — The widgets used in the add-on. If this field is not specified, it indicates that default set is used.
Returns
- (::Google::Apps::Script::Type::AddOnWidgetSet) — The widgets used in the add-on. If this field is not specified, it indicates that default set is used.
#homepage_trigger
def homepage_trigger() -> ::Google::Apps::Script::Type::HomepageExtensionPoint
Returns
- (::Google::Apps::Script::Type::HomepageExtensionPoint) — Defines an endpoint that will be executed in any context, in any host. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.
#homepage_trigger=
def homepage_trigger=(value) -> ::Google::Apps::Script::Type::HomepageExtensionPoint
Parameter
- value (::Google::Apps::Script::Type::HomepageExtensionPoint) — Defines an endpoint that will be executed in any context, in any host. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.
Returns
- (::Google::Apps::Script::Type::HomepageExtensionPoint) — Defines an endpoint that will be executed in any context, in any host. Any cards generated by this function will always be available to the user, but may be eclipsed by contextual content when this add-on declares more targeted triggers.
#layout_properties
def layout_properties() -> ::Google::Apps::Script::Type::LayoutProperties
Returns
- (::Google::Apps::Script::Type::LayoutProperties) — Common layout properties for the add-on cards.
#layout_properties=
def layout_properties=(value) -> ::Google::Apps::Script::Type::LayoutProperties
Parameter
- value (::Google::Apps::Script::Type::LayoutProperties) — Common layout properties for the add-on cards.
Returns
- (::Google::Apps::Script::Type::LayoutProperties) — Common layout properties for the add-on cards.
#logo_url
def logo_url() -> ::String
Returns
- (::String) — Required. The URL for the logo image shown in the add-on toolbar.
#logo_url=
def logo_url=(value) -> ::String
Parameter
- value (::String) — Required. The URL for the logo image shown in the add-on toolbar.
Returns
- (::String) — Required. The URL for the logo image shown in the add-on toolbar.
#name
def name() -> ::String
Returns
- (::String) — Required. The display name of the add-on.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. The display name of the add-on.
Returns
- (::String) — Required. The display name of the add-on.
#open_link_url_prefixes
def open_link_url_prefixes() -> ::Google::Protobuf::ListValue
Returns
- (::Google::Protobuf::ListValue) — An OpenLink action can only use a URL with an HTTPS, MAILTO or TEL scheme. For HTTPS links, the URL must also match one of the prefixes specified in this whitelist. If the prefix omits the scheme, HTTPS is assumed. Notice that HTTP links are automatically rewritten to HTTPS links.
#open_link_url_prefixes=
def open_link_url_prefixes=(value) -> ::Google::Protobuf::ListValue
Parameter
- value (::Google::Protobuf::ListValue) — An OpenLink action can only use a URL with an HTTPS, MAILTO or TEL scheme. For HTTPS links, the URL must also match one of the prefixes specified in this whitelist. If the prefix omits the scheme, HTTPS is assumed. Notice that HTTP links are automatically rewritten to HTTPS links.
Returns
- (::Google::Protobuf::ListValue) — An OpenLink action can only use a URL with an HTTPS, MAILTO or TEL scheme. For HTTPS links, the URL must also match one of the prefixes specified in this whitelist. If the prefix omits the scheme, HTTPS is assumed. Notice that HTTP links are automatically rewritten to HTTPS links.
#universal_actions
def universal_actions() -> ::Array<::Google::Apps::Script::Type::UniversalActionExtensionPoint>
Returns
- (::Array<::Google::Apps::Script::Type::UniversalActionExtensionPoint>) — Defines a list of extension points in the universal action menu which serves as a setting menu for the add-on. The extension point can be link URL to open or an endpoint to execute as a form submission.
#universal_actions=
def universal_actions=(value) -> ::Array<::Google::Apps::Script::Type::UniversalActionExtensionPoint>
Parameter
- value (::Array<::Google::Apps::Script::Type::UniversalActionExtensionPoint>) — Defines a list of extension points in the universal action menu which serves as a setting menu for the add-on. The extension point can be link URL to open or an endpoint to execute as a form submission.
Returns
- (::Array<::Google::Apps::Script::Type::UniversalActionExtensionPoint>) — Defines a list of extension points in the universal action menu which serves as a setting menu for the add-on. The extension point can be link URL to open or an endpoint to execute as a form submission.
#use_locale_from_app
def use_locale_from_app() -> ::Boolean
Returns
- (::Boolean) — Whether to pass locale information from host app.
#use_locale_from_app=
def use_locale_from_app=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether to pass locale information from host app.
Returns
- (::Boolean) — Whether to pass locale information from host app.