Google Apps Script proporciona más de 30 servicios integrados para interactuar con los datos del usuario, otros sistemas de Google y sistemas externos. Estos servicios se proporcionan como objetos globales similares al objeto Math estándar de JavaScript. Por ejemplo, al igual que Math ofrece métodos como random() y constantes como PI, el servicio de hojas de cálculo de Apps Script ofrece métodos como openById(id), clases (objetos secundarios) como Range y enumeraciones como DataValidationCriteria.
La documentación de referencia para los servicios que controlan los productos deGoogle Workspace se recopila en la sección "Servicios deGoogle Workspace " en el encabezado "Referencia" de la barra lateral de este sitio. Los servicios de utilidad (para tareas como crear interfaces de usuario, analizar XML o escribir datos de registro) se recopilan en la sección "Servicios de secuencias de comandos".
Funciones de JavaScript modernas
Apps Script admite dos entornos de ejecución de JavaScript: el entorno de ejecución moderno V8 y uno más antiguo con tecnología del intérprete de JavaScript Rhino de Mozilla.
El tiempo de ejecución de V8 admite la sintaxis y las funciones modernas de ECMAScript. El entorno de ejecución de Rhino se basa en el estándar anterior de JavaScript 1.6, además de algunas funciones de 1.7 y 1.8. Puedes elegir libremente qué tiempo de ejecución usar con tu secuencia de comandos, pero se recomienda el tiempo de ejecución de V8.
Cada entorno de ejecución admite clases y objetos de JavaScript que están disponibles para tu secuencia de comandos, además de los servicios avanzados de Google y los integrados. Tus secuencias de comandos pueden usar objetos comunes como Array, Date, RegExp, y así sucesivamente, así como los objetos globales Math y Object.
Cómo usar la función autocompletar
El editor de secuencias de comandos proporciona una función de "asistencia de contenido", más comúnmente llamada "autocompletar", que revela los objetos globales, así como los métodos y las enumeraciones que son válidos en el contexto actual de la secuencia de comandos. Las sugerencias de autocompletado aparecen automáticamente cada vez que escribes un punto después de un objeto global, una enumeración o una llamada a un método que devuelve una clase de Apps Script. Por ejemplo:
- Si escribes el nombre completo de un objeto global o seleccionas uno en la función de autocompletar y, luego, escribes
.(un punto), verás todos los métodos y las enumeraciones de esa clase. - Si escribes algunos caracteres, verás todas las sugerencias válidas que comiencen con esos caracteres.
Información sobre los objetos globales
Cada servicio proporciona al menos un objeto global (de nivel superior). Por ejemplo, se accede al servicio de Gmail únicamente desde el objeto GmailApp. Algunos servicios proporcionan varios objetos globales. Por ejemplo, el servicio básico incluye cuatro objetos globales: Browser, Logger, MimeType y Session.
Métodos de llamada
Los objetos globales de casi todos los servicios avanzados o integrados incluyen métodos que devuelven datos o una clase de Apps Script. Las secuencias de comandos realizan llamadas a métodos en este formato:
GlobalObjectName.methodName(argument1, argument2, ..., argumentN);
Por ejemplo, una secuencia de comandos puede enviar un correo electrónico llamando al método sendEmail(recipient, subject, body) del servicio de Gmail de la siguiente manera:
GmailApp.sendEmail('claire@example.com', 'Subject line', 'This is the body.');
Si un método devuelve otra clase de Apps Script, puedes encadenar llamadas a métodos en una sola línea. (Los tipos de devolución se muestran tanto en el autocompletado como en la documentación de referencia de un método). Por ejemplo, el método DocumentApp.create() devuelve un Document, por lo que las siguientes dos secciones de código son 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.');
Cómo acceder a las clases secundarias
Cada servicio incluye una o más clases secundarias a las que no se puede acceder desde el nivel superior como a un objeto global. No puedes usar la palabra clave new para construir estas clases, como puedes hacerlo con las clases estándar de JavaScript, como Date. Solo puedes acceder a una clase secundaria llamando a un método que la devuelva. Si no sabes cómo acceder a una clase determinada, visita la página raíz de la documentación de referencia del servicio y busca un método que devuelva la clase que deseas.
Cómo trabajar con interfaces
Algunos servicios incluyen clases especiales que se etiquetan como "interfaces" en la documentación de referencia. Estas son clases genéricas que se usan como tipos de datos que se muestran para los métodos que no pueden determinar el tipo preciso con anticipación. Por ejemplo, el método Body.getChild(childIndex) del servicio de Documentos devuelve un objeto Element genérico.
Element es una interfaz que representa alguna otra clase, posiblemente un Paragraph o un Table. Los objetos de interfaz rara vez son útiles por sí solos; en cambio, generalmente deseas llamar a un método como Element.asParagraph() para volver a convertir el objeto en una clase precisa.
Trabaja con enumeraciones
La mayoría de los servicios incluyen algunos enums (tipos enumerados) de valores con nombre. Por ejemplo, el servicio de Drive usa las enumeraciones Access y Permission para determinar qué usuarios tienen acceso a un archivo o una carpeta. En casi todos los casos, accedes a estas enumeraciones desde el objeto global. Por ejemplo, una llamada al método Folder.setSharing(accessType, permissionType) se ve de la siguiente manera:
// 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);