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;
}

Methods

メソッド戻り値の型概要
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();

パラメータ

名前型説明
nameString引数の名前
valueString引数の値

リターン

StateTokenBuilder - 状態トークン ビルダー（チェーン用）

withMethod(method)

コールバック関数を設定します。デフォルトは callback() という名前の関数です。

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

パラメータ

名前型説明
methodStringかっこや引数のない文字列として表される、コールバック関数の名前。付属のライブラリの関数（ Library.libFunction1 など）を使用できます。

リターン

StateTokenBuilder - 状態トークン ビルダー（チェーン用）

withTimeout(seconds)

トークンが有効である期間（秒単位）を設定します。デフォルトは 60 秒です。最長時間は 3,600 秒（1 時間）です。

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

パラメータ

名前型説明
secondsIntegerトークンの有効期間。最大値は 3600 です。

リターン

StateTokenBuilder - 状態トークン ビルダー（チェーン用）