Skip to main content
Acessar Studio

Google Drive

O módulo Google Drive é responsável por ações que integram a ferramenta Google Drive. Seus métodos podem ser acessados conforme o exemplo abaixo:

const driveConnection = await API.Google.Drive.Connection["v1_0_0"]({
  connectionId: "id-da-conexao-configurada-no-workspace",
});
info

A ação Connection retorna diretamente uma instância de conexão autenticada com o Google Drive (e não um ID de texto). Essa instância deve ser armazenada em uma variável — como driveConnection nos exemplos abaixo — e reutilizada no parâmetro driveConnection de todas as demais ações deste módulo.

Métodos​

Connection​

Método responsável por estabelecer uma conexão com o Google Drive a partir de uma conexão configurada no workspace.

const driveConnection = await API.Google.Drive.Connection["v1_0_0"]({
  connectionId: "id-da-conexao-configurada-no-workspace",
});

Parâmetros obrigatórios​

  • connectionId:String - espera o ID da conexão do Google configurada no workspace (Workspace → Conexões).

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Retorna a instância de conexão autenticada com o Google Drive, que deve ser armazenada em uma variável (ex.: driveConnection) e reutilizada como parâmetro driveConnection nos demais métodos deste módulo.

EmptyTrash​

Método responsável por esvaziar a lixeira de um drive específico ou do "Meu Drive" padrão, excluindo permanentemente todos os itens nela contidos.

