Servicios de Google integrados

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Google Apps Script proporciona más de 30 servicios integrados para interactuar con 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, así como Math ofrece métodos como random() y constantes como PI, el servicio de hoja 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 controlanGoogle Workspace productos se recopila en la secciónGoogle Workspace Servicios debajo del encabezado "Referencia" en 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 "Script Services”.

Funciones modernas de JavaScript

Apps Script admite dos entornos de ejecución de JavaScript: el entorno de ejecución moderno de V8 y uno más antiguo con tecnología de intérprete de JavaScript de Rhino de Mozilla.

El entorno 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 más antiguo de JavaScript 1.6 y algunas funciones de 1.7 y 1.8. Puedes elegir libremente el entorno de ejecución para usar con tu secuencia de comandos, pero se recomienda usar el entorno de ejecución de V8.

Cada entorno de ejecución es compatible con las clases y los objetos de JavaScript que están disponibles para tu secuencia de comandos, además de los servicios de Google integrados y avanzados. Tus secuencias de comandos pueden usar objetos comunes, como Array, Date, RegExp, etc., así como los objetos globales Math y Object.

Usa el autocompletado

El editor de secuencias de comandos proporciona una función de “ayuda con el contenido”, más conocida como “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 una llamada global de objeto, enumeración o método que muestra una clase de Apps Script. Por ejemplo:

  • Si escribes el nombre completo de un objeto global o seleccionas uno de la función de autocompletado y, luego, escribes . (un punto), verás todos los métodos y las enumeraciones para esa clase.
  • Si escribes algunos caracteres, verás todas las sugerencias válidas que comienzan con esos caracteres.

Información sobre los objetos globales

Cada servicio proporciona al menos un objeto global (de nivel superior); por ejemplo, solo se puede acceder al servicio de Gmail desde el objeto GmailApp. Algunos servicios proporcionan varios objetos globales; por ejemplo, el Servicio base incluye cuatro objetos globales: Browser, Logger, MimeType y Session.

Métodos de llamada

Los objetos globales de casi todos los servicios avanzados integrados incluyen métodos que muestran datos o una clase de Apps Script. Las secuencias de comandos realizan llamadas a métodos con el siguiente formato:

GlobalObjectName.methodName(argument1, argument2, ..., argumentN);

Por ejemplo, una secuencia de comandos puede enviar un correo electrónico mediante una llamada 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 muestra otra clase de Apps Script, puedes encadenar llamadas al método en una línea. (Los tipos de datos que se muestran se muestran en autocompletado y en la documentación de referencia de un método). Por ejemplo, el método DocumentApp.create() muestra un Document. Por lo tanto, las siguientes dos secciones de código son equivalentes:

var doc = DocumentApp.create('New document');
var body = doc.getBody();
body.appendParagraph('New paragraph.');

// Same result as above.
DocumentApp.create('New document').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 un objeto global. No puedes usar la palabra clave new para construir estas clases, como con las clases de JavaScript estándar, como Date; solo puedes acceder a una clase secundaria llamando a un método que la muestre. Si no estás seguro de 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 muestre la clase que deseas.

Trabajar con interfaces

Algunos servicios incluyen clases especiales etiquetadas como "interfaces" en la documentación de referencia. Estas son clases genéricas que se usan como tipos de datos que se muestran para métodos que no pueden determinar el tipo preciso con anticipación. Por ejemplo, el método Document service Body.getChild(childIndex) muestra un objeto Element genérico. Element es una interfaz que representa otra clase, posiblemente una Paragraph o Table. Los objetos de la interfaz rara vez son útiles por sí solos. En su lugar, se suele llamar a un método como Element.asParagraph() para convertir el objeto en una clase precisa.

Trabaja con enumeraciones

La mayoría de los servicios incluyen algunas enumeraciones (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, puedes acceder 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);