Esta página foi traduzida pela API Cloud Translation.

Drive Service

Esse serviço permite que os scripts criem, encontrem e modifiquem arquivos e pastas no Google Drive

Se o script usa uma projeto padrão do Cloud em vez de um projeto padrão do Cloud, é preciso ativar manualmente a API Drive. No projeto padrão do Cloud, ative a API Drive:

Ativar a API Drive

O exemplo de código a seguir mostra como registrar os nomes de cada arquivo no Pasta Meu Drive:

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

Observação:administradores do Google Workspace pode desativar o SDK do Drive no domínio, o que impede que os usuários instalem e usem os serviços Apps do Drive. Essa configuração também impede que os usuários usem Apps Script, apps da Web e complementos do Apps Script que usam o Drive serviço ou Serviço avançado do Drive (mesmo se o complemento ou aplicativo da Web tiver sido instalado antes de o administrador desativar o SDK do Drive).

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 script que o cliente OAuth está na lista de permissões; pelo administrador do domínio, as funções do complemento para esses usuários, mesmo se o O SDK do Drive está desativado no domínio.

Classes

Nome	Breve descrição
`Access`	Um tipo enumerado que representa classes de usuários que podem acessar um arquivo ou pasta, além de qualquer usuários que receberam acesso explícito.
`DriveApp`	Permite que os scripts criem, encontrem 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 possivelmente grande de arquivos.
`Folder`	Uma pasta no Google Drive.
`FolderIterator`	Um objeto que permite que os scripts iterem em uma coleção possivelmente grande de pastas.
`Permission`	Uma enumeração que representa as permissões concedidas a usuários que podem acessar um arquivo ou pasta, além das usuários individuais que receberam acesso explícito.
`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 tipo enumerado que representa classes de usuários que podem acessar um arquivo ou pasta, além de qualquer usuários que receberam acesso explícito.
`Permission`	`Permission`	Uma enumeração que representa as permissões concedidas a usuários que podem acessar um arquivo ou pasta, além das usuários individuais que receberam acesso explícito.

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 fornecidos.
`createFolder(name)`	`Folder`	Cria uma pasta na raiz do Drive do usuário com o nome determinado.
`createShortcut(targetId)`	`File`	Cria um atalho para o código de item do Google Drive fornecido e o retorna.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Cria um atalho para o ID do item do Drive e a chave de recurso fornecidos e o retorna.
`enforceSingleParent(value)`	`void`	Ativa ou desativa o comportamento de applySingleParent para todas as chamadas que afetam os pais do item.
`getFileById(id)`	`File`	Extrai 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 uma coleção de todos os arquivos no Google Drive do usuário.
`getFilesByName(name)`	`FileIterator`	Recebe uma coleção de todos os arquivos no Google Drive do usuário que têm o nome determinado.
`getFilesByType(mimeType)`	`FileIterator`	Recebe uma coleção de todos os arquivos no Drive do usuário que têm o tipo MIME especificado.
`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 uma coleção de todas as pastas no Google Drive do usuário.
`getFoldersByName(name)`	`FolderIterator`	Recebe uma coleção de todas as pastas no Google Drive do usuário que tenham o nome determinado.
`getRootFolder()`	`Folder`	Extrai 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`	Recebe uma coleção de todos os arquivos na lixeira do Drive do usuário.
`getTrashedFolders()`	`FolderIterator`	Recebe uma coleção de todas as pastas na lixeira do Drive do usuário.
`searchFiles(params)`	`FileIterator`	Recebe uma coleção de todos os arquivos no Drive do usuário que correspondem à pesquisa especificada critérios.
`searchFolders(params)`	`FolderIterator`	Recebe uma coleção de todas as pastas no Drive do usuário que correspondem à pesquisa especificada critérios.

`File`

Métodos

Método	Tipo de retorno	Breve descrição
`addCommenter(emailAddress)`	`File`	Adiciona o usuário à lista de usuários que fizeram comentários no `File`.
`addCommenter(user)`	`File`	Adiciona o usuário à lista de usuários que fizeram comentários no `File`.
`addCommenters(emailAddresses)`	`File`	Adicione a matriz de usuários especificada à lista de comentaristas para o `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 `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 no tipo de conteúdo especificado.
`getBlob()`	`Blob`	Retorne os dados dentro desse objeto como um blob.
`getDateCreated()`	`Date`	Recebe a data de criação do `File`.
`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 desse `File`.
`getId()`	`String`	Recebe o ID do `File`.
`getLastUpdated()`	`Date`	Recebe a data em que o `File` foi atualizado pela última vez.
`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 uma coleção de pastas que são mães imediatas do `File`.
`getResourceKey()`	`String`	Recebe a chave de recurso do `File` necessária para acessar os itens que foram compartilhadas usando um link.
`getSecurityUpdateEligible()`	`Boolean`	Identifica se este `File` está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando é compartilhado usando um link.
`getSecurityUpdateEnabled()`	`Boolean`	Descobre se este `File` precisa de uma chave de recurso para acesso quando é compartilhada usando um link.
`getSharingAccess()`	`Access`	Extrai qual classe de usuários pode acessar o `File`, além de qualquer usuários que receberam acesso explícito.
`getSharingPermission()`	`Permission`	Recebe a permissão concedida aos usuários que podem acessar o `File`, além dos usuários individuais que receberam acesso explícito.
`getSize()`	`Integer`	Recebe o número de bytes usados para armazenar o `File` no Drive.
`getTargetId()`	`String`	Se for um atalho, retorna o ID 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 do 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 Drive ou 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 do `File` têm permissão para 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 `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 esse item para a pasta de destino fornecida.
`removeCommenter(emailAddress)`	`File`	Remove o usuário especificado da lista de comentadores do `File`.
`removeCommenter(user)`	`File`	Remove o usuário especificado da lista de comentadores 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 determinada substituição.
`setDescription(description)`	`File`	Define a descrição do `File`.
`setName(name)`	`File`	Define o nome do `File`.
`setOwner(emailAddress)`	`File`	Altera o proprietário de `File`.
`setOwner(user)`	`File`	Altera o proprietário de `File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Define se o `File` exige uma chave de recurso para acesso quando é compartilhada usando um link.
`setShareableByEditors(shareable)`	`File`	Define se os usuários com permissões para edição do `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 esses usuários recebem, além dos 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 `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()` vai retornar um item.
`next()`	`File`	Acessa 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 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 `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 especificado.
`createShortcut(targetId)`	`File`	Cria um atalho para o código de item do Google Drive fornecido e o retorna.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Cria um atalho para o ID do item do Drive e a chave de recurso fornecidos e o 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 de criação do `Folder`.
`getDescription()`	`String`	Recebe a descrição do `Folder`.
`getEditors()`	`User[]`	Recebe a lista de editores desse `Folder`.
`getFiles()`	`FileIterator`	Recebe uma coleção de todos os arquivos filhos da pasta atual.
`getFilesByName(name)`	`FileIterator`	Recebe uma coleção de todos os arquivos filhos da pasta atual e com o nome determinado.
`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`	Recebe uma coleção de todas as pastas filhas da pasta atual.
`getFoldersByName(name)`	`FolderIterator`	Recebe uma coleção de todas as pastas filhas da pasta atual e com o nome determinado.
`getId()`	`String`	Recebe o ID do `Folder`.
`getLastUpdated()`	`Date`	Recebe a data em que o `Folder` foi atualizado pela última vez.
`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 mães imediatas do `Folder`.
`getResourceKey()`	`String`	Recebe a chave de recurso do `Folder` necessária para acessar os itens que foram compartilhadas usando um link.
`getSecurityUpdateEligible()`	`Boolean`	Identifica se este `Folder` está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando é compartilhado usando um link.
`getSecurityUpdateEnabled()`	`Boolean`	Descobre se este `Folder` precisa de uma chave de recurso para acesso quando é compartilhada usando um link.
`getSharingAccess()`	`Access`	Extrai qual classe de usuários pode acessar o `Folder`, além de qualquer usuários que receberam acesso explícito.
`getSharingPermission()`	`Permission`	Recebe a permissão concedida aos usuários que podem acessar o `Folder`, além dos usuários individuais que receberam acesso explícito.
`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 Drive ou 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 do `Folder` têm permissão para 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 `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 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 que são filhos da pasta atual e correspondem à pesquisa especificada critérios.
`searchFolders(params)`	`FolderIterator`	Recebe uma coleção de todas as pastas filhas da pasta atual e que correspondem à pesquisa especificada critérios.
`setDescription(description)`	`Folder`	Define a descrição do `Folder`.
`setName(name)`	`Folder`	Define o nome do `Folder`.
`setOwner(emailAddress)`	`Folder`	Altera o proprietário de `Folder`.
`setOwner(user)`	`Folder`	Altera o proprietário de `Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Define se o `Folder` exige uma chave de recurso para acesso quando é compartilhada usando um link.
`setShareableByEditors(shareable)`	`Folder`	Define se os usuários com permissões para edição do `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 esses usuários recebem, além dos 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 `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()` vai retornar um item.
`next()`	`Folder`	Acessa o próximo item na coleção de arquivos ou pastas.

`Permission`

Propriedades

Propriedade	Tipo	Descrição
`VIEW`	`Enum`	Os usuários que têm acesso ao arquivo ou à pasta só podem visualizar ou copiar o item.
`EDIT`	`Enum`	Os usuários com acesso ao arquivo ou à pasta também podem editar o item.
`COMMENT`	`Enum`	Os usuários com acesso ao arquivo ou à pasta só podem ver, copiar ou comentar o item.
`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 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`	Recebe 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.