Class StateTokenBuilder

StateTokenBuilder

Ermöglicht es Scripts, Status-Token zu erstellen, die in Callback-APIs (z. B. OAuth-Abläufe) 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) {
  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;
}

Methoden

MethodeRückgabetypKurzbeschreibung
createToken()StringErstellt eine verschlüsselte Stringdarstellung des Statustokens.
withArgument(name, value)StateTokenBuilderFügt dem Token ein Argument hinzu.
withMethod(method)StateTokenBuilderHier wird eine Rückruffunktion festgelegt.
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. 

const 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. 

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

Parameter

NameTypBeschreibung
nameStringDer Name des Arguments
valueStringWert des Arguments

Rückflug

StateTokenBuilder – State Token-Builder, zum Verketten

withMethod(method)

Hier wird eine Rückruffunktion festgelegt. Standardmäßig ist dies die Funktion callback(). 

const 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 den enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

Rückflug

StateTokenBuilder – State Token-Builder, zum Verketten

withTimeout(seconds)

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

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

Parameter

NameTypBeschreibung
secondsIntegerdie Dauer, für die das Token gültig ist. Der maximale Wert ist 3600.

Rückflug

StateTokenBuilder – State Token-Builder, zum Verketten