Class Folder

Uma pasta no Google Drive. É possível acessar ou criar pastas em DriveApp.

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

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 que são filhos da pasta atual.
`getFilesByName(name)`	`FileIterator`	Recebe uma coleção de todos os arquivos filhos da pasta atual e com 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 da `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.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`addFile(child)`	`Folder`	Adiciona o arquivo especificado à pasta atual.
`addFolder(child)`	`Folder`	Adiciona a pasta especificada à pasta atual.
`removeFile(child)`	`Folder`	Remove o arquivo especificado da pasta atual.
`removeFolder(child)`	`Folder`	Remove a pasta especificada da pasta atual.

Documentação detalhada

`addEditor(emailAddress)`

Adiciona o usuário especificado à lista de editores do Folder. Se o usuário já estava na lista de leitores, esse método o remove dela.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser adicionado.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`addEditor(user)`

Adiciona o usuário especificado à lista de editores do Folder. Se o usuário já estava na lista de leitores, esse método o remove dela.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`addEditors(emailAddresses)`

Adiciona a matriz de usuários à lista de editores do Folder. Se algum dos usuários já estava na lista de espectadores, esse método o remove dela.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`addViewer(emailAddress)`

Adiciona o usuário especificado à lista de leitores do Folder. Se o usuário já estava na lista de editores, esse método não tem efeito.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser adicionado.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`addViewer(user)`

Adiciona o usuário especificado à lista de leitores do Folder. Se o usuário já estava na lista de editores, esse método não tem efeito.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`addViewers(emailAddresses)`

Adiciona a matriz de usuários à lista de leitores do Folder. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para eles.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`createFile(blob)`

Cria um arquivo na pasta atual com um determinado Blob de dados arbitrários.

Parâmetros

Nome	Tipo	Descrição
`blob`	`BlobSource`	Os dados do novo arquivo.

Retornar

File: o novo arquivo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`createFile(name, content)`

Cria um arquivo de texto na pasta atual com o nome e o conteúdo especificados. Gera uma exceção se content for maior que 50 MB.

// Create a text file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome do novo arquivo.
`content`	`String`	O conteúdo do novo arquivo.

Retornar

File: o novo arquivo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`createFile(name, content, mimeType)`

Cria um arquivo na pasta atual com o nome, o conteúdo e o tipo MIME especificados. Gera uma exceção se content for maior que 10 MB.

// Create an HTML file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome do novo arquivo.
`content`	`String`	O conteúdo do novo arquivo.
`mimeType`	`String`	O tipo MIME do novo arquivo.

Retornar

File: o novo arquivo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`createFolder(name)`

Cria uma pasta na pasta atual com o nome especificado.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome da nova pasta.

Retornar

Folder: a nova pasta.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`createShortcut(targetId)`

Cria e retorna um atalho para o ID do item do Drive fornecido.

Parâmetros

Nome	Tipo	Descrição
`targetId`	`String`	O ID do arquivo ou da pasta de destino.

Retornar

File: o novo atalho.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

Cria um atalho para o ID do item do Drive e a chave do recurso fornecidos e o retorna. Uma chave de recurso é um parâmetro adicional que precisa ser transmitido para acessar o arquivo ou a pasta de destino compartilhada usando um link.

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

Parâmetros

Nome	Tipo	Descrição
`targetId`	`String`	O ID do arquivo ou da pasta de destino.
`targetResourceKey`	`String`	A chave do recurso do arquivo ou pasta de destino.

Retornar

File: o novo atalho.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`getAccess(email)`

Recebe a permissão concedida a um usuário específico. O método não oferece suporte ao retorno de permissões para um grupo do Google ou permissões herdadas por grupos do Google.

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	O endereço de e-mail do usuário cujas permissões precisam ser verificadas. Os Grupos do Google não são compatíveis.

Retornar

Permission: as permissões concedidas ao usuário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getAccess(user)`

Recebe a permissão concedida a um usuário específico. O método não oferece suporte ao retorno de permissões para um grupo do Google ou permissões herdadas por grupos do Google.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário cujas permissões precisam ser verificadas.

