Saltar al contenido principal
Ir al Studio
Google

Google Drive

Google Drive

El módulo Google Drive es responsable de acciones que integran la herramienta Google Drive. Sus métodos pueden accederse conforme al ejemplo a continuación:

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

La acción Connection devuelve directamente una instancia de conexión autenticada con Google Drive (y no un ID de texto). Esa instancia debe almacenarse en una variable — como driveConnection en los ejemplos a continuación — y reutilizarse en el parámetro driveConnection de todas las demás acciones de este módulo.

Métodos​

Connection​

Método responsable de establecer una conexión con Google Drive a partir de una conexión configurada en el workspace.

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

Parámetros obligatorios​

  • connectionId:String - espera el ID de la conexión de Google configurada en el workspace (Workspace → Conexiones).

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Devuelve la instancia de conexión autenticada con Google Drive, que debe almacenarse en una variable (ej.: driveConnection) y reutilizarse como parámetro driveConnection en los demás métodos de este módulo.

EmptyTrash​

Método responsable de vaciar la papelera de un drive específico o de "Mi unidad" predeterminada, eliminando permanentemente todos los elementos que contiene.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.

Parámetros opcionales​

  • name:String - espera el nombre del drive cuya papelera será vaciada. Si no se indica, vacía la papelera de "Mi unidad" de la cuenta autenticada.

Retorno​

Este método no tiene retorno.

Drives.List​

Método responsable de listar todos los drives disponibles para la cuenta autenticada, incluyendo los drives compartidos.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

Drives.GetByName​

Método responsable de obtener la información de un drive específico por su nombre.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • name:String - espera el nombre exacto del drive que será localizado.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

Si no se encuentra ningún drive con el nombre indicado, la ejecución se interrumpe con error.

Files.List​

Método responsable de listar los archivos presentes en una carpeta específica de Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta de la carpeta cuyos archivos serán listados. Usa / para listar la raíz del drive.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

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

Files.GetByName​

Método responsable de obtener la información detallada de un archivo a partir de su ruta en Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa del archivo, incluyendo el nombre y la extensión.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

js
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)

Si el archivo no se encuentra, la ejecución se interrumpe con error.

Files.Exists​

Método responsable de verificar si un archivo existe en una ruta específica de Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa del archivo que será verificado, incluyendo el nombre y la extensión.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

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

Esta acción nunca interrumpe la ejecución por no encontrar el archivo — usa el retorno exists para el control de flujo condicional.

Files.Download​

Método responsable de descargar un archivo de Google Drive a una ruta local.

js
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 obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • remotePath:String - espera la ruta completa del archivo en Google Drive, incluyendo el nombre y la extensión.
  • localPath:String - espera la ruta local donde el archivo será guardado, incluyendo el nombre del archivo.

Parámetros opcionales​

  • drive:String - espera el nombre del drive de origen. Predeterminado: "root" (Mi unidad).

Retorno​

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

Files.Upload​

Método responsable de cargar un archivo local a una ruta específica en Google Drive.

js
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 obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • remotePath:String - espera la ruta completa de destino en Google Drive, incluyendo el nombre y la extensión del archivo.
  • localPath:String - espera la ruta completa del archivo local que será enviado.

Parámetros opcionales​

  • drive:String - espera el nombre del drive de destino. Predeterminado: "root" (Mi unidad).
  • createFoldersIfNecessary:Boolean - cuando es true, crea automáticamente las carpetas de la ruta de destino que aún no existen. Si no se indica y la ruta de destino no existe, la ejecución se interrumpe con error.

Retorno​

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

Files.Rename​

Método responsable de renombrar un archivo existente en Google Drive.

js
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 obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa del archivo que será renombrado, incluyendo el nombre y la extensión.
  • newName:String - espera el nuevo nombre para el archivo, incluyendo la extensión.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

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

Files.Move​

Método responsable de mover un archivo a un nuevo destino, que puede estar en un drive diferente.

