Class File

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

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étodoTipo de retornoBreve descrição
addCommenter(emailAddress)FileAdicione o usuário em questão à lista de comentaristas do File.
addCommenter(user)FileAdicione o usuário em questão à lista de comentaristas do File.
addCommenters(emailAddresses)FileAdicione a matriz especificada de usuários à lista de comentaristas para o File.
addEditor(emailAddress)FileAdiciona o usuário especificado à lista de editores de File.
addEditor(user)FileAdiciona o usuário especificado à lista de editores de File.
addEditors(emailAddresses)FileAdiciona a matriz especificada de usuários à lista de editores de File.
addViewer(emailAddress)FileAdiciona o usuário especificado à lista de visualizadores do File.
addViewer(user)FileAdiciona o usuário especificado à lista de visualizadores do File.
addViewers(emailAddresses)FileAdiciona a matriz de usuários especificada à lista de visualizadores de File.
getAccess(email)PermissionRecebe a permissão concedida ao usuário especificado.
getAccess(user)PermissionRecebe a permissão concedida ao usuário especificado.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getDateCreated()DateRecebe a data em que o File foi criado.
getDescription()StringRecebe a descrição do File.
getDownloadUrl()StringRecebe o URL que pode ser usado para fazer o download do arquivo.
getEditors()User[]Recebe a lista de editores desse File.
getId()StringRecebe o ID da File.
getLastUpdated()DateRecebe a data da última atualização de File.
getMimeType()StringRecebe o Tipo MIME do arquivo.
getName()StringRecebe o nome da File.
getOwner()UserRecebe o proprietário do File.
getParents()FolderIteratorRecebe um conjunto de pastas que são pais imediatos do File.
getResourceKey()StringRecebe a chave de recurso do File necessária para acessar os itens que foram compartilhados usando um link.
getSecurityUpdateEligible()BooleanRecebe 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()BooleanRecebe se esse File exige uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSharingAccess()AccessRecebe qual classe de usuários pode acessar o File, 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 File, além de todos os usuários individuais que receberam acesso explicitamente.
getSize()IntegerRecebe o número de bytes usados para armazenar o File no Drive.
getTargetId()StringSe esse for um atalho, retorna o ID do item ao qual ele aponta.
getTargetMimeType()StringSe for um atalho, retornará o tipo MIME do item ao qual ele aponta.
getTargetResourceKey()StringSe o arquivo for um atalho, retornará a chave de recurso do item a que ele aponta.
getThumbnail()BlobRecebe uma imagem em miniatura para o arquivo, ou null se não houver miniatura.
getUrl()StringRecebe 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()BooleanDetermina se os usuários com permissões para edição do File podem compartilhar com outros usuários ou mudar as permissões.
isStarred()BooleanDetermina se o File foi marcado com estrela no Google Drive do usuário.
isTrashed()BooleanDetermina se o File está na lixeira do Drive do usuário.
makeCopy()FileCria uma cópia do arquivo.
makeCopy(destination)FileCria uma cópia do arquivo no diretório de destino.
makeCopy(name)FileCria uma cópia do arquivo e nomeia-o com o nome fornecido.
makeCopy(name, destination)FileCria uma cópia do arquivo no diretório de destino e o nomeia com o nome fornecido.
moveTo(destination)FileMove este item para a pasta de destino fornecida.
removeCommenter(emailAddress)FileRemove o usuário especificado da lista de comentaristas do File.
removeCommenter(user)FileRemove o usuário especificado da lista de comentaristas do File.
removeEditor(emailAddress)FileRemove o usuário especificado da lista de editores para o File.
removeEditor(user)FileRemove o usuário especificado da lista de editores para o File.
removeViewer(emailAddress)FileRemove o usuário em questão da lista de leitores e comentaristas do File.
removeViewer(user)FileRemove o usuário em questão da lista de leitores e comentaristas do File.
revokePermissions(user)FileRevoga o acesso ao File concedido ao usuário especificado.
revokePermissions(user)FileRevoga o acesso ao File concedido ao usuário especificado.
setContent(content)FileSubstitui o conteúdo do arquivo por uma determinada substituição
setDescription(description)FileDefine a descrição do File.
setName(name)FileDefine o nome da File.
setOwner(emailAddress)FileMuda o proprietário do File.
setOwner(user)FileMuda o proprietário do File.
setSecurityUpdateEnabled(enabled)FileDefine se o File requer uma chave de recurso para acesso quando ele for compartilhado usando um link.
setShareableByEditors(shareable)FileDefine 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)FileDefine 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)FileDefine se o File é marcado com estrela no Google Drive do usuário.
setTrashed(trashed)FileDefine 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

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

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

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

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

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

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

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

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

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

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

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

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

Retorne os dados dentro desse objeto como um blob.

Retornar

Blob: os dados como um blob.


getDateCreated()

Recebe a data em que o File foi criado.

Retornar

Date: a data em que a File 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 File.

Retornar

String: a descrição 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

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()

Recebe o ID da File.

Retornar

String: o ID 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

getLastUpdated()

Recebe a data da última atualização de File.

Retornar

Date: a data da última atualização 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

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()

Recebe o nome da File.

Retornar

String: o nome 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

getOwner()

Recebe o proprietário do File.

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 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

isShareableByEditors()

Determina se os usuários com permissões para edição do File 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 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()

Cria uma cópia do arquivo.

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(destination)

Cria uma cópia do arquivo no diretório de destino.

Parâmetros

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

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

NomeTipoDescrição
nameStringO nome do arquivo a ser aplicado à nova cópia.
destinationFolderO 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

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

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

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

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

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

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

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

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

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

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

Define a descrição do File.

Parâmetros

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

setName(name)

Define o nome da File.

Parâmetros

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

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

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

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

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

setShareableByEditors(shareable)

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

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

NomeTipoDescrição
accessTypeAccessqual classe de usuários poderá acessar o File
permissionTypePermissionas 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 Files novos é false.

Parâmetros

NomeTipoDescrição
starredBooleantrue 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 Files é false.

Parâmetros

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