Page Summary

outlined_flag

• Every Apps Script project uses Google Cloud to manage authorization, advanced services, and other details and has an associated Google Cloud project.

• You can use either a default project that Apps Script creates or a standard project that you create yourself; default projects are for simple scripts, while standard projects are for complex, commercial, or publishable applications.

• You can switch from a default to a standard project but not back, and switching later in development can cause complications like requiring users to re-authorize.

• Standard projects are required for tasks like publishing add-ons, verifying OAuth clients, viewing logs in the Google Cloud console, and manual control over project settings.

• Switching to a different standard project requires re-enabling advanced services and APIs, user re-authorization, and affects Google Workspace Marketplace listings if applicable.

Every Apps Script project usesGoogle Cloud to manage authorization,advanced services, and other details.To configure and manage these settings, every Apps Script project has anassociatedGoogle Cloud project.Your script project can use adefault project that Apps Scriptautomatically creates, or astandard project that you createyourself. In general, default projects are good for everyday or simplescripts, but you should use a standard project for any application thatis complex, commercial quality, or that you intend to publish.

You canswitch from a default project to a standard projectat any time, but you can't switch back to use a default project. It's bestto select the Cloud project your script uses early in development.Switching later can cause complications, like requiring your users tore-authorize.

Default Cloud projects

When you create an Apps Script project, Apps Script creates a defaultCloud project that operates in the background.

• For most scripts, you never need to see or adjust this default project. AppsScript handles the necessary interactions with Google Cloud. For example, ifyou activate an advanced service in the Apps Script editor, Apps Scriptactivates the advanced service in the default Cloud project when yousave the script project.
• For some scripts, you need to interact with the Google Cloud console. In thesecases, your script must instead use a standard Cloud project. Forexample, to view Google Cloud logs in the Google Cloud console, your script must usea standard project.

By default, Cloud projects have an Identity and Access Management(IAM) policy with one entry, a Google service account that acts as the owner ofthe default project. The Google service account isappsdev-apps-dev-script-auth@system.gserviceaccount.com.

View or update default Cloud projects

Most users can’t directly locate, view, or edit default projects in theGoogle Cloud console. If you're an Admin, refer toView default Google Cloud projects.

If you created your script project before April 8, 2019, you might use adefault project that you can access in the Google Cloud console. To access thedefault project, go to the script project's settings and click the projectnumber.

Delete default Cloud projects

If you're an administrator, you can delete default Cloud projects likeyou wouldstandard Cloud projects. SeeView or edit default Cloud projects.

If you're not an administrator, you can't manually delete default projects.However, ifyou delete the script project or switch it to use a standard project,Apps Script deletes the default project attached to the scriptalong with any settings or information it contains.

Standard Cloud projects

Default Cloud projects are the best option for most script projects,unless you need to manually configure the project.In these situations, you mustswitch your script project to use a standard project.

The following sections describe when Apps Script requires a standard project,the properties of such projects, and common tasks done with them. You can onlyperform the below tasks with standard projects.

When Apps Script requires standard Cloud projects

You must use a standard project in the following situations:

• To publish your script project as anadd-onin theGoogle Workspace Marketplace.
• Toverify your script project's OAuth client.
• When you have an application that needs to execute functions in yourscript project using theApps Script API'sscripts.run method.
• To view your script project'sGoogle Cloud logs in theGoogle Cloud console. The Google Cloud console provides more tools for filtering andviewing logs, and can be more helpful than the simplified view provided bytheApps Script dashboard.
• To view your script project's error reports usingError Reporting.
• To create afile-open dialog.
• When you otherwise need manual control over the project'sGoogle Cloud settings.

Standard Cloud project properties

Standard projects have the following properties:

• You can access all of the Google Cloud settings for the project directlyfrom theGoogle Cloud console. This lets you activate APIs, adjust authorizationcredentials, and configure other details.
• When you delete a script project or switch it touse another standard project, the original standard project remains and can be reused.
• When you activate anadvanced servicein a script project, you must manually activate the corresponding API in thestandard project.
• Multiple script projects and other apps can share the samestandard project. If you intend to publish a script projectto theGoogle Workspace Marketplaceas anadd-on,it must have its own standard project. Published apps can't shareCloud projects with other apps.
• If you want to execute functions in a script project from another app usingtheApps Script API'sscripts.run method,the script project and the calling application must share the same standardproject.
• When Apps Script asks a user to authorize a script that uses a standardproject, the Cloud project name is used to identify the script (not thescript project name). For this reason, be sure to set an appropriate Cloud project name.

