O Google Apps Script oferece mais de 30 serviços integrados para interagir com dados de usuários, 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 planilhas do Apps Script oferece métodos como
openById(id),
classes (objetos filhos) como
Range e enums como
DataValidationCriteria.
A documentação de referência para serviços que controlam produtosGoogle Workspace está na seção "ServiçosGoogle Workspace " no cabeçalho "Referência" na barra lateral deste site. Os serviços de utilidade (para coisas como criar interfaces de 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 é compatível com dois ambientes de execução do JavaScript: o ambiente moderno V8 e um mais antigo com tecnologia do interpretador JavaScript Rhino da Mozilla.
O tempo de execução do V8 é compatível com a sintaxe e os recursos modernos do ECMAScript. O ambiente de execução do Rhino é baseado no padrão mais antigo do JavaScript 1.6, além de alguns recursos das versões 1.7 e 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 integrados. Seus
scripts podem usar objetos comuns como
Array,
Date,
RegExp,
e assim por diante,
além dos objetos globais
Math e
Object.
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, além de métodos e enums válidos no contexto atual do script. As sugestões de preenchimento automático aparecem automaticamente sempre que você digita um ponto após um objeto global, uma enumeração ou uma chamada de método 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 digitar
.(um ponto), todos os métodos e enums dessa classe vão aparecer. - Se você digitar alguns caracteres, verá todas as sugestões válidas que começam com eles.
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
fornecem vários objetos globais. Por exemplo, o
serviço de base inclui quatro objetos globais:
Browser,
Logger,
MimeType e
Session.
Chamada de métodos
Os objetos globais de quase todos os serviços avançados ou integrados 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 desta forma:
GmailApp.sendEmail('claire@example.com', 'Subject line', 'This is the body.');
Se um método retornar outra classe do Apps Script, você poderá encadear 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.');
Acessar classes filhas
Cada serviço inclui uma ou mais classes secundárias que não podem ser acessadas do nível superior como um objeto global. Não é possível usar a palavra-chave new para
construir 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 retorne. 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 desejada.
Como lidar com interfaces
Alguns serviços incluem classes especiais rotuladas como "interfaces"
na documentação de referência. 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 Body.getChild(childIndex) do serviço de documentos retorna um objeto Element genérico.
Element é uma interface que representa alguma outra classe, possivelmente um
Paragraph ou
Table. Objetos de interface raramente são úteis por si só. Em vez disso, geralmente é necessário chamar um método como Element.asParagraph() para converter o objeto de volta a uma classe precisa.
Como trabalhar com enums
A maioria dos serviços inclui algumas enumerações (tipos enumerados) de valores nomeados. Por exemplo, o serviço do Drive usa as enumerações 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
do 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);