Skip to content
On this page
netzo/apis/googledrive

Google Drive

Google Drive is a file storage and synchronization service that allows users to store files. Google Drive encompasses Google Docs, Sheets and Slides, an office suite that permits collaborative editing of documents, spreadsheets, presentations, drawings, forms, and more. Files created and edited through the office suite are saved in Google Drive.

  • labels: productivity, storage, collaboration
  • authentication: googlejwtsa

Usage

ts
import { googledrive } from 'https://deno.land/x/netzo/apis/googledrive/mod.ts'

const { api } = googledrive({
  googleServiceAccountCredentials: Deno.env.get('GOOGLE_SERVICE_ACCOUNT_CREDENTIALS'),
  scope: ['drive.readonly'],
})
import { googledrive } from 'https://deno.land/x/netzo/apis/googledrive/mod.ts'

const { api } = googledrive({
  googleServiceAccountCredentials: Deno.env.get('GOOGLE_SERVICE_ACCOUNT_CREDENTIALS'),
  scope: ['drive.readonly'],
})

Configuration

The googlesheets factory function expects an object with the following, and returns an object with an HTTP client api.

ParamTypeDefaultDescription
googleServiceAccountCredentialsstringDeno.env.get('GOOGLE_SERVICE_ACCOUNT_CREDENTIALS')credentials to use for authentication
scopearray['spreadsheets.readonly']the permissions granted to interact with the resource

Refer to the API documentation to get the required information.

Examples

The following examples assume you have created an api client instance. Refer to the type definitions for all exported types to pass to the api client for typed responses.

Find files

Find all files that match the query.

ts
import type { Files, QueryFiles } from 'netzo/apis/googlesheets/types.ts'

const query: QueryFiles = {}
const result = await api.files.get<Files>(query)
const resultData = result.files
import type { Files, QueryFiles } from 'netzo/apis/googlesheets/types.ts'

const query: QueryFiles = {}
const result = await api.files.get<Files>(query)
const resultData = result.files

Get file

Get a file by id.

ts
import type { File, QueryFile } from 'netzo/apis/googlesheets/types.ts'

const query: QueryFile = {}
const resultData = await api.files[FILE_ID].get<File>(query)
import type { File, QueryFile } from 'netzo/apis/googlesheets/types.ts'

const query: QueryFile = {}
const resultData = await api.files[FILE_ID].get<File>(query)

Copy file

Create a copy of a file and apply updates.

ts
import type { DataCopyFile, File } from 'netzo/apis/googlesheets/types.ts'

const data: DataCopyFile = { description: 'Copy of my file' }
const resultData = await api.files[FILE_ID].copy.post<File>(data)
import type { DataCopyFile, File } from 'netzo/apis/googlesheets/types.ts'

const data: DataCopyFile = { description: 'Copy of my file' }
const resultData = await api.files[FILE_ID].copy.post<File>(data)

References