Drive Service

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

Com esse serviço, os scripts podem criar, encontrar e modificar 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());
}

Classes

NomeBreve descrição
AccessUma 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.
DriveAppPermite que os scripts criem, localizem e modifiquem arquivos e pastas no Google Drive.
FileUm arquivo no Google Drive.
FileIteratorUm iterador que permite que os scripts iterem uma coleção potencialmente grande de arquivos.
FolderUma pasta no Google Drive.
FolderIteratorUm objeto que permite que os scripts iterem uma coleção potencialmente grande de pastas.
PermissionUma 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.
UserUm usuário associado a um arquivo no Google Drive.

Access

Propriedades

PropriedadeTipoDescrição
ANYONEEnumQualquer pessoa na Internet pode encontrar e acessar.
ANYONE_WITH_LINKEnumQualquer pessoa com o link pode acessar.
DOMAINEnumAs pessoas no seu domínio podem encontrar e acessar.
DOMAIN_WITH_LINKEnumAs pessoas no seu domínio que têm o link podem acessar.
PRIVATEEnumSomente pessoas com permissão explícita podem acessar.

DriveApp

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.

File

Métodos

MétodoTipo de retornoBreve descrição
addCommenter(emailAddress)FileAdicione o usuário em questão à lista de comentaristas do File.
addCommenter(user)FileAdicione o usuário em questão à lista de comentaristas do File.
addCommenters(emailAddresses)FileAdicione a matriz especificada de usuários à lista de comentaristas para o File.
addEditor(emailAddress)FileAdiciona o usuário especificado à lista de editores de File.
addEditor(user)FileAdiciona o usuário especificado à lista de editores de File.
addEditors(emailAddresses)FileAdiciona a matriz especificada de usuários à lista de editores de File.
addViewer(emailAddress)FileAdiciona o usuário especificado à lista de visualizadores do File.
addViewer(user)FileAdiciona o usuário especificado à lista de visualizadores do File.
addViewers(emailAddresses)FileAdiciona a matriz de usuários especificada à lista de visualizadores de File.
getAccess(email)PermissionRecebe a permissão concedida ao usuário especificado.
getAccess(user)PermissionRecebe a permissão concedida ao usuário especificado.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getDateCreated()DateRecebe a data em que o File foi criado.
getDescription()StringRecebe a descrição do File.
getDownloadUrl()StringRecebe o URL que pode ser usado para fazer o download do arquivo.
getEditors()User[]Recebe a lista de editores desse File.
getId()StringRecebe o ID da File.
getLastUpdated()DateRecebe a data da última atualização de File.
getMimeType()StringRecebe o Tipo MIME do arquivo.
getName()StringRecebe o nome da File.
getOwner()UserRecebe o proprietário do File.
getParents()FolderIteratorRecebe um conjunto de pastas que são pais imediatos do File.
getResourceKey()StringRecebe a chave de recurso do File necessária para acessar os itens que foram compartilhados usando um link.
getSecurityUpdateEligible()BooleanRecebe se este File está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando for compartilhada usando um link.
getSecurityUpdateEnabled()BooleanRecebe se esse File exige uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSharingAccess()AccessRecebe qual classe de usuários pode acessar o File, além de todos os usuários individuais que receberam acesso explicitamente.
getSharingPermission()PermissionRecebe a permissão concedida aos usuários que podem acessar o File, além de todos os usuários individuais que receberam acesso explicitamente.
getSize()IntegerRecebe o número de bytes usados para armazenar o File no Drive.
getTargetId()StringSe esse for um atalho, retorna o ID do item ao qual ele aponta.
getTargetMimeType()StringSe for um atalho, retornará o tipo MIME do item ao qual ele aponta.
getTargetResourceKey()StringSe o arquivo for um atalho, retornará a chave de recurso do item a que ele aponta.
getThumbnail()BlobRecebe uma imagem em miniatura para o arquivo, ou null se não houver miniatura.
getUrl()StringRecebe o URL que pode ser usado para abrir File em um app do Google, como o Drive ou o Documentos.
getViewers()User[]Recebe a lista de espectadores e comentaristas deste File.
isShareableByEditors()BooleanDetermina se os usuários com permissões para edição do File podem compartilhar com outros usuários ou mudar as permissões.
isStarred()BooleanDetermina se o File foi marcado com estrela no Google Drive do usuário.
isTrashed()BooleanDetermina se o File está na lixeira do Drive do usuário.
makeCopy()FileCria uma cópia do arquivo.
makeCopy(destination)FileCria uma cópia do arquivo no diretório de destino.
makeCopy(name)FileCria uma cópia do arquivo e nomeia-o com o nome fornecido.
makeCopy(name, destination)FileCria uma cópia do arquivo no diretório de destino e o nomeia com o nome fornecido.
moveTo(destination)FileMove este item para a pasta de destino fornecida.
removeCommenter(emailAddress)FileRemove o usuário especificado da lista de comentaristas do File.
removeCommenter(user)FileRemove o usuário especificado da lista de comentaristas do File.
removeEditor(emailAddress)FileRemove o usuário especificado da lista de editores para o File.
removeEditor(user)FileRemove o usuário especificado da lista de editores para o File.
removeViewer(emailAddress)FileRemove o usuário em questão da lista de leitores e comentaristas do File.
removeViewer(user)FileRemove o usuário em questão da lista de leitores e comentaristas do File.
revokePermissions(user)FileRevoga o acesso ao File concedido ao usuário especificado.
revokePermissions(user)FileRevoga o acesso ao File concedido ao usuário especificado.
setContent(content)FileSubstitui o conteúdo do arquivo por uma determinada substituição
setDescription(description)FileDefine a descrição do File.
setName(name)FileDefine o nome da File.
setOwner(emailAddress)FileMuda o proprietário do File.
setOwner(user)FileMuda o proprietário do File.
setSecurityUpdateEnabled(enabled)FileDefine se o File requer uma chave de recurso para acesso quando ele for compartilhado usando um link.
setShareableByEditors(shareable)FileDefine se os usuários com permissões para edição do File podem compartilhar com outros usuários ou alterar as permissões.
setSharing(accessType, permissionType)FileDefine qual classe de usuários pode acessar o File e quais permissões esses usuários recebem, além de todos os usuários individuais que receberam acesso explicitamente.
setStarred(starred)FileDefine se o File é marcado com estrela no Google Drive do usuário.
setTrashed(trashed)FileDefine se o File está na lixeira do Drive do usuário.

