برنامه های وب

اگر یک رابط کاربری برای یک اسکریپت بسازید، می توانید اسکریپت را به عنوان یک برنامه وب منتشر کنید. به عنوان مثال، اسکریپتی که به کاربران اجازه می دهد قرارهای ملاقات با اعضای یک تیم پشتیبانی را برنامه ریزی کنند، بهتر است به عنوان یک برنامه وب ارائه شود تا کاربران بتوانند مستقیماً از مرورگرهای خود به آن دسترسی داشته باشند.

هم اسکریپت‌های مستقل و هم اسکریپت‌های متصل به برنامه‌های Google Workspace را می‌توان به برنامه‌های وب تبدیل کرد، تا زمانی که شرایط زیر را برآورده کنند.

الزامات برنامه های وب

یک اسکریپت می تواند به عنوان یک برنامه وب منتشر شود در صورتی که شرایط زیر را داشته باشد:

• این شامل یک تابع doGet(e) یا doPost(e) است.
• تابع یک شی HtmlOutput سرویس HTML یا یک شی TextOutput سرویس محتوا را برمی گرداند.

درخواست پارامترها

هنگامی که کاربر از یک برنامه بازدید می کند یا برنامه ای درخواست HTTP GET را برای برنامه ارسال می کند، Apps Script تابع doGet(e) را اجرا می کند. وقتی برنامه ای درخواست HTTP POST را برای برنامه ارسال می کند، Apps Script به جای آن doPost(e) را اجرا می کند. در هر دو مورد، آرگومان e یک پارامتر رویداد را نشان می‌دهد که می‌تواند حاوی اطلاعاتی درباره هر پارامتر درخواستی باشد. ساختار شی رویداد در جدول زیر نشان داده شده است:

زمینه های
e.queryString	مقدار بخش رشته پرس و جو از URL، یا اگر رشته پرس و جو مشخص نشده باشد، null name=alice&n=1&n=2
e.parameter	یک شی از جفت‌های کلید/مقدار که با پارامترهای درخواست مطابقت دارند. فقط اولین مقدار برای پارامترهایی که چندین مقدار دارند برگردانده می شود. {"name": "alice", "n": "1"}
e.parameters	یک شی شبیه به e.parameter ، اما با آرایه ای از مقادیر برای هر کلید {"name": ["alice"], "n": ["1", "2"]}
e.pathInfo	مسیر URL بعد از /exec یا /dev . برای مثال، اگر مسیر URL به /exec/hello ختم شود، اطلاعات مسیر hello است.
e.contextPath	استفاده نمی شود، همیشه رشته خالی است.
e.contentLength	طول بدنه درخواست برای درخواست‌های POST یا -1 برای درخواست‌های GET 332
e.postData.length	همان e.contentLength 332
e.postData.type	نوع MIME بدنه POST text/csv
e.postData.contents	متن محتوای بدنه POST Alice,21
e.postData.name	همیشه مقدار "postData" باشد postData

به عنوان مثال، می‌توانید پارامترهایی مانند username و age را مانند شکل زیر به URL ارسال کنید:

https://script.google.com/.../exec?username=jsmith&age=21

سپس، می توانید پارامترهای زیر را نمایش دهید:

function doGet(e) {
  var params = JSON.stringify(e);
  return ContentService.createTextOutput(params).setMimeType(ContentService.MimeType.JSON);
}

در مثال بالا، doGet(e) خروجی زیر را برمی گرداند:

{
  "queryString": "username=jsmith&age=21",
  "parameter": {
    "username": "jsmith",
    "age": "21"
  },
  "contextPath": "",
  "parameters": {
    "username": [
      "jsmith"
    ],
    "age": [
      "21"
    ]
  },
  "contentLength": -1
}

اخطار: نام پارامترهای زیر توسط سیستم رزرو شده است و نباید در پارامترهای URL یا بدنه های POST استفاده شود:

• c
• sid

