Class File

Arquivo

É um arquivo no Google Drive. Os arquivos podem ser acessados ou criados em 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)FileAdiciona o usuário especificado à lista de comentaristas de File.
addCommenter(user)FileAdiciona o usuário especificado à lista de comentaristas de File.
addCommenters(emailAddresses)FileAdicione a matriz de usuários especificada à lista de comentaristas de File.
addEditor(emailAddress)FileAdiciona o usuário especificado à lista de editores do File.
addEditor(user)FileAdiciona o usuário especificado à lista de editores do File.
addEditors(emailAddresses)FileAdiciona a matriz de usuários especificada à lista de editores do File.
addViewer(emailAddress)FileAdiciona o usuário especificado à lista de leitores do File.
addViewer(user)FileAdiciona o usuário especificado à lista de leitores do File.
addViewers(emailAddresses)FileAdiciona a matriz de usuários especificada à lista de leitores para o File.
getAccess(email)PermissionRecebe a permissão concedida ao usuário em questão.
getAccess(user)PermissionRecebe a permissão concedida ao usuário em questão.
getAs(contentType)BlobRetorne 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()DateExtrai a data em que o File foi criado.
getDescription()StringRecebe a descrição do File.
getDownloadUrl()StringExtrai o URL que pode ser usado para fazer o download do arquivo.
getEditors()User[]Recebe a lista de editores deste File.
getId()StringRecebe o ID do File.
getLastUpdated()DateRecebe a data da última atualização do File.
getMimeType()StringRecebe o tipo MIME do arquivo.
getName()StringRecebe o nome do File.
getOwner()UserExtrai o proprietário do arquivo.
getParents()FolderIteratorRecebe uma coleção de pastas que são pais imediatos de File.
getResourceKey()StringRecebe a chave de recurso do File que é necessária para acessar itens que foram compartilhados usando um link.
getSecurityUpdateEligible()BooleanDescobre se este File 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()BooleanDescobre se este File requer uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSharingAccess()AccessExtrai 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 qualquer usuário individual que tenha recebido acesso explicitamente.
getSize()IntegerRecebe o número de bytes usados para armazenar o File no Drive.
getTargetId()StringSe for um atalho, retorna o código do item para o qual ele aponta.
getTargetMimeType()StringSe for um atalho, retorna o tipo MIME do item para o qual ele aponta.
getTargetResourceKey()StringSe o arquivo for um atalho, retorna a chave de recurso do item para o qual ele aponta.
getThumbnail()BlobRecebe uma imagem em miniatura para o arquivo ou null se não houver uma miniatura.
getUrl()StringRecebe o URL que pode ser usado para abrir o File em um Google app, como o Drive ou o Documentos.
getViewers()User[]Recebe a lista de leitores e comentadores deste File.
isShareableByEditors()BooleanDetermina se os usuários com permissões para edição no File podem compartilhar com outros usuários ou alterar as permissões.
isStarred()BooleanDetermina se o File foi marcado com estrela no 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 a nomeia com o nome fornecido.
makeCopy(name, destination)FileCria uma cópia do arquivo no diretório de destino e a nomeia com o nome fornecido.
moveTo(destination)FileMove o 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 do File.
removeEditor(user)FileRemove o usuário especificado da lista de editores do File.
removeViewer(emailAddress)FileRemove o usuário especificado da lista de leitores e comentadores do File.
removeViewer(user)FileRemove o usuário especificado da lista de leitores e comentadores do File.
revokePermissions(emailAddress)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 substituição.
setDescription(description)FileDefine a descrição do File.
setName(name)FileDefine o nome do File.
setOwner(emailAddress)FileMuda o proprietário de File.
setOwner(user)FileMuda o proprietário de File.
setSecurityUpdateEnabled(enabled)FileDefine se o File requer uma chave de recurso para acesso quando é compartilhado por um link.
setShareableByEditors(shareable)FileDefine se os usuários com permissões para edição no File têm permissão para 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 eles recebem, além de usuários individuais que receberam acesso explicitamente.
setStarred(starred)FileDefine se o File está marcado com estrela no Drive do usuário.
setTrashed(trashed)FileDefine se o File está na lixeira do Drive do usuário.

Documentação detalhada

addCommenter(emailAddress)

Adiciona o usuário especificado à lista de comentaristas de File. Se o usuário já estava na lista de espectadores, esse método o removerá da lista.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you
// want to add as a commenter.
while (files.hasNext()) {
  const file = files.next();
  email = 'cloudysanfrancisco@gmail.com';
  console.log(file.addCommenter(email));
}

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário a ser adicionado.

Retorno

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)

