Script Service

Script

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

Clases

NombreDescripción breve
AuthModeEs una enumeración que identifica qué categorías de servicios autorizados puede ejecutar Apps Script a través de una función activada.
AuthorizationInfoEs un objeto que verifica si el usuario otorgó autorización para los alcances requeridos de la secuencia de comandos.
AuthorizationStatusEs una enumeración que denota el estado de autorización de una secuencia de comandos.
CalendarTriggerBuilderEs un compilador para activadores de calendario.
ClockTriggerBuilderEs un compilador para activadores de reloj.
DocumentTriggerBuilderEs un compilador de activadores de documentos.
EventTypeEs una enumeración que denota el tipo de evento activado.
FormTriggerBuilderEs un compilador para activadores de formularios.
InstallationSourceEs una enumeración que indica cómo se instaló la secuencia de comandos como complemento para el usuario actual.
ScriptAppAcceder a la publicación y los activadores de secuencias de comandos, y manipularlos
ServiceAcceder a la publicación de secuencias de comandos y manipularla
SpreadsheetTriggerBuilderCompilador para activadores de hojas de cálculo.
StateTokenBuilderPermite que las secuencias de comandos creen tokens de estado que se pueden usar en las APIs de devolución de llamada (como los flujos de OAuth).
TriggerEs un activador de secuencia de comandos.
TriggerBuilderEs un compilador genérico para activadores de secuencias de comandos.
TriggerSourceEs una enumeración que denota la fuente del evento que hace que se active el disparador.

AuthMode

Propiedades

PropiedadTipoDescripción
NONEEnumEs un modo que no permite el acceso a ningún servicio que requiera autorización.
CUSTOM_FUNCTIONEnumEs un modo que permite el acceso a un subconjunto limitado de servicios para su uso en funciones personalizadas de hojas de cálculo.
LIMITEDEnumEs un modo que permite el acceso a un subconjunto limitado de servicios.
FULLEnumEs un 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()String|nullObtiene la URL de autorización que se puede usar para otorgar acceso a la secuencia de comandos.
getAuthorizedScopes()String[]|nullObtiene una lista de los permisos autorizados para 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 actualmente.

CalendarTriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
create()TriggerCrea el activador y lo devuelve.
onEventUpdated()CalendarTriggerBuilderEspecifica un activador que se dispara 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 la 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 el activador se ejecute cada n días.
everyHours(n)ClockTriggerBuilderEspecifica que el activador se ejecute cada n horas.
everyMinutes(n)ClockTriggerBuilderEspecifica que el activador se ejecute cada n minutos.
everyWeeks(n)ClockTriggerBuilderEspecifica que el activador se ejecute cada n semanas.
inTimezone(timezone)ClockTriggerBuilderEspecifica la zona horaria para las fechas y horas especificadas en las que 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 la 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 devuelve el activador nuevo.
onOpen()DocumentTriggerBuilderEspecifica un activador que se activará cuando se abra el documento.

EventType

Propiedades

PropiedadTipoDescripción
CLOCKEnumEl activador se activa una vez que el evento basado en el tiempo alcanza un momento específico.
ON_OPENEnumEl activador se dispara una vez que el usuario abre el archivo de Documentos, Hojas de cálculo o Formularios de Google.
ON_EDITEnumEl activador se dispara una vez que el usuario edita el archivo de Hojas de cálculo de Google (por ejemplo, cuando ingresa un valor nuevo en una celda, lo que se considera una edición en lugar de un cambio).
ON_FORM_SUBMITEnumEl activador se dispara una vez que el usuario responde un formulario de Google.
ON_CHANGEEnumEl activador se dispara una vez que el usuario cambia el archivo de Hojas de cálculo de Google (por ejemplo, cuando agrega una fila, lo que se considera un cambio en lugar de una edición).
ON_EVENT_UPDATEDEnumEl activador se dispara una vez que 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 devuelve el activador nuevo.
onFormSubmit()FormTriggerBuilderEspecifica un activador que se activará cuando se envíe una respuesta al formulario.
onOpen()FormTriggerBuilderEspecifica un activador que se activará cuando se abra 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 ejecuta como complemento.
WEB_STORE_ADD_ONEnumEl usuario instaló el complemento desde Chrome Web Store.

ScriptApp

Propiedades