FileIterator

Métodos

MétodoTipo de retornoBreve descrição
getContinuationToken()StringRecebe um token que pode ser usado para retomar essa iteração posteriormente.
hasNext()BooleanDetermina se chamar next() retornará um item.
next()FileRecebe o próximo item na coleção de arquivos ou pastas.

Folder

Métodos

MétodoTipo de retornoBreve descrição
addEditor(emailAddress)FolderAdiciona o usuário especificado à lista de editores de Folder.
addEditor(user)FolderAdiciona o usuário especificado à lista de editores de Folder.
addEditors(emailAddresses)FolderAdiciona a matriz especificada de usuários à lista de editores de Folder.
addViewer(emailAddress)FolderAdiciona o usuário especificado à lista de visualizadores do Folder.
addViewer(user)FolderAdiciona o usuário especificado à lista de visualizadores do Folder.
addViewers(emailAddresses)FolderAdiciona a matriz de usuários especificada à lista de visualizadores de Folder.
createFile(blob)FileCria um arquivo na pasta atual com base em um determinado Blob de dados arbitrários.
createFile(name, content)FileCria um arquivo de texto na pasta atual com o nome e o conteúdo fornecidos.
createFile(name, content, mimeType)FileCria um arquivo na pasta atual com o nome, o conteúdo e o tipo MIME fornecidos.
createFolder(name)FolderCria uma pasta na pasta atual 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.
getAccess(email)PermissionRecebe a permissão concedida ao usuário especificado.
getAccess(user)PermissionRecebe a permissão concedida ao usuário especificado.
getDateCreated()DateRecebe a data em que o Folder foi criado.
getDescription()StringRecebe a descrição do Folder.
getEditors()User[]Recebe a lista de editores desse Folder.
getFiles()FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual.
getFilesByName(name)FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual e tem o nome informado.
getFilesByType(mimeType)FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual e tem o tipo MIME fornecido.
getFolders()FolderIteratorRecebe um conjunto de todas as pastas filhas da pasta atual.
getFoldersByName(name)FolderIteratorRecebe um conjunto de todas as pastas filhas da pasta atual e tem o nome fornecido.
getId()StringRecebe o ID da Folder.
getLastUpdated()DateRecebe a data da última atualização de Folder.
getName()StringRecebe o nome da Folder.
getOwner()UserRecebe o proprietário do Folder.
getParents()FolderIteratorRecebe um conjunto de pastas que são pais imediatos do Folder.
getResourceKey()StringRecebe a chave de recurso do Folder necessária para acessar os itens que foram compartilhados usando um link.
getSecurityUpdateEligible()BooleanRecebe se este Folder está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando for compartilhada usando um link.
getSecurityUpdateEnabled()BooleanRecebe se esse Folder exige uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSharingAccess()AccessRecebe qual classe de usuários pode acessar o Folder, além de todos os usuários individuais que receberam acesso explicitamente.
getSharingPermission()PermissionRecebe a permissão concedida aos usuários que podem acessar o Folder, além de todos os usuários individuais que receberam acesso explicitamente.
getSize()IntegerRecebe o número de bytes usados para armazenar o Folder no Drive.
getUrl()StringRecebe o URL que pode ser usado para abrir Folder em um app do Google, como o Drive ou o Documentos.
getViewers()User[]Recebe a lista de espectadores e comentaristas deste Folder.
isShareableByEditors()BooleanDetermina se os usuários com permissões para edição do Folder podem compartilhar com outros usuários ou mudar as permissões.
isStarred()BooleanDetermina se o Folder foi marcado com estrela no Google Drive do usuário.
isTrashed()BooleanDetermina se o Folder está na lixeira do Drive do usuário.
moveTo(destination)FolderMove este item para a pasta de destino fornecida.
removeEditor(emailAddress)FolderRemove o usuário especificado da lista de editores para o Folder.
removeEditor(user)FolderRemove o usuário especificado da lista de editores para o Folder.
removeViewer(emailAddress)FolderRemove o usuário em questão da lista de leitores e comentaristas do Folder.
removeViewer(user)FolderRemove o usuário em questão da lista de leitores e comentaristas do Folder.
revokePermissions(user)FolderRevoga o acesso ao Folder concedido ao usuário especificado.
revokePermissions(user)FolderRevoga o acesso ao Folder concedido ao usuário especificado.
searchFiles(params)FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual e corresponde aos critérios de pesquisa fornecidos.
searchFolders(params)FolderIteratorRecebe um conjunto de todas as pastas filhas da pasta atual e corresponde aos critérios de pesquisa especificados.
setDescription(description)FolderDefine a descrição do Folder.
setName(name)FolderDefine o nome da Folder.
setOwner(emailAddress)FolderMuda o proprietário do Folder.
setOwner(user)FolderMuda o proprietário do Folder.
setSecurityUpdateEnabled(enabled)FolderDefine se o Folder requer uma chave de recurso para acesso quando ele for compartilhado usando um link.
setShareableByEditors(shareable)FolderDefine se os usuários com permissões para edição do Folder podem compartilhar com outros usuários ou alterar as permissões.
setSharing(accessType, permissionType)FolderDefine qual classe de usuários pode acessar o Folder e quais permissões esses usuários recebem, além de todos os usuários individuais que receberam acesso explicitamente.
setStarred(starred)FolderDefine se o Folder é marcado com estrela no Google Drive do usuário.
setTrashed(trashed)FolderDefine se o Folder está na lixeira do Drive do usuário.

