Class File

Arquivo

Um arquivo no Google Drive. É possível acessar ou criar arquivos em DriveApp.

// Trash every untitled spreadsheet that hasn't been updated in a week.
const files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  const 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 do File.
addCommenter(user)FileAdiciona o usuário especificado à lista de comentaristas do File.
addCommenters(emailAddresses)FileAdiciona a matriz de usuários à lista de comentaristas do 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 à 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 à lista de leitores do File.
getAccess(email)PermissionRecebe a permissão concedida a um usuário específico.
getAccess(user)PermissionRecebe a permissão concedida a um usuário específico.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorna 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 para este 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()UserRecebe o proprietário do arquivo.
getParents()FolderIteratorRecebe uma coleção de pastas que são pais imediatos do File.
getResourceKey()StringRecebe a chave de recurso do File necessária para acessar itens compartilhados usando um link.
getSecurityUpdateEligible()BooleanRecebe se este File está qualificado para aplicar a atualização de segurança que exige uma chave de recurso para acesso quando é compartilhado usando um link.
getSecurityUpdateEnabled()BooleanRecebe se este File exige uma chave de recurso para acesso quando é compartilhado usando um link.
getSharingAccess()AccessRecebe a classe de usuários que podem acessar o File, além de usuários individuais que receberam acesso explícito.
getSharingPermission()PermissionRecebe a permissão concedida aos usuários que podem acessar o File, além de usuários individuais que receberam acesso explícito.
getSize()IntegerRecebe o número de bytes usados para armazenar o File no Drive.
getTargetId()StringSe for um atalho, retorna o ID do item a que ele aponta.
getTargetMimeType()StringSe for um atalho, retorna o tipo MIME do item a que ele aponta.
getTargetResourceKey()StringSe o arquivo for um atalho, vai retornar a chave de recurso do item a que ele aponta.
getThumbnail()Blob|nullRecebe uma imagem em miniatura do arquivo ou null se não houver uma miniatura.
getUrl()StringRecebe o URL que pode ser usado para abrir o File em um app do Google, como Drive ou Documentos.
getViewers()User[]Recebe a lista de leitores e comentaristas deste File.
isShareableByEditors()BooleanDetermina se os usuários com permissões de edição no File podem compartilhar com outros usuários ou mudar as permissões.
isStarred()BooleanDetermina se o File foi marcado como favorito 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 pessoas que fizeram comentários no File.
removeCommenter(user)FileRemove o usuário especificado da lista de pessoas que fizeram comentários no 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 espectadores e comentaristas do File.
removeViewer(user)FileRemove o usuário especificado da lista de espectadores e comentaristas do File.
revokePermissions(emailAddress)FileRevoga o acesso ao File concedido ao usuário.
revokePermissions(user)FileRevoga o acesso ao File concedido ao usuário.
setContent(content)FileSubstitui o conteúdo do arquivo por uma substituição específica.
setDescription(description)FileDefine a descrição do File.
setName(name)FileDefine o nome do File.
setOwner(emailAddress)FileMuda o proprietário do File.
setOwner(user)FileMuda o proprietário do File.
setSecurityUpdateEnabled(enabled)FileDefine se o File exige uma chave de recurso para acesso quando é compartilhado usando um link.
setShareableByEditors(shareable)FileDefine se os usuários com permissões de edição no File podem compartilhar com outros usuários ou mudar as permissões.
setSharing(accessType, permissionType)FileDefine qual classe de usuários pode acessar o File e quais permissões são concedidas a eles, além de usuários individuais que receberam acesso explícito.
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 do File. Se o usuário já estava na lista de leitores, esse método o promove para fora dela.

const files = DriveApp.getFilesByName('Test');

// Loops through the files
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter('hello@example.com');
}

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)

Adiciona o usuário especificado à lista de comentaristas do File. Se o usuário já estava na lista de leitores, esse método o promove para fora dela.

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

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)

Adiciona a matriz de usuários à lista de comentaristas do File. Se algum dos usuários já estiver na lista de leitores, esse método os promove para fora dela.

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

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 do File. Se o usuário já estava na lista de leitores, esse método o remove dela.

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 do File. Se o usuário já estava na lista de leitores, esse método o remove dela.

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

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 leitores do File. Se o usuário já estava na lista de editores, esse método não tem 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 leitores do File. Se o usuário já estava na lista de editores, esse método não tem 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 à lista de leitores do 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 a um usuário específico. O método não oferece suporte ao retorno de permissões para um grupo do Google ou permissões herdadas por grupos do Google.

Parâmetros

NomeTipoDescrição
emailStringO endereço de e-mail do usuário cujas permissões precisam ser verificadas. Os Grupos do Google não são compatíveis.

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 a um usuário específico. O método não oferece suporte ao retorno de permissões para um grupo do Google ou permissões herdadas por grupos do Google.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário cujas permissões precisam 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, "meuarquivo.pdf". No entanto, ele pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão existente que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".

Para conferir as cotas diárias de conversões, consulte Cotas para serviços do Google. Os domínios do Google Workspace criados recentemente podem estar sujeitos temporariamente a cotas mais rígidas.

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 em formato BMP, GIF, JPEG ou PNG, qualquer uma das opções 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válida. Para um documento do Google Docs, 'text/markdown' também é válido.

Retornar

Blob: os dados como um blob.


getBlob()

Retorna 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 o File foi criado.

