Class Folder

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

Uma pasta no Google Drive. As pastas podem ser acessadas ou criadas a partir de 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étodoTipo de retornoBreve descrição
addEditor(emailAddress)FolderAdiciona o usuário especificado à lista de editores de Folder.
addEditor(user)FolderAdiciona o usuário especificado à lista de editores de Folder.
addEditors(emailAddresses)FolderAdiciona a matriz especificada de usuários à lista de editores de Folder.
addViewer(emailAddress)FolderAdiciona o usuário especificado à lista de visualizadores do Folder.
addViewer(user)FolderAdiciona o usuário especificado à lista de visualizadores do Folder.
addViewers(emailAddresses)FolderAdiciona a matriz de usuários especificada à lista de visualizadores de Folder.
createFile(blob)FileCria um arquivo na pasta atual com base em um determinado Blob de dados arbitrários.
createFile(name, content)FileCria um arquivo de texto na pasta atual com o nome e o conteúdo fornecidos.
createFile(name, content, mimeType)FileCria um arquivo na pasta atual com o nome, o conteúdo e o tipo MIME fornecidos.
createFolder(name)FolderCria uma pasta na pasta atual com o nome fornecido.
createShortcut(targetId)FileCria um atalho para o código do item do Drive informado e o retorna.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCria um atalho para o código do item do Drive e a chave de recurso retornados.
getAccess(email)PermissionRecebe a permissão concedida ao usuário especificado.
getAccess(user)PermissionRecebe a permissão concedida ao usuário especificado.
getDateCreated()DateRecebe a data em que o Folder foi criado.
getDescription()StringRecebe a descrição do Folder.
getEditors()User[]Recebe a lista de editores desse Folder.
getFiles()FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual.
getFilesByName(name)FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual e tem o nome informado.
getFilesByType(mimeType)FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual e tem o tipo MIME fornecido.
getFolders()FolderIteratorRecebe um conjunto de todas as pastas filhas da pasta atual.
getFoldersByName(name)FolderIteratorRecebe um conjunto de todas as pastas filhas da pasta atual e tem o nome fornecido.
getId()StringRecebe o ID da Folder.
getLastUpdated()DateRecebe a data da última atualização de Folder.
getName()StringRecebe o nome da Folder.
getOwner()UserRecebe o proprietário do Folder.
getParents()FolderIteratorRecebe um conjunto de pastas que são pais imediatos do Folder.
getResourceKey()StringRecebe a chave de recurso do Folder necessária para acessar os itens que foram compartilhados usando um link.
getSecurityUpdateEligible()BooleanRecebe se este Folder está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando for compartilhada usando um link.
getSecurityUpdateEnabled()BooleanRecebe se esse Folder exige uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSharingAccess()AccessRecebe qual classe de usuários pode acessar o Folder, além de todos os usuários individuais que receberam acesso explicitamente.
getSharingPermission()PermissionRecebe a permissão concedida aos usuários que podem acessar o Folder, além de todos os usuários individuais que receberam acesso explicitamente.
getSize()IntegerRecebe o número de bytes usados para armazenar o Folder no Drive.
getUrl()StringRecebe o URL que pode ser usado para abrir Folder em um app do Google, como o Drive ou o Documentos.
getViewers()User[]Recebe a lista de espectadores e comentaristas deste Folder.
isShareableByEditors()BooleanDetermina se os usuários com permissões para edição do Folder podem compartilhar com outros usuários ou mudar as permissões.
isStarred()BooleanDetermina se o Folder foi marcado com estrela no Google Drive do usuário.
isTrashed()BooleanDetermina se o Folder está na lixeira do Drive do usuário.
moveTo(destination)FolderMove este item para a pasta de destino fornecida.
removeEditor(emailAddress)FolderRemove o usuário especificado da lista de editores para o Folder.
removeEditor(user)FolderRemove o usuário especificado da lista de editores para o Folder.
removeViewer(emailAddress)FolderRemove o usuário em questão da lista de leitores e comentaristas do Folder.
removeViewer(user)FolderRemove o usuário em questão da lista de leitores e comentaristas do Folder.
revokePermissions(user)FolderRevoga o acesso ao Folder concedido ao usuário especificado.
revokePermissions(user)FolderRevoga o acesso ao Folder concedido ao usuário especificado.
searchFiles(params)FileIteratorRecebe um conjunto de todos os arquivos filhos da pasta atual e corresponde aos critérios de pesquisa fornecidos.
searchFolders(params)FolderIteratorRecebe um conjunto de todas as pastas filhas da pasta atual e corresponde aos critérios de pesquisa especificados.
setDescription(description)FolderDefine a descrição do Folder.
setName(name)FolderDefine o nome da Folder.
setOwner(emailAddress)FolderMuda o proprietário do Folder.
setOwner(user)FolderMuda o proprietário do Folder.
setSecurityUpdateEnabled(enabled)FolderDefine se o Folder requer uma chave de recurso para acesso quando ele for compartilhado usando um link.
setShareableByEditors(shareable)FolderDefine se os usuários com permissões para edição do Folder podem compartilhar com outros usuários ou alterar as permissões.
setSharing(accessType, permissionType)FolderDefine qual classe de usuários pode acessar o Folder e quais permissões esses usuários recebem, além de todos os usuários individuais que receberam acesso explicitamente.
setStarred(starred)FolderDefine se o Folder é marcado com estrela no Google Drive do usuário.
setTrashed(trashed)FolderDefine se o Folder está na lixeira do Drive do usuário.

