Class Trigger

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

Um acionador de script.

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.

Documentação detalhada

getEventType()

Retorna o tipo de evento em que o acionador é disparado.

var triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
  if (triggers[i].getEventType() == ScriptApp.EventType.CLOCK) {
    // Some code here - other options are:
    // ScriptApp.EventType.ON_EDIT
    // ScriptApp.EventType.ON_FORM_SUBMIT
    // ScriptApp.EventType.ON_OPEN
  }
}

Retornar

EventType: o tipo de evento para o qual esse é um acionador

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/script.scriptapp

getHandlerFunction()

Retorna a função que será chamada quando o acionador for disparado.

// Create a trigger for the script.
ScriptApp.newTrigger('myFunction').forSpreadsheet('id of my spreadsheet').onEdit().create();
Logger.log(ScriptApp.getProjectTriggers()[0].getHandlerFunction()); // logs "myFunction"

Retornar

String: o nome do método

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSource()

Retorna a origem dos eventos que farão com que o acionador seja disparado.

Por exemplo, uma planilha onEdit retornará SPREADSHEETS ou um gatilho com base em tempo retornaria "Clock".

var triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
  if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.CLOCK) {
    Logger.log(triggers[i].getUniqueId() + " source is clock");
  } else if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.SPREADSHEETS) {
    Logger.log(triggers[i].getUniqueId() + " source is spreadsheets");
  }
}

Retornar

TriggerSource: o editor do qual isso é um acionador

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSourceId()

Retorna o ID específico da origem.

Por exemplo, se a origem do acionador for uma planilha, esse será o ID da planilha. Para eventos de relógio, ele retorna nulo.

Retornar

String: o ID da entidade no editor para o qual isso é um acionador

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/script.scriptapp

getUniqueId()

Retorna um identificador exclusivo que pode ser usado para distinguir acionadores uns dos outros.

Retornar

String: o identificador exclusivo do acionador

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/script.scriptapp