Retornar

Permission: as permissões concedidas ao usuário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getDateCreated()`

Recebe a data em que o Folder foi criado.

Retornar

Date: a data em que o Folder foi criado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getDescription()`

Recebe a descrição do Folder.

Retornar

String: a descrição do Folder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getEditors()`

Recebe a lista de editores para este Folder. Se o usuário que executar o script não tiver acesso de edição ao Folder, esse método vai retornar uma matriz vazia.

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (const editor of editors) {
  console.log(editor.getName());
}

Retornar

User[]: a lista de editores para este Folder se o usuário tiver acesso de edição ou uma matriz vazia caso contrário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFiles()`

Recebe uma coleção de todos os arquivos que são filhos da pasta atual.

Retornar

FileIterator: uma coleção de todos os arquivos filhos da pasta atual.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFilesByName(name)`

Recebe uma coleção de todos os arquivos filhos da pasta atual e com o nome especificado.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome dos arquivos a serem encontrados.

Retornar

FileIterator: uma coleção de todos os arquivos filhos da pasta atual com o nome especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFilesByType(mimeType)`

Recebe uma coleção de todos os arquivos filhos da pasta atual e com o tipo MIME especificado.

Parâmetros

Nome	Tipo	Descrição
`mimeType`	`String`	O tipo MIME dos arquivos a serem encontrados.

Retornar

FileIterator: uma coleção de todos os arquivos que são filhos da pasta atual e têm o tipo MIME especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFolders()`

Recebe uma coleção de todas as pastas que são filhas da pasta atual.

Retornar

FolderIterator: uma coleção de todas as pastas filhas da pasta atual.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFoldersByName(name)`

Recebe uma coleção de todas as pastas filhas da pasta atual com o nome especificado.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome das pastas a serem encontradas.

Retornar

FolderIterator: uma coleção de todas as pastas que são filhas da pasta atual e têm o nome especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getId()`

Recebe o ID da Folder.

Retornar

String: o ID do Folder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getLastUpdated()`

Recebe a data da última atualização do Folder.

Retornar

Date: a data da última atualização do Folder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getName()`

Recebe o nome do Folder.

Retornar

String: o nome do Folder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getOwner()`

Recebe o proprietário deste Folder.

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

Retornar

User: o proprietário deste Folder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getParents()`

Recebe uma coleção de pastas que são pais imediatos do Folder.

Retornar

FolderIterator: uma coleção de pastas que são pais imediatos do Folder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getResourceKey()`

Recebe a chave de recurso do Folder necessária para acessar itens compartilhados usando um link.

Retornar

String: a chave de recurso do Folder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSecurityUpdateEligible()`

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.

O Drive exige uma chave de recurso para acessar alguns arquivos ou pastas compartilhados usando um link. Essa mudança faz parte de uma atualização de segurança. A atualização fica ativada por padrão para arquivos e pastas qualificados. Para ativar ou desativar a exigência de chave de recurso para arquivos qualificados, use setSecurityUpdateEnabled.

Saiba mais sobre a atualização de segurança do Google Drive.

Retornar

Boolean: indica se o requisito de chave de recurso pode ser aplicado ao Folder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSecurityUpdateEnabled()`

Recebe se este Folder exige uma chave de recurso para acesso quando é compartilhado usando um link. Esse requisito é ativado por padrão para arquivos e pastas qualificados. Para ativar ou desativar a exigência de chave de recurso para arquivos qualificados, use setSecurityUpdateEnabled.

Saiba mais sobre a atualização de segurança do Google Drive.

Retornar

Boolean: indica se o requisito de chave de recurso está ativado para este Folder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSharingAccess()`

Recebe a classe de usuários que podem acessar o Folder, além de usuários individuais que receberam acesso explícito.

Retornar

Access: qual classe de usuários pode acessar o Folder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSharingPermission()`

Recebe a permissão concedida aos usuários que podem acessar o Folder, além de usuários individuais que receberam acesso explícito.

Retornar