Documentação detalhada

addEditor(emailAddress)

Adiciona o usuário especificado à lista de editores de Folder. Se o usuário já estiver na lista de visualizadores, esse método vai promovê-lo fora da lista.

Parâmetros

NomeTipoDescrição
emailAddressStringO 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 de Folder. Se o usuário já estiver na lista de visualizadores, esse método vai promovê-lo fora da lista.

Parâmetros

NomeTipoDescrição
userUserUma 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 especificada de usuários à lista de editores de Folder. Se algum dos usuários já estiver na lista de visualizadores, esse método os promoverá fora da lista de espectadores.

Parâmetros

NomeTipoDescrição
emailAddressesString[]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 visualizadores do Folder. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

NomeTipoDescrição
emailAddressStringO 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 visualizadores do Folder. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

NomeTipoDescrição
userUserUma 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 especificada à lista de visualizadores de Folder. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para eles.

Parâmetros

NomeTipoDescrição
emailAddressesString[]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 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

NomeTipoDescrição
blobBlobSourceOs 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 fornecidos. Uma exceção será gerada 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

NomeTipoDescrição
nameStringO nome do novo arquivo.
contentStringO 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 fornecidos. Uma exceção será gerada 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

NomeTipoDescrição
nameStringO nome do novo arquivo.
contentStringO conteúdo do novo arquivo.
mimeTypeStringO 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 fornecido.

Parâmetros

NomeTipoDescrição
nameStringO 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 um atalho para o código do item do Drive informado e o retorna.

Parâmetros

NomeTipoDescrição
targetIdStringO 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 código do item do Drive e a chave de recurso retornados. Chaves de recurso são um parâmetro extra que precisa ser transmitido para acessar a pasta ou o arquivo de destino que foi compartilhado usando um link.

Parâmetros

NomeTipoDescrição
targetIdStringO ID da pasta ou do arquivo de destino.
targetResourceKeyStringChave de recurso da pasta ou do arquivo 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 ao usuário especificado.

Parâmetros

NomeTipoDescrição
emailStringEndereç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 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 ao usuário especificado.

Parâmetros

NomeTipoDescrição
userUseruma 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 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 a Folder foi criada

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 desse Folder. Se o usuário que executar o script não tiver acesso para editar a Folder, esse método retornará uma matriz vazia.

Retornar

User[]: uma matriz de usuários com permissão para ediçã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

getFiles()

Recebe um conjunto 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 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 um conjunto de todos os arquivos filhos da pasta atual e tem o nome informado.

Parâmetros

NomeTipoDescrição
nameStringO 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 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 um conjunto de todos os arquivos filhos da pasta atual e tem o tipo MIME fornecido.

Parâmetros

NomeTipoDescrição
mimeTypeStringO tipo MIME dos arquivos a serem encontrados.

Retornar

FileIterator: uma coleção de todos os arquivos filhos da pasta atual e que 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 um conjunto de todas as pastas filhas da pasta atual.

Retornar

FolderIterator: um conjunto 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 um conjunto de todas as pastas filhas da pasta atual e tem o nome fornecido.

Parâmetros

NomeTipoDescrição
nameStringO nome das pastas que você quer encontrar.

Retornar

FolderIterator: um conjunto de todas as pastas filhas da pasta atual e que têm o nome fornecido.

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 da 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 de 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 da Folder.

Retornar

String: o nome da 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 do Folder.

Retornar

User: um objeto User que representa o proprietá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

getParents()

Recebe um conjunto de pastas que são pais imediatos do Folder.

Retornar

FolderIterator: uma coleção de pastas que são mães imediatas 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 os itens que foram compartilhados usando um link.

Retornar

String: a chave de recurso da 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 requer uma chave de recurso para acesso quando for compartilhada usando um link.

O Drive exige uma chave de recurso para acessar alguns arquivos ou pastas compartilhados com um link. Essa mudança faz parte de uma atualização de segurança. A atualização é ativada 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 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 esse Folder exige uma chave de recurso para acesso quando ele é compartilhado usando um link. Esse requisito é ativado por padrão para pastas e arquivos 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 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 qual classe de usuários pode acessar o Folder, além de todos os usuários individuais que receberam acesso explicitamente.

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 todos os usuários individuais que receberam acesso explicitamente.

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 do 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 Folder em um app do Google, como o Drive ou o Documentos.

Retornar

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

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 espectadores e comentaristas deste Folder. Se o usuário que executa o script não tiver acesso para editar a Folder, esse método vai retornar uma matriz vazia.

