Script Service

Script

Este serviço fornece acesso a gatilhos e publicação de scripts.

Aulas

NomeBreve descrição
AuthModeUma enumeração que identifica quais categorias de serviços autorizados o Apps Script podem executar com uma função acionada.
AuthorizationInfoUm objeto usado para determinar se o usuário precisa autorizar esse script a usar um ou mais serviços e fornecer o URL de uma caixa de diálogo de autorização.
AuthorizationStatusUma enumeração que indica o status de autorização de um script.
CalendarTriggerBuilderBuilder para acionadores da agenda.
ClockTriggerBuilderUm builder para gatilhos de relógio.
DocumentTriggerBuilderUm builder para acionadores de documentos.
EventTypeUma enumeração que indica o tipo de evento acionado.
FormTriggerBuilderUm builder para acionadores de formulário.
InstallationSourceUma enumeração que indica como o script foi instalado como um complemento para o usuário atual.
ScriptAppAcessar e manipular a publicação e os acionadores de scripts.
ServiceAcessar e manipular a publicação de scripts.
SpreadsheetTriggerBuilderBuilder para acionadores de planilhas.
StateTokenBuilderPermite que os scripts criem tokens de estado que podem ser usados em APIs de callback (como fluxos do OAuth).
TriggerUm acionador de script.
TriggerBuilderUm builder genérico para acionadores de script.
TriggerSourceUma enumeração que indica a origem do evento que faz com que o acionador seja disparado.

AuthMode

Propriedades

PropriedadeTipoDescrição
NONEEnumUm modo que não permite acesso a nenhum serviço que exige autorização.
CUSTOM_FUNCTIONEnumUm modo que permite acesso a um subconjunto limitado de serviços para uso em funções de planilhas personalizadas.
LIMITEDEnumUm modo que permite acesso a um subconjunto limitado de serviços.
FULLEnumUm modo que dá acesso a todos os serviços que exigem autorização.

AuthorizationInfo

Métodos

