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 comentaristas da File . |
addCommenter(user) | File | Adiciona o usuário à lista de comentaristas da File . |
addCommenters(emailAddresses) | File | Adiciona a matriz de usuários à 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 à lista de leitores de File . |
addViewer(user) | File | Adiciona o usuário à lista de leitores de File . |
addViewers(emailAddresses) | File | Adiciona a matriz de usuários especificada à lista de leitores de File . |
getAccess(email) | Permission | Recebe a permissão concedida ao usuário especificado. |
getAccess(user) | Permission | Recebe a permissão concedida ao usuário especificado. |
getAs(contentType) | Blob | Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getDateCreated() | Date | Obtém a data de criação do File . |
getDescription() | String | Recebe a descrição do File . |
getDownloadUrl() | String | Obtém o URL que pode ser usado para fazer download do arquivo. |
getEditors() | User[] | Obtém a lista de editores para este File . |
getId() | String | Recebe o ID do File . |
getLastUpdated() | Date | Obtém a data da última atualização do File . |
getMimeType() | String | Obtém o tipo MIME do arquivo. |
getName() | String | Recebe o nome do File . |
getOwner() | User | Obtém o proprietário do arquivo. |
getParents() | FolderIterator | Recebe uma coleção de pastas mães imediatas de File . |
getResourceKey() | String | Recebe a chave de recurso do File necessária para acessar itens que foram compartilhados usando um link. |
getSecurityUpdateEligible() | Boolean | Determina se File está qualificado para aplicar a atualização de segurança que
requer uma chave de recurso para acesso quando é compartilhada usando um link. |
getSecurityUpdateEnabled() | Boolean | Obtém se File requer uma chave de recurso para acesso quando é compartilhado usando um link. |
getSharingAccess() | Access | Recebe qual classe de usuários pode acessar o File , além de todos os usuários individuais que receberam acesso explicitamente. |
getSharingPermission() | Permission | Recebe a permissão concedida aos usuários que podem acessar o File , além de todos os usuários individuais que receberam acesso explicitamente. |
getSize() | Integer | Recebe o número de bytes usados para armazenar o File no Drive. |
getTargetId() | String | Se for um atalho, retorna o ID do item para o qual aponta. |
getTargetMimeType() | String | Se for um atalho, retorna o tipo mime do item para o qual aponta. |
getTargetResourceKey() | String | Se o arquivo for um atalho, retorna a chave de recurso do item que aponta. |
getThumbnail() | Blob | Recebe uma imagem em miniatura do arquivo, ou null se não houver miniatura. |
getUrl() | String | Recebe o URL que pode ser usado para abrir o File em um app do Google, como o Drive ou o 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 podem 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 com o nome fornecido. |
makeCopy(name, destination) | File | Cria uma cópia do arquivo no diretório de destino e o nomeia com o nome fornecido. |
moveTo(destination) | File | Move esse item para a pasta de destino fornecida. |
removeCommenter(emailAddress) | File | Remove o usuário da lista de comentaristas de File . |
removeCommenter(user) | File | Remove o usuário da lista de comentaristas de 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 da lista de leitores e comentadores do File . |
removeViewer(user) | File | Remove o usuário 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 de File . |
setName(name) | File | Define o nome do File . |
setOwner(emailAddress) | File | Muda o proprietário do File . |
setOwner(user) | File | Muda o proprietário do File . |
setSecurityUpdateEnabled(enabled) | File | Define se o File exige uma chave de recurso para acesso quando
é compartilhado usando um link. |
setShareableByEditors(shareable) | File | Define se os usuários com permissão para edição do File podem compartilhar
com outros usuários ou alterar as permissões. |
setSharing(accessType, permissionType) | File | Define qual classe de usuários pode acessar o File e quais permissões esses usuários recebem, além de todos os usuários individuais que receberam acesso explicitamente. |
setStarred(starred) | File | Define se o File está marcado com estrela no Drive do usuário. |
setTrashed(trashed) | File | Define se o File está na lixeira do Drive do usuário. |
Documentação detalhada
addCommenter(emailAddress)
Adiciona o usuário à lista de comentaristas da File
. Se o usuário já estiver na lista de leitores, esse método o promoverá fora da lista de leitores.
// 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 | O endereço de e-mail do usuário a ser adicionado. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
addCommenter(user)
Adiciona o usuário à lista de comentaristas da File
. Se o usuário já estiver na lista de leitores, esse método o promoverá fora da lista de leitores.
// 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 requerem 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 para o File
. Se algum dos usuários já estiver na lista de leitores, esse método os promoverá fora da lista de leitores.
// 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 requerem 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 leitores, esse método o promoverá fora da lista de leitores.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário a ser adicionado. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem 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 leitores, esse método o promoverá 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 requerem 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 leitores, esse método os promoverá fora da lista de leitores.
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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
addViewer(emailAddress)
Adiciona o usuário à lista de leitores de File
. Se o usuário já estiver
na lista de editores, esse método não terá efeito.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O endereço de e-mail do usuário a ser adicionado. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
addViewer(user)
Adiciona o usuário à lista de leitores de File
. Se o usuário já estiver
na lista de editores, esse método não terá efeito.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário a ser adicionado. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem 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 de File
. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para eles.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddresses | String[] | Uma matriz de endereços de e-mail dos usuários a serem adicionados. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem 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 requerem 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 requerem 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, presume-se que a parte do nome do arquivo que segue o último ponto (se houver) seja uma extensão existente que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".
Para ver as cotas diárias para 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 rígidas.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
contentType | String | O tipo MIME para converter. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens nos formatos BMP, GIF, JPEG ou PNG, qualquer um dos 'image/bmp' , 'image/gif' , 'image/jpeg' ou 'image/png' também é válido. |
Retornar
Blob
: os dados como um blob.
getBlob()
getDateCreated()
getDescription()
getDownloadUrl()
Obtém o URL que pode ser usado para fazer download do arquivo. Somente usuários com permissão para abrir o arquivo no Google Drive podem acessar o URL. É possível usar esse URL em um navegador para fazer o download do arquivo, mas
não é possível buscar o arquivo 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()); }
Retornar
String
: o URL que pode ser usado para fazer o download do arquivo.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
Obtém a lista de editores para este File
. Se o usuário que executa o script não tiver acesso de edição ao 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 esse File
, a lista de editores será retornada. Se o usuário não tiver acesso para editar, uma matriz vazia será retornada.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
getLastUpdated()
getMimeType()
Obtém 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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getName()
getOwner()
Obtém 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 requerem 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 mães imediatas de 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 requerem 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 que foram compartilhados usando um link.
Retornar
String
: a chave de recurso do File
.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEligible()
Determina se File
está qualificado para aplicar a atualização de segurança que
requer uma chave de recurso para acesso quando é compartilhada usando um link.
O Drive exige uma chave de recurso para acessar alguns arquivos ou pastas que foram compartilhados usando um link. Essa alteração faz parte de uma atualização de segurança. A atualização é ativada por padrão para arquivos e pastas
qualificados. Para ativar ou desativar o requisito de chave de recurso para arquivos qualificados, use setSecurityUpdateEnabled
.
Saiba mais sobre a atualização de segurança do Google Drive.
Retornar
Boolean
: se o requisito de chave de recurso pode ser aplicado ao File
.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
Obtém se File
requer 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 o requisito de chave de recurso para arquivos qualificados, use
setSecurityUpdateEnabled
.
Saiba mais sobre a atualização de segurança do Google Drive.
Retornar
Boolean
: se o requisito de chave de recurso está ativado para File
.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
Recebe qual classe de usuários pode acessar o File
, além de todos os usuários individuais que receberam acesso explicitamente.
Retornar
Access
: qual classe de usuários pode acessar o File
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingPermission()
Recebe a permissão concedida aos usuários que podem acessar o File
, além de todos os usuários individuais que receberam acesso explicitamente.
Retornar
Permission
: as permissões concedidas aos usuários que podem acessar o File
Autorização
Os scripts que usam esse método requerem 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 contam para os 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 requerem 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 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 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 que 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());
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 requerem 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 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 requerem 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 o Drive ou o Documentos.
Retornar
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 requerem 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 de edição ao 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()); } }
Retornar
User[]
: se o usuário tiver acesso para editar esse File
, a lista de leitores e comentaristas será retornada. Se o usuário não tiver acesso para editar, uma matriz vazia será retornada.
Autorização
Os scripts que usam esse método requerem 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 File
estiver marcado com estrela no Google Drive do usuário; false
se não estiver
Autorização
Os scripts que usam esse método requerem 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 File
estiver na lixeira do Drive do usuário; false
se não estiver
Autorização
Os scripts que usam esse método requerem 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 requerem 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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
makeCopy(name)
Cria uma cópia do arquivo 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 do arquivo que deve ser aplicado à nova cópia. |
Retornar
File
: a nova cópia.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
makeCopy(name, destination)
Cria uma cópia do arquivo no diretório de destino e o nomeia com o nome fornecido.
// 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 do 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 requerem 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 edição à pasta pai atual do item 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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
removeCommenter(emailAddress)
Remove o usuário da lista de comentaristas de 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
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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
removeCommenter(user)
Remove o usuário da lista de comentaristas de 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
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 requerem 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 com
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 ele possa 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 requerem 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 com
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 ele possa acessar.
Nos arquivos do Drive, isso também remove o usuário da lista de leitores.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário a ser removido. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
Remove o usuário 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 impedirá que os usuários acessem o File
se pertencerem a uma classe de usuários com acesso geral. Por exemplo, se o File
for compartilhado com todo o domínio do usuário ou se o File
estiver em um drive compartilhado que ele 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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
removeViewer(user)
Remove o usuário 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. Esse método também não impedirá que
os usuários acessem o File
se pertencerem a uma classe de usuários com acesso
geral. Por exemplo, se o File
for compartilhado com todo o domínio do usuário ou
se o File
estiver em um drive compartilhado que ele 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 requerem 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 o File
se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o File
for compartilhado com todo o domínio do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | O 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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
revokePermissions(user)
Revoga o acesso ao File
concedido ao usuário especificado. Esse método não impede que os usuários acessem o File
se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o File
for compartilhado com todo o domínio do usuário.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma representação do usuário cujo acesso deve ser revogado. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem 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. Emite 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 requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
setDescription(description)
setName(name)
setOwner(emailAddress)
Muda o proprietário do File
. Esse método também concede ao proprietário anterior
acesso explícito para editar o 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 requerem 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 para editar o 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 requerem 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. 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
Nome | Tipo | Descrição |
---|---|---|
enabled | Boolean | Define se o requisito de chave de recurso para o File será ativado. |
Retornar
File
: este File
, para encadeamento.
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive
setSharing(accessType, permissionType)
Define qual classe de usuários pode acessar o File
e quais permissões esses usuários recebem, além de todos os usuários individuais que receberam acesso explicitamente.
// Creates a folder that anyone on the Internet can read from and write to. (Domain // administrators can prohibit this setting for users of a Google Workspace domain.) var folder = DriveApp.createFolder('Shared Folder'); folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
accessType | Access | qual classe de usuários deve ter acesso ao File |
permissionType | Permission | as 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 requerem 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 File
s é false
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
starred | Boolean | true se a File precisar ser marcada com estrela no Drive do usuário. Caso contrário, será false . |
Retornar
File
— este File
, para encadeamento
Autorização
Os scripts que usam esse método requerem 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 File
para a lixeira. O padrão para novos File
s é false
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
trashed | Boolean | true se o File precisar ser movido para a lixeira do Drive do usuário. false se não for |
Retornar
File
— este File
, para encadeamento
Autorização
Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/drive