appsscript.json

Google Apps Script manifest file

appsscript.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your appsscript.json and it validates in your browser — nothing is uploaded.

Validate a appsscript.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`runtimeVersion`	`enum`	Version of the server to use when executing this project default: `"STABLE"` one of: `"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
`dependencies.enabledAdvancedServices`	`array<object>`	The list of advanced services enabled for use by the script project
`dependencies.libraries`	`array<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
`webapp.access`	`enum`	The levels of permission for running the web app default: `"MYSELF"` one of: `"MYSELF", "DOMAIN", "ANYONE", "ANYONE_ANONYMOUS"`
`webapp.executeAs`	`enum`	The identity under which the web app executes default: `"USER_DEPLOYING"` one of: `"USER_ACCESSING", "USER_DEPLOYING"`
`exceptionLogging`	`enum`	The location where exceptions are logged one of: `"NONE", "STACKDRIVER"`
`oauthScopes`	`array<string>`	The definition of authorization scopes used by the script project
`urlFetchWhitelist`	`array<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
`executionApi.access`	`enum`	Determines who has permission to run the script from the API one of: `"MYSELF", "DOMAIN", "ANYONE", "ANYONE_ANONYMOUS"`
`sheets`	`object`	Defines manifest values specific to Sheets
`sheets.macros`	`array<object>`	A list of defined macros and their associated properties
`dataStudio`	`object`	Data Studio add-on manifest
`dataStudio.name`required	`string`	Display name for add-on
`dataStudio.logoUrl`required	`string`	URL for logo image of add-on
`dataStudio.company`required	`string`	Company name for the add-on
`dataStudio.addonUrl`	`string`	—
`dataStudio.companyUrl`	`string`	—
`dataStudio.supportUrl`required	`string`	URL for support information of the add-on
`dataStudio.description`required	`string`	Short description about the add-on
`dataStudio.sources`	`array<string>`	List of sources or services that can be accessed with this add-on
`dataStudio.templates`	`object`	Map of template name to report ID
`dataStudio.shortDescription`	`string`	Even shorter description used in gallery cards. Only a maximum of 114 characters will be shown on the card
`dataStudio.authType`	`array`	List of AuthTypes supported
`dataStudio.privacyPolicyUrl`	`string`	Url for privacy policy information about the add-on
`dataStudio.termsOfServiceUrl`	`string`	Url for terms of service information about the add-on
`addOns`	`object`	G Suite Add-ons
`addOns.common`	`object`	Common properties between all G Suite add-on types
`addOns.common.name`required	`string`	The add-on name
`addOns.common.logoUrl`required	`string`	The logo URL
`addOns.common.layoutProperties`	`object`	Layout properties
`addOns.common.homepageTrigger`	`object`	Homepage trigger data
`addOns.common.universalActions`	`array<object>`	Universal add-on actions
`addOns.common.openLinkUrlPrefixes`	`array<string>`	Link prefixes
`addOns.common.useLocaleFromApp`	`boolean`	Use the locale from the host application?
`addOns.gmail`	`object`	Gmail add-on metadata
`addOns.gmail.contextualTriggers`	`array<object>`	Contextual triggers
`addOns.gmail.homepageTrigger`	`object`	The trigger function specification for creating the add-on homepage in the Gmail host
`addOns.calendar`	`object`	Calendar add-on metadata
`addOns.calendar.homepageTrigger`	`object`	The trigger function specification for creating the add-on homepage in the Calendar host
`addOns.calendar.eventOpenTrigger`	`object`	When a Calendar event is opened
`addOns.calendar.eventUpdateTrigger`	`object`	When a Calendar event is updated
`addOns.calendar.eventAccess`	`enum`	Handler access to Calendar event one of: `"METADATA", "READ", "WRITE", "READ_WRITE"`
`addOns.sheets`	`object`	Configurations for the Google Workspace Add-on's appearance and behavior within the Sheets host application
`addOns.sheets.homepageTrigger`	`object`	The Google Workspace add-on manifest configuration for homepage triggers
`addOns.sheets.onFileScopeGrantedTrigger`	`object`	A configuration for a contextual trigger that fires when the add-on presents the request file scope dialog

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
77 properties, 95% carrying a description, max nesting depth 10.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`format`	JSON Schema Validation, draft 2020-12	§7 — Vocabularies for Semantic Content With "format"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`maxLength`	JSON Schema Validation, draft 2020-12	§6.3.1 — "maxLength"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`format: "uri"`	RFC 3986 (STD 66)	§3 — Syntax Components

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas