Class DriveApp

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
DriveApp

Permite que os scripts criem, localizem e modifiquem arquivos e pastas no Google Drive.

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Propriedades

PropriedadeTipoDescrição
AccessAccessUma enumeração que representa classes de usuários que podem acessar um arquivo ou uma pasta, além de todos os usuários individuais que receberam acesso explícito.
PermissionPermissionUma enumeração que representa as permissões concedidas aos usuários que podem acessar um arquivo ou uma pasta, além de qualquer usuário individual que tenha recebido acesso explícito.

Métodos

MétodoTipo de retornoBreve descrição
continueFileIterator(continuationToken)FileIteratorRetoma uma iteração de arquivo usando um token de continuação de um iterador anterior.
continueFolderIterator(continuationToken)FolderIteratorRetoma uma iteração de pasta usando um token de continuação de um iterador anterior.
createFile(blob)FileCria um arquivo na raiz do Drive do usuário com base em um determinado Blob de dados arbitrários.
createFile(name, content)FileCria um arquivo de texto na raiz do Drive do usuário com o nome e o conteúdo fornecidos.
createFile(name, content, mimeType)FileCria um arquivo na raiz do Drive do usuário com o nome, o conteúdo e o tipo MIME fornecidos.
createFolder(name)FolderCria uma pasta na raiz do Drive do usuário com o nome fornecido.
createShortcut(targetId)FileCria um atalho para o código do item do Drive informado e o retorna.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCria um atalho para o código do item do Drive e a chave de recurso retornados.
enforceSingleParent(value)voidAtiva ou desativa o comportamento applySingleParent para todas as chamadas que afetam o pai do item.
getFileById(id)FileRecebe o arquivo com o ID fornecido.
getFileByIdAndResourceKey(id, resourceKey)FileRecebe o arquivo com o ID e a chave de recurso fornecidos.
getFiles()FileIteratorRecebe uma coleção de todos os arquivos no Google Drive do usuário.
getFilesByName(name)FileIteratorRecebe um conjunto de todos os arquivos no Drive do usuário com o nome informado.
getFilesByType(mimeType)FileIteratorRecebe uma coleção de todos os arquivos no Drive do usuário que têm o tipo MIME especificado.
getFolderById(id)FolderRecebe a pasta com o ID informado.
getFolderByIdAndResourceKey(id, resourceKey)FolderRecebe a pasta com o ID e a chave de recurso fornecidos.
getFolders()FolderIteratorRecebe um conjunto de todas as pastas no Google Drive do usuário.
getFoldersByName(name)FolderIteratorRecebe um conjunto de todas as pastas no Drive do usuário com o nome informado.
getRootFolder()FolderRecebe a pasta na raiz do Drive do usuário.
getStorageLimit()IntegerRecebe o número de bytes que o usuário pode armazenar no Drive.
getStorageUsed()IntegerRecebe o número de bytes que o usuário está armazenando no Drive.
getTrashedFiles()FileIteratorRecebe uma coleção de todos os arquivos na lixeira do Google Drive do usuário.
getTrashedFolders()FolderIteratorRecebe um conjunto de todas as pastas na lixeira do Google Drive do usuário.
searchFiles(params)FileIteratorRecebe um conjunto de todos os arquivos no Drive do usuário que correspondem aos critérios de pesquisa especificados.
searchFolders(params)FolderIteratorRecebe um conjunto de todas as pastas no Drive do usuário que correspondem aos critérios de pesquisa especificados.

Documentação detalhada

continueFileIterator(continuationToken)

Retoma uma iteração de arquivo usando um token de continuação de um iterador anterior. Esse método é útil se o processamento de um iterador em uma execução exceder o tempo máximo de execução. Os tokens de continuação geralmente são válidos por uma semana.

Parâmetros

NomeTipoDescrição
continuationTokenStringum token de continuação de um iterador de arquivo anterior

Retornar

FileIterator: uma coleção de arquivos que permaneceu em um iterador anterior quando o token de continuação foi gerado.


continueFolderIterator(continuationToken)