js
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 obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa del archivo que será movido, incluyendo el nombre y la extensión.
  • newParentPath:String - espera la ruta de la carpeta de destino.

Parámetros opcionales​

  • originDrive:String - espera el nombre del drive donde el archivo está actualmente. Predeterminado: "root" (Mi unidad).
  • destinationDrive:String - espera el nombre del drive hacia donde será movido el archivo. Predeterminado: el mismo drive de origen.
  • createFoldersIfNecessary:Boolean - cuando es true, crea automáticamente las carpetas de la ruta de destino que aún no existen. Si no se indica y el destino no existe, la ejecución se interrumpe con error.

Retorno​

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

Files.Trash​

Método responsable de mover un archivo a la papelera de Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa del archivo que será movido a la papelera, incluyendo el nombre y la extensión.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

Este método no tiene retorno. El archivo puede restaurarse usando el método Files.RestoreFromTrash, o eliminarse permanentemente con el método EmptyTrash.

Files.RestoreFromTrash​

Método responsable de restaurar un archivo de la papelera a su ubicación original en Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).
  • path:String - espera la ruta que tenía el archivo antes de ser movido a la papelera, incluyendo el nombre y la extensión. Aunque es técnicamente opcional (con el valor predeterminado "/"), este campo debe indicarse siempre para que el archivo correcto sea localizado y restaurado.

Retorno​

Este método no tiene retorno.

Folders.List​

Método responsable de listar las carpetas presentes en una ruta específica de Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta de la carpeta que será listada. Usa / para listar la raíz del drive.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

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

Folders.GetByName​

Método responsable de obtener la información detallada de una carpeta a partir de su ruta en Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa de la carpeta.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

js
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)

Si la carpeta no se encuentra, la ejecución se interrumpe con error.

Folders.Create​

Método responsable de crear una nueva carpeta en una ruta específica de Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa de la carpeta que será creada, incluyendo el nombre.

Parámetros opcionales​

  • drive:String - espera el nombre del drive donde será creada la carpeta. Predeterminado: "root" (Mi unidad).
  • recursive:Boolean - cuando es true, crea automáticamente todas las carpetas de la ruta que aún no existen. Si no se indica y alguna carpeta de la ruta no existe, la ejecución se interrumpe con error.

Retorno​

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

Folders.Exists​

Método responsable de verificar si una carpeta existe en una ruta específica de Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa de la carpeta que será verificada.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

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

Esta acción nunca interrumpe la ejecución por no encontrar la carpeta — usa el retorno exists para el control de flujo condicional.

Folders.Rename​

Método responsable de renombrar una carpeta existente en Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa de la carpeta que será renombrada.
  • newName:String - espera el nuevo nombre para la carpeta.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

Este método no tiene retorno.

Folders.Move​

Método responsable de mover una carpeta a un nuevo destino dentro de Google Drive.

js
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 obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa de la carpeta que será movida.
  • newParentPath:String - espera la ruta de la carpeta de destino.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).
  • createFoldersIfNecessary:Boolean - cuando es true, crea automáticamente las carpetas de la ruta de destino que aún no existen. Si no se indica y el destino no existe, la ejecución se interrumpe con error.

Retorno​

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

Folders.Trash​

Método responsable de mover una carpeta a la papelera de Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • path:String - espera la ruta completa de la carpeta que será movida a la papelera.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

Este método no tiene retorno. La carpeta puede restaurarse usando el método Folders.RestoreFromTrash, o eliminarse permanentemente con el método EmptyTrash.

Folders.RestoreFromTrash​

Método responsable de restaurar una carpeta de la papelera a su ubicación original en Google Drive.

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

Parámetros obligatorios​

  • driveConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • pathBeforeTrash:String - espera la ruta que tenía la carpeta antes de ser movida a la papelera.

Parámetros opcionales​

  • drive:String - espera el nombre del drive al que se accederá. Predeterminado: "root" (Mi unidad).

Retorno​

Este método no tiene retorno.