Class StateTokenBuilder

StateTokenBuilder

Ermöglicht Skripts, 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

Methode	Rückgabetyp	Kurzbeschreibung
createToken()	String	Erstellt eine verschlüsselte Stringdarstellung des Status-Tokens.
withArgument(name, value)	StateTokenBuilder	Fügt dem Token ein Argument hinzu.
withMethod(method)	StateTokenBuilder	Legt eine Callback-Funktion fest.
withTimeout(seconds)	StateTokenBuilder	Legt 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 : Eine verschlüsselte Stringdarstellung des Tokens.

---

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

Name	Typ	Beschreibung
name	String	Der Name des Arguments.
value	String	Der Wert des Arguments.

Rückflug

StateTokenBuilder : Der Status-Token-Builder für die Verkettung.

---

withMethod(method)

Legt eine Callback-Funktion fest. Die Standardeinstellung ist eine Funktion mit dem Namen callback().

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

Parameter

Name	Typ	Beschreibung
method	String	Der Name der Callback-Funktion, dargestellt als String ohne Klammern oder Argumente. Sie können Funktionen aus eingeschlossenen Bibliotheken verwenden, z. B. Library.libFunction1.

Rückflug

StateTokenBuilder : Der Status-Token-Builder für die Verkettung.

---

withTimeout(seconds)

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

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

Parameter

Name	Typ	Beschreibung
seconds	Integer	Die Dauer, für die das Token gültig ist. Der Maximalwert ist 3600.

Rückflug

StateTokenBuilder : Der Status-Token-Builder für die Verkettung.