O Google Apps Script oferece mais de 30 serviços integrados para interagir com
dados do usuário, outros sistemas do Google e sistemas externos. Esses serviços são
fornecidos como objetos globais semelhantes ao objeto
Math
padrão do JavaScript. Por exemplo, assim como Math oferece métodos como random() e
constantes como PI, o
serviço de planilha do Apps Script oferece métodos como
openById(id),
classes (objetos filhos) como
Range e enumerações como
DataValidationCriteria.
A documentação de referência para serviços que controlam produtosGoogle Workspace é coletada na seção "ServiçosGoogle Workspace ", no cabeçalho "Referência", na barra lateral deste site. Os serviços de utilitários (para coisas como criar interfaces do usuário, analisar XML ou gravar dados de registro) são coletados na seção "Serviços de script".
Recursos modernos do JavaScript
O Apps Script oferece suporte a dois ambientes de execução do JavaScript: o moderno V8 e um mais antigo com o intérprete Rhino JavaScript do Mozilla.
O ambiente de execução V8 oferece suporte à sintaxe e aos recursos modernos do ECMAScript. O ambiente de execução do Rhino é baseado no padrão JavaScript 1.6 mais antigo, além de alguns recursos da 1.7 e da 1.8. Você pode escolher livremente qual ambiente de execução usar com seu script, mas o ambiente de execução V8 é altamente recomendado.
Cada ambiente de execução oferece suporte a classes e objetos JavaScript disponíveis para seu
script, além dos serviços avançados do Google e integrados. Seus
scripts podem usar objetos comuns, como
Array,
Date,
RegExp
e assim por diante,
bem como os objetos globais
Math e
Object.
Como usar o preenchimento automático
O editor de script oferece um recurso de "assistência de conteúdo", mais conhecido como "preenchimento automático", que revela os objetos globais, bem como métodos e enumerações válidos no contexto atual do script. As sugestões de preenchimento automático aparecem automaticamente sempre que você digita um período após uma chamada de objeto, enumeração ou método global que retorna uma classe do Apps Script. Exemplo:
- Se você digitar o nome completo de um objeto global ou selecionar um no preenchimento automático e, em seguida, digitar
.(um ponto), todos os métodos e tipos enumerados dessa classe vão aparecer. - Se você digitar alguns caracteres, vai aparecer todas as sugestões válidas que começam com esses caracteres.
Noções básicas sobre objetos globais
Cada serviço fornece pelo menos um objeto global (de nível superior). Por exemplo,
o serviço do Gmail é acessado apenas pelo
objeto GmailApp. Alguns serviços
oferecem vários objetos globais. Por exemplo, o
serviço base inclui quatro objetos globais:
Browser,
Logger,
MimeType e
Session.
Chamar métodos
Os objetos globais de quase todos os serviços integrados ou avançados incluem métodos que retornam dados ou uma classe do Apps Script. Os scripts fazem chamadas de método neste formato:
GlobalObjectName.methodName(argument1, argument2, ..., argumentN);
Por exemplo, um script pode enviar um e-mail chamando o método
sendEmail(recipient, subject, body)
do serviço Gmail, assim:
GmailApp.sendEmail('claire@example.com', 'Subject line', 'This is the body.');
Se um método retornar outra classe do Apps Script, você poderá encadenar chamadas de método em uma
linha. Os tipos de retorno são mostrados no preenchimento automático e na documentação de referência
de um método. Por exemplo, o método
DocumentApp.create()
retorna um Document. Portanto, as
duas seções de código a seguir são equivalentes:
var doc = DocumentApp.create('New document');
var body = doc.getTab('t.0').asDocumentTab().getBody();
body.appendParagraph('New paragraph.');
// Same result as above.
DocumentApp.create('New document').getTab('t.0').asDocumentTab().getBody()
.appendParagraph('New paragraph.');
Como acessar classes filhas
Cada serviço inclui uma ou mais classes filhas que não podem ser acessadas do
nível superior, como um objeto global. Não é possível usar a palavra-chave new para
criar essas classes, como é possível com classes JavaScript padrão, como
Date.
Só é possível acessar uma classe filha chamando um método que a retorna. Se você
não souber como acessar uma determinada classe, acesse a página raiz da documentação de referência do
serviço e procure um método que retorne a classe que você quer.
Como lidar com interfaces
Alguns serviços incluem classes especiais que são marcadas como "interfaces"
na documentação de referência. Essas são classes genéricas usadas como tipos de retorno
para métodos que não podem determinar o tipo exato com antecedência. Por exemplo,
o método Document service
Body.getChild(childIndex)
retorna um objeto Element genérico.
Element é uma interface que representa outra classe, possivelmente uma
Paragraph ou
Table. Os objetos de interface raramente são
úteis por conta própria. Em vez disso, geralmente é necessário chamar um método como
Element.asParagraph()
para converter o objeto de volta a uma classe específica.
Como trabalhar com tipos enumerados
A maioria dos serviços inclui alguns tipos enumerados de valores nomeados. Por
exemplo, o serviço do Drive usa os tipos enumerados
Access e
Permission para determinar quais usuários
têm acesso a um arquivo ou pasta. Em quase todos os casos, você acessa essas enumerações
no objeto global. Por exemplo, uma chamada para o método
Folder.setSharing(accessType, permissionType)
tem esta aparência:
// Creates a folder that anyone on the Internet can read from and write to. (Domain administrators can
// prohibit this setting for Google Workspace users.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);