await API.Google.Drive.EmptyTrash["v1_0_0"]({
  driveConnection: driveConnection,
  name: "",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.

Parâmetros opcionais​

  • name:String - espera o nome do drive cuja lixeira será esvaziada. Caso não seja informado, esvazia a lixeira do "Meu Drive" da conta autenticada.

Retorno​

Este método não possui retorno.

Drives.List​

Método responsável por listar todos os drives disponíveis para a conta autenticada, incluindo drives compartilhados.

const drivesList = await API.Google.Drive.Drives.List["v1_0_0"]({
  driveConnection: driveConnection,
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.drivesList.drives // lista de drives disponíveis, cada item contendo id e name (Array)

Drives.GetByName​

Método responsável por obter as informações de um drive específico pelo seu nome.

const drive = await API.Google.Drive.Drives.GetByName["v1_0_0"]({
  driveConnection: driveConnection,
  name: "Drive Compartilhado",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • name:String - espera o nome exato do drive a ser localizado.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.drive.id   // identificador único do drive (String)
actions.drive.name // nome do drive (String)

Se nenhum drive for encontrado com o nome informado, a execução é interrompida com erro.

Files.List​

Método responsável por listar os arquivos presentes em uma pasta específica do Google Drive.

const filesList = await API.Google.Drive.Files.List["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho da pasta cujos arquivos serão listados. Use / para listar a raiz do drive.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

actions.filesList.files // lista de arquivos encontrados, cada item contendo id, name e extension (Array)

Files.GetByName​

Método responsável por obter as informações detalhadas de um arquivo a partir do seu caminho no Google Drive.

const file = await API.Google.Drive.Files.GetByName["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/relatorio.pdf",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo do arquivo, incluindo o nome e extensão.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

actions.file.id           // identificador único do arquivo (String)
actions.file.name         // nome do arquivo (String)
actions.file.extension    // extensão do arquivo (String)
actions.file.createdTime  // data de criação (String)
actions.file.modifiedTime // data da última modificação (String)
actions.file.shared       // indica se o arquivo está compartilhado (Boolean)

Se o arquivo não for encontrado, a execução é interrompida com erro.

Files.Exists​

Método responsável por verificar se um arquivo existe em um caminho específico do Google Drive.

const fileExists = await API.Google.Drive.Files.Exists["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/relatorio.pdf",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo do arquivo a verificar, incluindo o nome e extensão.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

actions.fileExists.exists // verdadeiro se o arquivo existe, falso caso contrário (Boolean)

Esta ação nunca interrompe a execução por não encontrar o arquivo — use o retorno exists para controle de fluxo condicional.

Files.Download​

Método responsável por fazer o download de um arquivo do Google Drive para um caminho local.

const download = await API.Google.Drive.Files.Download["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  remotePath: "/Documentos/relatorio.pdf",
  localPath: "C:\\Downloads\\relatorio.pdf",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • remotePath:String - espera o caminho completo do arquivo no Google Drive, incluindo o nome e extensão.
  • localPath:String - espera o caminho local onde o arquivo será salvo, incluindo o nome do arquivo.

Parâmetros opcionais​

  • drive:String - espera o nome do drive de origem. Padrão: "root" (Meu Drive).

Retorno​

actions.download.downloadPath // caminho local completo onde o arquivo foi salvo (String)

Files.Upload​

Método responsável por fazer o upload de um arquivo local para um caminho específico no Google Drive.

const upload = await API.Google.Drive.Files.Upload["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  remotePath: "/Documentos/relatorio.pdf",
  localPath: "C:\\Relatorios\\relatorio.pdf",
  createFoldersIfNecessary: false,
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • remotePath:String - espera o caminho completo de destino no Google Drive, incluindo o nome e extensão do arquivo.
  • localPath:String - espera o caminho completo do arquivo local a ser enviado.

Parâmetros opcionais​

  • drive:String - espera o nome do drive de destino. Padrão: "root" (Meu Drive).
  • createFoldersIfNecessary:Boolean - quando true, cria automaticamente as pastas do caminho de destino que ainda não existem. Se não for informado e o caminho de destino não existir, a execução é interrompida com erro.

Retorno​

actions.upload.id // identificador único do arquivo criado no Google Drive (String)

Files.Rename​

Método responsável por renomear um arquivo existente no Google Drive.

const rename = await API.Google.Drive.Files.Rename["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/relatorio_antigo.pdf",
  newName: "relatorio_2026.pdf",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo do arquivo a ser renomeado, incluindo o nome e extensão.
  • newName:String - espera o novo nome para o arquivo, incluindo a extensão.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

actions.rename.name // novo nome do arquivo após a renomeação (String)

Files.Move​

Método responsável por mover um arquivo para um novo destino, podendo ser em um drive diferente.

const move = await API.Google.Drive.Files.Move["v1_0_0"]({
  driveConnection: driveConnection,
  originDrive: "",
  destinationDrive: "",
  path: "/Documentos/relatorio.pdf",
  newParentPath: "/Arquivo/2026",
  createFoldersIfNecessary: false,
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo do arquivo a ser movido, incluindo o nome e extensão.
  • newParentPath:String - espera o caminho da pasta de destino.

Parâmetros opcionais​

  • originDrive:String - espera o nome do drive onde o arquivo está atualmente. Padrão: "root" (Meu Drive).
  • destinationDrive:String - espera o nome do drive para onde o arquivo será movido. Padrão: mesmo drive de origem.
  • createFoldersIfNecessary:Boolean - quando true, cria automaticamente as pastas do caminho de destino que ainda não existem. Se não for informado e o destino não existir, a execução é interrompida com erro.

Retorno​

actions.move.newParentId // identificador único da pasta pai de destino (String)

Files.Trash​

Método responsável por mover um arquivo para a lixeira do Google Drive.

await API.Google.Drive.Files.Trash["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/relatorio_antigo.pdf",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo do arquivo a ser movido para a lixeira, incluindo o nome e extensão.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

Este método não possui retorno. O arquivo pode ser restaurado usando o método Files.RestoreFromTrash, ou excluído permanentemente com o método EmptyTrash.

Files.RestoreFromTrash​

Método responsável por restaurar um arquivo da lixeira para o seu local original no Google Drive.

await API.Google.Drive.Files.RestoreFromTrash["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/relatorio_antigo.pdf",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).
  • path:String - espera o caminho que o arquivo tinha antes de ser movido para a lixeira, incluindo o nome e extensão. Embora tecnicamente opcional (com valor padrão "/"), este campo deve sempre ser informado para que o arquivo correto seja localizado e restaurado.

Retorno​

Este método não possui retorno.

Folders.List​

Método responsável por listar as pastas presentes em um caminho específico do Google Drive.

const foldersList = await API.Google.Drive.Folders.List["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho da pasta a ser listada. Use / para listar a raiz do drive.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

actions.foldersList.folders // lista de pastas encontradas, cada item contendo id e name (Array)

Folders.GetByName​

Método responsável por obter as informações detalhadas de uma pasta a partir do seu caminho no Google Drive.

const folder = await API.Google.Drive.Folders.GetByName["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/Relatórios",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo da pasta.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

actions.folder.id           // identificador único da pasta (String)
actions.folder.name         // nome da pasta (String)
actions.folder.createdTime  // data de criação (String)
actions.folder.modifiedTime // data da última modificação (String)
actions.folder.shared       // indica se a pasta está compartilhada (Boolean)

Se a pasta não for encontrada, a execução é interrompida com erro.

Folders.Create​

Método responsável por criar uma nova pasta em um caminho específico do Google Drive.

const folderCreated = await API.Google.Drive.Folders.Create["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/Relatórios/2026",
  recursive: false,
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo da pasta a ser criada, incluindo o nome.

Parâmetros opcionais​

  • drive:String - espera o nome do drive onde a pasta será criada. Padrão: "root" (Meu Drive).
  • recursive:Boolean - quando true, cria automaticamente todas as pastas do caminho que ainda não existem. Se não for informado e alguma pasta do caminho não existir, a execução é interrompida com erro.

Retorno​

actions.folderCreated.id // identificador único da pasta criada no Google Drive (String)

Folders.Exists​

Método responsável por verificar se uma pasta existe em um caminho específico do Google Drive.

const folderExists = await API.Google.Drive.Folders.Exists["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/Relatórios",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo da pasta a verificar.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

actions.folderExists.exists // verdadeiro se a pasta existe, falso caso contrário (Boolean)

Esta ação nunca interrompe a execução por não encontrar a pasta — use o retorno exists para controle de fluxo condicional.

Folders.Rename​

Método responsável por renomear uma pasta existente no Google Drive.

await API.Google.Drive.Folders.Rename["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/Relatórios",
  newName: "Relatórios Antigos",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo da pasta a ser renomeada.
  • newName:String - espera o novo nome para a pasta.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

Este método não possui retorno.

Folders.Move​

Método responsável por mover uma pasta para um novo destino dentro do Google Drive.

const folderMove = await API.Google.Drive.Folders.Move["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/Relatórios",
  newParentPath: "/Arquivo/2026",
  createFoldersIfNecessary: false,
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo da pasta a ser movida.
  • newParentPath:String - espera o caminho da pasta de destino.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).
  • createFoldersIfNecessary:Boolean - quando true, cria automaticamente as pastas do caminho de destino que ainda não existem. Se não for informado e o destino não existir, a execução é interrompida com erro.

Retorno​

actions.folderMove.newParentId // identificador único da pasta pai de destino (String)

Folders.Trash​

Método responsável por mover uma pasta para a lixeira do Google Drive.

await API.Google.Drive.Folders.Trash["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  path: "/Documentos/Antigos",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • path:String - espera o caminho completo da pasta a ser movida para a lixeira.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

Este método não possui retorno. A pasta pode ser restaurada usando o método Folders.RestoreFromTrash, ou excluída permanentemente com o método EmptyTrash.

Folders.RestoreFromTrash​

Método responsável por restaurar uma pasta da lixeira para o seu local original no Google Drive.

await API.Google.Drive.Folders.RestoreFromTrash["v1_0_0"]({
  driveConnection: driveConnection,
  drive: "",
  pathBeforeTrash: "/Documentos/Antigos",
});

Parâmetros obrigatórios​

  • driveConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • pathBeforeTrash:String - espera o caminho que a pasta tinha antes de ser movida para a lixeira.

Parâmetros opcionais​

  • drive:String - espera o nome do drive a ser acessado. Padrão: "root" (Meu Drive).

Retorno​

Este método não possui retorno.