Google Docs Component

Google Docs is an online word processor included as part of the free, web-based Google Docs Editors suite. Use the Google Docs component to create, and collaborate on online documents.

Component key: google-docs

Description

Google Docs is an online word processor included as part of the free, web-based Google Docs Editors suite. Use the Google Docs component to create, and collaborate on online documents.

Connections

Google Docs OAuth2

All requests to the Google Docs API must be authorized by an authenticated user.

The details of the authorization process, or "flow," for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:

1. When you create your application, you register it using the Google API Console. Google then provides information you'll need later, such as a client ID and a client secret.
2. From APIs & Services > Library, enable the Google Docs API
3. To create API Credentials navigate to Enabled APIs & Services > Credentials
   1. Select Create Credentials > OAuth Client ID
   2. Set the application type to ‘Web Application’
   3. Fill out the OAuth consent screen with an app name (your company or product's name), support email, app logo, domain, etc.
   4. Select Add Or Remove scopes, search Content API for Shopping, and check the boxes for the following scopes
      1. /auth/documents
      2. /auth/drive
      3. /auth/drive.file
4. Under Authorized redirect URIs enter the OAuth 2.0 callback URL: https://oauth2.prismatic.io/callback
   1. Take note of the Client ID and Client Secret that are generated, as you will enter them for authentication.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Google Docs	https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent
Client ID	Your Google Docs App's Client ID
Client Secret	Your Google Docs App's Client Secret
Scopes	Space delimited listing of scopes. See https://developers.google.com/docs/api/auth#scopes	https://www.googleapis.com/auth/documents
Token URL	The OAuth 2.0 Token URL for Google Docs	https://oauth2.googleapis.com/token

Actions

Batch Update Documents

Applies one or more updates to the document. | key: batchUpdateDocuments

Input	Notes	Example
Document ID	The ID of the document to update.
Connection
Requests	A list of updates to apply to the document.
Required Revision ID	The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error.	https://developers.google.com/docs/api/reference/rest/v1/documents/batchUpdate#writecontrol
Target Revision ID	The optional target revision ID of the document the write request is applied to.	https://developers.google.com/docs/api/reference/rest/v1/documents/batchUpdate#writecontrol

---

Create Document

Creates a blank document using the title given in the request. | key: createDocument

Input	Notes	Example
Connection
Title	The title of the document to create.

---

Get Document

Gets the latest version of the specified document. | key: getDocument

Input	Notes	Example
Document ID	The ID of the document to retrieve.
Connection
Suggestions View Mode	The suggestions view mode to apply to the document.	DEFAULT_FOR_CURRENT_ACCESS

---

Raw Request

Send raw HTTP request to Google Docs | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type.	false
Retry Delay (ms)	The delay in milliseconds between retries.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/v1/documents/{documentId}), The base URL is already included (https://docs.googleapis.com). For example, to connect to https://docs.googleapis.com/v1/documents/{documentId}, only /v1/documents/{documentId} is entered in this field.	/v1/documents/{documentId}
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries.	false

---