Script Service

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Script

Esse serviço fornece acesso a acionadores e publicação de scripts.

Classes

NomeBreve descrição
AuthModeUma enumeração que identifica as categorias de serviços autorizados que o Apps Script pode executar usando 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 para uma caixa de diálogo de autorização.
AuthorizationStatusUma enumeração que indica o status de autorização de um script.
CalendarTriggerBuilderBuilder para acionadores de agenda.
ClockTriggerBuilderUm builder para gatilhos de relógio.
DocumentTriggerBuilderUm builder para gatilhos de documentos.
EventTypeUma enumeração que indica o tipo de evento acionado.
FormTriggerBuilderUm builder para acionadores de formulários.
InstallationSourceUma enumeração que indica como o script foi instalado como um complemento para o usuário atual.
ScriptAppAcesse e manipule a publicação e o acionamento de scripts.
ServiceAcessar e manipular a publicação de scripts.
SpreadsheetTriggerBuilderBuilder para acionadores de planilha.
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 scripts.
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 exija autorização.
CUSTOM_FUNCTIONEnumUm modo que permite acesso a um subconjunto limitado de serviços para uso em funções de planilha personalizadas.
LIMITEDEnumUm modo que permite acesso a um subconjunto limitado de serviços.
FULLEnumUm modo que permite 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()StringRecebe 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 a usar um ou mais serviços.
NOT_REQUIREDEnumO usuário concedeu a esse script toda a autorização que ele precisa.

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 de 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 é disparado em uma determinada data, por padrão, perto da meia-noite (+/- 15 minutos).
atHour(hour)ClockTriggerBuilderEspecifica o horário em que o acionador é executado.
create()TriggerCria o gatilho.
everyDays(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n dias.
everyHours(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n horas.
everyMinutes(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n minutos.
everyWeeks(n)ClockTriggerBuilderEspecifica a execução do gatilho 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 gatilho é executado (mais ou menos 15 minutos).
onMonthDay(day)ClockTriggerBuilderEspecifica a data do 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 orientado a tempo atinge um horário específico.
ON_OPENEnumO acionador é disparado quando o usuário abre o arquivo do Documentos, do Planilhas ou do Formulários Google.
ON_EDITEnumO acionador é disparado quando o usuário edita o arquivo do Planilhas Google. Por exemplo, ao inserir um novo valor em uma célula, o que conta como uma edição em vez de uma mudança.
ON_FORM_SUBMITEnumO acionador é disparado quando o usuário responde a um arquivo do Formulários Google.
ON_CHANGEEnumO acionador é disparado quando o usuário muda o arquivo do Planilhas Google. Por exemplo, ele adiciona uma linha, o que conta como uma alteração em vez de 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_ONEnumComplemento 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 as categorias de serviços autorizados que o Apps Script pode executar usando 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 determinado 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 enum 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 do 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 por este usuário no documento especificado, somente para este script ou o complemento.
getUserTriggers(form)Trigger[]Recebe todos os acionadores instaláveis por este usuário no formulário fornecido, apenas para este script ou complemento.
getUserTriggers(spreadsheet)Trigger[]Recebe todos os acionadores instaláveis por este usuário na planilha especificada, para este script ou apenas um complemento.
invalidateAuth()voidInvalida a autorização que o usuário efetivo 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 de OAuth).
newTrigger(functionName)TriggerBuilderComeça o processo de criação de um gatilho instalável que, quando acionado, 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()BooleanRetornará true se o script estiver 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 tiver um formulário enviado.
onOpen()SpreadsheetTriggerBuilderEspecifica um acionador que será disparado quando a planilha for aberta.

StateTokenBuilder

Métodos

MétodoTipo de retornoBreve descrição
createToken()StringCria 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) para o token em que ele é 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 origem.
getUniqueId()StringRetorna um identificador exclusivo que pode ser usado para distinguir acionadores uns dos outros.

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 informado.
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 gatilhos de agenda.
timeBased()ClockTriggerBuilderCria e retorna um ClockTriggerBuilder para criar gatilhos baseados em tempo.

TriggerSource

Propriedades

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