Package google.apps.script.type.docs

  • DocsAddOnManifest customizes the appearance and execution of Google Docs add-ons, including homepage configuration, file scope authorization, link previews, and third-party resource creation.

  • DocsExtensionPoint defines a common format for Google Docs add-on triggers, specifying the endpoint function to execute when activated.

  • The manifest includes triggers for various events like homepage access, file authorization, link previews, and actions to create third-party resources.

  • Each extension point within the manifest specifies a runFunction which is the Apps Script function to be executed upon triggering the extension point.

Index

DocsAddOnManifest

Properties customizing the appearance and execution of a Google Docs add-on.

Fields
homepageTrigger

HomepageExtensionPoint

If present, this overrides the configuration from addOns.common.homepageTrigger.
onFileScopeGrantedTrigger

DocsExtensionPoint

Endpoint to execute when file scope authorization is granted for this document/user pair.
linkPreviewTriggers[]

LinkPreviewExtensionPoint

A list of extension points for previewing links in a Google Docs document. For details, see Preview links with smart chips.
createActionTriggers[]

CreateActionExtensionPoint

A list of extension points for creating third-party resources from within Google Workspace applications. For more information, see Create third-party resources from the @ menu.

DocsExtensionPoint

Common format for declaring a Docs add-on's triggers.

Fields
runFunction

string

Required. The endpoint to execute when this extension point is activated.