Esta página foi traduzida pela API Cloud Translation.

Drive Service

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());
}

Observação:os administradores de domínios do Google Workspace podem desativar o SDK do Drive, o que impede que os usuários instalem e usem apps do Google Drive. Essa configuração também impedirá que os usuários usem scripts do Apps Script, apps da Web e complementos que usam o serviço do Drive ou serviço avançado do Drive, mesmo que o complemento ou app da Web em questão tenha sido instalado antes da desativação do SDK do Drive pelo administrador.

No entanto, se um complemento que usa o serviço do Drive for publicado para instalação em todo o domínio e instalado pelo administrador para alguns ou todos os usuários no domínio ou para qualquer Apps Script que tenha o cliente OAuth permitido pelo administrador do domínio, os complementos vão funcionar para esses usuários mesmo que o SDK do Drive esteja desativado no domínio.

Classes

Nome	Breve descrição
`Access`	Uma enumeração que representa classes de usuários que podem acessar um arquivo ou uma pasta, além de cada usuário que recebeu acesso explicitamente.
`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 uma coleção potencialmente grande de arquivos.
`Folder`	Uma pasta no Google Drive
`FolderIterator`	Um objeto que permite que os scripts iterem uma coleção potencialmente grande de pastas.
`Permission`	Uma 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 recebeu 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`	Uma enumeração que representa classes de usuários que podem acessar um arquivo ou uma pasta, além de cada usuário que recebeu acesso explicitamente.
`Permission`	`Permission`	Uma 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 recebeu 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 um atalho para o código do item do Drive fornecido e o retorna.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Cria um atalho para o código do item do Google Drive e a chave de recurso, e os retorna.
`enforceSingleParent(value)`	`void`	Ativa ou desativa o comportamento applySingleParent para todas as chamadas que afetam os pais do item.
`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`	Recebe um conjunto de todos os arquivos no Drive do usuário.
`getFilesByName(name)`	`FileIterator`	Recebe um conjunto de todos os arquivos no Drive do usuário que têm o nome informado.
`getFilesByType(mimeType)`	`FileIterator`	Recebe um conjunto de todos os arquivos no Drive do usuário que têm o tipo MIME fornecido.
`getFolderById(id)`	`Folder`	Recebe a pasta com o ID fornecido.
`getFolderByIdAndResourceKey(id, resourceKey)`	`Folder`	Recebe a pasta com o ID e a chave de recurso fornecidos.
`getFolders()`	`FolderIterator`	Recebe um conjunto de todas as pastas no Drive do usuário.
`getFoldersByName(name)`	`FolderIterator`	Recebe um conjunto de todas as pastas no Drive do usuário que têm o nome informado.
`getRootFolder()`	`Folder`	Acessa a pasta na raiz do Drive do usuário.
`getStorageLimit()`	`Integer`	Recebe o número de bytes que o usuário pode armazenar no Drive.
`getStorageUsed()`	`Integer`	Recebe o número de bytes que o usuário está armazenando no Drive.
`getTrashedFiles()`	`FileIterator`	Coleta todos os arquivos na lixeira do Drive do usuário.
`getTrashedFolders()`	`FolderIterator`	Recebe um conjunto de todas as pastas na lixeira do Drive do usuário.
`searchFiles(params)`	`FileIterator`	Recebe um conjunto de todos os arquivos no Drive do usuário que correspondem aos critérios de pesquisa fornecidos.
`searchFolders(params)`	`FolderIterator`	Recebe um conjunto de todas as pastas no Drive do usuário que correspondem aos critérios de pesquisa especificados.

`File`

Métodos

