Class StateTokenBuilder

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

Permite que os scripts criem tokens de estado que podem ser usados em APIs de callback (como fluxos do OAuth).

// Reusable function to generate a callback URL, assuming the script has been published as a
// web app (necessary to obtain the URL programmatically). If the script has not been published
// as a web app, set `var url` in the first line to the URL of your script project (which
// cannot be obtained programmatically).
function getCallbackURL(callbackFunction){
  var url = ScriptApp.getService().getUrl();      // Ends in /exec (for a web app)
  url = url.slice(0, -4) + 'usercallback?state='; // Change /exec to /usercallback
  var stateToken = ScriptApp.newStateToken()
      .withMethod(callbackFunction)
      .withTimeout(120)
      .createToken();
  return url + stateToken;
}

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.

Documentação detalhada

createToken()

Cria uma representação de string criptografada do token de estado.

var stateToken = ScriptApp.newStateToken().createToken();

Retornar

String: uma string criptografada que representa o token


withArgument(name, value)

Adiciona um argumento ao token. Esse método pode ser chamado várias vezes.

var stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();

Parâmetros

NomeTipoDescrição
nameStringo nome do argumento
valueStringo valor do argumento

Retornar

StateTokenBuilder: o builder de tokens de estado, para encadeamento


withMethod(method)

Define uma função de callback. O padrão é uma função chamada callback().

var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();

Parâmetros

NomeTipoDescrição
methodStringO nome da função de callback, representada como uma string sem parênteses ou argumentos. É possível usar funções de bibliotecas incluídas, como Library.libFunction1.

Retornar

StateTokenBuilder: o builder de tokens de estado, para encadeamento


withTimeout(seconds)

Define a duração (em segundos) para o token em que ele é válido. O padrão é 60 segundos. A duração máxima é 3.600 segundos (1 hora).

var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();

Parâmetros

NomeTipoDescrição
secondsIntegerO tempo de validade do token é de 3600

Retornar

StateTokenBuilder: o builder de tokens de estado, para encadeamento