Um arquivo no Google Drive. Os arquivos podem ser acessados ou criados a partir do DriveApp
.
// Trash every untitled spreadsheet that hasn't been updated in a week. var files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { var file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addCommenter(emailAddress) | File | Adicione o usuário em questão à lista de comentaristas do File . |
addCommenter(user) | File | Adicione o usuário em questão à lista de comentaristas do File . |
addCommenters(emailAddresses) | File | Adicione a matriz especificada de usuários à lista de comentaristas para o File . |
addEditor(emailAddress) | File | Adiciona o usuário especificado à lista de editores de File . |
addEditor(user) | File | Adiciona o usuário especificado à lista de editores de File . |
addEditors(emailAddresses) | File | Adiciona a matriz especificada de usuários à lista de editores de File . |
addViewer(emailAddress) | File | Adiciona o usuário especificado à lista de visualizadores do File . |
addViewer(user) | File | Adiciona o usuário especificado à lista de visualizadores do File . |
addViewers(emailAddresses) | File | Adiciona a matriz de usuários especificada à lista de visualizadores de File . |
getAccess(email) | Permission | Recebe a permissão concedida ao usuário especificado. |
getAccess(user) | Permission | Recebe a permissão concedida ao usuário especificado. |
getAs(contentType) | Blob | Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getDateCreated() | Date | Recebe a data em que o File foi criado. |
getDescription() | String | Recebe a descrição do File . |
getDownloadUrl() | String | Recebe o URL que pode ser usado para fazer o download do arquivo. |
getEditors() | User[] | Recebe a lista de editores desse File . |
getId() | String | Recebe o ID da File . |
getLastUpdated() | Date | Recebe a data da última atualização de File . |
getMimeType() | String | Recebe o Tipo MIME do arquivo. |
getName() | String | Recebe o nome da File . |
getOwner() | User | Recebe o proprietário do File . |
getParents() | FolderIterator | Recebe um conjunto de pastas que são pais imediatos do File . |
getResourceKey() | String | Recebe a chave de recurso do File necessária para acessar os itens que foram compartilhados usando um link. |
getSecurityUpdateEligible() | Boolean | Recebe se este File 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() | Boolean | Recebe se esse File exige uma chave de recurso para acesso quando ele é compartilhado usando um link. |
getSharingAccess() | Access | Recebe qual classe de usuários pode acessar o File , 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 File , além de todos os usuários individuais que receberam acesso explicitamente. |
getSize() | Integer | Recebe o número de bytes usados para armazenar o File no Drive. |
getTargetId() | String | Se esse for um atalho, retorna o ID do item ao qual ele aponta. |
getTargetMimeType() | String | Se for um atalho, retornará o tipo MIME do item ao qual ele aponta. |
getTargetResourceKey() | String | Se o arquivo for um atalho, retornará a chave de recurso do item a que ele aponta. |
getThumbnail() | Blob | Recebe uma imagem em miniatura para o arquivo, ou null se não houver miniatura. |
getUrl() | String | Recebe o URL que pode ser usado para abrir File em um app do Google, como o Drive ou o Documentos. |
getViewers() | User[] | Recebe a lista de espectadores e comentaristas deste File . |
isShareableByEditors() | Boolean | Determina se os usuários com permissões para edição do File podem
compartilhar com outros usuários ou mudar as permissões. |
isStarred() | Boolean | Determina se o File foi marcado com estrela no Google Drive do usuário. |
isTrashed() | Boolean | Determina se o File está na lixeira do Drive do usuário. |
makeCopy() | File | Cria uma cópia do arquivo. |
makeCopy(destination) | File | Cria uma cópia do arquivo no diretório de destino. |
makeCopy(name) | File | Cria uma cópia do arquivo e nomeia-o com o nome fornecido. |
makeCopy(name, destination) | File | Cria uma cópia do arquivo no diretório de destino e o nomeia com o nome fornecido. |
moveTo(destination) | File | Move este item para a pasta de destino fornecida. |
removeCommenter(emailAddress) | File | Remove o usuário especificado da lista de comentaristas do File . |
removeCommenter(user) | File | Remove o usuário especificado da lista de comentaristas do File . |
removeEditor(emailAddress) | File | Remove o usuário especificado da lista de editores para o File . |
removeEditor(user) | File | Remove o usuário especificado da lista de editores para o File . |
removeViewer(emailAddress) | File | Remove o usuário em questão da lista de leitores e comentaristas do File . |
removeViewer(user) | File | Remove o usuário em questão da lista de leitores e comentaristas do File . |
revokePermissions(user) | File | Revoga o acesso ao File concedido ao usuário especificado. |
revokePermissions(user) | File | Revoga o acesso ao File concedido ao usuário especificado. |
setContent(content) | File | Substitui o conteúdo do arquivo por uma determinada substituição |
setDescription(description) | File | Define a descrição do File . |
setName(name) | File | Define o nome da File . |
setOwner(emailAddress) | File | Muda o proprietário do File . |
setOwner(user) | File | Muda o proprietário do File . |
setSecurityUpdateEnabled(enabled) | File | Define se o File requer uma chave de recurso para acesso quando ele for compartilhado usando um link. |
setShareableByEditors(shareable) | File | Define se os usuários com permissões para edição do File podem compartilhar
com outros usuários ou alterar as permissões. |
setSharing(accessType, permissionType) | File | Define qual classe de usuários pode acessar o File e quais permissões esses usuários recebem, além de todos os usuários individuais que receberam acesso explicitamente. |
setStarred(starred) | File | Define se o File é marcado com estrela no Google Drive do usuário. |
setTrashed(trashed) | File | Define se o File está na lixeira do Drive do usuário. |
Documentação detalhada
addCommenter(emailAddress)
Adicione o usuário em questão à lista de comentaristas do File
. Se o usuário já estiver na lista de usuários, esse método vai promovê-lo fora da lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário a ser adicionado. |
Retornar
File
: este File
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
addCommenter(user)
Adicione o usuário em questão à lista de comentaristas do File
. Se o usuário já estiver na lista de usuários, esse método vai promovê-lo fora da lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário a ser adicionado. |
Retornar
File
: este File
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
addCommenters(emailAddresses)
Adicione a matriz especificada de usuários à lista de comentaristas para o File
. Se algum
usuário já estiver na lista de visualizadores, esse método vai promovê-lo fora 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. |
Retornar
File
: este File
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(emailAddress)
Adiciona o usuário especificado à lista de editores de File
. Se o usuário já estiver
na lista de visualizadores, esse método vai promovê-lo fora da lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário a ser adicionado. |
Retornar
File
: este File
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 File
. Se o usuário já estiver
na lista de visualizadores, esse método vai promovê-lo fora da lista.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário a ser adicionado. |
Retornar
File
: este File
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 File
. Se algum dos
usuários já estiver na lista de visualizadores, esse método os promoverá fora 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. |
Retornar
File
: este File
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 File
. 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. |
Retornar
File
: este File
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 File
. 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. |
Retornar
File
: este File
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 File
. Se algum dos
usuários já estiver na lista de editores, esse método não terá efeito para eles.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddresses | String[] | Uma matriz de endereços de e-mail dos usuários a serem adicionados. |
Retornar
File
: este File
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
getAccess(email)
Recebe a permissão concedida ao usuário especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
email | String | 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 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
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 exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAs(contentType)
Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. Esse método adiciona a extensão apropriada ao nome do arquivo, por exemplo, "myfile.pdf". No entanto, supõe que a parte do nome do arquivo que segue o último período (se houver) é uma extensão existente que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".
Para ver as cotas diárias de conversões, consulte Cotas do Google Services. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a cotas mais rígidas.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
contentType | String | O tipo MIME para o qual será feita a conversão. Para a maioria dos blobs, 'application/pdf' é
a única opção válida. Para imagens nos formatos BMP, GIF, JPEG ou PNG, qualquer um dos 'image/bmp' , 'image/gif' , 'image/jpeg' ou 'image/png' também é válido. |
Retornar
Blob
: os dados como um blob.
getBlob()
getDateCreated()
getDescription()
getDownloadUrl()
Recebe o URL que pode ser usado para fazer o download do arquivo. Somente usuários com permissão para abrir o arquivo no Google Drive podem acessar o URL. É possível usar esse URL em um navegador para o download do arquivo, mas
não é possível usá-lo para buscar o arquivo com UrlFetchApp
. Se você quiser o conteúdo do
arquivo no script, use getBlob()
.
Retornar
String
: é o URL que pode ser usado para fazer o download do 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.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
Recebe a lista de editores desse File
. Se o usuário que executar o script não tiver acesso para editar a File
, 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
getId()
getLastUpdated()
getMimeType()
Recebe o Tipo MIME do arquivo.
Retornar
String
: o tipo MIME do 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.readonly
-
https://www.googleapis.com/auth/drive
getName()
getOwner()
getParents()
Recebe um conjunto de pastas que são pais imediatos do File
.
Retornar
FolderIterator
: uma coleção de pastas que são mães imediatas do File
.
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 File
necessária para acessar os itens que foram compartilhados usando um link.
Retornar
String
: a chave de recurso da File
.
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 File
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 File
.
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 File
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 File
.
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 File
, além de todos os usuários individuais que receberam acesso explicitamente.
Retornar
Access
: qual classe de usuários pode acessar o File
.
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 File
, 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 File
.
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 File
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 File
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
getTargetId()
Se esse for um atalho, retorna o ID do item ao qual ele aponta.
Caso contrário, retorna null
.
Retornar
String
: o ID do item de destino.
getTargetMimeType()
Se for um atalho, retornará o tipo MIME do item ao qual ele aponta.
Caso contrário, retorna null
.
Retornar
String
: o tipo MIME do item de destino.
getTargetResourceKey()
Se o arquivo for um atalho, retornará a chave de recurso do item a que ele aponta. As chaves de recurso são um parâmetro adicional que precisa ser passado para acessar os arquivos que foram compartilhados por meio de um link.
Se o arquivo não for um atalho, ele retornará null
.
Retornar
String
: a chave de recurso do item de destino ou null
, se o arquivo não for um 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.readonly
-
https://www.googleapis.com/auth/drive
getThumbnail()
Recebe uma imagem em miniatura para o arquivo, ou null
se não houver miniatura.
Retornar
Blob
: é a imagem em miniatura do 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.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
Recebe o URL que pode ser usado para abrir File
em um app do Google, como o Drive ou o Documentos.
Retornar
String
: o URL que pode ser usado para visualizar este File
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 File
. Se o usuário que
executa o script não tiver acesso para editar a File
, 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
isStarred()
Determina se o File
foi marcado com estrela no Google Drive do usuário.
Retornar
Boolean
: true
se File
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 File
está na lixeira do Drive do usuário.
Retornar
Boolean
: true
se File
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
makeCopy()
makeCopy(destination)
Cria uma cópia do arquivo no diretório de destino.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
destination | Folder | O diretório em que o arquivo será copiado. |
Retornar
File
: a nova cópia.
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
makeCopy(name)
Cria uma cópia do arquivo e nomeia-o com o nome fornecido.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | O nome do arquivo a ser aplicado à nova cópia. |
Retornar
File
: a nova cópia.
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
makeCopy(name, destination)
Cria uma cópia do arquivo no diretório de destino e o nomeia com o nome fornecido.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | O nome do arquivo a ser aplicado à nova cópia. |
destination | Folder | O diretório em que o arquivo será copiado. |
Retornar
File
: a nova cópia.
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
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
Nome | Tipo | Descrição |
---|---|---|
destination | Folder | A pasta que se torna o novo pai. |
Retornar
File
: este File
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
removeCommenter(emailAddress)
Remove o usuário especificado da lista de comentaristas do File
. Esse método
não impedirá que os usuários acessem o File
se pertencerem a uma classe de usuários
que têm acesso geral, por exemplo, se o File
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 a ser removido. |
Retornar
File
: este File
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
removeCommenter(user)
Remove o usuário especificado da lista de comentaristas do File
. Esse método
não impedirá que os usuários acessem o File
se pertencerem a uma classe de usuários
que têm acesso geral, por exemplo, se o File
for compartilhado com todo o domínio
do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário a ser removido. |
Retornar
File
: este File
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 File
. Esse método não
impede que os usuários acessem o File
se pertencerem a uma classe de usuários que tenham
acesso geral, por exemplo, se o File
for compartilhado com todo o domínio
do usuário ou se o File
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
File
: este File
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 File
. Esse método não
impede que os usuários acessem o File
se pertencerem a uma classe de usuários que tenham
acesso geral, por exemplo, se o File
for compartilhado com todo o domínio
do usuário ou se o File
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 |
---|---|---|
user | User | Uma representação do usuário a ser removido. |
Retornar
File
: este File
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 File
. 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 File
se pertencerem a uma classe de usuários que
têm acesso geral, por exemplo, se o File
for compartilhado com todo o domínio
do usuário ou se o File
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
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário a ser removido. |
Retornar
File
: este File
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 File
. 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 File
se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o File
for compartilhado com todo o domínio do usuário ou se File
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
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário a ser removido. |
Retornar
File
: este File
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 File
concedido ao usuário especificado. Esse método não
impede que os usuários acessem o File
se pertencerem a uma classe de usuários
que têm acesso geral, por exemplo, se o File
for compartilhado com todo o domínio
do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | String | Endereço de e-mail do usuário cujo acesso deve ser revogado |
Retornar
File
: este File
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 File
concedido ao usuário especificado. Esse método não
impede que os usuários acessem o File
se pertencerem a uma classe de usuários
que têm acesso geral, por exemplo, se o File
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 precisa ser revogado |
Retornar
File
: este File
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
setContent(content)
Substitui o conteúdo do arquivo por uma determinada substituição Uma exceção vai ser gerada se content
for maior que 10 MB.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
content | String | O novo conteúdo do arquivo. |
Retornar
File
: este File
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
setDescription(description)
setName(name)
setOwner(emailAddress)
Muda o proprietário do File
. Esse método também dá ao proprietário anterior acesso explícito para edição ao File
.
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
File
: este File
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 File
. Esse método também dá ao proprietário anterior acesso explícito para edição ao File
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | uma representação do usuário que deve se tornar o novo proprietário |
Retornar
File
: este File
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 File
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
Nome | Tipo | Descrição |
---|---|---|
enabled | Boolean | Define se o requisito da chave de recurso para o File será ativado. |
Retornar
File
: este File
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 File
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
Nome | Tipo | Descrição |
---|---|---|
accessType | Access | qual classe de usuários poderá acessar o File |
permissionType | Permission | as permissões que precisam ser concedidas aos usuários que podem acessar o File |
Retornar
File
: este File
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 File
é marcado com estrela no Google Drive do usuário. O padrão para
File
s novos é false
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
starred | Boolean | true se o File precisar ser marcado com estrela no Drive do usuário. Caso contrário, false . |
Retornar
File
: este File
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 File
está na lixeira do Drive do usuário. Apenas o
proprietário pode mover o File
para a lixeira. O padrão para novos File
s é false
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
trashed | Boolean | true se o File precisar ser movido para a lixeira do
Drive do usuário. Caso contrário, será false |
Retornar
File
: este File
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