- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.1
- 2.1.12
public interface CommonAddOnManifestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAddOnWidgetSet()
public abstract AddOnWidgetSet getAddOnWidgetSet()The widgets used in the add-on. If this field is not specified, it indicates that default set is used.
.google.apps.script.type.AddOnWidgetSet add_on_widget_set = 4;
| Returns | |
|---|---|
| Type | Description |
AddOnWidgetSet |
The addOnWidgetSet. |
getAddOnWidgetSetOrBuilder()
public abstract AddOnWidgetSetOrBuilder getAddOnWidgetSetOrBuilder()The widgets used in the add-on. If this field is not specified, it indicates that default set is used.
.google.apps.script.type.AddOnWidgetSet add_on_widget_set = 4;
| Returns | |
|---|---|
| Type | Description |
AddOnWidgetSetOrBuilder |
|
getHomepageTrigger()
public abstract HomepageExtensionPoint getHomepageTrigger()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.
.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 6;
| Returns | |
|---|---|
| Type | Description |
HomepageExtensionPoint |
The homepageTrigger. |
getHomepageTriggerOrBuilder()
public abstract HomepageExtensionPointOrBuilder getHomepageTriggerOrBuilder()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.
.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 6;
| Returns | |
|---|---|
| Type | Description |
HomepageExtensionPointOrBuilder |
|
getLayoutProperties()
public abstract LayoutProperties getLayoutProperties()Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Returns | |
|---|---|
| Type | Description |
LayoutProperties |
The layoutProperties. |
getLayoutPropertiesOrBuilder()
public abstract LayoutPropertiesOrBuilder getLayoutPropertiesOrBuilder()Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Returns | |
|---|---|
| Type | Description |
LayoutPropertiesOrBuilder |
|
getLogoUrl()
public abstract String getLogoUrl()Required. The URL for the logo image shown in the add-on toolbar.
string logo_url = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The logoUrl. |
getLogoUrlBytes()
public abstract ByteString getLogoUrlBytes()Required. The URL for the logo image shown in the add-on toolbar.
string logo_url = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for logoUrl. |
getName()
public abstract String getName()Required. The display name of the add-on.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()Required. The display name of the add-on.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOpenLinkUrlPrefixes()
public abstract ListValue getOpenLinkUrlPrefixes()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.
.google.protobuf.ListValue open_link_url_prefixes = 8;
| Returns | |
|---|---|
| Type | Description |
ListValue |
The openLinkUrlPrefixes. |
getOpenLinkUrlPrefixesOrBuilder()
public abstract ListValueOrBuilder getOpenLinkUrlPrefixesOrBuilder()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.
.google.protobuf.ListValue open_link_url_prefixes = 8;
| Returns | |
|---|---|
| Type | Description |
ListValueOrBuilder |
|
getUniversalActions(int index)
public abstract UniversalActionExtensionPoint getUniversalActions(int index)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.
repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
UniversalActionExtensionPoint |
|
getUniversalActionsCount()
public abstract int getUniversalActionsCount()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.
repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getUniversalActionsList()
public abstract List<UniversalActionExtensionPoint> getUniversalActionsList()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.
repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;
| Returns | |
|---|---|
| Type | Description |
List<UniversalActionExtensionPoint> |
|
getUniversalActionsOrBuilder(int index)
public abstract UniversalActionExtensionPointOrBuilder getUniversalActionsOrBuilder(int index)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.
repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
UniversalActionExtensionPointOrBuilder |
|
getUniversalActionsOrBuilderList()
public abstract List<? extends UniversalActionExtensionPointOrBuilder> getUniversalActionsOrBuilderList()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.
repeated .google.apps.script.type.UniversalActionExtensionPoint universal_actions = 7;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.apps.script.type.UniversalActionExtensionPointOrBuilder> |
|
getUseLocaleFromApp()
public abstract boolean getUseLocaleFromApp()Whether to pass locale information from host app.
bool use_locale_from_app = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
The useLocaleFromApp. |
hasAddOnWidgetSet()
public abstract boolean hasAddOnWidgetSet()The widgets used in the add-on. If this field is not specified, it indicates that default set is used.
.google.apps.script.type.AddOnWidgetSet add_on_widget_set = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the addOnWidgetSet field is set. |
hasHomepageTrigger()
public abstract boolean hasHomepageTrigger()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.
.google.apps.script.type.HomepageExtensionPoint homepage_trigger = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the homepageTrigger field is set. |
hasLayoutProperties()
public abstract boolean hasLayoutProperties()Common layout properties for the add-on cards.
.google.apps.script.type.LayoutProperties layout_properties = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the layoutProperties field is set. |
hasOpenLinkUrlPrefixes()
public abstract boolean hasOpenLinkUrlPrefixes()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.
.google.protobuf.ListValue open_link_url_prefixes = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the openLinkUrlPrefixes field is set. |