Managed API for Google Drive v3

Managed API for Google Drive is an API Client for Google Drive by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.

This is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.

Platform specific ports

• ScriptRunner Connect

Supported API calls

• fetch
• About
  • me
• File
  • copyFile
  • createFile
  • deleteFile
  • downloadFile
  • emptyTrash
  • exportFile
  • generateIds
  • getFile
  • getFiles
  • getFileLabels
  • editFileLabels
  • updateFile
  • watchFile

Porting to other runtimes

While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.

You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have yo specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:

{
    buffer: {
        encode(input: string): ArrayBuffer;
        decode(input: ArrayBuffer): string;
    },
    performHttpCall(request: Request): Promise<Response>
}

Here is an example how to create a Node port of the Managed API:

import { GoogleDriveApiCore } from "@managed-api/google-drive-v3-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class GoogleDriveApi extends GoogleDriveApiCore {
    constructor(private baseUrl: string, private authToken: string) {
        super();
    }

    protected getPlatformImplementation(): PlatformImplementation {
        return {
            buffer: {
                encode: (input) => Buffer.from(input, 'utf-8'),
                decode: (input) => Buffer.from(input).toString('utf-8')
            },
            performHttpCall: (request) => this.performHttpCall(request)
        };
    }

    private async performHttpCall(request: Request): Promise<Response> {
        const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
        request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
        const response = await fetch(requestUrl, {
            method: request.method,
            headers: request.headers as any,
            body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
        });

        const apiHeaders = new Headers();
        response.headers.forEach((value, key) => apiHeaders.append(key, value));

        const body = await response.arrayBuffer();

        return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
    }
}

Please note that the authentication handling details may not be accurate and serve as an example. If you wish yo use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.

Contact

At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [email protected] for ideas, suggestions and improvements.

Changelog

• 1.4.0

  • Updated File method response types.

• 1.3.0

  • Removed Drive methods.

• 1.2.0

  • Made options optional for methods that support empty requests.

• 1.1.0

  • Added additional content type fallback value for file creation and update.

• 1.0.0

  • Added support for the following About methods:

    • get that can be used as About.me or All.aboutMe.

  • Added support for the following Drive methods:

    • create that can be used as Drive.createDrive or All.createDrive.
    • delete that can be used as Drive.deleteDrive or All.deleteDrive.
    • get that can be used as Drive.getDrive or All.getDrive.
    • hide that can be used as Drive.hideDrive or All.hideDrive.
    • list that can be used as Drive.getDrives or All.getDrives.
    • unhide that can be used as Drive.unhideDrive or All.unhideDrive.
    • update that can be used as Drive.updateDrive or All.updateDrive.

  • Added support for the following File methods:

    • copy that can be used as File.copyFile or All.copyFile.
    • create that can be used as File.createFile or All.createFile.
    • delete that can be used as File.deleteFile or All.deleteFile.
    • download that can be used as File.downloadFile or All.downloadFile.
    • emptyTrash that can be used as File.emptyTrash or All.emptyTrash.
    • export that can be used as File.exportFile or All.exportFile.
    • generateIds that can be used as File.generateIds or All.generateIds.
    • get that can be used as File.getFile or All.getFile.
    • list that can be used as File.getFiles or All.getFiles.
    • listLabels that can be used as File.getFileLabels or All.getFileLabels.
    • modifyLabels that can be used as File.editFileLabels or All.editFileLabels.
    • update that can be used as File.updateFile or All.updateFile.
    • watch that can be used as File.watchFile or All.watchFile.

Copyright Adaptavist 2025 (c) All rights reserved