استفاده از این پارامترها ممکن است منجر به پاسخ HTTP 405 با پیام خطا شود "با عرض پوزش، فایلی که درخواست کرده اید انجام نمی شود. وجود داشته باشد." در صورت امکان، اسکریپت خود را برای استفاده از نام پارامترهای مختلف به روز کنید.

یک اسکریپت را به عنوان یک برنامه وب اجرا کنید

برای استقرار یک اسکریپت به عنوان یک برنامه وب، این مراحل را دنبال کنید:

1. در سمت راست بالای پروژه اسکریپت، روی Deploy > New Deployment کلیک کنید.
2. در کنار «انتخاب نوع»، روی فعال کردن انواع استقرار > برنامه وب کلیک کنید.
3. اطلاعات مربوط به برنامه وب خود را در فیلدهای زیر "پیکربندی استقرار" وارد کنید.
4. روی Deploy کلیک کنید.

می‌توانید URL برنامه وب را با کسانی که می‌خواهید از برنامه شما استفاده کنند به اشتراک بگذارید، مشروط بر اینکه به آنها اجازه دسترسی داده باشید.

توجه: برنامه‌های وب مستقر در یک دامنه در صورتی که مالکیت آنها به یک درایو مشترک یا حساب در دامنه دیگری تغییر کند، دیگر کار نمی‌کنند. این را می توان با قرار دادن مالک یا شریک جدید برنامه وب در دامنه جدید اصلاح کرد. از طرف دیگر، اگر برنامه وب به دامنه اصلی خود بازگردانده شود، برنامه وب دوباره برای آن دامنه بدون استقرار مجدد شروع به کار می کند.

استقرار یک برنامه وب را آزمایش کنید

برای آزمایش اسکریپت خود به عنوان یک برنامه وب، مراحل زیر را دنبال کنید:

1. در سمت راست بالای پروژه اسکریپت، روی Deploy > Test Deployments کلیک کنید.
2. در کنار «انتخاب نوع»، روی فعال کردن انواع استقرار > برنامه وب کلیک کنید.
3. در زیر URL برنامه وب، روی کپی کلیک کنید.

4. URL را در مرورگر خود قرار دهید و برنامه وب خود را آزمایش کنید.

   این URL به /dev ختم می شود و فقط برای کاربرانی که دسترسی ویرایش به اسکریپت دارند می توانند به آن دسترسی داشته باشند. این نمونه از برنامه همیشه آخرین کد ذخیره شده را اجرا می کند و فقط برای آزمایش در حین توسعه در نظر گرفته شده است.

هشدار: هنگام استقرار برنامه‌های وب برای اجرا به‌عنوان توسعه‌دهنده، باید هنگام مدیریت توکن‌های OAuth که از طریق ScriptApp.getOAuthToken() به دست می‌آیند، دقت زیادی به خرج دهید. این توکن‌ها می‌توانند به برنامه‌های دیگر اجازه دسترسی به داده‌های شما را بدهند - هرگز آنها را به مشتری منتقل نکنید.

مجوزها

مجوزهای یک برنامه وب بسته به نحوه اجرای برنامه متفاوت است:

• برنامه را مانند من اجرا کنید — در این مورد، اسکریپت همیشه مانند شما، صاحب اسکریپت اجرا می شود، مهم نیست چه کسی به برنامه وب دسترسی دارد.
• برنامه را به عنوان کاربر در حال دسترسی به برنامه وب اجرا کنید — در این مورد، اسکریپت تحت هویت کاربر فعال با استفاده از برنامه وب اجرا می شود. این رویکرد مجوز باعث می شود که برنامه وب ایمیل مالک اسکریپت را زمانی که کاربر اجازه دسترسی را می دهد نشان دهد.

هشدار: برای جلوگیری از سوء استفاده، Apps Script محدودیت‌هایی را بر نرخی اعمال می‌کند که کاربران جدید می‌توانند برنامه وب را که به عنوان کاربر اجرا می‌شود مجوز دهند. این محدودیت‌ها، در میان سایر عوامل، به این بستگی دارد که آیا حساب انتشار بخشی از دامنه Google Workspace است یا خیر.

