Class 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) {
  let url = ScriptApp.getService().getUrl();  // Ends in /exec (for a web app)
  url = `${
      url.slice(0, -4)}usercallback?state=`;  // Change /exec to /usercallback
  const stateToken = ScriptApp.newStateToken()
                         .withMethod(callbackFunction)
                         .withTimeout(120)
                         .createToken();
  return url + stateToken;
}

Методы

Метод Тип возврата Краткое описание
create Token() String Создает зашифрованное строковое представление токена состояния.
with Argument(name, value) State Token Builder Добавляет аргумент к токену.
with Method(method) State Token Builder Устанавливает функцию обратного вызова.
with Timeout(seconds) State Token Builder Устанавливает продолжительность (в секундах), в течение которой токен действителен.

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

create Token()

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

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

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

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

with Argument(name, value)

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

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

Параметры

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

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

State Token Builder — конструктор государственных токенов для создания цепочек

with Method(method)

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

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

Параметры

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

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

State Token Builder — конструктор государственных токенов для создания цепочек

with Timeout(seconds)

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

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

Параметры

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

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

State Token Builder — конструктор государственных токенов для создания цепочек