Mengizinkan skrip untuk membuat token status yang dapat digunakan dalam 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){ 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
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
createToken() | String | Membuat representasi string terenkripsi dari token status. |
withArgument(name, value) | StateTokenBuilder | Menambahkan argumen ke token. |
withMethod(method) | StateTokenBuilder | Menetapkan fungsi callback. |
withTimeout(seconds) | StateTokenBuilder | Menetapkan durasi (dalam detik) untuk validitas token. |
Dokumentasi mendetail
createToken()
Membuat representasi string terenkripsi dari token status.
var 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.
var stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | nama argumen |
value | String | nilai argumen |
Pulang pergi
StateTokenBuilder
— builder token status, untuk perantaian
withMethod(method)
Menetapkan fungsi callback. Defaultnya adalah fungsi bernama callback()
.
var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
method | String | Nama 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
— builder token status, untuk perantaian
withTimeout(seconds)
Menetapkan durasi (dalam detik) untuk validitas token. Defaultnya adalah 60 detik; tindakan durasi maksimum adalah 3600 detik (1 jam).
var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
seconds | Integer | durasi validitas token; nilai maksimumnya adalah 3600 |
Pulang pergi
StateTokenBuilder
— builder token status, untuk perantaian