Skip to main content

Google Docs API Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Google Docs API location.
google_docs_api.png

Google Docs API

  1. Click the + icon on the Nexset that will be sent to the Google Docs API destination, and select the Send to Destination option from the menu.

  2. Select the Google Docs API connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Google Docs API account, and click Next; or, create a new Google Docs API credential for use in this flow.

  3. Google Docs API destinations can be manually configured to send data to any valid Google Docs API endpoint. You can also configure Nexla to automatically send the response received from the Google Docs API after each call to a new Nexla webhook data source.

    First, select the API method that will be used for calls to the Google Docs API from the Method pulldown menu. The Google Docs API supports the following methods for write operations:

    • POST: For creating new documents or submitting batchUpdate requests to apply changes to an existing document
    • PUT: For replacing or overwriting specific document content

Data Format​

  1. Select the format in which the Nexset data will be sent to the Google Docs API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

The Google Docs API uses JSON for all request and response bodies. Select JSON as the content format to ensure compatibility. The batchUpdate endpoint in particular expects a JSON body containing a requests array with one or more request objects that describe the changes to apply to the document.

API Endpoint URL​

  1. Enter the URL of the Google Docs API endpoint to which you want to send the Nexset data in the URL field.

    Common Google Docs API write endpoints include:

    • Create a new document: https://docs.googleapis.com/v1/documents
    • Apply batch updates to an existing document: {'https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate'}

Replace {documentId} in the URL with the actual document ID of the target Google Docs document. The document ID can be found in the document's URL — it is the string between /d/ and /edit. Ensure the authenticated account has at least Editor access to the target document when using the batchUpdate endpoint.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header — it is managed automatically by the Google Docs API credential. The Content-Type: application/json header is also handled automatically by Nexla.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Google Docs API destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

The Google Docs API batchUpdate endpoint is designed to accept multiple update requests in a single call. When sending document modification requests, consider using the Property Inside JSON Object batching algorithm and setting the property name to requests to assemble individual request objects into the requests array format required by the batchUpdate endpoint.

Response Webhook​

Optional

Nexla can automatically send the response received from the Google Docs API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as the document ID of a newly created document or the write control revision ID returned by a batchUpdate response.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Google Docs API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the Google Docs API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Google Docs API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Google Docs API endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Google Docs API endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.