Class StateTokenBuilder

StateTokenBuilder

Позволяет сценариям создавать токены состояния, которые можно использовать в API обратного вызова (например, в потоках 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;
}

Методы

Метод Тип возврата Краткое описание
createToken() String Создает зашифрованное строковое представление токена состояния.
withArgument(name, value) StateTokenBuilder Добавляет аргумент к токену.
withMethod(method) StateTokenBuilder Устанавливает функцию обратного вызова.
withTimeout(seconds) StateTokenBuilder Устанавливает продолжительность (в секундах), в течение которой токен действителен.

Подробная документация

createToken()

Создает зашифрованное строковое представление токена состояния.

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

Возвращаться

String — зашифрованная строка, представляющая токен.

withArgument(name, value)

Добавляет аргумент к токену. Этот метод можно вызывать несколько раз.

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

Параметры

Имя Тип Описание
name String название аргумента
value String значение аргумента

Возвращаться

StateTokenBuilder — конструктор токенов состояния для цепочки

withMethod(method)

Устанавливает функцию обратного вызова. По умолчанию используется функция с именем callback() .

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

Параметры

Имя Тип Описание
method String Имя функции обратного вызова, представленное в виде строки без круглых скобок и аргументов. Вы можете использовать функции из включенных библиотек, например Library.libFunction1 .

Возвращаться

StateTokenBuilder — конструктор токенов состояния для цепочки

withTimeout(seconds)

Устанавливает продолжительность (в секундах), в течение которой токен действителен. Значение по умолчанию — 60 секунд; максимальная продолжительность — 3600 секунд (1 час).

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

Параметры

Имя Тип Описание
seconds Integer срок действия токена; максимальное значение 3600

Возвращаться

StateTokenBuilder — конструктор токенов состояния для цепочки