Editor manifest resource

Page Summary

outlined_flag

• Google Workspace add-on manifest configurations for Editor extensions require specific components, especially if they extend the Editor.

• The onFileScopeGrantedTrigger is necessary if your add-on interacts with the current Editor document after the user grants drive.file scope.

• linkPreviewTriggers[] are mandatory for enabling link previews in Docs, Sheets, or Slides.

• createActionTriggers[] are required for allowing the creation of third-party resources via the @ menu.

• The runFunction field in triggers specifies the function to execute when the trigger fires.

The resource configuration used to define Google Workspace add-on content and behavior within the editors. Google Workspace add-on manifests must include all components marked as Requiredif they extend the Editor.

Editors

The Google Workspace add-on manifest configuration for Editor extensions. See Extending Editors with Google Workspace add-ons for details.

{
    "homepageTrigger": {
      object ( HomepageTrigger 
)
    },
    "onFileScopeGrantedTrigger": {
      object ( OnFileScopeGrantedTrigger 
)
    },
    "linkPreviewTriggers": [
      {
        object ( LinkPreviewTriggers 
)
      }
    ],
    "createActionTriggers": [
      {
        object ( CreateActionTriggers 
)
      }
  }

OnFileScopeGrantedTrigger

A configuration for a contextual trigger that fires when the request file scope dialog uses CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build(); and the user grants drive.file scope authorization.

{
  "runFunction": string
}

LinkPreviewTriggers

The configuration for a trigger that fires when a user types or pastes a link from a third-party service into a Docs, Sheets, or Slides file.

To set up this trigger for a Google Workspace add-on, see Preview links with smart chips .

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object( patterns 
)
    }
  ]
}

UriPattern

The configuration for each URL pattern that triggers a link preview.

{
  "hostPattern": string,
  "pathPrefix" : string
}

CreateActionTriggers

The configuration for a trigger that fires when a user selects a third-party integration menu item from the Google Docs @ menu.

To set up this trigger for a Google Workspace add-on, see Create third-party resources with smart chips .

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}