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. Embora o serviço integrado do Drive seja mais fácil de usar, ele tem algumas limitações. Para ter acesso aos recursos e suporte mais atualizados e acessar arquivos ou pastas em drives compartilhados, use o serviço avançado do Drive.

Se o script usar um projeto padrão do Cloud em vez de um projeto padrão do Cloud, você precisará 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 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());
}

Observação:os administradores do Google Workspace podem desativar o SDK do Drive no domínio, o que impede que os usuários instalem e usem os apps do Google Drive. Essa configuração também impede que os usuários usem scripts do Apps Script, web apps e complementos que usam o serviço do Drive ou o serviço avançado do Drive (mesmo que o complemento ou web app tenha 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 for instalado pelo administrador para alguns ou todos os usuários do domínio, ou qualquer script que tenha o cliente OAuth na lista de permissões pelo administrador do domínio, o complemento vai 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 pasta, além de usuários individuais que receberam acesso explícito.
`DriveApp`	Permite que 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 potencialmente grande de arquivos.
`Folder`	Uma pasta no Google Drive.
`FolderIterator`	Um objeto que permite que os scripts iterem em 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 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`	Uma enumeração que representa classes de usuários que podem acessar um arquivo ou pasta, além de usuários individuais que receberam acesso explícito.
`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 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 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 especificados.
`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 especificado.
`createShortcut(targetId)`	`File`	Cria e retorna um atalho para o ID do item do Drive fornecido.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Cria um atalho para o ID do item do Drive e a chave do recurso fornecidos e o retorna.
`enforceSingleParent(value)`	`void`	Ativa ou desativa o comportamento "enforceSingleParent" para todas as chamadas que afetam os itens principais.
`getFileById(id)`	`File`	Recebe o arquivo com o ID especificado.
`getFileByIdAndResourceKey(id, resourceKey)`	`File`	Recebe o arquivo com o ID e a chave de recurso especificados.
`getFiles()`	`FileIterator`	Recebe uma coleção de todos os arquivos no Drive do usuário.
`getFilesByName(name)`	`FileIterator`	Recebe uma coleção de todos os arquivos no Drive do usuário com o nome especificado.
`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 especificado.
`getFolderByIdAndResourceKey(id, resourceKey)`	`Folder`	Recebe a pasta com o ID e a chave de recurso especificados.
`getFolders()`	`FolderIterator`	Recebe uma coleção de todas as pastas no Drive do usuário.
`getFoldersByName(name)`	`FolderIterator`	Recebe uma coleção de todas as pastas no Drive do usuário com o nome especificado.
`getRootFolder()`	`Folder`	Recebe 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 aos critérios de pesquisa especificados.
`searchFolders(params)`	`FolderIterator`	Recebe uma coleção 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 comentaristas do `File`.
`addCommenter(user)`	`File`	Adiciona o usuário especificado à lista de comentaristas do `File`.
`addCommenters(emailAddresses)`	`File`	Adiciona a matriz de usuários à lista de comentaristas do `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 à 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 à lista de leitores do `File`.
`getAccess(email)`	`Permission`	Recebe a permissão concedida a um usuário específico.
`getAccess(user)`	`Permission`	Recebe a permissão concedida a um usuário específico.
`getAs(contentType)`	`Blob`	Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
`getBlob()`	`Blob`	Retorna 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 este `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`	Recebe o proprietário do arquivo.
`getParents()`	`FolderIterator`	Recebe uma coleção de pastas que são pais imediatos do `File`.
`getResourceKey()`	`String`	Recebe a chave de recurso do `File` necessária para acessar itens compartilhados usando um link.
`getSecurityUpdateEligible()`	`Boolean`	Recebe se este `File` está qualificado para aplicar a atualização de segurança que exige uma chave de recurso para acesso quando é compartilhado usando um link.
`getSecurityUpdateEnabled()`	`Boolean`	Recebe se este `File` exige uma chave de recurso para acesso quando é compartilhado usando um link.
`getSharingAccess()`	`Access`	Recebe a classe de usuários que podem acessar o `File`, além de usuários individuais que receberam acesso explícito.
`getSharingPermission()`	`Permission`	Recebe a permissão concedida aos usuários que podem acessar o `File`, além de 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 a que ele aponta.
`getTargetMimeType()`	`String`	Se for um atalho, retorna o tipo MIME do item a que ele aponta.
`getTargetResourceKey()`	`String`	Se o arquivo for um atalho, vai retornar a chave de recurso do item a que ele aponta.
`getThumbnail()`	`Blob\|null`	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 app do Google, como Drive ou Documentos.
`getViewers()`	`User[]`	Recebe a lista de leitores e comentaristas deste `File`.
`isShareableByEditors()`	`Boolean`	Determina se os usuários com permissões de edição no `File` podem compartilhar com outros usuários ou mudar as permissões.
`isStarred()`	`Boolean`	Determina se o `File` foi marcado como favorito 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 pessoas que fizeram comentários no `File`.
`removeCommenter(user)`	`File`	Remove o usuário especificado da lista de pessoas que fizeram comentários no `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 espectadores e comentaristas do `File`.
`removeViewer(user)`	`File`	Remove o usuário especificado da lista de espectadores e comentaristas do `File`.
`revokePermissions(emailAddress)`	`File`	Revoga o acesso ao `File` concedido ao usuário.
`revokePermissions(user)`	`File`	Revoga o acesso ao `File` concedido ao usuário.
`setContent(content)`	`File`	Substitui o conteúdo do arquivo por uma substituição específica.
`setDescription(description)`	`File`	Define a descrição do `File`.
`setName(name)`	`File`	Define o nome do `File`.
`setOwner(emailAddress)`	`File`	Muda o proprietário do `File`.
`setOwner(user)`	`File`	Muda o proprietário do `File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Define se o `File` exige uma chave de recurso para acesso quando é compartilhado usando um link.
`setShareableByEditors(shareable)`	`File`	Define se os usuários com permissões de edição no `File` podem 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 são concedidas a eles, além de usuários individuais que receberam acesso explícito.
`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 a chamada de `next()` vai 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 à 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 à lista de leitores do `Folder`.
`createFile(blob)`	`File`	Cria um arquivo na pasta atual com 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 especificados.
`createFile(name, content, mimeType)`	`File`	Cria um arquivo na pasta atual com o nome, o conteúdo e o tipo MIME especificados.
`createFolder(name)`	`Folder`	Cria uma pasta na pasta atual com o nome especificado.
`createShortcut(targetId)`	`File`	Cria e retorna um atalho para o ID do item do Drive fornecido.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Cria um atalho para o ID do item do Drive e a chave do recurso fornecidos e o retorna.
`getAccess(email)`	`Permission`	Recebe a permissão concedida a um usuário específico.
`getAccess(user)`	`Permission`	Recebe a permissão concedida a um usuário específico.
`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 este `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 que são filhos da pasta atual e têm o nome especificado.
`getFilesByType(mimeType)`	`FileIterator`	Recebe uma coleção de todos os arquivos filhos da pasta atual e com o tipo MIME especificado.
`getFolders()`	`FolderIterator`	Recebe uma coleção de todas as pastas que são filhas da pasta atual.
`getFoldersByName(name)`	`FolderIterator`	Recebe uma coleção de todas as pastas filhas da pasta atual com o nome especificado.
`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 do `Folder`.
`getResourceKey()`	`String`	Recebe a chave de recurso do `Folder` necessária para acessar itens compartilhados usando um link.
`getSecurityUpdateEligible()`	`Boolean`	Recebe se este `Folder` está qualificado para aplicar a atualização de segurança que exige uma chave de recurso para acesso quando é compartilhado usando um link.
`getSecurityUpdateEnabled()`	`Boolean`	Recebe se este `Folder` exige uma chave de recurso para acesso quando é compartilhado usando um link.
`getSharingAccess()`	`Access`	Recebe a classe de usuários que podem acessar o `Folder`, além de usuários individuais que receberam acesso explícito.
`getSharingPermission()`	`Permission`	Recebe a permissão concedida aos usuários que podem acessar o `Folder`, além de 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 app do Google, como Drive ou Documentos.
`getViewers()`	`User[]`	Recebe a lista de leitores e comentaristas deste `Folder`.
`isShareableByEditors()`	`Boolean`	Determina se os usuários com permissões de edição no `Folder` podem compartilhar com outros usuários ou mudar as permissões.
`isStarred()`	`Boolean`	Determina se o `Folder` foi marcado como favorito 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 espectadores e comentaristas do `Folder`.
`removeViewer(user)`	`Folder`	Remove o usuário especificado da lista de espectadores e comentaristas do `Folder`.
`revokePermissions(emailAddress)`	`Folder`	Revoga o acesso ao `Folder` concedido ao usuário.
`revokePermissions(user)`	`Folder`	Revoga o acesso ao `Folder` concedido ao usuário.
`searchFiles(params)`	`FileIterator`	Recebe uma coleção de todos os arquivos que são filhos da pasta atual e correspondem aos critérios de pesquisa especificados.
`searchFolders(params)`	`FolderIterator`	Recebe uma coleção de todas as pastas que são filhas da pasta atual e correspondem aos critérios de pesquisa especificados.
`setDescription(description)`	`Folder`	Define a descrição do `Folder`.
`setName(name)`	`Folder`	Define o nome do `Folder`.
`setOwner(emailAddress)`	`Folder`	Muda o proprietário do `Folder`.
`setOwner(user)`	`Folder`	Muda o proprietário do `Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Define se o `Folder` exige uma chave de recurso para acesso quando é compartilhado usando um link.
`setShareableByEditors(shareable)`	`Folder`	Define se os usuários com permissões de edição no `Folder` podem 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 são concedidas a eles, além de usuários individuais que receberam acesso explícito.
`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 a chamada de `next()` vai 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 que podem acessar o arquivo ou a pasta só podem visualizar ou copiar.
`EDIT`	`Enum`	Os usuários que podem acessar o arquivo ou a pasta podem editar o conteúdo.
`COMMENT`	`Enum`	Os usuários que podem acessar o arquivo ou a pasta só podem visualizar, copiar ou comentar.
`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, 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\|null`	Recebe o nome de domínio associado à conta do usuário.
`getEmail()`	`String\|null`	Recebe o endereço de e-mail do usuário.
`getName()`	`String\|null`	Recebe o nome do usuário.
`getPhotoUrl()`	`String\|null`	Recebe o URL da foto do usuário.

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

Classes

Propriedades

Propriedades

Métodos

Métodos

Métodos

Métodos

Métodos

Propriedades

Métodos

Drive Service