Esta página foi traduzida pela API Cloud Translation.

Class Folder

Uma pasta no Google Drive. As pastas podem ser acessadas ou criadas no DriveApp.

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var 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 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.

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 visualizadores, esse método promove o usuário para fora da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	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 precisam de 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 visualizadores, esse método promove o usuário para fora da lista de leitores.

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 precisam de autorização com um ou mais dos seguintes escopos:

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

`addEditors(emailAddresses)`

Adiciona a matriz de usuários especificada à lista de editores do Folder. Se algum dos usuários já estavam na lista de visualizadores, este método os promove para fora da lista de os espectadores.

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 precisam de 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 terá efeito.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	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 precisam de 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 terá 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`addViewers(emailAddresses)`

Adiciona a matriz de usuários especificada à lista de leitores para Folder. Se algum dos usuários já estavam na lista de editores, este 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`createFile(blob)`

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

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(blob);

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 precisam de 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 fornecidos. Lança 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 precisam de 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 fornecidos. Gera uma 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 precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`createShortcut(targetId)`

Cria um atalho para o código de item do Google Drive fornecido e o retorna.

Parâmetros

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

Retornar

File: o novo atalho.

Autorização

Os scripts que usam esse método precisam de 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 de recurso fornecidos e o retorna. Um recurso key é um parâmetro adicional que precisa ser transmitido para acessar o arquivo ou a pasta de destino que foi compartilhado 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 pasta de destino.
`targetResourceKey`	`String`	A chave de recurso do arquivo ou pasta de destino.

Retornar

File: o novo atalho.

Autorização

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

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

`getAccess(email)`

Recebe a permissão concedida ao usuário especificado.

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	o endereço de e-mail do usuário cujas permissões devem ser verificadas

Retornar

Permission: as permissões concedidas ao usuário

Autorização

Os scripts que usam esse método precisam de 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 ao usuário especificado.

Parâmetros

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

Retornar

Permission: as permissões concedidas ao usuário

Autorização

Os scripts que usam esse método precisam de 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 de criação do Folder.

Retornar

Date: a data de criação do Folder.

Autorização

Os scripts que usam esse método precisam de 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 de Folder

Autorização

Os scripts que usam esse método precisam de 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 desse Folder. Se o usuário que executa o script não tiver acesso para editar a Folder, esse método 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 (editor of editors) {
  console.log(editor.getName());
}

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 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 precisam de 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 determinado.

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 e que têm o nome fornecido.

Autorização

Os scripts que usam esse método precisam de 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 que têm 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 MIME especificado não é válido.

Autorização

Os scripts que usam esse método precisam de 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 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 precisam de 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 e com o nome determinado.

Parâmetros

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

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 do Folder.

Retornar

String: o ID de Folder.

Autorização

Os scripts que usam esse método precisam de 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 em que o Folder foi atualizado pela última vez.

Retornar

Date: a data em que o Folder foi atualizado pela última vez

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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 precisam de 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 mães imediatas do Folder.

Retornar

FolderIterator: uma coleção de pastas que são mães imediatas de Folder.

Autorização

Os scripts que usam esse método precisam de 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 os itens que foram compartilhadas usando um link.

Retornar

String: a chave de recurso do Folder.

Autorização

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

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

`getSecurityUpdateEligible()`

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.

O Google Drive exige uma chave de recurso para acessar alguns arquivos ou pastas que foram compartilhados usando um . Essa mudança faz parte de uma atualização de segurança. A atualização é ativada por padrão para os canais arquivos e pastas. Para ativar ou desativar o requisito de chave de recurso nos arquivos qualificados, use setSecurityUpdateEnabled:

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

Retornar

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

Autorização

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

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

`getSecurityUpdateEnabled()`

Descobre se este Folder precisa de uma chave de recurso para acesso quando é compartilhada usando um link. Esse requisito é ativado por padrão para arquivos e pastas qualificados. Para ativar ou desativar o requisito de chave de recurso para arquivos qualificados, use setSecurityUpdateEnabled.

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

Retornar

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

Autorização

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

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

`getSharingAccess()`

Extrai qual classe de usuários pode acessar o Folder, além de qualquer usuários 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 precisam de 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 dos 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 precisam de 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. Observe que Os arquivos de aplicativo do Google Workspace não são contabilizados nos limites de armazenamento do Drive e, portanto, retornam 0 bytes.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 Google app, como Drive ou Documentos.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 comentadores deste Folder. Se o usuário que executa o script não tem acesso de edição para o Folder, este método retorna 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 (viewer of viewers) {
  console.log(viewer.getName());
}

Retornar

User[]: a lista de leitores e comentadores deste Folder, se o usuário tiver feito edições acesso ou uma matriz vazia.

Autorização

Os scripts que usam esse método precisam de 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 para edição do Folder têm permissão para compartilhar com outros usuários ou alterar as permissões.

Retornar

Boolean — true se os usuários com permissões para edição tiverem permissão para compartilhar com outros usuários ou alterar as permissões; false se não for

Autorização

