Esta página foi traduzida pela API Cloud Translation.

Class File

Um arquivo no Google Drive. Os arquivos podem ser acessados ou criados no DriveApp.

// Trash every untitled spreadsheet that hasn't been updated in a week.
var files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  var file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

Métodos

Método	Tipo de retorno	Breve descrição
`addCommenter(emailAddress)`	`File`	Adiciona o usuário à lista de usuários que fizeram comentários no `File`.
`addCommenter(user)`	`File`	Adiciona o usuário à lista de usuários que fizeram comentários no `File`.
`addCommenters(emailAddresses)`	`File`	Adicione a matriz de usuários especificada à lista de comentaristas para o `File`.
`addEditor(emailAddress)`	`File`	Adiciona o usuário especificado à lista de editores do `File`.
`addEditor(user)`	`File`	Adiciona o usuário especificado à lista de editores do `File`.
`addEditors(emailAddresses)`	`File`	Adiciona a matriz de usuários especificada à lista de editores do `File`.
`addViewer(emailAddress)`	`File`	Adiciona o usuário especificado à lista de leitores do `File`.
`addViewer(user)`	`File`	Adiciona o usuário especificado à lista de leitores do `File`.
`addViewers(emailAddresses)`	`File`	Adiciona a matriz de usuários especificada à lista de leitores para `File`.
`getAccess(email)`	`Permission`	Recebe a permissão concedida ao usuário especificado.
`getAccess(user)`	`Permission`	Recebe a permissão concedida ao usuário especificado.
`getAs(contentType)`	`Blob`	Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado.
`getBlob()`	`Blob`	Retorne os dados dentro desse objeto como um blob.
`getDateCreated()`	`Date`	Recebe a data de criação do `File`.
`getDescription()`	`String`	Recebe a descrição do `File`.
`getDownloadUrl()`	`String`	Recebe o URL que pode ser usado para fazer o download do arquivo.
`getEditors()`	`User[]`	Recebe a lista de editores desse `File`.
`getId()`	`String`	Recebe o ID do `File`.
`getLastUpdated()`	`Date`	Recebe a data em que o `File` foi atualizado pela última vez.
`getMimeType()`	`String`	Recebe o tipo MIME do arquivo.
`getName()`	`String`	Recebe o nome do `File`.
`getOwner()`	`User`	Recebe o proprietário do arquivo.
`getParents()`	`FolderIterator`	Recebe uma coleção de pastas que são mães imediatas do `File`.
`getResourceKey()`	`String`	Recebe a chave de recurso do `File` necessária para acessar os itens que foram compartilhadas usando um link.
`getSecurityUpdateEligible()`	`Boolean`	Identifica se este `File` está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando é compartilhado usando um link.
`getSecurityUpdateEnabled()`	`Boolean`	Descobre se este `File` precisa de uma chave de recurso para acesso quando é compartilhada usando um link.
`getSharingAccess()`	`Access`	Extrai qual classe de usuários pode acessar o `File`, além de qualquer usuários que receberam acesso explícito.
`getSharingPermission()`	`Permission`	Recebe a permissão concedida aos usuários que podem acessar o `File`, além dos usuários individuais que receberam acesso explícito.
`getSize()`	`Integer`	Recebe o número de bytes usados para armazenar o `File` no Drive.
`getTargetId()`	`String`	Se for um atalho, retorna o ID do item para o qual ele aponta.
`getTargetMimeType()`	`String`	Se for um atalho, retorna o tipo MIME do item para o qual ele aponta.
`getTargetResourceKey()`	`String`	Se o arquivo for um atalho, retorna a chave de recurso do item para o qual ele aponta.
`getThumbnail()`	`Blob`	Recebe uma imagem em miniatura do arquivo ou `null` se não houver uma miniatura.
`getUrl()`	`String`	Recebe o URL que pode ser usado para abrir o `File` em um Google app, como Drive ou Documentos.
`getViewers()`	`User[]`	Recebe a lista de leitores e comentadores deste `File`.
`isShareableByEditors()`	`Boolean`	Determina se os usuários com permissões para edição do `File` têm permissão para compartilhar com outros usuários ou alterar as permissões.
`isStarred()`	`Boolean`	Determina se o `File` foi marcado com estrela no Drive do usuário.
`isTrashed()`	`Boolean`	Determina se `File` está na lixeira do Drive do usuário.
`makeCopy()`	`File`	Cria uma cópia do arquivo.
`makeCopy(destination)`	`File`	Cria uma cópia do arquivo no diretório de destino.
`makeCopy(name)`	`File`	Cria uma cópia do arquivo e a nomeia com o nome fornecido.
`makeCopy(name, destination)`	`File`	Cria uma cópia do arquivo no diretório de destino e a nomeia com o nome fornecido.
`moveTo(destination)`	`File`	Move esse item para a pasta de destino fornecida.
`removeCommenter(emailAddress)`	`File`	Remove o usuário especificado da lista de comentadores do `File`.
`removeCommenter(user)`	`File`	Remove o usuário especificado da lista de comentadores do `File`.
`removeEditor(emailAddress)`	`File`	Remove o usuário especificado da lista de editores do `File`.
`removeEditor(user)`	`File`	Remove o usuário especificado da lista de editores do `File`.
`removeViewer(emailAddress)`	`File`	Remove o usuário especificado da lista de leitores e comentadores do `File`.
`removeViewer(user)`	`File`	Remove o usuário especificado da lista de leitores e comentadores do `File`.
`revokePermissions(emailAddress)`	`File`	Revoga o acesso ao `File` concedido ao usuário especificado.
`revokePermissions(user)`	`File`	Revoga o acesso ao `File` concedido ao usuário especificado.
`setContent(content)`	`File`	Substitui o conteúdo do arquivo por uma determinada substituição.
`setDescription(description)`	`File`	Define a descrição do `File`.
`setName(name)`	`File`	Define o nome do `File`.
`setOwner(emailAddress)`	`File`	Altera o proprietário de `File`.
`setOwner(user)`	`File`	Altera o proprietário de `File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Define se o `File` exige uma chave de recurso para acesso quando é compartilhada usando um link.
`setShareableByEditors(shareable)`	`File`	Define se os usuários com permissões para edição do `File` têm permissão para compartilhar com outros usuários ou alterar as permissões.
`setSharing(accessType, permissionType)`	`File`	Define qual classe de usuários pode acessar o `File` e quais permissões esses usuários recebem, além dos usuários individuais que receberam acesso explicitamente.
`setStarred(starred)`	`File`	Define se o `File` está marcado com estrela no Drive do usuário.
`setTrashed(trashed)`	`File`	Define se `File` está na lixeira do Drive do usuário.

Documentação detalhada

`addCommenter(emailAddress)`

Adiciona o usuário à lista de usuários que fizeram comentários no File. Se o usuário já estiver na lista de visualizadores, esse método promove o usuário para fora da lista de visualizadores.

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

Nome	Tipo	Descrição
`emailAddress`	`String`	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 precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`addCommenter(user)`

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

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 para o File. Se houver dos usuários já estavam na lista de visualizadores, este método os promove para fora da lista de os 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

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 visualizadores, esse método promove o usuário para fora da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	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 precisam de 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 visualizadores, esse método promove o usuário para fora da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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á estavam na lista de visualizadores, este método os promove para fora da lista de os espectadores.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 terá efeito.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	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 precisam de 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 terá efeito.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 File. Se algum dos usuários já estavam na lista de editores, este método não terá efeito para eles.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`getAccess(email)`

Recebe a permissão concedida ao usuário especificado.

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	o endereço de e-mail do usuário cujas permissões devem ser verificadas

Retornar

Permission: as permissões concedidas ao usuário

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getAccess(user)`

