Cho phép tập lệnh tạo mã thông báo trạng thái có thể dùng trong API gọi lại (chẳng hạn như luồng 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; }
Phương thức
Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
---|---|---|
createToken() | String | Tạo một chuỗi đại diện đã mã hoá của mã thông báo trạng thái. |
withArgument(name, value) | StateTokenBuilder | Thêm một đối số vào mã thông báo. |
withMethod(method) | StateTokenBuilder | Đặt một hàm callback. |
withTimeout(seconds) | StateTokenBuilder | Đặt thời lượng (tính bằng giây) mà mã thông báo hợp lệ. |
Tài liệu chi tiết
createToken()
Tạo một chuỗi đại diện đã mã hoá của mã thông báo trạng thái.
var stateToken = ScriptApp.newStateToken().createToken();
Cầu thủ trả bóng
String
– một chuỗi đã mã hoá đại diện cho mã thông báo
withArgument(name, value)
Thêm một đối số vào mã thông báo. Phương thức này có thể được gọi nhiều lần.
var stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | tên của đối số |
value | String | giá trị của đối số |
Cầu thủ trả bóng
StateTokenBuilder
– trình tạo mã thông báo trạng thái để tạo chuỗi
withMethod(method)
Đặt một hàm callback. Giá trị mặc định là hàm có tên callback()
.
var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();
Tham số
Tên | Loại | Mô tả |
---|---|---|
method | String | Tên của hàm callback, được biểu thị dưới dạng một chuỗi không có dấu ngoặc đơn hoặc
đối số. Bạn có thể dùng các hàm trong các thư viện đi kèm, chẳng hạn như
Library.libFunction1 . |
Cầu thủ trả bóng
StateTokenBuilder
– trình tạo mã thông báo trạng thái để tạo chuỗi
withTimeout(seconds)
Đặt thời lượng (tính bằng giây) mà mã thông báo hợp lệ. Các giá trị mặc định là 60 giây; thời gian thời lượng tối đa là 3600 giây (1 giờ).
var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
Tham số
Tên | Loại | Mô tả |
---|---|---|
seconds | Integer | khoảng thời gian mã thông báo hợp lệ; giá trị lớn nhất là 3600 |
Cầu thủ trả bóng
StateTokenBuilder
– trình tạo mã thông báo trạng thái để tạo chuỗi