توجه: می‌توانید با استفاده از درایو مشترک در برنامه‌های وب همکاری کنید. هنگامی که یک برنامه وب در یک اشتراک‌گذاری شده استقرار می‌یابد، انتخاب «اجرا به‌عنوان شما» باعث می‌شود برنامه وب تحت اختیار کاربری که آن را اجرا کرده است اجرا شود (زیرا مالک اسکریپت وجود ندارد).

برنامه وب خود را در Google Sites جاسازی کنید

هشدار: برنامه‌های وب جاسازی شده همچنان برای جلوگیری از استفاده مخرب، مشمول مجوزهای دسترسی هستند. اگر به نظر می رسد برنامه وب جاسازی شده شما کار نمی کند، بررسی کنید که آیا مجوزهای تنظیم شده توسط مالک برنامه وب و سرپرست دامنه اجازه استفاده از آن را می دهد یا خیر.

برای جاسازی یک برنامه وب در Google Sites، ابتدا باید آن را مستقر کنید . شما همچنین به URL Deployed از گفتگوی Deploy نیاز دارید.

برای جاسازی یک برنامه وب در صفحه Sites ، این مراحل را دنبال کنید:

1. صفحه Sites را که می‌خواهید برنامه وب را در آنجا اضافه کنید باز کنید.
2. Insert > Embed URL را انتخاب کنید.
3. URL برنامه وب را جای‌گذاری کنید و سپس روی ADD کلیک کنید.

برنامه وب در یک قاب در پیش نمایش صفحه ظاهر می شود. هنگامی که صفحه را منتشر می کنید، بینندگان سایت شما ممکن است نیاز به مجوز برنامه وب قبل از اجرای عادی داشته باشند. برنامه های وب غیرمجاز درخواست های مجوز را به کاربر ارائه می دهند.

برنامه های وب و تاریخچه مرورگر

داشتن یک برنامه وب Apps Script که یک برنامه چند صفحه ای را شبیه سازی می کند، یا برنامه ای با رابط کاربری پویا که از طریق پارامترهای URL کنترل می شود، می تواند مطلوب باشد. برای اینکه این کار را به خوبی انجام دهید، می‌توانید یک شیء حالت برای نمایش رابط کاربری یا صفحه برنامه تعریف کنید، و در حالی که کاربر برنامه شما را هدایت می‌کند، وضعیت را به تاریخچه مرورگر فشار دهید. همچنین می‌توانید به رویدادهای تاریخچه گوش دهید تا وقتی کاربر با دکمه‌های مرورگر به جلو و عقب حرکت می‌کند، برنامه وب شما رابط کاربری صحیح را نشان دهد. با پرس و جو از پارامترهای URL در زمان بارگذاری، می توانید از برنامه خود بخواهید که به صورت پویا رابط کاربری خود را بر اساس این پارامترها بسازد و به کاربر این امکان را می دهد که برنامه را در یک وضعیت خاص راه اندازی کند.

Apps Script دو ​​API جاوا اسکریپت سمت کلاینت ناهمزمان را برای کمک به ایجاد برنامه های وب که به تاریخچه مرورگر پیوند دارند ارائه می دهد:

• google.script.history روش هایی را ارائه می دهد که امکان پاسخ پویا به تغییرات سابقه مرورگر را فراهم می کند. این شامل: فشار دادن حالت ها (اشیاء ساده ای که می توانید تعریف کنید) در تاریخچه مرورگر، جایگزینی حالت بالا در پشته سابقه، و تنظیم یک تابع پاسخ به تماس شنونده برای پاسخ به تغییرات سابقه است.

• google.script.url ابزاری را برای بازیابی پارامترهای URL صفحه فعلی و قطعه URL در صورت وجود فراهم می کند.

این API های تاریخچه فقط برای برنامه های وب در دسترس هستند. آنها برای نوارهای کناری، گفتگوها یا افزونه ها پشتیبانی نمی شوند. این عملکرد همچنین برای استفاده در برنامه‌های وب تعبیه‌شده در Google Sites توصیه نمی‌شود.