Komut dosyalarının, geri çağırma API'lerinde (OAuth akışları gibi) kullanılabilecek durum jetonları oluşturmasına izin verir.
// 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; }
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
createToken() | String | Durum jetonunun şifrelenmiş bir dize temsilini oluşturur. |
withArgument(name, value) | StateTokenBuilder | Jetona bir bağımsız değişken ekler. |
withMethod(method) | StateTokenBuilder | Bir geri çağırma işlevi ayarlar. |
withTimeout(seconds) | StateTokenBuilder | Jetonun geçerli olduğu süreyi (saniye cinsinden) ayarlar. |
Ayrıntılı belgeler
createToken()
Durum jetonunun şifrelenmiş bir dize temsilini oluşturur.
var stateToken = ScriptApp.newStateToken().createToken();
Return
String
: jetonu temsil eden şifrelenmiş bir dize
withArgument(name, value)
Jetona bir bağımsız değişken ekler. Bu yöntem birden çok kez çağrılabilir.
var stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();
Parametreler
Ad | Tür | Açıklama |
---|---|---|
name | String | bağımsız değişkenin adı |
value | String | bağımsız değişkenin değeri |
Return
StateTokenBuilder
: Zincirleme için durum jetonu oluşturucu
withMethod(method)
Bir geri çağırma işlevi ayarlar. Varsayılan değer, callback()
adlı bir işlevdir.
var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();
Parametreler
Ad | Tür | Açıklama |
---|---|---|
method | String | Parantez veya bağımsız değişken olmadan bir dize olarak gösterilen geri çağırma işlevinin adı. Dahil edilen kitaplıklardaki
Library.libFunction1 gibi işlevleri kullanabilirsiniz. |
Return
StateTokenBuilder
: Zincirleme için durum jetonu oluşturucu
withTimeout(seconds)
Jetonun geçerli olduğu süreyi (saniye cinsinden) ayarlar. Varsayılan süre 60 saniye, maksimum süre ise 3.600 saniyedir (1 saat).
var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
Parametreler
Ad | Tür | Açıklama |
---|---|---|
seconds | Integer | jetonun geçerli olduğu süredir; maksimum değer 3600 şeklindedir |
Return
StateTokenBuilder
: Zincirleme için durum jetonu oluşturucu