Script Service

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

Este servicio proporciona acceso a los activadores y la publicación de secuencias de comandos.

Clases

NombreDescripción breve
AuthModeUna enumeración que identifica las categorías de servicios autorizados que Apps Script puede ejecutar a través de una función activada.
AuthorizationInfoUn objeto que se usa a fin de determinar si el usuario debe autorizar esta secuencia de comandos para usar uno o más servicios y proporcionar la URL para un diálogo de autorización.
AuthorizationStatusUna enumeración que denota el estado de autorización de una secuencia de comandos.
CalendarTriggerBuilderCompilador para activadores de calendario.
ClockTriggerBuilderUn compilador para activadores de reloj
DocumentTriggerBuilderUn compilador para activadores de documentos.
EventTypeUna enumeración que denota el tipo de evento activado.
FormTriggerBuilderUn compilador para activadores de formularios.
InstallationSourceUna enumeración que indica cómo se instaló la secuencia de comandos como un complemento para el usuario actual.
ScriptAppAccede y manipula la publicación de secuencias de comandos y los activadores.
ServiceAccede y manipula la publicación de secuencias de comandos.
SpreadsheetTriggerBuilderCompilador para activadores de hojas de cálculo.
StateTokenBuilderPermite que las secuencias de comandos creen tokens de estado que se puedan usar en las API de devolución de llamada (como los flujos de OAuth).
TriggerUn activador de secuencia de comandos
TriggerBuilderUn compilador genérico para activadores de secuencias de comandos
TriggerSourceUna enumeración que indica el origen del evento que activa el activador.

AuthMode

Propiedades

PropiedadTipoDescripción
NONEEnumUn modo que no permite el acceso a ningún servicio que requiera autorización.
CUSTOM_FUNCTIONEnumUn modo que permite el acceso a un subconjunto limitado de servicios para su uso en funciones personalizadas de hojas de cálculo.
LIMITEDEnumUn modo que permite el acceso a un subconjunto limitado de servicios.
FULLEnumUn modo que permite el acceso a todos los servicios que requieren autorización.

AuthorizationInfo

Métodos