Recebe a permissão concedida ao usuário especificado.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	uma representação do usuário cujas permissões devem ser verificadas

Retornar

Permission: as permissões concedidas ao usuário

Autorização

Os scripts que usam esse método precisam de 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 no tipo de conteúdo especificado. Isso adiciona a extensão adequada ao nome do arquivo, por exemplo, "myfile.pdf". No entanto, pressupõe que a parte do nome do arquivo que segue o ponto final (se houver) é uma que deve ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ListaShopping.12.25.pdf".

Para acessar as cotas diárias para conversões, consulte Cotas do Google Serviços. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a medidas cotas.

Parâmetros

Nome	Tipo	Descrição
`contentType`	`String`	O tipo MIME em que a conversão será feita. Para a maioria dos blobs, `'application/pdf'` é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer um dos valores `'image/bmp'`, `'image/gif'`, `'image/jpeg'` ou `'image/png'` também precisa ser válidos. Para um documento do Documentos Google, `'text/markdown'` 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 de criação do File.

Retornar

Date: a data de criação do File.

Autorização

Os scripts que usam esse método precisam de 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 de File

Autorização

Os scripts que usam esse método precisam de 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. Só os 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 que não podem ser usadas para buscar o arquivo com UrlFetchApp. Se você quiser que o conteú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 precisam de 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 executa o script não tiver acesso para editar a 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());
  }
}

