HomepageTrigger manifest resource

  • The HomepageTrigger 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 a HomepageTrigger includes enabled (boolean) and runFunction (string) fields.

  • The runFunction field specifies the name of the function that runs when the trigger fires and should return an array of Card objects.

The resource configuration that is used to define Google Workspace add-on homepage triggers.

HomepageTrigger

The Google Workspace add-on manifest configuration for homepage triggers.

Homepage triggers can be defined in the addOns.common.homepageTrigger resource or the resources of the individual host applications. The homepage trigger of a host application, if defined and enabled, overrides the homepage trigger defined in addOns.common.homepageTrigger.

See Homepage configuration for 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 to true.
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 more Card objects for display as this add-on's homepage in this host application.