Com esse serviço, os scripts podem criar, encontrar e modificar arquivos e pastas no Google Drive.
Se o script usar um projeto padrão do Cloud em vez de um projeto padrão, você precisará ativar manualmente a API Drive. No projeto padrão do Cloud, ative a API Drive:
O exemplo de código a seguir mostra como registrar os nomes de cada arquivo na pasta Meu Drive do usuário:// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
var file = files.next();
console.log(file.getName());
}
Aulas
Nome | Breve descrição |
---|---|
Access | Um enum que representa classes de usuários que podem acessar um arquivo ou pasta, além de quaisquer usuários individuais que receberam acesso explícito. |
DriveApp | Permite que os scripts criem, localizem e modifiquem arquivos e pastas no Google Drive. |
File | É um arquivo no Google Drive. |
FileIterator | Um iterador que permite que os scripts iterem em uma coleção potencialmente grande de arquivos. |
Folder | Uma pasta no Google Drive. |
FolderIterator | Um objeto que permite que os scripts façam iterações em uma coleção potencialmente grande de pastas. |
Permission | Um enum que representa as permissões concedidas a usuários que podem acessar um arquivo ou pasta, além de qualquer usuário individual que tenha recebido acesso explicitamente. |
User | Um usuário associado a um arquivo no Google Drive. |
Access
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
ANYONE | Enum | Qualquer pessoa na Internet pode encontrar e acessar. |
ANYONE_WITH_LINK | Enum | Qualquer pessoa com o link pode acessar. |
DOMAIN | Enum | As pessoas no seu domínio podem encontrar e acessar. |
DOMAIN_WITH_LINK | Enum | As pessoas no seu domínio que têm o link podem acessar. |
PRIVATE | Enum | Somente pessoas com permissão explícita podem acessar. |
DriveApp
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
Access | Access | Um enum que representa classes de usuários que podem acessar um arquivo ou pasta, além de quaisquer usuários individuais que receberam acesso explícito. |
Permission | Permission | Um enum que representa as permissões concedidas a usuários que podem acessar um arquivo ou pasta, além de qualquer usuário individual que tenha recebido acesso explicitamente. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Retoma uma iteração de arquivo usando um token de continuação de um iterador anterior. |
continueFolderIterator(continuationToken) | FolderIterator | Retoma uma iteração de pasta usando um token de continuação de um iterador anterior. |
createFile(blob) | File | Cria um arquivo na raiz do Drive do usuário com base em um determinado Blob de dados arbitrários. |
createFile(name, content) | File | Cria um arquivo de texto na raiz do Drive do usuário com o nome e o conteúdo fornecidos. |
createFile(name, content, mimeType) | File | Cria um arquivo na raiz do Drive do usuário com o nome, o conteúdo e o tipo MIME especificados. |
createFolder(name) | Folder | Cria uma pasta na raiz do Drive do usuário com o nome informado. |
createShortcut(targetId) | File | Cria e retorna um atalho para o código do item do Drive fornecido. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Cria e retorna um atalho para o ID do item do Drive e a chave de recurso fornecidos. |
enforceSingleParent(value) | void | Ativa ou desativa o comportamento de aplicação de SingleParent para todas as chamadas que afetam os pais de itens. |
getFileById(id) | File | Recebe o arquivo com o ID fornecido. |
getFileByIdAndResourceKey(id, resourceKey) | File | Recebe o arquivo com o ID e a chave de recurso fornecidos. |
getFiles() | FileIterator | Extrai uma coleção de todos os arquivos no Google Drive do usuário. |
getFilesByName(name) | FileIterator | Extrai um conjunto de todos os arquivos no Google Drive do usuário com o nome indicado. |
getFilesByType(mimeType) | FileIterator | Extrai um conjunto de todos os arquivos no Drive do usuário que têm o tipo MIME especificado. |
getFolderById(id) | Folder | Extrai a pasta com o ID fornecido. |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | Recebe a pasta com o ID e a chave de recurso fornecidos. |
getFolders() | FolderIterator | Extrai uma coleção de todas as pastas no Drive do usuário. |
getFoldersByName(name) | FolderIterator | Extrai uma coleção de todas as pastas no Drive do usuário com o nome indicado. |
getRootFolder() | Folder | Extrai a pasta na raiz do Drive do usuário. |
getStorageLimit() | Integer | Mostra o número de bytes que o usuário pode armazenar no Drive. |
getStorageUsed() | Integer | Extrai o número de bytes que o usuário está armazenando no Drive. |
getTrashedFiles() | FileIterator | Extrai uma coleção de todos os arquivos na lixeira do Drive do usuário. |
getTrashedFolders() | FolderIterator | Extrai uma coleção de todas as pastas na lixeira do Drive do usuário. |
searchFiles(params) | FileIterator | Extrai um conjunto de todos os arquivos no Drive do usuário que correspondem aos critérios de pesquisa fornecidos. |
searchFolders(params) | FolderIterator | Extrai um conjunto de todas as pastas no Drive do usuário que correspondem aos critérios de pesquisa fornecidos. |
File
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addCommenter(emailAddress) | File | Adiciona o usuário especificado à lista de comentaristas de File . |
addCommenter(user) | File | Adiciona o usuário especificado à lista de comentaristas de File . |
addCommenters(emailAddresses) | File | Adicione a matriz de usuários especificada à lista de comentaristas de File . |
addEditor(emailAddress) | File | Adiciona o usuário especificado à lista de editores do File . |
addEditor(user) | File | Adiciona o usuário especificado à lista de editores do File . |
addEditors(emailAddresses) | File | Adiciona a matriz de usuários especificada à lista de editores do File . |
addViewer(emailAddress) | File | Adiciona o usuário especificado à lista de leitores do File . |
addViewer(user) | File | Adiciona o usuário especificado à lista de leitores do File . |
addViewers(emailAddresses) | File | Adiciona a matriz de usuários especificada à lista de leitores para o File . |
getAccess(email) | Permission | Recebe a permissão concedida ao usuário em questão. |
getAccess(user) | Permission | Recebe a permissão concedida ao usuário em questão. |
getAs(contentType) | Blob | Retorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getDateCreated() | Date | Extrai a data em que o File foi criado. |
getDescription() | String | Recebe a descrição do File . |
getDownloadUrl() | String | Extrai o URL que pode ser usado para fazer o download do arquivo. |
getEditors() | User[] | Recebe a lista de editores deste File . |
getId() | String | Recebe o ID do File . |
getLastUpdated() | Date | Recebe a data da última atualização do File . |
getMimeType() | String | Recebe o tipo MIME do arquivo. |
getName() | String | Recebe o nome do File . |
getOwner() | User | Extrai o proprietário do arquivo. |
getParents() | FolderIterator | Recebe uma coleção de pastas que são pais imediatos de File . |
getResourceKey() | String | Recebe a chave de recurso do File que é necessária para acessar itens que
foram compartilhados usando um link. |
getSecurityUpdateEligible() | Boolean | Descobre se este File está qualificado para aplicar a atualização de segurança que
requer uma chave de recurso para acesso quando ele é compartilhado usando um link. |
getSecurityUpdateEnabled() | Boolean | Descobre se este File requer uma chave de recurso para acesso quando ele é
compartilhado usando um link. |
getSharingAccess() | Access | Extrai qual classe de usuários pode acessar o File , além de todos os usuários
individuais que receberam acesso explicitamente. |
getSharingPermission() | Permission | Recebe a permissão concedida aos usuários que podem acessar o File ,
além de qualquer usuário individual que tenha recebido acesso explicitamente. |
getSize() | Integer | Recebe o número de bytes usados para armazenar o File no Drive. |
getTargetId() | String | Se for um atalho, retorna o código do item para o qual ele aponta. |
getTargetMimeType() | String | Se for um atalho, retorna o tipo MIME do item para o qual ele aponta. |
getTargetResourceKey() | String | Se o arquivo for um atalho, retorna a chave de recurso do item para o qual ele aponta. |
getThumbnail() | Blob | Recebe uma imagem em miniatura para o arquivo ou null se não houver uma miniatura. |
getUrl() | String | Recebe o URL que pode ser usado para abrir o File em um Google app, como o Drive ou o Documentos. |
getViewers() | User[] | Recebe a lista de leitores e comentadores deste File . |
isShareableByEditors() | Boolean | Determina se os usuários com permissões para edição no File podem
compartilhar com outros usuários ou alterar as permissões. |
isStarred() | Boolean | Determina se o File foi marcado com estrela no Drive do usuário. |
isTrashed() | Boolean | Determina se o File está na lixeira do Drive do usuário. |
makeCopy() | File | Cria uma cópia do arquivo. |
makeCopy(destination) | File | Cria uma cópia do arquivo no diretório de destino. |
makeCopy(name) | File | Cria uma cópia do arquivo e a nomeia com o nome fornecido. |
makeCopy(name, destination) | File | Cria uma cópia do arquivo no diretório de destino e a nomeia com o nome fornecido. |
moveTo(destination) | File | Move o item para a pasta de destino fornecida. |
removeCommenter(emailAddress) | File | Remove o usuário especificado da lista de comentaristas do File . |
removeCommenter(user) | File | Remove o usuário especificado da lista de comentaristas do File . |
removeEditor(emailAddress) | File | Remove o usuário especificado da lista de editores do File . |
removeEditor(user) | File | Remove o usuário especificado da lista de editores do File . |
removeViewer(emailAddress) | File | Remove o usuário especificado da lista de leitores e comentadores do File . |
removeViewer(user) | File | Remove o usuário especificado da lista de leitores e comentadores do File . |
revokePermissions(emailAddress) | File | Revoga o acesso ao File concedido ao usuário especificado. |
revokePermissions(user) | File | Revoga o acesso ao File concedido ao usuário especificado. |
setContent(content) | File | Substitui o conteúdo do arquivo por uma substituição. |
setDescription(description) | File | Define a descrição do File . |
setName(name) | File | Define o nome do File . |
setOwner(emailAddress) | File | Muda o proprietário de File . |
setOwner(user) | File | Muda o proprietário de File . |
setSecurityUpdateEnabled(enabled) | File | Define se o File requer uma chave de recurso para acesso quando é
compartilhado por um link. |
setShareableByEditors(shareable) | File | Define se os usuários com permissões para edição no File têm permissão para compartilhar
com outros usuários ou alterar as permissões. |
setSharing(accessType, permissionType) | File | Define qual classe de usuários pode acessar o File e quais permissões
eles recebem, além de usuários individuais que receberam acesso explicitamente. |
setStarred(starred) | File | Define se o File está marcado com estrela no Drive do usuário. |
setTrashed(trashed) | File | Define se o File está na lixeira do Drive do usuário. |
FileIterator
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getContinuationToken() | String | Recebe um token que pode ser usado para retomar essa iteração mais tarde. |
hasNext() | Boolean | Determina se chamar next() retornará um item. |
next() | File | Acessa o próximo item da coleção de arquivos ou pastas. |
Folder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addEditor(emailAddress) | Folder | Adiciona o usuário especificado à lista de editores do Folder . |
addEditor(user) | Folder | Adiciona o usuário especificado à lista de editores do Folder . |
addEditors(emailAddresses) | Folder | Adiciona a matriz de usuários especificada à lista de editores do Folder . |
addViewer(emailAddress) | Folder | Adiciona o usuário especificado à lista de leitores do Folder . |
addViewer(user) | Folder | Adiciona o usuário especificado à lista de leitores do Folder . |
addViewers(emailAddresses) | Folder | Adiciona a matriz de usuários especificada à lista de leitores para o Folder . |
createFile(blob) | File | Cria um arquivo na pasta atual com base em um determinado Blob de dados arbitrários. |
createFile(name, content) | File | Cria um arquivo de texto na pasta atual com o nome e o conteúdo fornecidos. |
createFile(name, content, mimeType) | File | Cria um arquivo na pasta atual com o nome, o conteúdo e o tipo MIME fornecidos. |
createFolder(name) | Folder | Cria uma pasta na pasta atual com o nome informado. |
createShortcut(targetId) | File | Cria e retorna um atalho para o código do item do Drive fornecido. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Cria e retorna um atalho para o ID do item do Drive e a chave de recurso fornecidos. |
getAccess(email) | Permission | Recebe a permissão concedida ao usuário em questão. |
getAccess(user) | Permission | Recebe a permissão concedida ao usuário em questão. |
getDateCreated() | Date | Extrai a data em que o Folder foi criado. |
getDescription() | String | Recebe a descrição do Folder . |
getEditors() | User[] | Recebe a lista de editores deste Folder . |
getFiles() | FileIterator | Extrai uma coleção de todos os arquivos filhos da pasta atual. |
getFilesByName(name) | FileIterator | Extrai uma coleção de todos os arquivos filhos da pasta atual e que têm o nome indicado. |
getFilesByType(mimeType) | FileIterator | Recebe uma coleção de todos os arquivos filhos da pasta atual e que têm o tipo MIME especificado. |
getFolders() | FolderIterator | Extrai uma coleção de todas as pastas filhas da pasta atual. |
getFoldersByName(name) | FolderIterator | Extrai uma coleção de todas as pastas filhas da pasta atual e que têm o nome indicado. |
getId() | String | Recebe o ID do Folder . |
getLastUpdated() | Date | Recebe a data da última atualização do Folder . |
getName() | String | Recebe o nome do Folder . |
getOwner() | User | Recebe o proprietário deste Folder . |
getParents() | FolderIterator | Recebe uma coleção de pastas que são pais imediatos de Folder . |
getResourceKey() | String | Recebe a chave de recurso do Folder que é necessária para acessar itens que
foram compartilhados usando um link. |
getSecurityUpdateEligible() | Boolean | Descobre se este Folder está qualificado para aplicar a atualização de segurança que
requer uma chave de recurso para acesso quando ele é compartilhado usando um link. |
getSecurityUpdateEnabled() | Boolean | Descobre se este Folder requer uma chave de recurso para acesso quando ele é
compartilhado usando um link. |
getSharingAccess() | Access | Extrai qual classe de usuários pode acessar o Folder , além de todos os usuários
individuais que receberam acesso explicitamente. |
getSharingPermission() | Permission | Recebe a permissão concedida aos usuários que podem acessar o Folder ,
além de qualquer usuário individual que tenha recebido acesso explicitamente. |
getSize() | Integer | Recebe o número de bytes usados para armazenar o Folder no Drive. |
getUrl() | String | Recebe o URL que pode ser usado para abrir o Folder em um Google app, como o Drive ou o Documentos. |
getViewers() | User[] | Recebe a lista de leitores e comentadores deste Folder . |
isShareableByEditors() | Boolean | Determina se os usuários com permissões para edição no Folder podem
compartilhar com outros usuários ou alterar as permissões. |
isStarred() | Boolean | Determina se o Folder foi marcado com estrela no Drive do usuário. |
isTrashed() | Boolean | Determina se o Folder está na lixeira do Drive do usuário. |
moveTo(destination) | Folder | Move o item para a pasta de destino fornecida. |
removeEditor(emailAddress) | Folder | Remove o usuário especificado da lista de editores do Folder . |
removeEditor(user) | Folder | Remove o usuário especificado da lista de editores do Folder . |
removeViewer(emailAddress) | Folder | Remove o usuário especificado da lista de leitores e comentadores do Folder . |
removeViewer(user) | Folder | Remove o usuário especificado da lista de leitores e comentadores do Folder . |
revokePermissions(emailAddress) | Folder | Revoga o acesso ao Folder concedido ao usuário especificado. |
revokePermissions(user) | Folder | Revoga o acesso ao Folder concedido ao usuário especificado. |
searchFiles(params) | FileIterator | Recebe uma coleção de todos os arquivos filhos da pasta atual e correspondem aos critérios de pesquisa fornecidos. |
searchFolders(params) | FolderIterator | Recebe uma coleção de todas as pastas filhas da pasta atual e correspondem aos critérios de pesquisa fornecidos. |
setDescription(description) | Folder | Define a descrição do Folder . |
setName(name) | Folder | Define o nome do Folder . |
setOwner(emailAddress) | Folder | Muda o proprietário de Folder . |
setOwner(user) | Folder | Muda o proprietário de Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Define se o Folder requer uma chave de recurso para acesso quando é
compartilhado por um link. |
setShareableByEditors(shareable) | Folder | Define se os usuários com permissões para edição no Folder têm permissão para compartilhar
com outros usuários ou alterar as permissões. |
setSharing(accessType, permissionType) | Folder | Define qual classe de usuários pode acessar o Folder e quais permissões
eles recebem, além de usuários individuais que receberam acesso explicitamente. |
setStarred(starred) | Folder | Define se o Folder está marcado com estrela no Drive do usuário. |
setTrashed(trashed) | Folder | Define se o Folder está na lixeira do Drive do usuário. |
FolderIterator
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getContinuationToken() | String | Recebe um token que pode ser usado para retomar essa iteração mais tarde. |
hasNext() | Boolean | Determina se chamar next() retornará um item. |
next() | Folder | Acessa o próximo item da coleção de arquivos ou pastas. |
Permission
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
VIEW | Enum | Os usuários com permissão para acessar o arquivo ou a pasta só poderão ver ou copiar o item. |
EDIT | Enum | Os usuários com permissão para acessar o arquivo ou a pasta podem editá-lo. |
COMMENT | Enum | Os usuários com permissão para acessar o arquivo ou a pasta só poderão ver, copiar ou comentar o item. |
OWNER | Enum | O usuário é proprietário do arquivo ou da pasta. |
ORGANIZER | Enum | Usuários que podem organizar arquivos e pastas em um drive compartilhado. |
FILE_ORGANIZER | Enum | Usuários que podem editar, enviar para a lixeira e mover conteúdo em um drive compartilhado. |
NONE | Enum | O usuário não tem permissões para o arquivo ou a pasta. |
User
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDomain() | String | Acessa o nome de domínio associado à conta do usuário. |
getEmail() | String | Extrai o endereço de e-mail do usuário. |
getName() | String | Extrai o nome do usuário. |
getPhotoUrl() | String | Extrai o URL da foto do usuário. |