Retornar

User[]: se o usuário tiver acesso para editar essa File, retornará a lista de editores. Se o usuário não tiver acesso para editar, retornará uma matriz vazia.

Autorização

Os scripts que usam esse método precisam de 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 de File.

Autorização

Os scripts que usam esse método precisam de 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 em que o File foi atualizado pela última vez.

Retornar

Date: a data em que o File foi atualizado pela última vez

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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 precisam de 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 precisam de 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 mães imediatas do File.

Retornar

FolderIterator: uma coleção de pastas que são mães imediatas de File.

Autorização

Os scripts que usam esse método precisam de 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 compartilhadas usando um link.

Retornar

String: a chave de recurso do File.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSecurityUpdateEligible()`

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

O Google Drive exige uma chave de recurso para acessar alguns arquivos ou pastas que foram compartilhados usando um . Essa mudança faz parte de uma atualização de segurança. A atualização é ativada por padrão para os canais arquivos e pastas. Para ativar ou desativar o requisito de chave de recurso nos arquivos qualificados, use setSecurityUpdateEnabled:

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

Retornar

Boolean: se o requisito da chave de recurso pode ser aplicado ao File.

Autorização

Os scripts que usam esse método precisam de 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 precisa de uma chave de recurso para acesso quando é compartilhada usando um link. Esse requisito é ativado 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 está ativado para este File.

Autorização

Os scripts que usam esse método precisam de 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 qualquer usuários 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 precisam de 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 dos 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 precisam de 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 de aplicativo 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 arquivo File no Drive

Autorização

Os scripts que usam esse método precisam de 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 para o qual ele aponta.

Caso contrário, 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 para o qual ele aponta.

Caso contrário, 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, retorna a chave de recurso do item para o qual ele aponta. Uma chave de recurso é um parâmetro adicional que você precisa passar para acessar arquivos que foram compartilhados usando um .

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

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 precisam de 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: a imagem em miniatura do arquivo.

Autorização

Os scripts que usam esse método precisam de 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 Drive ou Documentos.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 tem acesso de edição para o File, este método retorna 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());
  }
}

Retornar

User[]: se o usuário tiver acesso para editar essa File, retornará a lista de leitores e comentadores. Se o usuário não tiver acesso para editar, retornará uma matriz vazia.

Autorização

Os scripts que usam esse método precisam de 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 têm permissão para compartilhar com outros usuários ou alterar 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 alterar as permissões; false se não for

Autorização

Os scripts que usam esse método precisam de 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.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 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 for

Autorização

Os scripts que usam esse método precisam de 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: a nova cópia.

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
`destination`	`Folder`	O diretório em que o arquivo será copiado.

Retornar

File: a nova cópia.

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
`name`	`String`	O nome de arquivo que deve ser aplicado à nova cópia.

Retornar

File: a nova cópia.

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
`name`	`String`	O nome de arquivo que deve ser aplicado à nova cópia.
`destination`	`Folder`	O diretório em que o arquivo será copiado.

Retornar

File: a nova cópia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`moveTo(destination)`

Move esse 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 o pasta pai atual para mover o item para a pasta de destino.

Parâmetros

Nome	Tipo	Descrição
`destination`	`Folder`	A pasta que se torna o novo pai.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 comentadores do File. Esse método não bloqueia o acesso dos usuários à File caso eles pertençam a uma classe de usuários que têm acesso geral, por exemplo, se o File for compartilhado com o em todo o domínio.

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

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeCommenter(user)`

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

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 bloquear o acesso de usuários a File se eles pertencerem a uma classe de usuários acesso geral, por exemplo, se o File for compartilhado com todo o 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 leitores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`removeEditor(user)`