Autorizaçã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. Você pode usar esse URL em um navegador para baixar o arquivo, mas não pode usá-lo para buscar o arquivo com UrlFetchApp. Se 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());
}

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 para este File. Se o usuário que executar o script não tiver acesso de edição ao File, esse método vai 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());
  }
}

Retornar

User[]: se o usuário tiver acesso de edição a este File, vai retornar a lista de editores. Se o usuário não tiver acesso de edição, 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.

Retornar

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

getLastUpdated()

Recebe a data da última atualização do 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.

// 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());
}

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

Retornar

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

getOwner()

Recebe 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());
}

Retornar

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

Retornar

FolderIterator: uma coleção de pastas que são pais imediatos 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 itens compartilhados usando um link.

Retornar

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

Recebe se este File está qualificado para aplicar a atualização de segurança que exige uma chave de recurso para acesso quando é compartilhado usando um link.

O Drive exige uma chave de recurso para acessar alguns arquivos ou pastas compartilhados usando um link. Essa mudança faz parte de uma atualização de segurança. A atualização fica ativada por padrão para arquivos e pastas qualificados. Para ativar ou desativar a exigência de chave de recurso para arquivos qualificados, use setSecurityUpdateEnabled.

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

Retornar

Boolean: indica 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 este File exige uma chave de recurso para acesso quando é compartilhado usando um link. Esse requisito é ativado por padrão para arquivos e pastas qualificados. Para ativar ou desativar a exigência de chave de recurso para arquivos qualificados, use setSecurityUpdateEnabled.

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

Retornar

Boolean: indica se o requisito de chave de recurso está ativado para este 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 a classe de usuários que podem acessar o File, além de usuários individuais que receberam acesso explícito.

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 usuários individuais que receberam acesso explícito.

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 for um atalho, retorna o ID do item a que 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()}`);

Retornar

String: o ID do item de destino.


getTargetMimeType()

Se for um atalho, retorna o tipo MIME do item a que 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()}`);

Retornar

String: o tipo MIME do item de destino.


getTargetResourceKey()

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

Se o arquivo não for um atalho, ele vai 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());

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 do 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());
}

Retornar

Blob|null: 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 app do Google, como Drive ou Documentos.

Retornar

String: o URL que pode ser usado para ver este File em um app do Google, como Drive ou Docs.

Autorizaçã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 comentaristas deste File. Se o usuário que executa o script não tiver acesso de edição ao File, esse método vai 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 (const viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

Retornar

User[]: se o usuário tiver acesso de edição a este File, vai retornar a lista de leitores e comentaristas. Se o usuário não tiver acesso de edição, 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 de edição no File podem compartilhar com outros usuários ou mudar as permissões.

Retornar

Boolean: true se os usuários com permissões de edição puderem compartilhar com outras pessoas ou mudar as permissões; false se não puderem

Autorizaçã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 como favorito no Drive do usuário.

Retornar

Boolean: true se o File estiver marcado com estrela no Drive do usuário; false se não estiver.

Autorizaçã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 o File estiver na lixeira do Drive do usuário; false se não estiver.

Autorizaçã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());
}

Retornar

File: o novo texto.

Autorizaçã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.

Retornar

File: o novo texto.

Autorizaçã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.

Retornar

File: o novo texto.

Autorizaçã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.

Retornar

File: o novo texto.

Autorizaçã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 de edição à 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.

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 pessoas que fizeram comentários no File. Esse método não impede que os usuários acessem o File se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o File for compartilhado com o domínio inteiro 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.

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 pessoas que fizeram comentários no File. Esse método não impede que os usuários acessem o File se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o File for compartilhado com o domínio inteiro 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.

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

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

Para 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 especificado da lista de espectadores e comentaristas do File. Esse método não tem 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 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.

Para 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: 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 espectadores e comentaristas do File. Esse método não tem 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 eles 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 possa acessar.

Para 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: 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. Esse método não impede que os usuários acessem o File se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o File for compartilhado com o domínio inteiro do usuário.

Parâmetros

NomeTipoDescrição
emailAddressStringO 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. Esse método não impede que os usuários acessem o File se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o File for compartilhado com o domínio inteiro do usuário.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário que teve o acesso 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 substituição específica. Gera uma exceção se content for maior que 10 MB.

// Creates a text file with the content 'Hello, world!'
const 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.

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 do 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 concede ao proprietário anterior acesso explícito de edição ao File.

Parâmetros

NomeTipoDescrição
emailAddressStringo endereço de e-mail do usuário que vai ser 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 concede ao proprietário anterior acesso explícito de edição ao File.

Parâmetros

NomeTipoDescrição
userUseruma representação do usuário que vai 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 exige uma chave de recurso para acesso quando é compartilhado usando um link. Os arquivos e pastas 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 de chave de recurso será ativado para 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

setShareableByEditors(shareable)

Define se os usuários com permissões de edição no File podem compartilhar com outros usuários ou mudar as permissões. O padrão para um novo File é true.

Parâmetros

NomeTipoDescrição
shareableBooleantrue se os usuários com permissões de edição puderem compartilhar com outros usuários ou mudar as permissões; false se nã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 são concedidas a eles, além de usuários individuais que receberam acesso explícito.

// 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.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parâmetros

NomeTipoDescrição
accessTypeAccessqual classe de usuários deve ter acesso ao File
permissionTypePermissionas permissões que devem 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 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

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. Somente 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; false caso contrá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