Google is committed to advancing racial equity for Black communities. See how.

AddOns manifest resource

The resource configuration that is used to define Google Workspace add-on content and behavior. Google Workspace add-on manifests must have all the components marked as Required.

AddOns

The top-level of the Google Workspace add-on manifest configuration.

JSON representation
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
Fields
common

object (Common)

Required. Defines values for a Google Workspace add-on that are common for every host application. Some values defined here are used as a default when specific values for a particular host are omitted.

calendar

object (Calendar)

Required if the Google Workspace add-on extends Calendar. Configurations for Google Workspace add-on appearance and behavior within the Google Calendar host application. If this field is omitted, the add-on is disabled in Google Calendar.

drive

object (Drive)

Required if the Google Workspace add-on extends Google Drive. Configurations for Google Workspace add-on appearance and behavior within the Google Drive host application. If this field is omitted, the add-on is disabled in Google Drive.

gmail

object (Gmail)

Required if the Google Workspace add-on extends Gmail. Configurations for Google Workspace add-on appearance and behavior within the Gmail host application. If this field is omitted, the add-on is disabled in Gmail.

docs

object (Docs)

Required if the Google Workspace Add-on extends Docs. Configurations for the Google Workspace Add-on's appearance and behavior within the Docs host application. If this field is omitted, the add-on is disabled in Docs.

sheets

object (Sheets)

Required if the Google Workspace Add-on extends Sheets. Configurations for the Google Workspace Add-on's appearance and behavior within the Sheets host application. If this field is omitted, the add-on is disabled in Sheets.

slides

object (Slides)

Required if the Google Workspace Add-on extends Slides. Configurations for the Google Workspace Add-on's appearance and behavior within the Slides host application. If this field is omitted, the add-on is disabled in Slides.

Common

The manifest configuration for parameters that are common for every host application. Some values defined here are used as a default when specific values for a particular host are omitted.

JSON representation
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "logoUrl": string,
  "name": string,
  "openLinkUrlPrefixes": [
    string
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "useLocaleFromApp": boolean
}
Fields
homepageTrigger

object (HomepageTrigger)

The default trigger function specification for creating the add-on homepage. This specification is used if a host-specific homepage trigger is not defined. If this is omitted as well, a generic homepage card is constructed and used when needed.
layoutProperties

object (LayoutProperties)

A configuration for the colors used in the add-on toolbar and buttons.
logoUrl

string

Required. The URL of the image shown in the toolbar.

name

string

Required. The name of the add-on shown in the toolbar.

openLinkUrlPrefixes[]

string

Required if the add-on displays any outbound links, whether within widgets using an OpenLink or text widget using HTML anchor tags. A list of HTTPS URL prefixes. To protect user data, any link rendered by the add-on must match one of the prefixes in this list.

See Whitelisting URLs for more details.

universalActions[]

object (UniversalAction)

List of universal actions that are always available in the add-on UI.
useLocaleFromApp

boolean

If true, add-on event objects passed to action callback functions or trigger functions include the locale and timezone information of the user. Defaults to false.

See Accessing user locale and timezones for more details.

LayoutProperties

A configuration that controls the Google Workspace add-on toolbar and button colors and appearance.

JSON representation
{
  "primaryColor": string,
  "secondaryColor": string
}
Fields
primaryColor

string

The color of toolbar. Defaults to grey (#424242).
secondaryColor

string

The default color of buttons. Defaults to the primary color (if it is set); otherwise defaults to blue (#2196F3).

UniversalAction

A configuration for a universal action. When selected, a universal action either opens the specified URL link, or runs the specified Apps Script function.

JSON representation
{
  "label": string,

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
Fields
label

string

Required for each universal action. The text shown in the UI menu for this action.
runFunction

string

Required for each universal action if openLink is not present. If provided, the name of the Apps Script function that executes when the user selects this action.

See the Universal actions guide for details.