Nos arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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. Isso não terá efeito se o usuário for um editor, não um leitor ou comentador. Esse método também não impede que os usuários acessem a File caso pertençam a uma classe de usuários que ter acesso geral, por exemplo, se o File for compartilhado com o o domínio inteiro ou se o File estiver em um drive compartilhado que o usuário possa acessar.

Nos arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retornar

File: este File para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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. Isso não terá efeito se o usuário for um editor, não um leitor. Esse método também não bloqueia que os usuários acessem a File caso pertençam a uma classe de usuários com problemas acesso, 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.

Nos arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retornar

File: este File para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 bloquear o acesso de usuários a File se eles pertencerem a uma classe de usuários que ter acesso geral, por exemplo, se o File for compartilhado com o em todo o domínio.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário que terá o acesso revogado.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`revokePermissions(user)`

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário que terá o acesso revogado.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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. Gera 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

Nome	Tipo	Descrição
`content`	`String`	O novo conteúdo do arquivo.

Retornar

File: este File, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
`description`	`String`	a nova descrição de `File`

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setName(name)`

Define o nome do File.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o novo nome do objeto `File`

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setOwner(emailAddress)`

Altera o proprietário de File. Esse método também fornece ao proprietário anterior acesso explícito para edição ao File.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	o endereço de e-mail do usuário que deve se tornar o novo proprietário

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setOwner(user)`

Altera o proprietário de File. Esse método também fornece ao proprietário anterior acesso explícito para edição ao File.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	uma representação do usuário que deve se tornar o novo proprietário

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 é compartilhada 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

Nome	Tipo	Descrição
`enabled`	`Boolean`	Define 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 precisam de 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 têm permissão para compartilhar com outros usuários ou alterar as permissões. O padrão para uma nova File é true.

Parâmetros

Nome	Tipo	Descrição
`shareable`	`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` caso contrário

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 dos usuários individuais que receberam acesso explicitamente.

// Creates a folder that anyone on the Internet can read from and write to. (Domain
// administrators can prohibit this setting for users of a Google Workspace domain.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parâmetros

Nome	Tipo	Descrição
`accessType`	`Access`	qual classe de usuários vai poder acessar o `File`
`permissionType`	`Permission`	as permissões que precisam ser concedidas aos usuários que podem acessar o `File`

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 são false.

Parâmetros

Nome	Tipo	Descrição
`starred`	`Boolean`	`true` se o `File` precisar ser marcado com estrela no Drive; `false` se não for

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive

`setTrashed(trashed)`

Define se File está na lixeira do Drive do usuário. Somente o proprietário pode mover File para a lixeira. O padrão para novas Files é false.

Parâmetros

Nome	Tipo	Descrição
`trashed`	`Boolean`	`true` se o `File` precisar ser movido para a lixeira de o Google Drive do usuário; `false` se não for

Retornar

File: este File, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/drive