Retoma uma iteração de pasta usando um token de continuação de um iterador anterior. Esse método é útil se o processamento de um iterador em uma execução exceder o tempo máximo de execução. Os tokens de continuação geralmente são válidos por uma semana.

Parâmetros

NomeTipoDescrição
continuationTokenStringum token de continuação de um iterador de pasta anterior

Retornar

FolderIterator: uma coleção de pastas que permaneceu em um iterador anterior quando o token de continuação foi gerado.


createFile(blob)

Cria um arquivo na raiz do Drive do usuário com base em um determinado Blob de dados arbitrários.

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.createFile(blob);

Parâmetros

NomeTipoDescrição
blobBlobSourceOs dados do novo arquivo.

Retornar

File: o novo arquivo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

createFile(name, content)

Cria um arquivo de texto na raiz do Drive do usuário com o nome e o conteúdo fornecidos. Uma exceção será gerada se content for maior que 50 MB.

// Create a text file with the content "Hello, world!"
DriveApp.createFile('New Text File', 'Hello, world!');

Parâmetros

NomeTipoDescrição
nameStringO nome do novo arquivo.
contentStringO conteúdo do novo arquivo.

Retornar

File: o novo arquivo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

createFile(name, content, mimeType)

Cria um arquivo na raiz do Drive do usuário com o nome, o conteúdo e o tipo MIME fornecidos. Uma exceção será gerada se content for maior que 10 MB.

// Create an HTML file with the content "Hello, world!"
DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Parâmetros

NomeTipoDescrição
nameStringO nome do novo arquivo.
contentStringO conteúdo do novo arquivo.
mimeTypeStringO tipo MIME do novo arquivo.

Retornar

File: o novo arquivo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

createFolder(name)

Cria uma pasta na raiz do Drive do usuário com o nome fornecido.

Parâmetros

NomeTipoDescrição
nameStringO nome da nova pasta.

Retornar

Folder: a nova pasta.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

createShortcut(targetId)

Cria um atalho para o código do item do Drive informado e o retorna.

Parâmetros

NomeTipoDescrição
targetIdStringO ID do arquivo ou da pasta de destino.

Retornar

File: o novo atalho.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Cria um atalho para o código do item do Drive e a chave de recurso retornados. Chaves de recurso são um parâmetro extra que precisa ser transmitido para acessar a pasta ou o arquivo de destino que foi compartilhado usando um link.

Parâmetros

NomeTipoDescrição
targetIdStringO ID da pasta ou do arquivo de destino.
targetResourceKeyStringChave de recurso da pasta ou do arquivo de destino.

Retornar

File: o novo atalho.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

enforceSingleParent(value)

Ativa ou desativa o comportamento applySingleParent para todas as chamadas que afetam o pai do item.

Veja mais detalhes no blog Como simplificar a estrutura de pastas e o compartilhamento de modelos do Google Drive.

Parâmetros

NomeTipoDescrição
valueBooleanO novo estado da sinalização applySingleParent.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFileById(id)

Recebe o arquivo com o ID fornecido. Uma exceção de script será gerada se o arquivo não existir ou se o usuário não tiver permissão para acessá-lo.

Parâmetros

NomeTipoDescrição
idStringo código do arquivo

Retornar

File: o arquivo com o ID fornecido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFileByIdAndResourceKey(id, resourceKey)

Recebe o arquivo com o ID e a chave de recurso fornecidos. Chaves de recurso são um parâmetro adicional que precisa ser transmitido para acessar arquivos que foram compartilhados usando um link.

Uma exceção de script será gerada se o arquivo não existir ou se o usuário não tiver permissão para acessá-lo.

Parâmetros

NomeTipoDescrição
idStringO ID do arquivo.
resourceKeyStringChave de recurso da pasta.

Retornar

File: o arquivo com o ID fornecido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFiles()

Recebe uma coleção de todos os arquivos no Google Drive do usuário.

Retornar

FileIterator: uma coleção de todos os arquivos no Google Drive do usuário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFilesByName(name)

Recebe um conjunto de todos os arquivos no Drive do usuário com o nome informado.

Parâmetros

NomeTipoDescrição
nameStringO nome dos arquivos a serem encontrados.

Retornar