Adiciona o usuário especificado à lista de comentaristas de File. Se o usuário já estava na lista de espectadores, esse método o removerá da lista.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retorno

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 de usuários especificada à lista de comentaristas de File. Se algum usuário já estiver na lista de espectadores, esse método o removerá da lista de espectadores.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

while (files.hasNext()) {
  const file = files.next();
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and
  // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters.
  const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com'];
  console.log(file.addCommenters(emails));
}

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retorno

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 do File. Se o usuário já estiver na lista de espectadores, esse método o removerá da lista.

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário a ser adicionado.

Retorno

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 do File. Se o usuário já estiver na lista de espectadores, esse método o removerá da lista.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retorno

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 de usuários especificada à lista de editores do File. Se algum dos usuários já estiver na lista de espectadores, esse método o removerá da lista de espectadores.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retorno

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

Retorno

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

Retorno

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 leitores para o File. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para ele.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retorno

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 em questão.

Parâmetros

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

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

getAs(contentType)

Retorne 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, "meuarquivo.pdf". No entanto, ela pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão 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 para Serviços do Google. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a cotas mais rigorosas.

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME para conversão. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer elemento 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válido.

Retorno

Blob: os dados como um blob.


getBlob()

Retorne os dados dentro desse objeto como um blob.

Retorno

Blob: os dados como um blob.


getDateCreated()

Extrai a data em que o File foi criado.

Retorno

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.

Retorno

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

Extrai 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. Você pode usar esse URL em um navegador para fazer o download do arquivo, mas não para buscá-lo com UrlFetchApp. Se você quiser o conteúdo do arquivo no script, use getBlob().

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the download URLs to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getDownloadUrl());
}

Retorno

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

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Adds the email addresses in the array as editors of each file.
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com'
  // and 'baklavainthebalkans@gmail.com' with valid email addresses.
  file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']);

  // Gets a list of the file editors.
  const editors = file.getEditors();

  // For each file, logs the editors' email addresses to the console.
  for (const editor of editors) {
    console.log(editor.getEmail());
  }
}

Retorno

User[]: se o usuário tiver acesso para editar esse File, a lista de editores será retornada. Se o usuário não tiver acesso para editar, vai retornar 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

getId()

Recebe o ID do File.

Retorno

String: o ID de 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 do File.

Retorno

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

getMimeType()

Recebe o tipo MIME do arquivo.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the MIME type to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getMimeType());
}

Retorno

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 do File.

Retorno

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

Extrai o proprietário do arquivo.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the names of the file owners to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getOwner().getName());
}

Retorno

User: o proprietário 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

getParents()

Recebe uma coleção de pastas que são pais imediatos de File.

Retorno

FolderIterator: uma coleção de pastas que são pais imediatos de 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 que é necessária para acessar itens que foram compartilhados usando um link.

Retorno

String: a chave de recurso 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

getSecurityUpdateEligible()

Descobre se este File 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 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()

Descobre se este File 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 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()

Extrai qual classe de usuários pode acessar o File, além de todos os usuários individuais que receberam acesso explicitamente.

Retorno

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 qualquer usuário individual que tenha recebido acesso explicitamente.

Retorno

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. 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 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 for um atalho, retorna o código do item para o qual ele aponta.

Caso contrário, ele retorna null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the target ID of the shortcut.
console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);

Retorno

String: código do item de destino.


getTargetMimeType()

Se for um atalho, retorna o tipo MIME do item para o qual ele aponta.

Caso contrário, ele retorna null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the MIME type of the file that the shortcut points to.
console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);

Retorno

String: o tipo MIME do item de destino.


getTargetResourceKey()

Se o arquivo for um atalho, retorna a chave de recurso do item para o qual ele aponta. Uma chave de recurso é um parâmetro adicional que você precisa transmitir para acessar arquivos que foram compartilhados usando um link.

Se o arquivo não for um atalho, ele retornará null.

// Gets a file by its ID.
// TODO(developer): Replace 'abc123456' with your file ID.
const file = DriveApp.getFileById('abc123456');

// If the file is a shortcut, returns the resource key of the file that it points to.
console.log(file.getTargetResourceKey());

Retorno

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 uma miniatura.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Logs the thumbnail image for each file to the console as a blob,
  // or null if no thumbnail exists.
  console.log(file.getThumbnail());
}

Retorno

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

Retorno