Método	Tipo de retorno	Breve descrição
`addCommenter(emailAddress)`	`File`	Adiciona o usuário especificado à lista de comentadores de `File`.
`addCommenter(user)`	`File`	Adiciona o usuário especificado à lista de comentadores de `File`.
`addCommenters(emailAddresses)`	`File`	Adiciona a matriz fornecida de usuários à lista de comentadores 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 visualizadores para o `File`.
`addViewer(user)`	`File`	Adiciona o usuário especificado à lista de visualizadores para o `File`.
`addViewers(emailAddresses)`	`File`	Adiciona a matriz de usuários especificada à lista de visualizadores para o `File`.
`getAccess(email)`	`Permission`	Recebe a permissão concedida ao usuário especificado.
`getAccess(user)`	`Permission`	Recebe a permissão concedida ao usuário especificado.
`getAs(contentType)`	`Blob`	Retorna 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`	Recebe a data em que o `File` foi criado.
`getDescription()`	`String`	Recebe a descrição do `File`.
`getDownloadUrl()`	`String`	Recebe o URL que pode ser usado para fazer o download do arquivo.
`getEditors()`	`User[]`	Recebe a lista de editores para esse `File`.
`getId()`	`String`	Recebe o ID de `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`	Recebe o proprietário do arquivo.
`getParents()`	`FolderIterator`	Recebe um conjunto de pastas mães imediatas do `File`.
`getResourceKey()`	`String`	Recebe a chave de recurso do `File` que é necessária para acessar os itens que foram compartilhados usando um link.
`getSecurityUpdateEligible()`	`Boolean`	Determina se `File` está qualificado para aplicar a atualização de segurança que exige uma chave de recurso para acesso quando ela é compartilhada usando um link.
`getSecurityUpdateEnabled()`	`Boolean`	Recebe se essa `File` exige uma chave de recurso para acesso quando é compartilhada usando um link.
`getSharingAccess()`	`Access`	Recebe 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 a usuários que podem acessar o `File`, além de todos os usuários individuais que receberam acesso explicitamente.
`getSize()`	`Integer`	Recebe o número de bytes usados para armazenar o `File` no Drive.
`getTargetId()`	`String`	Se este for um atalho, retornará o ID do item para o qual ele aponta.
`getTargetMimeType()`	`String`	Se este for um atalho, retornará o tipo MIME do item para o qual ele aponta.
`getTargetResourceKey()`	`String`	Se o arquivo for um atalho, a chave de recurso do item para o qual ela aponta será retornada.
`getThumbnail()`	`Blob`	Recebe uma imagem em miniatura para o arquivo ou `null`, se não houver miniatura.
`getUrl()`	`String`	Recebe o URL que pode ser usado para abrir o `File` em um app do Google, como o Drive ou o Documentos.
`getViewers()`	`User[]`	Recebe a lista de leitores e comentaristas desta `File`.
`isShareableByEditors()`	`Boolean`	Determina se os usuários com permissões para edição da `File` podem compartilhar com outros usuários ou mudar 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 nomeia com o nome fornecido.
`makeCopy(name, destination)`	`File`	Cria uma cópia do arquivo no diretório de destino com o nome fornecido.
`moveTo(destination)`	`File`	Move esse item para a pasta de destino fornecida.
`removeCommenter(emailAddress)`	`File`	Remove o usuário da lista de comentaristas da `File`.
`removeCommenter(user)`	`File`	Remove o usuário da lista de comentaristas da `File`.
`removeEditor(emailAddress)`	`File`	Remove o usuário em questão da lista de editores do `File`.
`removeEditor(user)`	`File`	Remove o usuário em questão da lista de editores do `File`.
`removeViewer(emailAddress)`	`File`	Remove o usuário da lista de leitores e comentaristas da `File`.
`removeViewer(user)`	`File`	Remove o usuário da lista de leitores e comentaristas da `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 determinada substituição.
`setDescription(description)`	`File`	Define a descrição de `File`.
`setName(name)`	`File`	Define o nome do `File`.
`setOwner(emailAddress)`	`File`	Altera o proprietário do `File`.
`setOwner(user)`	`File`	Altera o proprietário do `File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Define se o `File` exige uma chave de recurso para acesso quando for compartilhado usando um link.
`setShareableByEditors(shareable)`	`File`	Define se os usuários com permissão para edição a `File` têm permissão para compartilhar com outros usuários ou mudar 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 qualquer usuário individual que tenha recebido explicitamente o acesso.
`setStarred(starred)`	`File`	Define se o `File` é 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 no futuro.
`hasNext()`	`Boolean`	Determina se chamar `next()` retornará um item.
`next()`	`File`	Recebe o próximo item na 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 visualizadores para o `Folder`.
`addViewer(user)`	`Folder`	Adiciona o usuário especificado à lista de visualizadores para o `Folder`.
`addViewers(emailAddresses)`	`Folder`	Adiciona a matriz de usuários especificada à lista de visualizadores 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, conteúdo e tipo MIME fornecidos.
`createFolder(name)`	`Folder`	Cria uma pasta na pasta atual com o nome informado.
`createShortcut(targetId)`	`File`	Cria um atalho para o código do item do Drive fornecido e o retorna.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Cria um atalho para o código do item do Google Drive e a chave de recurso, e os retorna.
`getAccess(email)`	`Permission`	Recebe a permissão concedida ao usuário especificado.
`getAccess(user)`	`Permission`	Recebe a permissão concedida ao usuário especificado.
`getDateCreated()`	`Date`	Recebe a data em que o `Folder` foi criado.
`getDescription()`	`String`	Recebe a descrição do `Folder`.
`getEditors()`	`User[]`	Recebe a lista de editores para esse `Folder`.
`getFiles()`	`FileIterator`	Recebe um conjunto de todos os arquivos filhos na pasta atual.
`getFilesByName(name)`	`FileIterator`	Recebe um conjunto de todos os arquivos filhos na pasta atual e que têm o nome fornecido.
`getFilesByType(mimeType)`	`FileIterator`	Recebe um conjunto de todos os arquivos filhos na pasta atual e tem o tipo MIME fornecido.
`getFolders()`	`FolderIterator`	Recebe um conjunto de todas as pastas filhas da pasta atual.
`getFoldersByName(name)`	`FolderIterator`	Recebe um conjunto de todas as pastas filhas da pasta atual e com o nome fornecido.
`getId()`	`String`	Recebe o ID de `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 do `Folder`.
`getParents()`	`FolderIterator`	Recebe um conjunto de pastas mães imediatas do `Folder`.
`getResourceKey()`	`String`	Recebe a chave de recurso do `Folder` que é necessária para acessar os itens que foram compartilhados usando um link.
`getSecurityUpdateEligible()`	`Boolean`	Determina se `Folder` está qualificado para aplicar a atualização de segurança que exige uma chave de recurso para acesso quando ela é compartilhada usando um link.
`getSecurityUpdateEnabled()`	`Boolean`	Recebe se essa `Folder` exige uma chave de recurso para acesso quando é compartilhada usando um link.
`getSharingAccess()`	`Access`	Recebe 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 a usuários que podem acessar o `Folder`, além de todos os usuários individuais que receberam 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 app do Google, como o Drive ou o Documentos.
`getViewers()`	`User[]`	Recebe a lista de leitores e comentaristas desta `Folder`.
`isShareableByEditors()`	`Boolean`	Determina se os usuários com permissões para edição da `Folder` podem compartilhar com outros usuários ou mudar 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 esse item para a pasta de destino fornecida.
`removeEditor(emailAddress)`	`Folder`	Remove o usuário em questão da lista de editores do `Folder`.
`removeEditor(user)`	`Folder`	Remove o usuário em questão da lista de editores do `Folder`.
`removeViewer(emailAddress)`	`Folder`	Remove o usuário da lista de leitores e comentaristas da `Folder`.
`removeViewer(user)`	`Folder`	Remove o usuário da lista de leitores e comentaristas da `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 um conjunto de todos os arquivos filhos na pasta atual e que correspondem aos critérios de pesquisa fornecidos.
`searchFolders(params)`	`FolderIterator`	Recebe um conjunto de todas as pastas filhas da pasta atual e que correspondem aos critérios de pesquisa fornecidos.
`setDescription(description)`	`Folder`	Define a descrição de `Folder`.
`setName(name)`	`Folder`	Define o nome do `Folder`.
`setOwner(emailAddress)`	`Folder`	Altera o proprietário do `Folder`.
`setOwner(user)`	`Folder`	Altera o proprietário do `Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Define se o `Folder` exige uma chave de recurso para acesso quando for compartilhado usando um link.
`setShareableByEditors(shareable)`	`Folder`	Define se os usuários com permissão para edição a `Folder` têm permissão para compartilhar com outros usuários ou mudar 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 qualquer usuário individual que tenha recebido explicitamente o acesso.
`setStarred(starred)`	`Folder`	Define se o `Folder` é 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 no futuro.
`hasNext()`	`Boolean`	Determina se chamar `next()` retornará um item.
`next()`	`Folder`	Recebe o próximo item na coleção de arquivos ou pastas.

`Permission`

Propriedades

Propriedade	Tipo	Descrição
`VIEW`	`Enum`	Os usuários com acesso à pasta ou ao arquivo só poderão ver ou copiar o item.
`EDIT`	`Enum`	Os usuários podem acessar o arquivo ou a pasta.
`COMMENT`	`Enum`	Os usuários com acesso à pasta ou ao arquivo só poderão ver, copiar ou comentar.
`OWNER`	`Enum`	O usuário é o 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, mover e mover o conteúdo para 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`	Recebe o endereço de e-mail do usuário.
`getName()`	`String`	Recebe o nome do usuário.
`getPhotoUrl()`	`String`	Recebe o URL da foto do usuário.