Os scripts que usam esse método precisam de 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 com estrela no Drive do usuário.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 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 for

Autorização

Os scripts que usam esse método precisam de 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 esse item para a pasta de destino fornecida.

O usuário atual precisa ser o proprietário do arquivo ou ter pelo menos acesso para editar o pasta pai atual para mover o item 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 precisam de 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 bloquear o acesso de usuários a Folder se eles pertencerem a uma classe de usuários acesso geral, por exemplo, se o Folder for compartilhado com todo o ou se Folder estiver em um drive compartilhado que o usuário pode acessar.

Nos 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`removeEditor(user)`

Nos 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 precisam de 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 leitores e comentadores do Folder. Isso não terá efeito se o usuário for um editor, não um leitor ou comentador. Esse método também não impede que os usuários acessem a Folder caso pertençam a uma classe de usuários que ter acesso geral, por exemplo, se o Folder for compartilhado com o o domínio inteiro ou se o Folder estiver em um drive compartilhado que o usuário possa acessar.

Nos 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: este Folder para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 leitores e comentadores do Folder. Isso não terá efeito se o usuário for um editor, não um leitor. Esse método também não bloqueia que os usuários acessem a Folder caso pertençam a uma classe de usuários com problemas acesso, 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.

Nos 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: este Folder para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 especificado. Esse método não bloquear o acesso de usuários a Folder se eles pertencerem a uma classe de usuários que ter acesso geral, por exemplo, se o Folder for compartilhado com o em todo o domínio.

Parâmetros

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

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 terá o acesso revogado.

Retornar

Folder: este Folder, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 à pesquisa especificada critérios. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. Observe que o Drive usa a v2 da API Drive e alguns campos de consulta são diferentes da v3. Revise o campo as diferenças entre a v2 e a v3.

O argumento params é uma string de consulta que pode conter valores de string, então tenha cuidado para usar o escape correto das aspas (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.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var 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 à pesquisa. critérios.

Autorização

Os scripts que usam esse método precisam de 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 filhas da pasta atual e que correspondem à pesquisa especificada critérios. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. Observe que o Drive usa a v2 da API Drive e alguns campos de consulta são diferentes da v3. Revise o campo as diferenças 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.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var 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 filhas da pasta atual e que correspondem à pesquisa critérios.

Autorização

Os scripts que usam esse método precisam de 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 de `Folder`

Retornar

Folder: este Folder, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 objeto `Folder`

Retornar

Folder: este Folder, para encadeamento

Autorização

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

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

`setOwner(emailAddress)`

Altera o proprietário de Folder. Esse método também fornece ao proprietário anterior acesso explícito para edição ao Folder.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	o endereço de e-mail do usuário que deve se tornar o novo proprietário

Retornar

Folder: este Folder, para encadeamento

Autorização

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

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

`setOwner(user)`

Altera o proprietário de Folder. Esse método também fornece ao proprietário anterior acesso explícito para edição ao Folder.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	uma representação do usuário que deve se tornar o novo proprietário

Retornar

Folder: este Folder, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 é compartilhada 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 precisam de 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 para edição do Folder têm permissão para compartilhar com outros usuários ou alterar as permissões. O padrão para uma nova Folder é true.

Parâmetros

Nome	Tipo	Descrição
`shareable`	`Boolean`	`true` se os usuários com permissões para edição tiverem permissão para compartilhar com outros usuários ou alterar as permissões; `false` caso contrário

Retornar

Folder: este Folder, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 esses usuários recebem, além dos usuários individuais que receberam acesso explicitamente.

// 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.)
var 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 vai poder acessar o `Folder`
`permissionType`	`Permission`	as permissões que precisam ser concedidas aos usuários que podem acessar o `Folder`

Retornar

Folder: este Folder, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 são false.

Parâmetros

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

Retornar

Folder: este Folder, para encadeamento

Autorização

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

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

`setTrashed(trashed)`

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

Parâmetros

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

Retornar

Folder: este Folder, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 para fora do pasta principal existente. um arquivo pode ter mais de um pai simultaneamente.

Parâmetros

Nome	Tipo	Descrição
`child`	`File`	O arquivo secundário a ser adicionado.

Retornar

Folder: o novo pai do arquivo adicionado como filho.

Autorização

Os scripts que usam esse método precisam de 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 sua pasta pai existente; uma pasta pode ter mais de um elemento pai 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 precisam de 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 principais, ele não poderá ser visto no Drive, exceto na pesquisa ou a opção "Todos os itens" visualização.

Parâmetros

Nome	Tipo	Descrição
`child`	`File`	O arquivo secundário a ser removido.

Retornar

Folder: o pai anterior do filho.

Autorização

Os scripts que usam esse método precisam de 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 ou o conteúdo dela. Porém, se uma pasta for removida de todas as pastas principais, ela não poderá ser vista no Drive. exceto ao pesquisar ou usar a opção "Todos os itens" visualização.

Parâmetros

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

Retornar

Folder: o pai anterior do filho.

Autorização

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

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