String: o URL que pode ser usado para ver 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 leitores e comentadores deste File. Se o usuário que executa o script não tiver acesso para editar File, esse método retornará uma matriz vazia.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // For each file, logs the viewers' email addresses to the console.
  const viewers = file.getViewers();
  for (viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

Retorno

User[]: se o usuário tiver acesso para editar esse File, retornará a lista de leitores e comentadores. Se o usuário não tiver acesso para editar, vai retornar 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

isShareableByEditors()

Determina se os usuários com permissões para edição no File podem compartilhar com outros usuários ou alterar as permissões.

Retorno

Boolean: true se os usuários com permissões para edição tiverem permissão para compartilhar com outros usuários ou alterar as permissões. false se não 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 Drive do usuário.

Retorno

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.

Retorno

Boolean: true se o File 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

makeCopy()

Cria uma cópia do arquivo.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and logs the file name to the console.
  console.log(file.makeCopy().getName());
}

Retorno

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.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and adds it to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy(destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

Parâmetros

NomeTipoDescrição
destinationFolderO diretório em que o arquivo será copiado.

Retorno

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 a nomeia com o nome fornecido.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and sets the name to 'Test-Copy.'
  const filename = file.makeCopy('Test-Copy');

  // Logs the copied file's name to the console.
  console.log(filename.getName());
}

Parâmetros

NomeTipoDescrição
nameStringO nome de arquivo que deve ser aplicado à nova cópia.

Retorno

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 a nomeia com o nome fornecido.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file, sets the file name, and adds the copied file
  // to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy('Test-Copy', destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

Parâmetros

NomeTipoDescrição
nameStringO nome de arquivo que deve ser aplicado à nova cópia.
destinationFolderO diretório em que o arquivo será copiado.

Retorno

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

NomeTipoDescrição
destinationFolderA pasta que se torna o novo pai.

Retorno

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 impede que os usuários acessem o File se eles 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.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  // TODO(developer): Replace the email with the email of the user you want to remove.
  file.removeCommenter('cloudysanfrancisco@gmail.com');
}

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário a ser removido.

Retorno

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 impede que os usuários acessem o File se eles 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.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  console.log(file.removeCommenter(Session.getActiveUser()));
}

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retorno

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 do File. Esse método não impede que os usuários acessem o File se eles pertencerem a uma classe de usuários que tenham acesso geral. Por exemplo, se 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, essa ação 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.

Retorno

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 do File. Esse método não impede que os usuários acessem o File se eles pertencerem a uma classe de usuários que tenham acesso geral. Por exemplo, se 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, essa ação também remove o usuário da lista de leitores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retorno

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 especificado da lista de leitores e comentadores 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 impede que os usuários acessem o File se eles pertencerem a uma classe de usuários com acesso geral. Por exemplo, se 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, essa ação 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.

Retorno

File: esse 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 especificado da lista de leitores e comentadores do File. 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 File se eles pertencerem a uma classe de usuários com acesso geral, por exemplo, se 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, essa ação também remove o usuário da lista de editores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retorno

File: esse 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(emailAddress)

Revoga o acesso ao File concedido ao usuário especificado. Esse método não impede que os usuários acessem File se eles pertencerem a uma classe de usuários com acesso geral, por exemplo, se File for compartilhado com todo o domínio do usuário.

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário cujo acesso será revogado.

Retorno

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 File se eles pertencerem a uma classe de usuários com acesso geral, por exemplo, se File for compartilhado com todo o domínio do usuário.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário cujo acesso deve ser revogado.

Retorno

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 substituição. Lança uma exceção se content for maior que 10 MB.

// Creates a text file with the content 'Hello, world!'
file = DriveApp.createFile('New Text File', 'Hello, world!');

// Logs the content of the text file to the console.
console.log(file.getBlob().getDataAsString());

// Updates the content of the text file to 'Updated text!'
file.setContent('Updated text!')

// Logs content of the text file to the console.
console.log(file.getBlob().getDataAsString());

Parâmetros

NomeTipoDescrição
contentStringO novo conteúdo do arquivo.

Retorno

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

Retorno

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 do File.

Parâmetros

NomeTipoDescrição
nameStringo novo nome do File

Retorno

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

Retorno

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

Retorno

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

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

Retorno

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 no File têm permissão para 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 tiverem permissão para compartilhar com outros usuários ou alterar as permissões; false se não tiver permissão

Retorno

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

NomeTipoDescrição
accessTypeAccessqual classe de usuários pode acessar o File.
permissionTypePermissionas permissões que precisam ser concedidas aos usuários que podem acessar o File.

Retorno

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 está marcado com estrela no Drive do usuário. O padrão para novos Files é false.

Parâmetros

NomeTipoDescrição
starredBooleantrue se o File precisar ser marcado com estrela no Drive do usuário; false se não tiver sido

Retorno

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. Somente o proprietário pode enviar a 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, false.

Retorno

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