FolderIterator

Métodos

MétodoTipo de retornoBreve descrição
getContinuationToken()StringRecebe um token que pode ser usado para retomar essa iteração posteriormente.
hasNext()BooleanDetermina se chamar next() retornará um item.
next()FolderRecebe o próximo item na coleção de arquivos ou pastas.

Permission

Propriedades

PropriedadeTipoDescrição
VIEWEnumOs usuários que podem acessar o arquivo ou a pasta só podem vê-lo ou copiá-lo.
EDITEnumOs usuários que podem acessar o arquivo ou a pasta podem editá-lo.
COMMENTEnumOs usuários que podem acessar o arquivo ou a pasta só poderão ver, copiar ou comentar o item.
OWNEREnumO usuário é o proprietário do arquivo ou da pasta.
ORGANIZEREnumUsuários que podem organizar arquivos e pastas em um drive compartilhado.
FILE_ORGANIZEREnumUsuários que podem editar, mover e mover conteúdo para um drive compartilhado.
NONEEnumO usuário não tem permissões para o arquivo ou a pasta.

User

Métodos

MétodoTipo de retornoBreve descrição
getDomain()StringRecebe o nome de domínio associado à conta do usuário.
getEmail()StringRecebe o endereço de e-mail do usuário.
getName()StringRecebe o nome do usuário.
getPhotoUrl()StringRecebe o URL da foto do usuário.