Updated code samples for Forms API GA launch (#299)

* New and updated code samples for Forms API GA * Standardize on client_secrets.json * Remove API key * Fix region tag * Update README to include Google Forms API * Remove API key requirement * Remove f-string prefix
googleworkspace · Mar 14, 2022 · 27016d5 · 27016d5
1 parent b524108
commit 27016d5
Show file tree

Hide file tree

Showing 16 changed files with 142 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,11 @@ Perform mail merges from plain text or Google Sheets data sources
 - [Quickstart](https://developers.google.com/drive/v3/web/quickstart/python)
 - [DriveApp](drive/driveapp): A simple app that uploads a file to Google Drive.
 
+### Forms
+
+- [Quickstart](https://developers.google.com/forms/api/quickstart/python)
+- [Snippets](https://developers.google.com/forms/api/guides)
+
 ### Gmail
 
 - [Quickstart](https://developers.google.com/gmail/api/quickstart/python)

diff --git a/forms/quickstart/README.md b/forms/quickstart/README.md
@@ -0,0 +1,18 @@
+# Google Forms Python Quickstart
+
+Complete the steps described in the [Google Forms Python Quickstart](
+https://developers.google.com/forms/quickstart/python), and in
+about five minutes you'll have a simple Python command-line application that
+makes requests to the Google Forms API.
+
+## Install
+
+```shell
+pip install -r requirements.txt
+```
+
+## Run
+
+```shell
+python quickstart.py
+```
diff --git a/forms/quickstart/quickstart.py b/forms/quickstart/quickstart.py
@@ -0,0 +1,80 @@
+# Copyright 2021 Google LLC
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     https://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START forms_quickstart]
+from __future__ import print_function
+
+from apiclient import discovery
+from httplib2 import Http
+from oauth2client import client, file, tools
+
+SCOPES = "https://www.googleapis.com/auth/forms.body"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
+
+store = file.Storage('token.json')
+creds = None
+if not creds or creds.invalid:
+    flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
+    creds = tools.run_flow(flow, store)
+
+form_service = discovery.build('forms', 'v1', http=creds.authorize(
+    Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
+
+# Request body for creating a form
+NEW_FORM = {
+    "info": {
+        "title": "Quickstart form",
+    }
+}
+
+# Request body to add a multiple-choice question
+NEW_QUESTION = {
+    "requests": [{
+        "createItem": {
+            "item": {
+                "title": "In what year did the United States land a mission on the moon?",
+                "questionItem": {
+                    "question": {
+                        "required": True,
+                        "choiceQuestion": {
+                            "type": "RADIO",
+                            "options": [
+                                {"value": "1965"},
+                                {"value": "1967"},
+                                {"value": "1969"},
+                                {"value": "1971"}
+                            ],
+                            "shuffle": True
+                        }
+                    }
+                },
+            },
+            "location": {
+                "index": 0
+            }
+       }
+    }]
+}
+
+# Creates the initial form
+result = form_service.forms().create(body=NEW_FORM).execute()
+
+# Adds the question to the form
+question_setting = form_service.forms().batchUpdate(formId=result["formId"], body=NEW_QUESTION).execute()
+
+# Prints the result to show the question has been added
+get_result = form_service.forms().get(formId=result["formId"]).execute()
+print(get_result)
+
+# [END forms_quickstart]
diff --git a/forms/quickstart/requirements.txt b/forms/quickstart/requirements.txt
@@ -0,0 +1,3 @@
+google-api-python-client==1.7.9
+google-auth-httplib2==0.0.3
+google-auth-oauthlib==0.4.0
diff --git a/forms/snippets/README.md b/forms/snippets/README.md
diff --git a/forms/snippets/add_item.py b/forms/snippets/add_item.py
@@ -20,16 +20,15 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/forms.body"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
 
-form_service = discovery.build('forms', 'v1beta', http=creds.authorize(
+form_service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 form = {

diff --git a/forms/snippets/convert_form.py b/forms/snippets/convert_form.py
@@ -20,21 +20,20 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/forms.body"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
 
-form_service = discovery.build('forms', 'v1beta', http=creds.authorize(
+form_service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 form = {
     "info": {
-        "title": "My new form",
+        "title": "My new quiz",
     }
 }
 

diff --git a/forms/snippets/create_form.py b/forms/snippets/create_form.py
@@ -20,16 +20,15 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/drive"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
 
-form_service = discovery.build('forms', 'v1beta', http=creds.authorize(
+form_service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 form = {

diff --git a/forms/snippets/create_watch.py b/forms/snippets/create_watch.py
@@ -20,16 +20,15 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/drive"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secret.json', SCOPES)
     creds = tools.run_flow(flow, store)
 
-service = discovery.build('forms', 'v1beta', http=creds.authorize(
+service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 watch = {

diff --git a/forms/snippets/delete_watch.py b/forms/snippets/delete_watch.py
@@ -20,15 +20,14 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/drive"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secret.json', SCOPES)
     creds = tools.run_flow(flow, store)
-service = discovery.build('forms', 'v1beta', http=creds.authorize(
+service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 form_id = '<YOUR_FORM_ID>'

diff --git a/forms/snippets/list_watches.py b/forms/snippets/list_watches.py
@@ -20,15 +20,14 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/drive"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
-    flow = client.flow_from_clientsecrets('client_secret.json', SCOPES)
+    flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
-service = discovery.build('forms', 'v1beta', http=creds.authorize(
+service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 form_id = '<YOUR_FORM_ID>'

diff --git a/forms/snippets/renew_watch.py b/forms/snippets/renew_watch.py
@@ -20,15 +20,14 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/drive"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
-    flow = client.flow_from_clientsecrets('client_secret.json', SCOPES)
+    flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
-service = discovery.build('forms', 'v1beta', http=creds.authorize(
+service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 form_id = '<YOUR_FORM_ID>'

diff --git a/forms/snippets/retrieve_all_responses.py b/forms/snippets/retrieve_all_responses.py
@@ -20,15 +20,14 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/forms.responses.readonly"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
-service = discovery.build('forms', 'v1beta', http=creds.authorize(
+service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 # Prints the responses of your specified form:

diff --git a/forms/snippets/retrieve_contents.py b/forms/snippets/retrieve_contents.py
@@ -20,15 +20,14 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/forms.body.readonly"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
-service = discovery.build('forms', 'v1beta', http=creds.authorize(
+service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 # Prints the title of the sample form:

diff --git a/forms/snippets/retrieve_single_response.py b/forms/snippets/retrieve_single_response.py
@@ -20,15 +20,14 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/forms.responses.readonly"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
-service = discovery.build('forms', 'v1beta', http=creds.authorize(
+service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 # Prints the specified response from your form:

diff --git a/forms/snippets/update_form.py b/forms/snippets/update_form.py
@@ -20,16 +20,15 @@
 from oauth2client import client, file, tools
 
 SCOPES = "https://www.googleapis.com/auth/forms.body"
-API_KEY = "<YOUR_API_KEY>"
-DISCOVERY_DOC = f"https://forms.googleapis.com/$discovery/rest?version=v1beta&key={API_KEY}&labels=FORMS_BETA_TESTERS"
+DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
-store = file.Storage('credentials.json')
+store = file.Storage('token.json')
 creds = None
 if not creds or creds.invalid:
     flow = client.flow_from_clientsecrets('client_secrets.json', SCOPES)
     creds = tools.run_flow(flow, store)
 
-form_service = discovery.build('forms', 'v1beta', http=creds.authorize(
+form_service = discovery.build('forms', 'v1', http=creds.authorize(
     Http()), discoveryServiceUrl=DISCOVERY_DOC, static_discovery=False)
 
 form = {