Permission: as permissões concedidas aos usuários que podem acessar o Folder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSize()`

Recebe o número de bytes usados para armazenar o Folder no Drive. Os arquivos de aplicativos do Google Workspace não são contabilizados nos limites de armazenamento no Drive e, portanto, retornam 0 bytes.

Retornar

Integer: o número de bytes usados para armazenar o Folder no Drive

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getUrl()`

Recebe o URL que pode ser usado para abrir o Folder em um app do Google, como Drive ou Documentos.

Retornar

String: o URL que pode ser usado para ver este Folder em um app do Google, como o Drive ou o Docs.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getViewers()`

Recebe a lista de leitores e comentaristas deste Folder. Se o usuário que executa o script não tiver acesso de edição ao Folder, esse método vai retornar uma matriz vazia.

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

Retornar

User[]: a lista de leitores e comentaristas do Folder se o usuário tiver acesso de edição ou uma matriz vazia caso contrário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isShareableByEditors()`

Determina se os usuários com permissões de edição no Folder podem compartilhar com outros usuários ou mudar as permissões.

Retornar

Boolean — true se os usuários com permissões de edição puderem compartilhar com outras pessoas ou mudar as permissões; false se não.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isStarred()`

Determina se o Folder foi marcado como favorito no Drive do usuário.

Retornar

Boolean: true se o Folder estiver marcado com estrela no Drive do usuário; false se não estiver.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isTrashed()`

Determina se o Folder está na lixeira do Drive do usuário.

Retornar

Boolean: true se o Folder estiver na lixeira do Drive do usuário; false se não estiver.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`moveTo(destination)`

Move o item para a pasta de destino fornecida.

O usuário atual precisa ser o proprietário do arquivo ou ter pelo menos acesso de edição à pasta mãe atual do item para movê-lo para a pasta de destino.

Parâmetros

Nome	Tipo	Descrição
`destination`	`Folder`	A pasta que se torna o novo pai.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeEditor(emailAddress)`

Remove o usuário especificado da lista de editores do Folder. Esse método não impede que os usuários acessem o Folder se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o Folder for compartilhado com todo o domínio do usuário ou se o Folder estiver em um drive compartilhado que o usuário pode acessar.

Para arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeEditor(user)`

Para arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeViewer(emailAddress)`

Remove o usuário especificado da lista de espectadores e comentaristas do Folder. Esse método não tem efeito se o usuário for um editor, não um leitor ou comentarista. Esse método também não impede que os usuários acessem o Folder se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o Folder for compartilhado com todo o domínio do usuário ou se o Folder estiver em um drive compartilhado que o usuário pode acessar.

Para arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retornar

Folder: Folder para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeViewer(user)`

Remove o usuário especificado da lista de espectadores e comentaristas do Folder. Esse método não tem efeito se o usuário for um editor, não um leitor. Esse método também não impede que os usuários acessem o Folder se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o Folder for compartilhado com todo o domínio do usuário ou se o Folder estiver em um drive compartilhado que o usuário possa acessar.

Para arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retornar

Folder: Folder para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`revokePermissions(emailAddress)`

Revoga o acesso ao Folder concedido ao usuário. Esse método não impede que os usuários acessem o Folder se eles pertencerem a uma classe de usuários que têm acesso geral, por exemplo, se o Folder for compartilhado com o domínio inteiro do usuário.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário cujo acesso deve ser revogado.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`revokePermissions(user)`

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário que teve o acesso revogado.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`searchFiles(params)`

Recebe uma coleção de todos os arquivos que são filhos da pasta atual e correspondem aos critérios de pesquisa especificados. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. O serviço do Drive usa a v2 da API Drive, e alguns campos de consulta são diferentes da v3. Revise as diferenças de campo entre a v2 e a v3.

O argumento params é uma string de consulta que pode conter valores de string. Portanto, tome cuidado para fazer o escape das aspas corretamente (por exemplo, "title contains 'Gulliver\\'s Travels'" ou 'title contains "Gulliver\'s Travels"').

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Parâmetros