MétodoTipo de retornoBreve descrição
getAuthorizationStatus()AuthorizationStatusRecebe um valor que indica se o usuário precisa autorizar esse script a usar um ou mais serviços (por exemplo, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringExtrai o URL de autorização que pode ser usado para conceder acesso ao script.

AuthorizationStatus

Propriedades

PropriedadeTipoDescrição
REQUIREDEnumO usuário precisa autorizar esse script para usar um ou mais serviços.
NOT_REQUIREDEnumO usuário concedeu a esse script toda a autorização necessária no momento.

CalendarTriggerBuilder

Métodos

MétodoTipo de retornoBreve descrição
create()TriggerCria o gatilho e o retorna.
onEventUpdated()CalendarTriggerBuilderEspecifica um acionador que é disparado quando uma entrada da agenda é criada, atualizada ou excluída.

ClockTriggerBuilder

Métodos

MétodoTipo de retornoBreve descrição
after(durationMilliseconds)ClockTriggerBuilderEspecifica a duração mínima (em milissegundos) após o tempo atual em que o acionador é executado.
at(date)ClockTriggerBuilderEspecifica quando o gatilho é executado.
atDate(year, month, day)ClockTriggerBuilderEspecifica que o acionador será disparado na data especificada, por padrão, perto da meia-noite (+/- 15 minutos).
atHour(hour)ClockTriggerBuilderEspecifica a hora em que o gatilho é executado.
create()TriggerCria o gatilho.
everyDays(n)ClockTriggerBuilderEspecifica a execução do acionador a cada n dias.
everyHours(n)ClockTriggerBuilderEspecifica a execução do acionador a cada n horas.
everyMinutes(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n minutos.
everyWeeks(n)ClockTriggerBuilderEspecifica a execução do acionador a cada n semanas.
inTimezone(timezone)ClockTriggerBuilderEspecifica o fuso horário das datas/horas especificadas quando o acionador é executado.
nearMinute(minute)ClockTriggerBuilderEspecifica o minuto em que o acionador é executado (mais ou menos 15 minutos).
onMonthDay(day)ClockTriggerBuilderEspecifica a data no mês em que o acionador é executado.
onWeekDay(day)ClockTriggerBuilderEspecifica o dia da semana em que o acionador é executado.

DocumentTriggerBuilder

Métodos

MétodoTipo de retornoBreve descrição
create()TriggerCria e retorna o novo gatilho.
onOpen()DocumentTriggerBuilderEspecifica um acionador que será disparado quando o documento for aberto.

EventType

Propriedades

PropriedadeTipoDescrição
CLOCKEnumO acionador é disparado quando o evento baseado em tempo atinge um horário específico.
ON_OPENEnumO acionador é disparado quando o usuário abre o arquivo do Documentos, Planilhas ou Formulários Google.
ON_EDITEnumO acionador é disparado quando o usuário edita o arquivo das Planilhas Google (por exemplo, ao inserir um novo valor em uma célula, que é contabilizado como uma edição, e não uma alteração).
ON_FORM_SUBMITEnumO acionador é disparado quando o usuário responde a um arquivo dos Formulários Google.
ON_CHANGEEnumO acionador é disparado quando o usuário altera o arquivo do Planilhas Google (por exemplo, adicionando uma linha, o que conta como uma alteração, e não uma edição).
ON_EVENT_UPDATEDEnumO acionador é disparado quando um evento é criado, atualizado ou excluído no Google Agenda especificado.

FormTriggerBuilder

Métodos

MétodoTipo de retornoBreve descrição
create()TriggerCria e retorna o novo gatilho.
onFormSubmit()FormTriggerBuilderEspecifica um acionador que será disparado quando uma resposta for enviada ao formulário.
onOpen()FormTriggerBuilderEspecifica um acionador que será disparado quando a visualização de edição do formulário for aberta.

InstallationSource

Propriedades

PropriedadeTipoDescrição
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumO complemento foi instalado pelo administrador para o domínio do usuário.
NONEEnumO script não está sendo executado como um complemento.
WEB_STORE_ADD_ONEnumO complemento foi instalado pelo usuário pela Chrome Web Store.

ScriptApp

Propriedades

PropriedadeTipoDescrição
AuthModeAuthModeUma enumeração que identifica quais categorias de serviços autorizados o Apps Script podem executar com uma função acionada.
AuthorizationStatusAuthorizationStatusUma enumeração que indica o status de autorização de um script.
EventTypeEventTypeUma enumeração que indica o tipo de evento acionado.
InstallationSourceInstallationSourceUma enumeração que indica como o script foi instalado para o usuário como um complemento.
TriggerSourceTriggerSourceUma enumeração que indica a origem do evento que faz com que o acionador seja disparado.
WeekDayWeekdayUma enumeração que representa os dias da semana.

Métodos

MétodoTipo de retornoBreve descrição
deleteTrigger(trigger)voidRemove o gatilho especificado para que ele não seja mais executado.
getAuthorizationInfo(authMode)AuthorizationInfoRecebe um objeto usado para determinar se o usuário precisa autorizar esse script a usar um ou mais serviços e fornecer o URL para uma caixa de diálogo de autorização.
getIdentityToken()StringRecebe um token de identidade do OpenID Connect para o usuário efetivo, se o escopo openid tiver sido concedido.
getInstallationSource()InstallationSourceRetorna um valor de enumeração que indica como o script foi instalado como um complemento para o usuário atual. Por exemplo, se o usuário o instalou pessoalmente pela Chrome Web Store ou se um administrador do domínio o instalou para todos os usuários.
getOAuthToken()StringRecebe o token de acesso OAuth 2.0 do usuário efetivo.
getProjectTriggers()Trigger[]Recebe todos os gatilhos instaláveis associados ao projeto atual e ao usuário atual.
getScriptId()StringRecebe o ID exclusivo do projeto de script.
getService()ServiceRecebe um objeto usado para controlar a publicação do script como um app da Web.
getUserTriggers(document)Trigger[]Recebe todos os acionadores instaláveis deste usuário no documento especificado, apenas para este script ou complemento.
getUserTriggers(form)Trigger[]Recebe todos os acionadores instaláveis deste usuário no formato fornecido, somente para este script ou complemento.
getUserTriggers(spreadsheet)Trigger[]Recebe todos os acionadores instaláveis que pertencem a esse usuário na planilha especificada, somente para este script ou complemento.
invalidateAuth()voidInvalida a autorização que o usuário em vigor tem para executar o script atual.
newStateToken()StateTokenBuilderCria um builder para um token de estado que pode ser usado em uma API de callback (como um fluxo OAuth).
newTrigger(functionName)TriggerBuilderInicia o processo de criação de um gatilho instalável que, quando disparado, chama uma determinada função.

Service

Métodos

MétodoTipo de retornoBreve descrição
getUrl()StringRetorna o URL do app da Web, se ele tiver sido implantado. Caso contrário, retorna null.
isEnabled()BooleanRetorna true se o script for acessível como um app da Web.

SpreadsheetTriggerBuilder

Métodos

MétodoTipo de retornoBreve descrição
create()TriggerCria o gatilho e o retorna.
onChange()SpreadsheetTriggerBuilderEspecifica um acionador que será disparado quando o conteúdo ou a estrutura da planilha for alterado.
onEdit()SpreadsheetTriggerBuilderEspecifica um acionador que será disparado quando a planilha for editada.
onFormSubmit()SpreadsheetTriggerBuilderEspecifica um acionador que será disparado quando a planilha receber um formulário.
onOpen()SpreadsheetTriggerBuilderEspecifica um acionador que será disparado quando a planilha for aberta.

StateTokenBuilder

Métodos

MétodoTipo de retornoBreve descrição
createToken()StringConstrói uma representação de string criptografada do token de estado.
withArgument(name, value)StateTokenBuilderAdiciona um argumento ao token.
withMethod(method)StateTokenBuilderDefine uma função de callback.
withTimeout(seconds)StateTokenBuilderDefine a duração (em segundos) pela qual o token é válido.

Trigger

Métodos

MétodoTipo de retornoBreve descrição
getEventType()EventTypeRetorna o tipo de evento em que o acionador é disparado.
getHandlerFunction()StringRetorna a função que será chamada quando o acionador for disparado.
getTriggerSource()TriggerSourceRetorna a origem dos eventos que farão com que o acionador seja disparado.
getTriggerSourceId()StringRetorna o ID específico da fonte.
getUniqueId()StringRetorna um identificador exclusivo que pode ser usado para distinguir acionadores entre si.

TriggerBuilder

Métodos

MétodoTipo de retornoBreve descrição
forDocument(document)DocumentTriggerBuilderCria e retorna um DocumentTriggerBuilder vinculado ao documento especificado.
forDocument(key)DocumentTriggerBuilderCria e retorna um DocumentTriggerBuilder vinculado ao documento com o ID fornecido.
forForm(form)FormTriggerBuilderCria e retorna um FormTriggerBuilder vinculado ao formulário especificado.
forForm(key)FormTriggerBuilderCria e retorna um FormTriggerBuilder vinculado ao formulário com o ID fornecido.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderCria e retorna um SpreadsheetTriggerBuilder vinculado à planilha especificada.
forSpreadsheet(key)SpreadsheetTriggerBuilderCria e retorna um SpreadsheetTriggerBuilder vinculado à planilha com o ID fornecido.
forUserCalendar(emailId)CalendarTriggerBuilderRetorna um builder para criar acionadores da agenda.
timeBased()ClockTriggerBuilderCria e retorna um ClockTriggerBuilder para criar gatilhos baseados em tempo.

TriggerSource

Propriedades

PropriedadeTipoDescrição
SPREADSHEETSEnumO app Planilhas Google dispara o acionador.
CLOCKEnumUm evento orientado por tempo faz com que o acionador seja disparado.
FORMSEnumO app Formulários Google faz com que o acionador seja disparado.
DOCUMENTSEnumO Documentos Google faz com que o acionador seja disparado.
CALENDAREnumO Google Agenda faz com que o acionador seja disparado.