Access a standard Cloud project

To access the standard project associated with your scriptproject, do the following:

1. Open the Apps Script project.
2. At the left, clickProject Settingssettings.
3. UnderGoogle Cloud Platform (GCP) Project, click the project number.

You can also find a standard project directly on theGoogle Cloud consoleManage Resources page.

Activate an API in a standard Cloud project

Often an Apps Script application needs access to another Google API. To do this,you must activate the API in the corresponding Cloud project.Activate an API by doing the following:

1. Open the Cloud project.
2. Click Menumenu>APIs & Services.
3. ClickEnable APIs and Services.
4. In the search box, enter the API you want to activate and pressEnter.
5. Click the API from the search results and then clickEnable to activatethe API for this Cloud project.

You might be prompted to accept the Terms of Service forGoogle APIs orGoogle Cloud. Review the Termsof Service carefully before accepting them.

Depending on the application, you might also need to configure the API byselecting it in theAPIs & Services dashboard.

Determine the ID & number of a standard Cloud project

All Cloud projects have a project name, project ID, and project number.Occasionally, you must have these identifiers toconfigure services or complete other tasks.

To determine your standard project's ID and number, do the following:

1. Open the Cloud project.
2. At the top-right, click Moremore_vert>Project settings.
3. View theProject name,Project ID, andProject numberin the resultingSettings panel. TheProject number consists only ofdigits, while theProject ID is alphanumeric. You can edit theProject name, which displays to users during authorization prompts.

View Google Cloud logs & error reports in the Google Cloud console

If you're usingGoogle Cloud loggingorerror reportingfor your script project, you can view those logs and reports in theGoogle Cloud console by doing the following:

1. Open the Cloud project.
2. Click Menumenu.
3. Scroll down to theOperations sectionand clickLogging> Logs explorer.
4. To view error reports, scroll down to theOperations sectionand clickError Reporting. If you're prompted toset up error reporting, this means that your script project hasn'tlogged any exceptions yet.

Complete the OAuth consent screen

When using services that require OAuth, Google prompts users to authorize thoseservices. The OAuth consent screen settings let you set some of the informationthat Google presents to users, such asthe application name and Terms of Service URL.

Default Cloud projects create a consent screen automatically from theApps Script project details; you can't adjust those settings.Standard Cloud projects letyou customize this information. You can configure your script's consentscreen by doing the following:

1. Open the Cloud project.
2. Click Menumenu>APIs & Services>Credentials.
3. ClickConfigure consent screen.
4. Fill in each section of the consent screen workflow.
5. To record your changes at each stage of the workflow, clickSave and continue.

Create OAuth credentials

Apps Script usually sets up OAuth for the servicesyour script uses. For some applications, you must create additionalOAuth credentials (client IDs and client secrets). You can only do this withstandard projects.

To create a client ID and client secret for your script project, do thefollowing:

1. Open the Cloud project.
2. Click Menumenu>APIs & Services>Credentials.
3. ClickCreate credentials>OAuth client ID.
4. UnderApplication type, select your application type andfill in the resulting form if needed. When finished, clickCreate.
5. In the dialog that appears, clickDownload JSON. You canuse this file to configure OAuth.

Add additional owners to a standard Cloud project

You can add additional owners or other roles to a standard project.If you're collaborating on a project, this helps ensure that someone on yourteam always has access to the script project's Google Cloud settings.

You can add additional owners or other roles to a standard project by doing thefollowing. You must have edit permissions for the project to make any ofthese changes:

1. Determine who your collaborators should be. We recommended that youcreate or use an existing Google Group. You canalso specify domains in the collaborator list to include all users in thatdomain.
2. Open the script's Cloud project.
3. Click Menumenu>IAM & admin>IAM.
4. At the top, clickAdd.
5. Follow the on-screen instructions to add one or more new members and theirroles to the Cloud project. You can add individual emails, Google Groups, ordomains as new members.
6. ClickSave.

Group multiple scripts with a single Cloud project

You can have multiple Apps Script projects share the same standardCloud project. To do this, create a standard project and thenswitch each script projectto use it. You can't do this with default projects.

