AddOns manifest resource

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

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.

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.

object ()

Required if the Google Workspace add-on extends Chat. Configuration of a Google Chat app. If this field is omitted, the add-on is disabled in Google Chat.

The addOns.chat object must be empty. To configure the add-on's behavior and appearance in Chat, see Configure a Chat app.

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.

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.

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.

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.

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.

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

object (HomepageTrigger)

object (LayoutProperties)

string

Required. The URL of the image shown in the toolbar. The URL must be public.

string

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

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 Allowlist URLs for more details.

object (UniversalAction)

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.

{
  "primaryColor": string,
  "secondaryColor": string
}

string

string

{
  "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.

}

string

string

string

See the Universal actions guide for details.