Retornar

User[]: uma matriz de usuários com permissão para visualização ou comentá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 para edição do Folder podem compartilhar com outros usuários ou mudar 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 mudarem as permissões. false se não tiverem permissã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 com estrela no Google Drive do usuário.

Retornar

Boolean: true se Folder estiver marcado com estrela no Drive do usuário. Caso contrário, false.

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 Folder estiver na lixeira do Drive do usuário. false em caso negativo

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 este 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 a pasta mãe do item atual para mover o item para a pasta de destino.

Parâmetros

NomeTipoDescrição
destinationFolderA 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 para o Folder. Esse método não impede que os usuários acessem o Folder se pertencerem a uma classe de usuários que tenham 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.

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

Parâmetros

NomeTipoDescrição
emailAddressStringO 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)

Remove o usuário especificado da lista de editores para o Folder. Esse método não impede que os usuários acessem o Folder se pertencerem a uma classe de usuários que tenham 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.

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

Parâmetros

NomeTipoDescrição
userUserUma 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 em questão da lista de leitores e comentaristas do Folder. Esse método não terá efeito se o usuário for um editor, não um leitor ou comentarista. Esse método também não impedirá que os usuários acessem o Folder se 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.

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

Parâmetros

NomeTipoDescrição
emailAddressStringO 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

removeViewer(user)

Remove o usuário em questão da lista de leitores e comentaristas do Folder. Esse método não terá 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 pertencerem a uma classe de usuários com acesso geral, por exemplo, se o Folder for compartilhado com todo o domínio do usuário 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 editores.

Parâmetros

NomeTipoDescrição
userUserUma 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

revokePermissions(user)

Revoga o acesso ao Folder concedido ao usuário especificado. Esse método não impede que os usuários acessem o Folder se 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.

Parâmetros

NomeTipoDescrição
userStringEndereç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)

Revoga o acesso ao Folder concedido ao usuário especificado. Esse método não impede que os usuários acessem o Folder se 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.

Parâmetros

NomeTipoDescrição
userUseruma representação do usuário cujo acesso precisa 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

searchFiles(params)

Recebe um conjunto de todos os arquivos filhos da pasta atual e corresponde aos critérios de pesquisa fornecidos. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. O argumento params é uma string de consulta que pode conter valores de string. Portanto, evite usar aspas corretamente (por exemplo, "title contains 'Gulliver\\'s Travels'" ou 'title contains "Gulliver\'s Travels"').

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

Parâmetros

NomeTipoDescrição
paramsStringSão os critérios de pesquisa, conforme detalhado na documentação do SDK do Google Drive.

Retornar

FileIterator: um conjunto de todos os arquivos filhos da pasta atual e que 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 um conjunto de todas as pastas filhas da pasta atual e corresponde aos critérios de pesquisa especificados. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. O argumento params é uma string de consulta que pode conter valores de string. Portanto, evite usar aspas corretamente (por exemplo, "title contains 'Gulliver\\'s Travels'" ou 'title contains "Gulliver\'s Travels"').

// Log 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();
  Logger.log(folder.getName());
}

Parâmetros

NomeTipoDescrição
paramsStringSão os critérios de pesquisa, conforme detalhado na documentação do SDK do Google Drive.

Retornar

FolderIterator: um conjunto de todas as pastas filhas da pasta atual e que 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

NomeTipoDescrição
descriptionStringa nova descrição do 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

setName(name)

Define o nome da Folder.

Parâmetros

NomeTipoDescrição
nameStringo novo nome do 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

setOwner(emailAddress)

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

Parâmetros

NomeTipoDescrição
emailAddressStringo 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 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 dá ao proprietário anterior acesso explícito para edição ao Folder.

Parâmetros

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

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

setSecurityUpdateEnabled(enabled)

Define se o Folder requer uma chave de recurso para acesso quando ele for compartilhado usando um link. As pastas e os arquivos qualificados ficam ativados por padrão.

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

Parâmetros

NomeTipoDescrição
enabledBooleanDefine se o requisito da chave de recurso para o Folder será ativado.

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 para edição do Folder podem compartilhar com outros usuários ou alterar as permissões. O padrão para um novo Folder é true.

Parâmetros

NomeTipoDescrição
shareableBooleantrue se os usuários com permissões para edição puderem compartilhar com outros usuários ou mudar as permissões. false se não tiverem permissã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 esses usuários recebem, além de todos os 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

NomeTipoDescrição
accessTypeAccessqual classe de usuários poderá acessar o Folder
permissionTypePermissionas 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 exigem autorização com um ou mais dos seguintes escopos:

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

setStarred(starred)

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

Parâmetros

NomeTipoDescrição
starredBooleantrue se o Folder precisar ser marcado com estrela no Drive do usuário. Caso contrário, false.

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

setTrashed(trashed)

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

Parâmetros

NomeTipoDescrição
trashedBooleantrue se o Folder precisar ser movido para a lixeira do Drive do usuário. Caso contrário, será false

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

Métodos obsoletos