HomepageTrigger manifest resource

  • TheHomepageTrigger configuration defines the behavior of homepage triggers in Google Workspace add-ons.

  • Homepage triggers can be set at a common level or for individual host applications, with host application settings taking precedence.

  • The JSON representation of aHomepageTrigger includesenabled (boolean) andrunFunction (string) fields.

  • TherunFunction field specifies the name of the function that runs when the trigger fires and should return an array ofCard objects.

The resource configuration that is used to defineGoogle Workspace add-onhomepage triggers.

HomepageTrigger

The Google Workspace add-on manifest configuration forhomepage triggers.

Homepage triggers can be defined in theaddOns.common.homepageTriggerresource or the resources of the individualhost applications.The homepage trigger of a host application, if defined and enabled, overridesthe homepage trigger defined inaddOns.common.homepageTrigger.

SeeHomepage configurationfor more details.

JSON representation
{  "enabled": boolean,  "runFunction": string}
Fields
enabled

boolean

Whether or not homepage (non-contextual) cards are enabled for this host application. Defaults totrue.
runFunction

string

The name of the function to run this trigger fires. If specified, you must implement this function to build and return an array of one or moreCard objects for display as this add-on's homepage in this host application.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.