Diese Seite wurde von der Cloud Translation API übersetzt.

Class StateTokenBuilder

Ermöglicht Skripts das Erstellen von Statustokens, 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){
  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

Methode	Rückgabetyp	Kurzbeschreibung
`createToken()`	`String`	Erstellt eine verschlüsselte Stringdarstellung des Statustokens.
`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 Statustokens.

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

Return

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

Name	Typ	Beschreibung
`name`	`String`	Den Namen des Arguments
`value`	`String`	den Wert des Arguments

Return

StateTokenBuilder – der Statustoken-Builder zum Verketten

`withMethod(method)`

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

var 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 enthaltenen Bibliotheken wie `Library.libFunction1` verwenden.

Return

StateTokenBuilder – der Statustoken-Builder zum Verketten

`withTimeout(seconds)`

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

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

Parameter

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

Return

StateTokenBuilder – der Statustoken-Builder zum Verketten