appsscript.json

Google Apps Script manifest file

Type object
File match appsscript.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/appsscript-json/latest.json
Source https://www.schemastore.org/appsscript.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

runtimeVersion enum

Version of the server to use when executing this project

Default: "STABLE"
Values: "STABLE" "V8" "DEPRECATED_ES5"
timeZone string

The script time zone in one of the available ZoneId values such as "America/Denver"

Default: "America/New_York"
dependencies object

A list of advanced services and libraries

2 nested properties
enabledAdvancedServices object[]

The list of advanced services enabled for use by the script project

libraries object[]

The list of libraries used by the script project

webapp object

The script project's web app configuration. Only used if the project is deployed as a web app

2 nested properties
access enum

The levels of permission for running the web app

Default: "MYSELF"
Values: "MYSELF" "DOMAIN" "ANYONE" "ANYONE_ANONYMOUS"
executeAs enum

The identity under which the web app executes

Default: "USER_DEPLOYING"
Values: "USER_ACCESSING" "USER_DEPLOYING"
exceptionLogging enum

The location where exceptions are logged

Values: "NONE" "STACKDRIVER"
oauthScopes string[]

The definition of authorization scopes used by the script project

urlFetchWhitelist string[]

A list of HTTPS URL prefixes. If present, any URL endpoint fetched must match one of the prefixes in this list. This can help to protect user data

executionApi object

The script project's API executable configuration. Only used if the project is deployed for API execution

1 nested properties
access enum

Determines who has permission to run the script from the API

Values: "MYSELF" "DOMAIN" "ANYONE" "ANYONE_ANONYMOUS"
sheets object

Defines manifest values specific to Sheets

1 nested properties
macros object[]

A list of defined macros and their associated properties

dataStudio object

Data Studio add-on manifest

13 nested properties
name string required

Display name for add-on

logoUrl string required

URL for logo image of add-on

format=hostname
company string required

Company name for the add-on

supportUrl string required

URL for support information of the add-on

format=hostname
description string required

Short description about the add-on

addonUrl string
format=hostname
companyUrl string
format=hostname
sources string[]

List of sources or services that can be accessed with this add-on

templates object

Map of template name to report ID

shortDescription string

Even shorter description used in gallery cards. Only a maximum of 114 characters will be shown on the card

authType enum[]

List of AuthTypes supported

privacyPolicyUrl string

Url for privacy policy information about the add-on

format=hostname
termsOfServiceUrl string

Url for terms of service information about the add-on

format=hostname
addOns object

G Suite Add-ons

4 nested properties
common object

Common properties between all G Suite add-on types

7 nested properties
name string required

The add-on name

logoUrl string required

The logo URL

format=uri
layoutProperties object

Layout properties

2 nested properties
primaryColor string

The color of toolbar. Defaults to grey (#424242)

secondaryColor string

The default color of buttons. Defaults to the primary color (if it is set); otherwise defaults to blue (#2196F3)

homepageTrigger object

Homepage trigger data

2 nested properties
enabled boolean

Whether or not homepage (non-contextual) cards are enabled. Defaults to true

runFunctions string

The name of the function to run

universalActions object[]

Universal add-on actions

openLinkUrlPrefixes string[]

Link prefixes

useLocaleFromApp boolean

Use the locale from the host application?

gmail object

Gmail add-on metadata

2 nested properties
contextualTriggers object[]

Contextual triggers

homepageTrigger object

The trigger function specification for creating the add-on homepage in the Gmail host

2 nested properties
enabled boolean

Whether or not homepage (non-contextual) cards are enabled in Gmail. Defaults to true

runFunction string

The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects

calendar object

Calendar add-on metadata

4 nested properties
homepageTrigger object

The trigger function specification for creating the add-on homepage in the Calendar host

2 nested properties
enabled boolean

Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true

runFunction string

The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects

eventOpenTrigger object

When a Calendar event is opened

1 nested properties
runFunction string

Event handler function

eventUpdateTrigger object

When a Calendar event is updated

1 nested properties
runFunction string

Event handler function

eventAccess enum

Handler access to Calendar event

Values: "METADATA" "READ" "WRITE" "READ_WRITE"
sheets object

Configurations for the Google Workspace Add-on's appearance and behavior within the Sheets host application

2 nested properties
homepageTrigger object

The Google Workspace add-on manifest configuration for homepage triggers

2 nested properties
enabled boolean

Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true

runFunction string

The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects

onFileScopeGrantedTrigger object

A configuration for a contextual trigger that fires when the add-on presents the request file scope dialog

1 nested properties
runFunction string

Definitions

homepageTrigger object

The Google Workspace add-on manifest configuration for homepage triggers

enabled boolean

Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true

runFunction string

The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects