Class Trigger

Gatilho

Um acionador de script.

Métodos

Método	Tipo de retorno	Breve descrição
getEventType()	EventType	Retorna o tipo de evento em que o acionador é acionado.
getHandlerFunction()	String	Retorna a função que será chamada quando o acionador for acionado.
getTriggerSource()	TriggerSource	Retorna a origem dos eventos que acionam o acionador.
getTriggerSourceId()	String	Retorna o ID específico da fonte.
getUniqueId()	String	Retorna um identificador exclusivo que pode ser usado para distinguir gatilhos.

Documentação detalhada

getEventType()

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

const triggers = ScriptApp.getProjectTriggers();
for (let 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 que é acionado

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 acionado.

// 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 acionam o acionador.

Por exemplo, um acionador onEdit de planilha retornaria SPREADSHEETS, ou um acionador baseado em tempo retornaria CLOCK.

const triggers = ScriptApp.getProjectTriggers();
for (let 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 que é acionado

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 fonte.

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

Retornar

String: o ID da entidade no editor para que o gatilho é acionado.

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 gatilhos.

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