تسمح للبرامج النصية بإنشاء رموز مميّزة للحالة يمكن استخدامها في واجهات برمجة التطبيقات الخاصة بوظائف معاودة الاتصال (مثل مسارات 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; }
الطُرق
| الطريقة | نوع القيمة التي تم إرجاعها | وصف قصير |
|---|---|---|
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 ثانية، والحد الأقصى للمدة هو 3600 ثانية (ساعة واحدة).
const stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
seconds | Integer | مدة صلاحية الرمز المميز، والحد الأقصى للقيمة هو 3600. |
الإرجاع
State: أداة إنشاء الرموز المميزة للحالة، وذلك لربطها بسلسلة.