MétodoTipo de datos que se muestraDescripción breve
getAuthorizationStatus()AuthorizationStatusObtiene un valor que indica si el usuario debe autorizar esta secuencia de comandos para usar uno o más servicios (por ejemplo, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringObtiene la URL de autorización que se puede usar para otorgar acceso a la secuencia de comandos.

AuthorizationStatus

Propiedades

PropiedadTipoDescripción
REQUIREDEnumEl usuario debe autorizar esta secuencia de comandos para usar uno o más servicios.
NOT_REQUIREDEnumEl usuario otorgó a esta secuencia de comandos toda la autorización que requiere en la actualidad.

CalendarTriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
create()TriggerCrea el activador y lo muestra.
onEventUpdated()CalendarTriggerBuilderEspecifica un activador que se activa cuando se crea, actualiza o borra una entrada de calendario.

ClockTriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
after(durationMilliseconds)ClockTriggerBuilderEspecifica la duración mínima (en milisegundos) después de la hora actual en la que se ejecuta el activador.
at(date)ClockTriggerBuilderEspecifica cuándo se ejecuta el activador.
atDate(year, month, day)ClockTriggerBuilderEspecifica que el activador se activa en una fecha determinada, de forma predeterminada, cerca de la medianoche (+/- 15 minutos).
atHour(hour)ClockTriggerBuilderEspecifica la hora en la que se ejecuta el activador.
create()TriggerCrea el activador.
everyDays(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n días.
everyHours(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n horas.
everyMinutes(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n minutos.
everyWeeks(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n semanas.
inTimezone(timezone)ClockTriggerBuilderEspecifica la zona horaria para las fechas y horas especificadas cuando se ejecuta el activador.
nearMinute(minute)ClockTriggerBuilderEspecifica el minuto en el que se ejecuta el activador (más o menos 15 minutos).
onMonthDay(day)ClockTriggerBuilderEspecifica la fecha del mes en que se ejecuta el activador.
onWeekDay(day)ClockTriggerBuilderEspecifica el día de la semana en que se ejecuta el activador.

DocumentTriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
create()TriggerCrea y muestra el activador nuevo.
onOpen()DocumentTriggerBuilderEspecifica un activador que se activa cuando se abre el documento.

EventType

Propiedades

PropiedadTipoDescripción
CLOCKEnumEl activador se activa cuando el evento controlado por el tiempo alcanza una hora específica.
ON_OPENEnumEl activador se activa cuando el usuario abre el archivo de Documentos, Hojas de cálculo o Formularios de Google.
ON_EDITEnumEl activador se activa cuando el usuario edita el archivo de Hojas de cálculo de Google (por ejemplo, si ingresa un valor nuevo en una celda, que cuenta como una edición en lugar de un cambio).
ON_FORM_SUBMITEnumEl activador se activa cuando el usuario responde un formulario de Google.
ON_CHANGEEnumEl activador se activa cuando el usuario cambia el archivo de Hojas de cálculo de Google (por ejemplo, al agregar una fila, que cuenta como un cambio en lugar de una edición).
ON_EVENT_UPDATEDEnumEl activador se activa cuando se crea, actualiza o borra un evento en el Calendario de Google especificado.

FormTriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
create()TriggerCrea y muestra el activador nuevo.
onFormSubmit()FormTriggerBuilderEspecifica un activador que se activa cuando se envía una respuesta al formulario.
onOpen()FormTriggerBuilderEspecifica un activador que se activa cuando se abre la vista de edición del formulario.

InstallationSource

Propiedades

PropiedadTipoDescripción
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumEl administrador instaló el complemento para el dominio del usuario.
NONEEnumLa secuencia de comandos no se está ejecutando como complemento.
WEB_STORE_ADD_ONEnumEl usuario instaló el complemento desde Chrome Web Store.

ScriptApp

Propiedades

PropiedadTipoDescripción
AuthModeAuthModeUna enumeración que identifica las categorías de servicios autorizados que Apps Script puede ejecutar a través de una función activada.
AuthorizationStatusAuthorizationStatusUna enumeración que denota el estado de autorización de una secuencia de comandos.
EventTypeEventTypeUna enumeración que denota el tipo de evento activado.
InstallationSourceInstallationSourceUna enumeración que indica cómo se instaló la secuencia de comandos para el usuario como un complemento.
TriggerSourceTriggerSourceUna enumeración que indica el origen del evento que activa el activador.
WeekDayWeekdayUna enumeración que representa los días de la semana.

Métodos

MétodoTipo de datos que se muestraDescripción breve
deleteTrigger(trigger)voidQuita el activador determinado para que ya no se ejecute.
getAuthorizationInfo(authMode)AuthorizationInfoObtiene un objeto que se usa a fin de determinar si el usuario debe autorizar esta secuencia de comandos para usar uno o más servicios y proporcionar la URL para un diálogo de autorización.
getIdentityToken()StringObtiene un token de identidad de OpenID Connect para el usuario efectivo, si se otorgó el alcance openid.
getInstallationSource()InstallationSourceMuestra un valor de enumeración que indica cómo se instaló la secuencia de comandos como un complemento para el usuario actual (por ejemplo, si el usuario la instaló personalmente a través de Chrome Web Store o si un administrador de dominio la instaló para todos los usuarios).
getOAuthToken()StringObtiene el token de acceso de OAuth 2.0 para el usuario efectivo.
getProjectTriggers()Trigger[]Obtiene todos los activadores instalables asociados con el proyecto actual y el usuario actual.
getScriptId()StringObtiene el ID único del proyecto de secuencia de comandos.
getService()ServiceObtiene un objeto que se usa para controlar la publicación de la secuencia de comandos como una aplicación web.
getUserTriggers(document)Trigger[]Obtiene todos los activadores instalables que son propiedad de este usuario en el documento determinado, solo para esta secuencia de comandos o complemento.
getUserTriggers(form)Trigger[]Obtiene todos los activadores instalables que pertenecen a este usuario en el formulario dado, solo para esta secuencia de comandos o complemento.
getUserTriggers(spreadsheet)Trigger[]Obtiene todos los activadores instalables que pertenecen a este usuario en la hoja de cálculo determinada, solo para esta secuencia de comandos o complemento.
invalidateAuth()voidInvalida la autorización que tiene el usuario vigente para ejecutar la secuencia de comandos actual.
newStateToken()StateTokenBuilderCrea un compilador para un token de estado que se puede usar en una API de devolución de llamada (como un flujo de OAuth).
newTrigger(functionName)TriggerBuilderComienza el proceso de creación de un activador instalable que, cuando se activa, llama a una función determinada.

Service

Métodos

MétodoTipo de datos que se muestraDescripción breve
getUrl()StringMuestra la URL de la aplicación web, si se implementó; de lo contrario, muestra null.
isEnabled()BooleanMuestra true si se puede acceder a la secuencia de comandos como una aplicación web.

SpreadsheetTriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
create()TriggerCrea el activador y lo muestra.
onChange()SpreadsheetTriggerBuilderEspecifica un activador que se activa cuando se cambia el contenido o la estructura de la hoja de cálculo.
onEdit()SpreadsheetTriggerBuilderEspecifica un activador que se activa cuando se edita la hoja de cálculo.
onFormSubmit()SpreadsheetTriggerBuilderEspecifica un activador que se activará cuando se envíe un formulario a la hoja de cálculo.
onOpen()SpreadsheetTriggerBuilderEspecifica un activador que se activa cuando se abre la hoja de cálculo.

StateTokenBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
createToken()StringConstruye una representación de string encriptada del token de estado.
withArgument(name, value)StateTokenBuilderAgrega un argumento al token.
withMethod(method)StateTokenBuilderEstablece una función de devolución de llamada.
withTimeout(seconds)StateTokenBuilderEstablece la duración (en segundos) para la que el token es válido.

Trigger

Métodos

MétodoTipo de datos que se muestraDescripción breve
getEventType()EventTypeMuestra el tipo de evento en el que se activa el activador.
getHandlerFunction()StringMuestra la función que se llamará cuando se active el activador.
getTriggerSource()TriggerSourceMuestra la fuente de eventos que harán que se active el activador.
getTriggerSourceId()StringMuestra el ID específico de la fuente.
getUniqueId()StringMuestra un identificador único que se puede usar para distinguir los activadores entre sí.

TriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
forDocument(document)DocumentTriggerBuilderCrea y muestra un DocumentTriggerBuilder vinculado al documento determinado.
forDocument(key)DocumentTriggerBuilderCrea y muestra un DocumentTriggerBuilder vinculado al documento con el ID determinado.
forForm(form)FormTriggerBuilderCrea y muestra un FormTriggerBuilder vinculado al formulario especificado.
forForm(key)FormTriggerBuilderCrea y muestra un FormTriggerBuilder vinculado al formulario con el ID determinado.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderCrea y muestra un SpreadsheetTriggerBuilder vinculado a la hoja de cálculo determinada.
forSpreadsheet(key)SpreadsheetTriggerBuilderCrea y muestra un SpreadsheetTriggerBuilder vinculado a la hoja de cálculo con el ID determinado.
forUserCalendar(emailId)CalendarTriggerBuilderMuestra un compilador para compilar activadores de calendario.
timeBased()ClockTriggerBuilderCrea y muestra un ClockTriggerBuilder para compilar activadores basados en el tiempo.

TriggerSource

Propiedades

PropiedadTipoDescripción
SPREADSHEETSEnumHojas de cálculo de Google activa el activador.
CLOCKEnumUn evento controlado por el tiempo hace que el activador se active.
FORMSEnumFormularios de Google activa el activador.
DOCUMENTSEnumDocumentos de Google activa el activador.
CALENDAREnumCalendario de Google activa el activador.