Nome	Tipo	Descrição
`params`	`String`	Os critérios de pesquisa, conforme detalhado na documentação do SDK do Google Drive.

Retornar

FileIterator: uma coleção de todos os arquivos que são filhos da pasta atual e correspondem aos critérios de pesquisa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`searchFolders(params)`

Recebe uma coleção de todas as pastas que são filhas da pasta atual e correspondem aos critérios de pesquisa especificados. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. O serviço do Drive usa a v2 da API Drive, e alguns campos de consulta são diferentes da v3. Revise as diferenças de campo entre a v2 e a v3.

// Logs the name of every folder that are children of the current folder and you own and is starred.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Parâmetros

Nome	Tipo	Descrição
`params`	`String`	Os critérios de pesquisa, conforme detalhado na documentação do SDK do Google Drive.

Retornar

FolderIterator: uma coleção de todas as pastas que são filhas da pasta atual e correspondem aos critérios de pesquisa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`setDescription(description)`

Define a descrição do Folder.

Parâmetros

Nome	Tipo	Descrição
`description`	`String`	a nova descrição do `Folder`

Retornar

Folder: Folder para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setName(name)`

Define o nome do Folder.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o novo nome do `Folder`

Retornar

Folder: Folder para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setOwner(emailAddress)`

Muda o proprietário do Folder. Esse método também concede ao proprietário anterior acesso explícito de edição ao Folder.

O Drive não permite mudar a propriedade de itens pertencentes a contas do gmail.com, mas permite em contas do Workspace.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário que vai ser o novo proprietário.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setOwner(user)`

Muda o proprietário do Folder. Esse método também concede ao proprietário anterior acesso explícito de edição ao Folder.

O Drive não permite mudar a propriedade de itens pertencentes a contas do gmail.com, mas permite em contas do Workspace.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário que vai se tornar o novo proprietário.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setSecurityUpdateEnabled(enabled)`

Define se o Folder exige uma chave de recurso para acesso quando é compartilhado usando um link. Os arquivos e pastas qualificados são ativados por padrão.

Saiba mais sobre a atualização de segurança do Google Drive.

Parâmetros

Nome	Tipo	Descrição
`enabled`	`Boolean`	Define se o requisito de chave de recurso será ativado para o `Folder`.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setShareableByEditors(shareable)`

Define se os usuários com permissões de edição no Folder podem compartilhar com outros usuários ou mudar as permissões. O padrão para um novo Folder é true.

Parâmetros

Nome	Tipo	Descrição
`shareable`	`Boolean`	`true` se os usuários com permissões de edição puderem compartilhar com outros usuários ou mudar as permissões; `false` se não.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setSharing(accessType, permissionType)`

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.

// Creates a folder that anyone on the Internet can read from and write to.
// (Domain administrators can prohibit this setting for users of a Google
// Workspace domain.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parâmetros

Nome	Tipo	Descrição
`accessType`	`Access`	qual classe de usuários deve ter acesso ao `Folder`
`permissionType`	`Permission`	as permissões que devem ser concedidas aos usuários que podem acessar o `Folder`

Retornar

Folder: Folder para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setStarred(starred)`

Define se o Folder está marcado com estrela no Drive do usuário. O padrão para novos Folders é false.

Parâmetros

Nome	Tipo	Descrição
`starred`	`Boolean`	`true` se o `Folder` precisar ser marcado com estrela no Drive do usuário; `false` se não

Retornar

Folder: Folder para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setTrashed(trashed)`

Define se o Folder está na lixeira do Drive do usuário. Somente o proprietário pode mover o Folder para a lixeira. O padrão para novos Folders é false.

Parâmetros

Nome	Tipo	Descrição
`trashed`	`Boolean`	`true` se o `Folder` precisar ser movido para a lixeira do Drive do usuário; `false` caso contrário

Retornar

Folder: Folder para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

Métodos obsoletos

`addFile(child)`

Obsoleto. Em vez disso, use File.moveTo(destination) ou createShortcut(targetId).

