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 — конструктор токенов состояний для создания цепочек токенов.