Use a different standard Cloud project

You can switch a script project so that it uses a different standardCloud project. If your script requires manual configuration of theCloud project, you must switch from a default project to a standardproject. To learnmore about when you need to use a standard project, refer tostandard Cloud projects.

Effects of switching to a different standard Cloud project

If you switch your script from a default project or to a different standardproject, it has the following effects:

• If you activated advanced services for your script, you must turn on thecorresponding APIs inthe new Cloud project. You lose any data tied to the advancedservices in the previous Cloud project. To learn how to turn on APIsin your Cloud project, refer toEnable Google Workspace APIs.
• If your script uses the built-in Google Drive service, you must turn on theDrive API in standard Cloud projects.

  In your standard Cloud project, turn on the Drive API:

  Turn on the Drive API

• All users who have previously authorized the script must re-authorize. Inmost cases, all users who have previously authorized apps associated withthe new project must also re-authorize.
• If your script is associated with an app listing on the Google Workspace Marketplace, your app listing, users, and reviews don't carry over to thenew project. You must create an app listing within the new project and yourusers must reinstall your app. For information about creating a newapp listing, refer toPublish an app.
• You can't switch a script back to a default project. Apps Script deletesdefault projects after you set the script to use a standard project.

Switch to a different standard Cloud project

To switch a script's existing Cloud project over to anotherCloud project, follow these steps:

1. If you don't have a suitable Cloud project, create one by following theCreate a project instructions. Set a memorable project name so that you can locate it on theGoogle Cloud consoleManage Resources page. Apps Script uses this name when asking users to authorize the script.
2. If you want to use an existing project, open theGoogle Cloud consoleManage Resources page and locate an existing project to use. You must have the Project Browser and OAuth Config Editor roles, or roles with the equivalent permissions, for the project. You can't use a project that was automatically created by Apps Script.
3. Determine theProject number of your Cloud project.
4. Open the script whose Cloud project you want to replace.
5. At the left, clickProject Settingssettings.
6. UnderGoogle Cloud Platform (GCP) Project, clickChange project.
7. Enter the new project number and clickSet project.

Cloud projects & shared drives

Shared drives (formerly Team Drives) provideshared spaces where groups of Drive users can collaborate on Apps Scriptprojects and Drive documents. Shared drives are valuable when developingscripts, add-ons, and web apps with a team, but they place some restrictions onwhat you can do with older default Cloud projects.

The following list of restrictions describes how Cloud projects interactwith shared drives:

• If your script project uses a standard project, there are noadditional restrictions when the script project resides in a shared drive.
• If your script project uses a default project that was created on orafter April 8, 2019, there are no additional restrictions when the scriptproject resides in a shared drive.
• If your script project uses a default project that was created beforeApril 8, 2019, the following restrictions apply while the scriptproject resides on a shared drive:
  1. You can't access the default project using the Apps Script UI ortheGoogle Cloud console. This restriction prevents you from takingactions that require direct access to the project.
  2. You can't activateadvanced services.To activate advanced services, switch to a standardproject.
  3. When you move an existing Apps Script project into a shared drive, Googlerestricts access to the default Cloud project. You can stillaccess the default project if you had access prior to the move. Forexample,if you created a script in your My Drive folder and then movedit into a shared drive, you could still access the script'sCloud project. Your collaborators in the shared drive might not be able to.
  4. A script retains the Cloud project name it had prior to beingmoved toa shared drive. Even if you change the project name on the shared drive,users that authorize the script still see the old name on authorizationdialogs.

To avoid the above restrictions for older scripts,switch to a standard project.

Get a list of Apps Script Cloud projects

If you have theresourcemanager.projects.list permission for yourorganization's Apps Script project folder, you can view all of the standard anddefault Apps Script Cloud projects within the folder.

1. Open theGoogle Cloud consoleManage Resources page.
2. Next to theApps Script folder, copy the ID.
3. ClickFilter>Parent ID and pastethe Apps Script folder ID.

Delete Apps Script Cloud projects

To delete an Apps Script Cloud project, follow the steps underGet alist of Apps Script Cloud projects,select the project you want to delete and clickDelete.

gcloud projects list --filter='parent.id=APPS_SCRIPT_FOLDER_ID'gcloud projects deletePROJECT_ID

For more information about deleting Cloud projects, seeShutting down(deleting) projects.