Drive manifest resource
Stay organized with collections
Save and categorize content based on your preferences.
The resource configuration that is used to define
Google Workspace add-on
content and behavior within Google Drive.
Google Workspace add-on manifests must have
all the components marked as Required if they extend Drive.
Drive
The Google Workspace add-on manifest configuration for
Google Drive extensions. See
Extending Drive with Google Workspace add-ons
for more information.
| Fields |
homepageTrigger |
object (HomepageTrigger)
The trigger function specification for creating the add-on
homepage in the
Drive host. This overrides
addOns.common.homepageTrigger.
|
onItemsSelectedTrigger |
object (OnItemsSelectedTrigger)
Required to provide add-on behavior triggered by user selection of
items in Drive. The contextual trigger function specification for
item selections in Google Drive.
|
OnItemsSelectedTrigger
A configuration for a contextual trigger that fires when a user selects
one or more files or folders in Google Drive. See
Drive contextual interface for items selected
for more information.
| JSON representation |
{
"runFunction": string
} |
| Fields |
runFunction |
string
The name of the function to run when files or folders are selected in
Google Drive. If specified, you must implement this function to build
and return an array of
Card
objects for display in the add-on UI.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eGoogle Workspace Add-on manifests extending Drive must include all required components.\u003c/p\u003e\n"],["\u003cp\u003eDrive extensions utilize a manifest configuration for defining add-on content and behavior within Google Drive.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eonItemsSelectedTrigger\u003c/code\u003e is required in the manifest to enable add-on functionality when users select Drive items.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eonItemsSelectedTrigger\u003c/code\u003e specifies a function that builds and returns Card objects for the add-on UI.\u003c/p\u003e\n"]]],[],null,["# Drive manifest resource\n\nThe resource configuration that is used to define\n[Google Workspace add-on](/workspace/add-ons/concepts/types#g_suite_add-ons)\ncontent and behavior within Google Drive.\nGoogle Workspace add-on manifests must have\nall the components marked as **Required** if they extend Drive.\n\nDrive\n-----\n\nThe Google Workspace add-on manifest configuration for\nGoogle Drive extensions. See\n[Extending Drive with Google Workspace add-ons](/workspace/add-ons/drive)\nfor more information.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------|\n| ```text { \"homepageTrigger\": { object (HomepageTrigger) }, \"onItemsSelectedTrigger\": { object (OnItemsSelectedTrigger) } } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `homepageTrigger` | `object (`[HomepageTrigger](/apps-script/manifest/homepage-trigger)`)` The trigger function specification for creating the add-on [homepage](/workspace/add-ons/concepts/homepages) in the Drive host. This overrides [`addOns.common.homepageTrigger`](/apps-script/manifest/addons#Common.FIELDS.homepageTrigger). |\n| `onItemsSelectedTrigger` | `object (`[OnItemsSelectedTrigger](#onitemsselectedtrigger)`)` **Required to provide add-on behavior triggered by user selection of items in Drive.** The contextual trigger function specification for item selections in Google Drive. |\n\n### OnItemsSelectedTrigger\n\nA configuration for a contextual trigger that fires when a user selects\none or more files or folders in Google Drive. See\n[Drive contextual interface for items selected](/workspace/add-ons/drive/building-drive-interfaces#drive_contextual_interface_for_items_selected)\nfor more information.\n\n| JSON representation |\n|---------------------------------------|\n| ```text { \"runFunction\": string } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `runFunction` | `string` The name of the function to run when files or folders are selected in Google Drive. If specified, you must implement this function to build and return an array of [`Card`](/apps-script/reference/card-service/card) objects for display in the add-on UI. |"]]
