Python quickstart

Quickstarts explain how to set up and run an app that calls a Google Workspace API.

Google Workspace quickstarts use the API client libraries to handle some details of the authentication and authorization flow. We recommend that you use the client libraries for your own apps. This quickstart uses a simplified authentication approach that is appropriate for a testing environment. For a production environment, we recommend learning about authentication and authorization before choosing the access credentials that are appropriate for your app.

Create a Python command-line application that makes requests to the Google Apps Script API.

Objectives

Set up your environment.
Install the client library.
Set up the sample.
Run the sample.

Prerequisites

To run this quickstart, you need the following prerequisites:

Python 3.10.7 or greater
The pip package management tool
A Google Cloud project .

A Google account with Google Drive enabled.

Set up your environment

To complete this quickstart, set up your environment.

Enable the API

Before using Google APIs, you need to turn them on in a Google Cloud project. You can turn on one or more APIs in a single Google Cloud project.

In the Google Cloud console, enable the Google Apps Script API.

Enable the API

Configure the OAuth consent screen

If you're using a new Google Cloud project to complete this quickstart, configure the OAuth consent screen and add yourself as a test user. If you've already completed this step for your Cloud project, skip to the next section.

In the Google Cloud console, go to Menu > APIs & Services > OAuth consent screen .
Go to OAuth consent screen
For User type select Internal , then click Create .
Complete the app registration form, then click Save and Continue .
For now, you can skip adding scopes and click Save and Continue . In the future, when you create an app for use outside of your Google Workspace organization, you must change the User type to External , and then, add the authorization scopes that your app requires.
Review your app registration summary. To make changes, click Edit . If the app registration looks OK, click Back to Dashboard .

Authorize credentials for a desktop application

To authenticate end users and access user data in your app, you need to create one or more OAuth 2.0 Client IDs. A client ID is used to identify a single app to Google's OAuth servers. If your app runs on multiple platforms, you must create a separate client ID for each platform.

In the Google Cloud console, go to Menu > APIs & Services > Credentials .
Go to Credentials
Click Create Credentials > OAuth client ID .
Click Application type > Desktop app .
In the Name field, type a name for the credential. This name is only shown in the Google Cloud console.
Click Create . The OAuth client created screen appears, showing your new Client ID and Client secret.
Click OK . The newly created credential appears under OAuth 2.0 Client IDs.
Save the downloaded JSON file as credentials.json , and move the file to your working directory.

Install the Google client library

Install the Google client library for Python:

  pip 
 install 
 -- 
 upgrade 
 google 
 - 
 api 
 - 
 python 
 - 
 client 
 google 
 - 
 auth 
 - 
 httplib2 
 google 
 - 
 auth 
 - 
 oauthlib

Configure the sample

In your working directory, create a file named quickstart.py .

Include the following code in quickstart.py :

apps_script/quickstart/quickstart.py

View on GitHub

 """ 
 Shows basic usage of the Apps Script API. 
 Call the Apps Script API to create a new script project, upload a file to the 
 project, and log the script's URL to the user. 
 """ 
 import 
 os.path 
 from 
 google.auth.transport.requests 
 import 
 Request 
 from 
 google.oauth2.credentials 
 import 
 Credentials 
 from 
 google_auth_oauthlib.flow 
 import 
 InstalledAppFlow 
 from 
 googleapiclient 
 import 
 errors 
 from 
 googleapiclient.discovery 
 import 
 build 
 # If modifying these scopes, delete the file token.json. 
 SCOPES 
 = 
 [ 
 "https://www.googleapis.com/auth/script.projects" 
 ] 
 SAMPLE_CODE 
 = 
 """ 
 function helloWorld() { 
 console.log("Hello, world!"); 
 } 
 """ 
 . 
 strip 
 () 
 SAMPLE_MANIFEST 
 = 
 """ 
 { 
 "timeZone": "America/New_York", 
 "exceptionLogging": "CLOUD" 
 } 
 """ 
 . 
 strip 
 () 
 def 
 main 
 (): 
  
 """Calls the Apps Script API.""" 
 creds 
 = 
 None 
 # The file token.json stores the user's access and refresh tokens, and is 
 # created automatically when the authorization flow completes for the first 
 # time. 
 if 
 os 
 . 
 path 
 . 
 exists 
 ( 
 "token.json" 
 ): 
 creds 
 = 
 Credentials 
 . 
 from_authorized_user_file 
 ( 
 "token.json" 
 , 
 SCOPES 
 ) 
 # If there are no (valid) credentials available, let the user log in. 
 if 
 not 
 creds 
 or 
 not 
 creds 
 . 
 valid 
 : 
 if 
 creds 
 and 
 creds 
 . 
 expired 
 and 
 creds 
 . 
 refresh_token 
 : 
 creds 
 . 
 refresh 
 ( 
 Request 
 ()) 
 else 
 : 
 flow 
 = 
 InstalledAppFlow 
 . 
 from_client_secrets_file 
 ( 
 "credentials.json" 
 , 
 SCOPES 
 ) 
 creds 
 = 
 flow 
 . 
 run_local_server 
 ( 
 port 
 = 
 0 
 ) 
 # Save the credentials for the next run 
 with 
 open 
 ( 
 "token.json" 
 , 
 "w" 
 ) 
 as 
 token 
 : 
 token 
 . 
 write 
 ( 
 creds 
 . 
 to_json 
 ()) 
 try 
 : 
 service 
 = 
 build 
 ( 
 "script" 
 , 
 "v1" 
 , 
 credentials 
 = 
 creds 
 ) 
 # Call the Apps Script API 
 # Create a new project 
 request 
 = 
 { 
 "title" 
 : 
 "My Script" 
 } 
 response 
 = 
 service 
 . 
 projects 
 () 
 . 
 create 
 ( 
 body 
 = 
 request 
 ) 
 . 
 execute 
 () 
 # Upload two files to the project 
 request 
 = 
 { 
 "files" 
 : 
 [ 
 { 
 "name" 
 : 
 "hello" 
 , 
 "type" 
 : 
 "SERVER_JS" 
 , 
 "source" 
 : 
 SAMPLE_CODE 
 }, 
 { 
 "name" 
 : 
 "appsscript" 
 , 
 "type" 
 : 
 "JSON" 
 , 
 "source" 
 : 
 SAMPLE_MANIFEST 
 , 
 }, 
 ] 
 } 
 response 
 = 
 ( 
 service 
 . 
 projects 
 () 
 . 
 updateContent 
 ( 
 body 
 = 
 request 
 , 
 scriptId 
 = 
 response 
 [ 
 "scriptId" 
 ]) 
 . 
 execute 
 () 
 ) 
 print 
 ( 
 "https://script.google.com/d/" 
 + 
 response 
 [ 
 "scriptId" 
 ] 
 + 
 "/edit" 
 ) 
 except 
 errors 
 . 
 HttpError 
 as 
 error 
 : 
 # The API encountered a problem. 
 print 
 ( 
 error 
 . 
 content 
 ) 
 if 
 __name__ 
 == 
 "__main__" 
 : 
 main 
 ()

Run the sample

In your working directory, build and run the sample:
```
  python3 
 quickstart 
 . 
 py 
 
```

The first time you run the sample, it prompts you to authorize access:
1. If you're not already signed in to your Google Account, sign in when prompted. If you're signed in to multiple accounts, select one account to use for authorization.
2. Click Accept.
Your Python application runs and calls the Google Apps Script API.

Authorization information is stored in the file system, so the next time you run the sample code, you aren't prompted for authorization.