PropiedadTipoDescripción
AuthModeAuthModeEs una enumeración que identifica qué categorías de servicios autorizados puede ejecutar Apps Script a través de una función activada.
AuthorizationStatusAuthorizationStatusEs una enumeración que denota el estado de autorización de una secuencia de comandos.
EventTypeEventTypeEs una enumeración que denota el tipo de evento activado.
InstallationSourceInstallationSourceEs una enumeración que indica cómo se instaló la secuencia de comandos para el usuario como complemento.
TriggerSourceTriggerSourceEs una enumeración que denota la fuente del evento que hace que se active el disparador.
WeekDayWeekdayEs una 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 verifica si el usuario otorgó autorización para todos los requisitos de la secuencia de comandos.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoObtiene un objeto que verifica si el usuario otorgó autorización para los alcances solicitados.
getIdentityToken()String|nullObtiene un token de identidad de OpenID Connect para el usuario efectivo, si se otorgó el alcance de openid.
getInstallationSource()InstallationSourceDevuelve un valor de enumeración que indica cómo se instaló la secuencia de comandos como complemento para el usuario actual (por ejemplo, si el usuario la instaló personalmente a través de Chrome Web Store o si un administrador del 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 y el usuario actuales.
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 app web.
getUserTriggers(document)Trigger[]Obtiene todos los activadores instalables que posee este usuario en el documento determinado, solo para esta secuencia de comandos o complemento.
getUserTriggers(form)Trigger[]Obtiene todos los activadores instalables que posee este usuario en el formulario determinado, solo para esta secuencia de comandos o complemento.
getUserTriggers(spreadsheet)Trigger[]Obtiene todos los activadores instalables que posee 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 efectivo 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.
requireAllScopes(authMode)voidValida si el usuario otorgó su consentimiento para todos los permisos solicitados por la secuencia de comandos.
requireScopes(authMode, oAuthScopes)voidValida si el usuario otorgó su consentimiento para los alcances solicitados.

Service

Métodos

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

SpreadsheetTriggerBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
create()TriggerCrea el activador y lo devuelve.
onChange()SpreadsheetTriggerBuilderEspecifica un activador que se activará cuando se cambie el contenido o la estructura de la hoja de cálculo.
onEdit()SpreadsheetTriggerBuilderEspecifica un activador que se activará cuando se edite 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 activará cuando se abra la hoja de cálculo.

StateTokenBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
createToken()StringConstruye una representación de cadena 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) durante la cual el token es válido.

Trigger

Métodos

MétodoTipo de datos que se muestraDescripción breve
getEventType()EventTypeDevuelve el tipo de evento en el que se activa el disparador.
getHandlerFunction()StringDevuelve la función a la que se llamará cuando se active el disparador.
getTriggerSource()TriggerSourceDevuelve la fuente de los eventos que harán que se active el disparador.
getTriggerSourceId()StringDevuelve el ID específico de la fuente.
getUniqueId()StringDevuelve 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 devuelve un DocumentTriggerBuilder vinculado al documento determinado.
forDocument(key)DocumentTriggerBuilderCrea y devuelve un DocumentTriggerBuilder vinculado al documento con el ID determinado.
forForm(form)FormTriggerBuilderCrea y devuelve un FormTriggerBuilder vinculado al formulario determinado.
forForm(key)FormTriggerBuilderCrea y devuelve un FormTriggerBuilder vinculado al formulario con el ID determinado.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderCrea y devuelve un objeto SpreadsheetTriggerBuilder vinculado a la hoja de cálculo proporcionada.
forSpreadsheet(key)SpreadsheetTriggerBuilderCrea y devuelve un objeto SpreadsheetTriggerBuilder vinculado a la hoja de cálculo con el ID determinado.
forUserCalendar(emailId)CalendarTriggerBuilderDevuelve un compilador para crear activadores de calendario.
timeBased()ClockTriggerBuilderCrea y devuelve un ClockTriggerBuilder para compilar activadores basados en el tiempo.

TriggerSource

Propiedades

PropiedadTipoDescripción
SPREADSHEETSEnumHojas de cálculo de Google hace que se active el disparador.
CLOCKEnumUn evento basado en el tiempo hace que se active el disparador.
FORMSEnumFormularios de Google hace que se active el disparador.
DOCUMENTSEnumDocumentos de Google hace que se active el disparador.
CALENDAREnumEl Calendario de Google hace que se active el disparador.