מאפשרת לקבצים בסקריפט ליצור אסימוני מצב שאפשר להשתמש בהם בממשקי API להודעות חזרה (כמו תהליכי 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; }
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
create | String | יצירת ייצוג מחרוזת מוצפן של אסימון המצב. |
with | State | הוספת ארגומנט לטוקן. |
with | State | הגדרת פונקציית קריאה חוזרת. |
with | State | הגדרת משך הזמן (בשניות) שבו האסימון תקף. |
מסמכים מפורטים
create Token()
יצירת ייצוג מחרוזת מוצפן של אסימון המצב.
const stateToken = ScriptApp.newStateToken().createToken();
חזרה
String
– מחרוזת מוצפנת שמייצגת את האסימון
with Argument(name, value)
הוספת ארגומנט לטוקן. אפשר להפעיל את השיטה הזו כמה פעמים.
const stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | שם הארגומנט |
value | String | הערך של הארגומנט |
חזרה
State
– הכלי ליצירת טוקני מצב, לצורך קישור
with Method(method)
הגדרת פונקציית קריאה חוזרת. ברירת המחדל היא פונקציה בשם callback()
.
const stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();
פרמטרים
שם | סוג | תיאור |
---|---|---|
method | String | השם של פונקציית הקריאה החוזרת, שמיוצג כמחרוזת ללא סוגריים או ארגומנטים. אפשר להשתמש בפונקציות מספריות כלולות, כמו
Library.libFunction1 . |
חזרה
State
– הכלי ליצירת טוקני מצב, לצורך קישור
with Timeout(seconds)
הגדרת משך הזמן (בשניות) שבו האסימון תקף. ברירת המחדל היא 60 שניות, והמשך הזמן המקסימלי הוא 3,600 שניות (שעה אחת).
const stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
פרמטרים
שם | סוג | תיאור |
---|---|---|
seconds | Integer | משך הזמן שבו הטוקן תקף. הערך המקסימלי הוא 3600 . |
חזרה
State
– הכלי ליצירת טוקני מצב, לצורך קישור