Adiciona o arquivo especificado à pasta atual. Esse método não move o arquivo da pasta mãe atual. Um arquivo pode ter mais de uma pasta mãe simultaneamente.

Parâmetros

Nome	Tipo	Descrição
`child`	`File`	O arquivo filho a ser adicionado.

Retornar

Folder: o novo elemento pai do arquivo adicionado como filho.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`addFolder(child)`

Obsoleto. Em vez disso, use moveTo(destination) ou createShortcut(targetId).

Adiciona a pasta especificada à pasta atual. Esse método não move a pasta da pasta mãe atual. Uma pasta pode ter mais de uma pasta mãe simultaneamente.

Parâmetros

Nome	Tipo	Descrição
`child`	`Folder`	A pasta filha a ser adicionada.

Retornar

Folder: o novo pai da pasta adicionada como filha.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeFile(child)`

Obsoleto. Em vez disso, use File.moveTo(destination).

Remove o arquivo especificado da pasta atual. Esse método não exclui o arquivo, mas se um arquivo for removido de todos os itens principais, ele não poderá ser visto no Drive, a menos que seja pesquisado ou que a visualização "Todos os itens" seja usada.

Parâmetros

Nome	Tipo	Descrição
`child`	`File`	O arquivo filho a ser removido.

Retornar

Folder: o pai anterior da criança.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeFolder(child)`

Obsoleto. Em vez disso, use moveTo(destination).

Remove a pasta especificada da pasta atual. Esse método não exclui a pasta nem o conteúdo dela, mas se uma pasta for removida de todos os itens principais, ela não poderá ser vista no Drive, exceto se você pesquisar ou usar a visualização "Todos os itens".

Parâmetros

Nome	Tipo	Descrição
`child`	`Folder`	A pasta filha a ser removida.

Retornar

Folder: o pai anterior da criança.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

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

Métodos

Métodos obsoletos

Documentação detalhada

addEditor(emailAddress)

Parâmetros

Retornar

Autorização

addEditor(user)

Parâmetros

Retornar

Autorização

addEditors(emailAddresses)

Parâmetros

Retornar

Autorização

addViewer(emailAddress)

Parâmetros

Retornar

Autorização

addViewer(user)

Parâmetros

Retornar

Autorização

addViewers(emailAddresses)

Parâmetros

Retornar

Autorização

createFile(blob)

Parâmetros

Retornar

Autorização

createFile(name, content)

Parâmetros

Retornar

Autorização

createFile(name, content, mimeType)

Parâmetros

Retornar

Autorização

createFolder(name)

Parâmetros

Retornar

Autorização

createShortcut(targetId)

Parâmetros

Retornar

Autorização

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Parâmetros

Retornar

Autorização

getAccess(email)

Parâmetros

Retornar

Autorização

getAccess(user)

Parâmetros

Retornar

Autorização

getDateCreated()

Retornar

Autorização

getDescription()

Retornar

Autorização

getEditors()

Retornar

Autorização

getFiles()

Retornar

Autorização

getFilesByName(name)

Parâmetros

Retornar

Autorização

getFilesByType(mimeType)

Parâmetros

Retornar

Autorização

Class Folder

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`createFile(blob)`

`createFile(name, content)`

`createFile(name, content, mimeType)`

`createFolder(name)`

`createShortcut(targetId)`

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

`getAccess(email)`

`getAccess(user)`

`getDateCreated()`

`getDescription()`

`getEditors()`

`getFiles()`

`getFilesByName(name)`

`getFilesByType(mimeType)`

`getFolders()`

`getFoldersByName(name)`

`getId()`

`getLastUpdated()`

`getName()`

`getOwner()`

`getParents()`

`getResourceKey()`

`getSecurityUpdateEligible()`

`getSecurityUpdateEnabled()`

`getSharingAccess()`

`getSharingPermission()`

`getSize()`

`getUrl()`

`getViewers()`

`isShareableByEditors()`

`isStarred()`

`isTrashed()`

`moveTo(destination)`

`removeEditor(emailAddress)`

`removeEditor(user)`

`removeViewer(emailAddress)`