A Google Workspace add-on deployment
JSON representation{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object (AddOns
)
},
"etag": string
}
Fields name
string
The deployment resource name. Example: projects/123/deployments/my_deployment
.
oauthScopes[]
string
The list of Google OAuth scopes for which to request consent from the end user before executing an add-on endpoint.
addOns
object (
AddOns
)
The Google Workspace add-on configuration.
etag
string
This value is computed by the server based on the version of the deployment in storage, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
AddOnsA Google Workspace add-on configuration.
CommonAddOnManifestAdd-on configuration that is shared across all add-on host applications.
Fieldsname
string
Required. The display name of the add-on.
logoUrl
string
Required. The URL for the logo image shown in the add-on toolbar.
layoutProperties
object (
LayoutProperties
)
Common layout properties for the add-on cards.
addOnWidgetSet
object (
AddOnWidgetSet
)
The widgets used in the add-on. If this field is not specified, the default set is used.
useLocaleFromApp
boolean
Whether to pass locale information from host app.
homepageTrigger
object (
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 might be eclipsed by contextual content when this add-on declares more targeted triggers.
universalActions[]
object (
UniversalActionExtensionPoint
)
Defines a list of extension points in the universal action menu which serves as a settings menu for the add-on. The extension point can be a link URL to open or an endpoint to execute as a form submission.
openLinkUrlPrefixes
array (
ListValue
format)
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 the allowlist. If the prefix omits the scheme, HTTPS
is assumed. HTTP
links are automatically rewritten to HTTPS
links.
Card layout properties shared across all add-on host applications.
JSON representation{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean }Fields
primaryColor
string
The primary color of the add-on. It sets the color of the toolbar. If no primary color is set, the default value provided by the framework is used.
secondaryColor
string
The secondary color of the add-on. It sets the color of buttons. If the primary color is set but no secondary color is set, the secondary color is the same as the primary color. If neither primary color nor secondary color is set, the default value provided by the framework is used.
useNewMaterialDesign
(deprecated)
boolean
This item is deprecated!
Enables material design for cards.
The widget subset used by an add-on.
JSON representation{
"usedWidgets": [
enum (WidgetType
)
]
}
The widget type. WIDGET_TYPE_UNSPECIFIED
is the basic widget set.
Common format for declaring an add-on's homepage view.
JSON representation{ "runFunction": string, "enabled": boolean }Fields
runFunction
string
Required. The endpoint to execute when this extension point is activated.
enabled
boolean
Optional. If set to false
, deactivates the homepage view in this context.
Defaults to true
if unset.
If an add-on's custom homepage view is disabled, a generic overview card is provided for users instead.
UniversalActionExtensionPointFormat for declaring a universal action menu item extension point.
JSON representation{ "label": string, // Union fieldFieldsaction_type
can be only one of the following: "openLink": string, "runFunction": string // End of list of possible types for union fieldaction_type
. }
label
string
Required. User-visible text that describes the action taken by activating this extension point, for example, "Add a new contact."
Union fieldaction_type
. Required. The action type supported on a universal action menu item. It can either be a link to open or an endpoint to execute. action_type
can be only one of the following: openLink
string
URL to be opened by the UniversalAction.
runFunction
string
Endpoint to be run by the UniversalAction.
GmailAddOnManifestProperties customizing the appearance and execution of a Gmail add-on.
FieldshomepageTrigger
object (
HomepageExtensionPoint
)
Defines an endpoint that will be executed in contexts that don't match a declared contextual trigger. 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.
If present, this overrides the configuration from addons.common.homepageTrigger
.
contextualTriggers[]
object (
ContextualTrigger
)
Defines the set of conditions that trigger the add-on.
universalActions[]
object (
UniversalAction
)
Defines a set of universal actions for the add-on. The user triggers universal actions from the add-on toolbar menu.
composeTrigger
object (
ComposeTrigger
)
Defines the compose time trigger for a compose time add-on. This is the trigger that causes an add-on to take action when the user is composing an email. All compose time add-ons must have the gmail.addons.current.action.compose
scope even though it might not edit the draft.
authorizationCheckFunction
string
The name of an endpoint that verifies that the add-on has all the required third-party authorizations, by probing the third-party APIs. If the probe fails, the function should throw an exception to initiate the authorization flow. This function is called before each invocation of the add-on in order to ensure a smooth user experience.
ContextualTriggerDefines a trigger that fires when the open email meets a specific criteria. When the trigger fires, it executes a specific endpoint, usually in order to create new cards and update the UI.
JSON representation{ "onTriggerFunction": string, // Union fieldFieldstrigger
can be only one of the following: "unconditional": { object (UnconditionalTrigger
) } // End of list of possible types for union fieldtrigger
. }
onTriggerFunction
string
Required. The name of the endpoint to call when a message matches the trigger.
Union fieldtrigger
. The type of trigger determines the conditions Gmail uses to show the add-on. trigger
can be only one of the following: unconditional
object (
UnconditionalTrigger
)
Unconditional triggers are executed when any mail message is opened.
UnconditionalTriggerThis type has no fields.
A trigger that fires when any email message is opened.
UniversalActionAn action that is always available in the add-on toolbar menu regardless of message context.
JSON representation{ "text": string, // Union fieldFieldsaction_type
can be only one of the following: "openLink": string, "runFunction": string // End of list of possible types for union fieldaction_type
. }
text
string
Required. User-visible text describing the action, for example, "Add a new contact."
Union fieldaction_type
. The type of the action determines the behavior of Gmail when the user invokes the action. action_type
can be only one of the following: openLink
string
A link that is opened by Gmail when the user triggers the action.
runFunction
string
An endpoint that is called when the user triggers the action. See the universal actions guide for details.
ComposeTriggerA trigger that activates when user is composing an email.
Fieldsactions[]
object (
MenuItemExtensionPoint
)
Defines the set of actions for a compose time add-on. These are actions that users can trigger on a compose time add-on.
draftAccess
enum (
DraftAccess
)
Defines the level of data access when a compose time add-on is triggered.
DraftAccessAn enum that defines the level of data access the compose trigger requires.
EnumsUNSPECIFIED
Default value when nothing is set for draftaccess. NONE
The compose trigger can't access any data of the draft when a compose add-on is triggered. METADATA
Gives the compose trigger the permission to access the metadata of the draft when a compose add-on is triggered. This includes the audience list, such as the To and Cc list of a draft message. DriveAddOnManifest
Properties customizing the appearance and execution of a Drive add-on.
FieldshomepageTrigger
object (
HomepageExtensionPoint
)
If present, this overrides the configuration from addons.common.homepageTrigger
.
onItemsSelectedTrigger
object (
DriveExtensionPoint
)
Corresponds to behavior that executes when items are selected in the relevant Drive view, such as the My Drive Doclist.
DriveExtensionPointCommon format for declaring a Drive add-on's triggers.
JSON representation{ "runFunction": string }Fields
runFunction
string
Required. The endpoint to execute when the extension point is activated.
CalendarAddOnManifestProperties customizing the appearance and execution of a Calendar add-on.
FieldshomepageTrigger
object (
HomepageExtensionPoint
)
Defines an endpoint that is executed in contexts that don't match a declared contextual trigger. Any cards generated by this function will always be available to the user, but might be eclipsed by contextual content when this add-on declares more targeted triggers.
If present, this overrides the configuration from addons.common.homepageTrigger
.
conferenceSolution[]
object (
ConferenceSolution
)
Defines conference solutions provided by this add-on. Third-party conferencing add-ons can only be built in Apps Script.
createSettingsUrlFunction
string
An endpoint to execute that creates a URL to the add-on's settings page.
eventOpenTrigger
object (
CalendarExtensionPoint
)
An endpoint that triggers when an event is opened to be viewed or edited.
eventUpdateTrigger
object (
CalendarExtensionPoint
)
An endpoint that triggers when the open event is updated.
eventAttachmentTrigger
object (
MenuItemExtensionPoint
)
A configuration for a contextual trigger that fires when the user clicks on the add-on attachment provider in the Calendar dropdown menu.
currentEventAccess
enum (
EventAccess
)
Defines the level of data access when an event add-on is triggered.
ConferenceSolutionDefines conference-related values. Third-party conferencing add-ons can only be built in Apps Script.
JSON representation{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string }Fields
onCreateFunction
string
Required. The endpoint to call when conference data should be created.
id
string
Required. IDs should be uniquely assigned across conference solutions within one add-on, otherwise the wrong conference solution might be used when the add-on is triggered. While you can change the display name of an add-on, the ID shouldn’t be changed.
name
string
Required. The display name of the conference solution.
logoUrl
string
Required. The URL for the logo image of the conference solution.
CalendarExtensionPointCommon format for declaring a calendar add-on's triggers.
JSON representation{ "runFunction": string }Fields
runFunction
string
Required. The endpoint to execute when this extension point is activated.
EventAccessAn enum that defines the level of data access event triggers require.
EnumsUNSPECIFIED
Default value when nothing is set for eventAccess. METADATA
Gives event triggers the permission to access the metadata of events, such as event ID and calendar ID. READ
Gives event triggers access to all provided event fields including the metadata, attendees, and conference data. WRITE
Gives event triggers access to the metadata of events and the ability to perform all actions, including adding attendees and setting conference data. READ_WRITE
Gives event triggers access to all provided event fields including the metadata, attendees, and conference data and the ability to perform all actions. DocsAddOnManifest
Properties customizing the appearance and execution of a Google Docs add-on.
DocsExtensionPointCommon format for declaring a Docs add-on's triggers.
JSON representation{ "runFunction": string }Fields
runFunction
string
Required. The endpoint to execute when this extension point is activated.
LinkPreviewExtensionPointThe configuration for a trigger that fires when a user types or pastes a link from a third-party or non-Google service into a Google Docs, Sheets, or Slides file.
JSON representation{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object (UriPattern
)
}
],
"runFunction": string,
"logoUrl": string
}
Fields labelText
string
Required. The text for an example smart chip that prompts users to preview the link, such as Example: Support case
. This text is static and displays before users execute the add-on.
localizedLabelText
map (key: string, value: string)
Optional. A map of labeltext
to localize into other languages. Format the language in ISO 639 and the country/region in ISO 3166, separated by a hyphen -
. For example, en-US
.
If a user's locale is present in the map's keys, the user sees the localized version of the labeltext
.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
patterns[]
object (
UriPattern
)
Required. An array of URL patterns that trigger the add-on to preview links.
runFunction
string
Required. Endpoint to execute when a link preview is triggered.
logoUrl
string
Optional. The icon that displays in the smart chip and preview card. If omitted, the add-on uses its toolbar icon, logourl
.
The configuration for each URL pattern that triggers a link preview.
JSON representation{ "hostPattern": string, "pathPrefix": string }Fields
hostPattern
string
Required for each URL pattern to preview. The domain of the URL pattern. The add-on previews links that contain this domain in the URL. To preview links for a specific subdomain, like subdomain.example.com
, include the subdomain. To preview links for the entire domain, specify a wildcard character with an asterisk (*
) as the subdomain.
For example, *.example.com
matches subdomain.example.com
and another.subdomain.example.com
.
pathPrefix
string
Optional. The path that appends the domain of the hostpattern
.
For example, if the URL host pattern is support.example.com
, to match URLs for cases hosted at support.example.com/cases/
, enter cases
.
To match all URLs in the host pattern domain, leave pathprefix
empty.
The configuration for a trigger that fires when a user invokes the resource creation workflow in a Google Workspace application. For more information, see Create third-party resources from the @ menu.
JSON representation{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string }Fields
id
string
Required. The unique ID to differentiate this extension point. The ID can have up to 64 characters and should be in the format of [a-zA-Z0-9-]+
.
labelText
string
Required. The text that displays alongside an icon for the resource creation entry point, such as Create support case
. This text is static and displays before users execute the add-on.
localizedLabelText
map (key: string, value: string)
Optional. A map of labeltext
to localize into other languages. Format the language in ISO 639 and the country/region in ISO 3166, separated by a hyphen -
. For example, en-US
.
If a user's locale is present in the map's keys, the user sees the localized version of the labeltext
.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
runFunction
string
Required. Endpoint to execute when a resource creation workflow is triggered to create a link.
logoUrl
string
Optional. The icon that displays for the resource creation entry point. If omitted, the menu uses your add-on's toolbar icon, logourl
.
Meet add-on manifest.
JSON representation{ "homepageTrigger": { object (FieldsHomepageExtensionPoint
) }, "web": { object (Web
) }, "supportsCollaboration": boolean, "termsUri": string }
homepageTrigger
object (
HomepageExtensionPoint
)
If present, this overrides the configuration from addons.common.homepageTrigger
.
web
object (
Web
)
Details for addons that enhance the Meet web client.
supportsCollaboration
boolean
Whether the addon supports collaboration or inviting others into the addon experience.
termsUri
string
A link to the terms of service for the add-on, if any should be shown.
WebDetails for addons that enhance the Meet web client.
JSON representation{ "sidePanelUri": string, "sidePanelUrl": string, "mainStageUri": string, "supportsScreenSharing": boolean, "supportsCollaboration": boolean, "supportsPopOut": boolean, "hostOrigins": [ string ], "addOnOrigins": [ string ], "openState": enum (FieldsState
), "supportsCollaborationHostControls": boolean, "logoUrl": string, "darkModeLogoUrl": string, "displayFlow": enum (DisplayFlow
) }
sidePanelUri
(deprecated)
string
This item is deprecated!
The URI for the side panel iframe.
sidePanelUrl
string
The URL for the side panel iframe.
mainStageUri
(deprecated)
string
This item is deprecated!
The URI for the "main stage" iframe.
supportsScreenSharing
boolean
Whether the addon supports screen sharing the main stage.
supportsCollaboration
(deprecated)
boolean
This item is deprecated!
Whether the addon supports collaboration or inviting others into the addon experience. This field is deprecated now, please use the top level field in MeetAddOnManifest.
supportsPopOut
boolean
Whether the addon supports popping out to a browser PiP experience.
hostOrigins[]
(deprecated)
string
This item is deprecated!
Deprecated, legacy name. Origins that should be added to the frame-src property of the iframe containing the third party site. Use addonorigins instead.
addOnOrigins[]
string
Origins that should be added to the frame-src property of the iframe containing the third party site.
openState
enum (
State
)
The initial state when the addon is opened.
supportsCollaborationHostControls
boolean
Whether the collaboration add-on supports host controls.
logoUrl
string
The URL of the logo to be displayed for the addon. If not specified, the logo defaults to the logo in the common section of the manifest.
darkModeLogoUrl
string
A dark mode version of the logourl.
displayFlow
(deprecated)
enum (
DisplayFlow
)
This item is deprecated!
The display flow the add-on will follow when launched.
StateEnum for specifying initial addon opening state.
EnumsSTATE_UNSPECIFIED
Initial state has not been specified with the addon. SIDE_PANEL_ONLY
The addon opens with only the side panel active. MAIN_STAGE_ONLY
The addon opens with only the main stage active. SIDE_PANEL_AND_MAIN_STAGE
The addon opens with both the side panel and the main stage active. DisplayFlow
Enum for specifying the display flow the add-on will follow when launched
EnumsDISPLAY_FLOW_UNSPECIFIED
Display flow has not been specified. FOCUS
Add-on should launch in the "focus" display flow. AUGMENT
Add-on should launch in the "augment" display flow. SheetsAddOnManifest
Properties customizing the appearance and execution of a Google Sheets add-on.
SheetsExtensionPointCommon format for declaring a Sheets add-on's triggers.
JSON representation{ "runFunction": string }Fields
runFunction
string
Required. The endpoint to execute when this extension point is activated.
SlidesAddOnManifestProperties customizing the appearance and execution of a Google Slides add-on.
SlidesExtensionPointCommon format for declaring a Slides add-on's triggers.
JSON representation{ "runFunction": string }Fields
runFunction
string
Required. The endpoint to execute when this extension point is activated.
HttpOptionsOptions for sending requests to add-on HTTP
endpoints.
Whether the add-on has enabled Granular OAuth Consent.
EnumsGRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED
Default value, should not be used. OPT_IN
The add-on is opted in to Granular OAuth Consent. OPT_OUT
The add-on is opted out of Granular OAuth Consent. Methods create
Creates a deployment with the specified name and configuration. delete
Deletes the deployment with the given name. get
Gets the deployment with the specified name. getInstallStatus
Gets the install status of a test deployment. install
Installs a deployment to your account for testing. list
Lists all deployments in a particular project. replaceDeployment
Creates or replaces a deployment with the specified name. uninstall
Uninstalls a test deployment from the user’s account.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4