Class StateTokenBuilder

StateTokenBuilder

Ermöglicht Skripts das Erstellen von Statustokens, die in Callback-APIs (wie OAuth-Abläufen) verwendet werden können.

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

Methoden

MethodeRückgabetypKurzbeschreibung
createToken()StringErstellt eine verschlüsselte Stringdarstellung des Statustokens.
withArgument(name, value)StateTokenBuilderFügt dem Token ein Argument hinzu.
withMethod(method)StateTokenBuilderLegt eine Rückruffunktion fest.
withTimeout(seconds)StateTokenBuilderLegt die Dauer (in Sekunden) fest, für die das Token gültig ist.

Detaillierte Dokumentation

createToken()

Erstellt eine verschlüsselte Stringdarstellung des Statustokens.

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

Rückflug

String: ein verschlüsselter String, der das Token darstellt


withArgument(name, value)

Fügt dem Token ein Argument hinzu. Diese Methode kann mehrmals aufgerufen werden.

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

Parameter

NameTypBeschreibung
nameStringden Namen des Arguments
valueStringWert des Arguments

Rückflug

StateTokenBuilder – der Statustoken-Builder für Verkettungen


withMethod(method)

Legt eine Rückruffunktion fest. Die Standardeinstellung ist eine Funktion mit dem Namen callback().

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

Parameter

NameTypBeschreibung
methodStringDer Name der Callback-Funktion, dargestellt als String ohne Klammern oder Argumente. Sie können Funktionen aus enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

Rückflug

StateTokenBuilder – der Statustoken-Builder für Verkettungen


withTimeout(seconds)

Legt die Dauer (in Sekunden) fest, für die das Token gültig ist. Der Standardwert ist 60 Sekunden. die Die maximale Dauer beträgt 3.600 Sekunden (1 Stunde).

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

Parameter

NameTypBeschreibung
secondsIntegerDauer, für die das Token gültig ist der Maximalwert ist 3600

Rückflug

StateTokenBuilder – der Statustoken-Builder für Verkettungen