Create New File From Template with Google Drive API

Pipedream makes it easy to connect APIs for Google Drive and 2,200+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create New File From Template with the Google Drive API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create New File From Template with the Google Drive API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create New File From Template action
1. Connect your Google Drive account
2. Select a File
3. Select a Folder
4. Configure Name
5. Select one or more Mode
6. Configure Replace text placeholders
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create New File From Template with Google Drive API on New Row Added (Instant) from Google Sheets API

Google Sheets + Google Drive

Try it

Create New File From Template with Google Drive API on New Submission from Typeform API

Typeform + Google Drive

Try it

Create New File From Template with Google Drive API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Drive

Try it

Create New File From Template with Google Drive API on New Item in Feed from RSS API

RSS + Google Drive

Try it

Create New File From Template with Google Drive API on New Message from Discord API

Discord + Google Drive

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create New File From Template on Google Drive

Description:Create a new Google Docs file from a template. Optionally include placeholders in the template document that will get replaced from this action. [See documentation](https://www.npmjs.com/package/google-docs-mustaches)

Version:0.1.7

Key:google_drive-create-file-from-template

View on GitHub

Code#

import googleDrive from "../../google_drive.app.mjs";
import Mustaches from "google-docs-mustaches";

const MODE_GOOGLE_DOC = "Google Doc";
const MODE_PDF = "Pdf";

export default {
  key: "google_drive-create-file-from-template",
  name: "Create New File From Template",
  description: "Create a new Google Docs file from a template. Optionally include placeholders in the template document that will get replaced from this action. [See documentation](https://www.npmjs.com/package/google-docs-mustaches)",
  version: "0.1.7",
  type: "action",
  props: {
    googleDrive,
    templateId: {
      propDefinition: [
        googleDrive,
        "fileId",
      ],
      description:
        "Select the template document you'd like to use as the template, or use a custom expression to reference a document ID from a previous step. Template documents should contain placeholders in the format `{{xyz}}`.",
    },
    folderId: {
      propDefinition: [
        googleDrive,
        "folderId",
      ],
      description:
        "Select the folder of the newly created Google Doc and/or PDF, or use a custom expression to reference a folder ID from a previous step.",
    },
    name: {
      propDefinition: [
        googleDrive,
        "fileName",
      ],
      description:
        "Name of the file you want to create (eg. `myFile` will create a Google Doc called `myFile` and a pdf called `myFile.pdf`)",
      optional: false,
    },
    mode: {
      type: "string[]",
      label: "Mode",
      description: "Specify if you want to create a Google Doc, PDF or both.",
      options: [
        MODE_GOOGLE_DOC,
        MODE_PDF,
      ],
    },
    replaceValues: {
      type: "object",
      label: "Replace text placeholders",
      description: "Replace text placeholders in the document. Use the format `{{xyz}}` in the document but exclude the curly braces in the key. (eg. `{{myPlaceholder}}` in the document will be replaced by the value of the key `myPlaceholder` in the action.",
    },
  },
  async run({ $ }) {
    const result = {
      folderId: this.folderId,
      name: this.name,
      mode: this.mode,
    };

    const client = new Mustaches.default({
      token: () => this.googleDrive.$auth.oauth_access_token,
    });

    /* CREATE THE GOOGLE DOC */

    let googleDocId;
    try {
      googleDocId = await client.interpolate({
        source: this.templateId,
        destination: this.folderId,
        name: this.name,
        data: this.replaceValues,
      });
    } catch (e) {
      const {
        code, message,
      } = e.error.error;
      let errorMessage = `Status: ${code}, ${message} `;
      if (code == 404 || code == 400) {
        errorMessage += "Make sure that the template file selected contains placeholders in the format {{xyz}}.";
      }
      throw new Error(errorMessage);
    }
    result["googleDocId"] = googleDocId;

    /* CREATE THE PDF */

    if (this.mode.includes(MODE_PDF)) {
      const pdfId = await client.export({
        file: googleDocId,
        mimeType: "application/pdf",
        name: this.name,
        destination: this.folderId,
      });
      result["pdfId"] = pdfId;
    }

    /* REMOVE THE GOOGLE DOC */

    if (!this.mode.includes(MODE_GOOGLE_DOC)) {
      await this.googleDrive.deleteFile(googleDocId);
    }

    $.export("$summary", "New file successfully created");
    return result;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
File	`templateId`	`string`	Select a value from the drop down menu.
Folder	`folderId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the file you want to create (eg. `myFile` will create a Google Doc called `myFile` and a pdf called `myFile.pdf`)
Mode	`mode`	`string[]`	Select a value from the drop down menu:`Google DocPdf`
Replace text placeholders	`replaceValues`	`object`	Replace text placeholders in the document. Use the format `{{xyz}}` in the document but exclude the curly braces in the key. (eg. `{{myPlaceholder}}` in the document will be replaced by the value of the key `myPlaceholder` in the action.

Authentication#

Google Drive uses OAuth authentication. When you connect your Google Drive account, Pipedream will open a popup window where you can sign into Google Drive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Drive API.

Pipedream requests the following authorization scopes when you connect your account:

https://www.googleapis.com/auth/drive

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

More Ways to Use Google Drive#

Triggers#

Changes to Specific Files from the Google Drive API

Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to shared drive files, use the Changes to Specific Files (Shared Drive) source instead.

Try it

Changes to Specific Files (Shared Drive) from the Google Drive API

Watches for changes to specific files in a shared drive, emitting an event when a change is made to one of those files

Try it

New Files (Instant) from the Google Drive API

Emit new event when a new file is added in your linked Google Drive

Try it

New or Modified Comments (Instant) from the Google Drive API

Emit new event when a comment is created or modified in the selected file

Try it

New or Modified Files (Instant) from the Google Drive API

Emit new event when a file in the selected Drive is created, modified or trashed.