FileIterator: uma coleção de todos os arquivos no Drive do usuário com o nome fornecido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFilesByType(mimeType)

Recebe uma coleção de todos os arquivos no Drive do usuário que têm o tipo MIME especificado.

Parâmetros

NomeTipoDescrição
mimeTypeStringO tipo MIME dos arquivos a serem encontrados.

Retornar

FileIterator: uma coleção de todos os arquivos no Drive do usuário que têm o tipo MIME especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFolderById(id)

Recebe a pasta com o ID informado. Uma exceção de script será gerada se a pasta não existir ou o usuário não tiver permissão para acessá-la.

Parâmetros

NomeTipoDescrição
idStringo ID da pasta

Retornar

Folder: a pasta com o ID fornecido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFolderByIdAndResourceKey(id, resourceKey)

Recebe a pasta com o ID e a chave de recurso fornecidos. Chaves de recurso são um parâmetro adicional que precisa ser transmitido para acessar pastas que foram compartilhadas usando um link.

Uma exceção de script será gerada se a pasta não existir ou o usuário não tiver permissão para acessá-la.

Parâmetros

NomeTipoDescrição
idStringO ID da pasta.
resourceKeyStringChave de recurso da pasta.

Retornar

Folder: a pasta com o ID fornecido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFolders()

Recebe um conjunto de todas as pastas no Google Drive do usuário.

Retornar

FolderIterator: um conjunto de todas as pastas no Google Drive do usuário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getFoldersByName(name)

Recebe um conjunto de todas as pastas no Drive do usuário com o nome informado.

Parâmetros

NomeTipoDescrição
nameStringO nome das pastas que você quer encontrar.

Retornar

FolderIterator: um conjunto de todas as pastas no Drive do usuário com o nome fornecido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getRootFolder()

Recebe a pasta na raiz do Drive do usuário.

Retornar

Folder: a pasta raiz do Drive do usuário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getStorageLimit()

Recebe o número de bytes que o usuário pode armazenar no Drive.

Retornar

Integer: o número de bytes que o usuário pode armazenar no Drive

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getStorageUsed()

Recebe o número de bytes que o usuário está armazenando no Drive.

Retornar

Integer: o número de bytes que o usuário está armazenando no Drive.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTrashedFiles()

Recebe uma coleção de todos os arquivos na lixeira do Google Drive do usuário.

Retornar

FileIterator: uma coleção de arquivos na lixeira.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTrashedFolders()

Recebe um conjunto de todas as pastas na lixeira do Google Drive do usuário.

Retornar

FolderIterator: uma coleção de pastas na lixeira

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

searchFiles(params)

Recebe um conjunto de todos os arquivos no Drive do usuário que correspondem aos critérios de pesquisa especificados. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. O argumento params é uma string de consulta que pode conter valores de string. Portanto, evite usar aspas corretamente (por exemplo, "title contains 'Gulliver\\'s Travels'" ou 'title contains "Gulliver\'s Travels"').

// Log the name of every file in the user's Drive that modified after February 28,
// 2013 whose name contains "untitled".
var files = DriveApp.searchFiles(
    'modifiedDate > "2013-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Parâmetros

NomeTipoDescrição
paramsStringSão os critérios de pesquisa, conforme detalhado na documentação do SDK do Google Drive.

Retornar

FileIterator: um conjunto de todos os arquivos no Drive do usuário que correspondem aos critérios de pesquisa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

searchFolders(params)

Recebe um conjunto de todas as pastas no Drive do usuário que correspondem aos critérios de pesquisa especificados. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. O argumento params é uma string de consulta que pode conter valores de string. Portanto, evite usar aspas corretamente (por exemplo, "title contains 'Gulliver\\'s Travels'" ou 'title contains "Gulliver\'s Travels"').

// Log the name of every folder in the user's Drive that you own and is starred.
var folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

Parâmetros

NomeTipoDescrição
paramsStringSão os critérios de pesquisa, conforme detalhado na documentação do SDK do Google Drive.

Retornar

FolderIterator: um conjunto de todas as pastas no Drive do usuário que correspondem aos critérios de pesquisa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Métodos obsoletos