Class StateTokenBuilder

StateTokenBuilder

Ermöglicht es Scripts, Status-Tokens zu erstellen, die in Callback-APIs (z. B. 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) {
  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 Status-Tokens.
withArgument(name, value)StateTokenBuilderFügt dem Token ein Argument hinzu.
withMethod(method)StateTokenBuilderLegt eine Callback-Funktion 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 Status-Tokens. 

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.
valueStringDer Wert des Arguments.

Rückflug

StateTokenBuilder – Der Builder für das Status-Token zur Verkettung.

withMethod(method)

Legt eine Callback-Funktion fest. Der Standardwert ist eine Funktion namens 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 verwenden, z. B. Library.libFunction1.

Rückflug

StateTokenBuilder – Der Builder für das Status-Token zur Verkettung.

withTimeout(seconds)

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

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

Parameter

NameTypBeschreibung
secondsIntegerDer Zeitraum, für den das Token gültig ist. Der Höchstwert ist 3600.

Rückflug

StateTokenBuilder – Der Builder für das Status-Token zur Verkettung.