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 o 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 informado. |
createShortcut(targetId) | File | Cria e retorna um atalho para o código do item do Drive fornecido. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Cria e retorna um atalho para o ID do item do Drive e a chave de recurso fornecidos. |
getAccess(email) | Permission | Recebe a permissão concedida ao usuário em questão. |
getAccess(user) | Permission | Recebe a permissão concedida ao usuário em questão. |
getDateCreated() | Date | Extrai a data em que o Folder foi criado. |
getDescription() | String | Recebe a descrição do Folder . |
getEditors() | User[] | Recebe a lista de editores deste Folder . |
getFiles() | FileIterator | Extrai uma coleção de todos os arquivos filhos da pasta atual. |
getFilesByName(name) | FileIterator | Extrai uma coleção de todos os arquivos filhos da pasta atual e que têm o nome indicado. |
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 | Extrai uma coleção de todas as pastas filhas da pasta atual. |
getFoldersByName(name) | FolderIterator | Extrai uma coleção de todas as pastas filhas da pasta atual e que têm o nome indicado. |
getId() | String | Recebe o ID do Folder . |
getLastUpdated() | Date | Recebe a data da última atualização do Folder . |
getName() | String | Recebe o nome do Folder . |
getOwner() | User | Recebe o proprietário deste Folder . |
getParents() | FolderIterator | Recebe uma coleção de pastas que são pais imediatos de Folder . |
getResourceKey() | String | Recebe a chave de recurso do Folder que é necessária para acessar itens que
foram compartilhados usando um link. |
getSecurityUpdateEligible() | Boolean | Descobre se este Folder está qualificado para aplicar a atualização de segurança que
requer uma chave de recurso para acesso quando ele é compartilhado usando um link. |
getSecurityUpdateEnabled() | Boolean | Descobre se este Folder requer uma chave de recurso para acesso quando ele é
compartilhado usando um link. |
getSharingAccess() | Access | Extrai qual classe de usuários pode acessar o Folder , além de todos os usuários
individuais que receberam acesso explicitamente. |
getSharingPermission() | Permission | Recebe a permissão concedida aos usuários que podem acessar o Folder ,
além de qualquer usuário individual que tenha recebido acesso explicitamente. |
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 o Drive ou o 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 no Folder podem
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 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 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 filhos da pasta atual e correspondem aos critérios de pesquisa fornecidos. |
searchFolders(params) | FolderIterator | Recebe uma coleção de todas as pastas filhas da pasta atual e correspondem aos critérios de pesquisa fornecidos. |
setDescription(description) | Folder | Define a descrição do Folder . |
setName(name) | Folder | Define o nome do Folder . |
setOwner(emailAddress) | Folder | Muda o proprietário de Folder . |
setOwner(user) | Folder | Muda o proprietário de Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Define se o Folder requer uma chave de recurso para acesso quando é
compartilhado por um link. |
setShareableByEditors(shareable) | Folder | Define se os usuários com permissões para edição no 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
eles recebem, além de 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 o Folder está na lixeira do Drive do usuário. |
Documentação detalhada
addEditor(emailAddress)
Adiciona o usuário especificado à lista de editores do Folder
. Se o usuário já estiver
na lista de espectadores, esse método o removerá da lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário a ser adicionado. |
Retorno
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á estiver
na lista de espectadores, esse método o removerá da lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário a ser adicionado. |
Retorno
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 especificada à lista de editores do Folder
. Se algum dos
usuários já estiver na lista de espectadores, esse método o removerá da lista de
espectadores.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddresses | String[] | Uma matriz de endereços de e-mail dos usuários a serem adicionados. |
Retorno
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á estiver na lista de editores, esse método não terá efeito.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário a ser adicionado. |
Retorno
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á estiver 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. |
Retorno
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 leitores para o Folder
. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para ele.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddresses | String[] | Uma matriz de endereços de e-mail dos usuários a serem adicionados. |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
blob | BlobSource | Os dados do novo arquivo. |
Retorno
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. 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. |
Retorno
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. 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. |
Retorno
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)
createShortcut(targetId)
Cria e retorna um atalho para o código do item do Drive fornecido.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
targetId | String | O ID do arquivo ou pasta de destino. |
Retorno
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 e retorna um atalho para o ID do item do Drive e a chave de recurso fornecidos. Uma chave de recurso é um parâmetro extra que precisa ser transmitido para acessar o arquivo ou a pasta de destino 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. |
Retorno
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 em questão.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
email | String | o endereço de e-mail do usuário cujas permissões devem ser verificadas |
Retorno
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 em questão.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | uma representação do usuário cujas permissões devem ser verificadas |
Retorno
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()
getDescription()
getEditors()
Recebe a lista de editores deste Folder
. Se o usuário que executa o script não tiver acesso para editar 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()); }
Retorno
User[]
: a lista de editores para esse Folder
, se o usuário tiver acesso para editar. Caso contrário, será uma matriz vazia.
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()
Extrai uma coleção de todos os arquivos filhos da pasta atual.
Retorno
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)
Extrai uma coleção de todos os arquivos filhos da pasta atual e que têm o nome indicado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | O nome dos arquivos a serem localizados. |
Retorno
FileIterator
: uma coleção de todos os arquivos filhos da pasta atual e que têm o nome determinado.
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 que têm o tipo MIME especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
mimeType | String | O tipo MIME dos arquivos a serem encontrados. |
Retorno
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()
Extrai uma coleção de todas as pastas filhas da pasta atual.
Retorno
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)
Extrai uma coleção de todas as pastas filhas da pasta atual e que têm o nome indicado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | O nome das pastas a serem encontradas. |
Retorno
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 exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
getLastUpdated()
Recebe a data da última atualização do Folder
.
Retorno
Date
: a data em que o Folder
foi atualizado pela última vez
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()
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());
Retorno
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 de Folder
.
Retorno
FolderIterator
: uma coleção de pastas que são pais imediatos de 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
que é necessária para acessar itens que
foram compartilhados usando um link.
Retorno
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()
Descobre se este Folder
está qualificado para aplicar a atualização de segurança que
requer uma chave de recurso para acesso quando ele é compartilhado usando um link.
O Drive exige uma chave de recurso para acessar alguns arquivos ou pastas que foram compartilhados por 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 da chave de recurso para arquivos qualificados, use
setSecurityUpdateEnabled
.
Saiba mais sobre a Atualização de segurança do Google Drive.
Retorno
Boolean
: se o requisito da chave de recurso pode ser aplicado para 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
getSecurityUpdateEnabled()
Descobre se este Folder
requer uma chave de recurso para acesso quando ele é
compartilhado usando um link. Esse requisito é ativado por padrão para as pastas e os arquivos qualificados.
Para ativar ou desativar o requisito da chave de recurso para arquivos qualificados, use
setSecurityUpdateEnabled
.
Saiba mais sobre a Atualização de segurança do Google Drive.
Retorno
Boolean
: se o requisito da chave de recurso está ativado para esse 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()
Extrai qual classe de usuários pode acessar o Folder
, além de todos os usuários
individuais que receberam acesso explicitamente.
Retorno
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 qualquer usuário individual que tenha recebido acesso explicitamente.
Retorno
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. Observe que
os arquivos do aplicativo Google Workspace não são contabilizados nos limites de armazenamento do Drive e, portanto, retornam
0
bytes.
Retorno
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 Google app, como o Drive ou o Documentos.
Retorno
String
: o URL que pode ser usado para ver 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 leitores e comentadores deste Folder
. Se o usuário que executa o script não tiver acesso para editar 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 viewers and logs their names to the console. const viewers = folder.getViewers(); for (viewer of viewers) { console.log(viewer.getName()); }
Retorno
User[]
: a lista de leitores e comentadores para esse Folder
, se o usuário tiver acesso para editar. Caso contrário, será uma matriz vazia.
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 Drive do usuário.
Retorno
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.
Retorno
Boolean
: true
se o Folder
estiver na lixeira do Drive do usuário; se não estiver, 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
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 para editar a 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. |
Retorno
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 tenham acesso geral. Por exemplo, se 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, essa ação 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. |
Retorno
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 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 tenham acesso geral. Por exemplo, se 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, essa ação 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. |
Retorno
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 leitores e comentadores 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 impede que os usuários acessem o Folder
se eles pertencerem a uma classe de usuários com
acesso geral. Por exemplo, se 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, essa ação 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. |
Retorno
Folder
: esse 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 leitores e comentadores do Folder
. Esse
método não terá efeito se o usuário for um editor, não um visualizador. Esse método também não impede
que os usuários acessem o Folder
se eles pertencerem a uma classe de usuários com acesso
geral, por exemplo, se 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, essa ação 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. |
Retorno
Folder
: esse 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 especificado. Esse método não impede que os usuários acessem Folder
se eles pertencerem a uma classe de usuários com acesso geral, por exemplo, se Folder
for compartilhado com todo o domínio do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário cujo acesso será revogado. |
Retorno
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 Folder
se eles pertencerem a uma classe de usuários com acesso geral, por exemplo, se Folder
for compartilhado com todo o domínio do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário cujo acesso deve ser revogado. |
Retorno
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 filhos da pasta atual e correspondem aos critérios de pesquisa fornecidos. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. Observe que o serviço Drive usa a v2 da API Drive e alguns campos de consulta são diferentes da v3. Analise 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, faça o escape
correta 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. |
Retorno
FileIterator
: uma coleção 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 uma coleção de todas as pastas filhas da pasta atual e correspondem aos critérios de pesquisa fornecidos. Os critérios de pesquisa estão detalhados na documentação do SDK do Google Drive. Observe que o serviço Drive usa a v2 da API Drive e alguns campos de consulta são diferentes da v3. Analise 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, faça o escape
correta das aspas (por exemplo, "title contains 'Gulliver\\'s
Travels'"
ou 'title contains "Gulliver\'s Travels"'
).
// 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. |
Retorno
FolderIterator
: uma coleção 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)
setName(name)
setOwner(emailAddress)
Muda o proprietário de Folder
. Esse método também dá 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 |
Retorno
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 de Folder
. Esse método também dá 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 |
Retorno
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 é
compartilhado por um link. As pastas e os arquivos 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 da chave de recurso será ativado para o Folder . |
Retorno
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
eles recebem, além de 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 pode acessar o Folder . |
permissionType | Permission | as permissões que precisam ser concedidas aos usuários que podem acessar o Folder . |
Retorno
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
está marcado com estrela no Drive do usuário. O padrão para
novos Folder
s é 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 tiver sido |
Retorno
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. Somente o
proprietário pode enviar a Folder
para a lixeira. O padrão para novos Folder
s é false
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
trashed | Boolean | true se o Folder precisar ser movido para a lixeira do Drive do usuário; caso contrário, false . |
Retorno
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