Class StateTokenBuilder

StateTokenBuilder

Memungkinkan skrip membuat token status yang dapat digunakan di API callback (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) {
  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;
}

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) validitas token.

Dokumentasi mendetail

createToken()

Membuat representasi string terenkripsi dari token status.

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

Pulang pergi

String — string terenkripsi yang mewakili token


withArgument(name, value)

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

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

Parameter

NamaJenisDeskripsi
nameStringnama argumen
valueStringnilai argumen

Pulang pergi

StateTokenBuilder — pembuat token status, untuk pembuatan rantai


withMethod(method)

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

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

Pulang pergi

StateTokenBuilder — pembuat token status, untuk pembuatan rantai


withTimeout(seconds)

Menetapkan durasi (dalam detik) validitas token. Defaultnya adalah 60 detik; durasi maksimumnya adalah 3.600 detik (1 jam).

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

Parameter

NamaJenisDeskripsi
secondsIntegerdurasi validitas token; nilai maksimumnya adalah 3600

Pulang pergi

StateTokenBuilder — pembuat token status, untuk pembuatan rantai