Class StateTokenBuilder

StateTokenBuilder

Mengizinkan skrip untuk membuat token status yang dapat digunakan di callback API (seperti alur OAuth).

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
createToken()StringMembuat representasi string terenkripsi dari token status.
withArgument(name, value)StateTokenBuilderMenambahkan argumen ke token.
withMethod(method)StateTokenBuilderMenetapkan fungsi callback.
withTimeout(seconds)StateTokenBuilderMenetapkan durasi (dalam detik) saat token valid.

Dokumentasi mendetail

createToken()

Membuat representasi string terenkripsi dari token status.

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

Return

String — string terenkripsi yang mewakili token


withArgument(name, value)

Menambahkan argumen ke token. Metode ini bisa dipanggil beberapa kali.

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

Parameter

NamaJenisDeskripsi
nameStringnama argumen
valueStringnilai argumen

Return

StateTokenBuilder — builder token status, untuk membuat rantai


withMethod(method)

Menetapkan fungsi callback. Defaultnya adalah fungsi bernama callback().

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

Parameter

NamaJenisDeskripsi
methodStringNama fungsi callback, yang direpresentasikan sebagai string tanpa tanda kurung atau argumen. Anda dapat menggunakan fungsi dari library yang disertakan, seperti Library.libFunction1.

Return

StateTokenBuilder — builder token status, untuk membuat rantai


withTimeout(seconds)

Menetapkan durasi (dalam detik) saat token valid. Defaultnya adalah 60 detik; durasi maksimum adalah 3600 detik (1 jam).

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

Parameter

NamaJenisDeskripsi
secondsIntegerdurasi token valid; nilai maksimum adalah 3600

Return

StateTokenBuilder — builder token status, untuk membuat rantai