فرمها
فرمهای ثبتنام، کسانی که آنها را پر میکنند، و آمارشان.
ابزارهای فرمها
| ابزار | چه میکند |
|---|---|
| listForms | فرمهای ثبتنام فضای کاری، به ترتیب تازهترین تغییر، با وضعیت، ثبتنامها و بازدیدهایشان. |
| getForm | یک فرم بهطور کامل: فیلدها، متنها، گروههای مخاطبان، تأیید دوگانه و اعلانهایش. برای فرم منتشرشده، پیوند، کد جاسازی و نشانیای که یک فرم HTML ساده به آن ارسال میکند هم میآید، و includeDesign پیشنویس را بهصورت JSON برمیگرداند. |
| listFormStarters | نقطههای شروعی که یک فرم تازه میتواند از آنها آغاز شود، با فیلدهایی که هر کدام میخواهد. |
| createForm | یک فرم را از یک نقطهٔ شروع، از طراحیای که بهصورت document نوشته شده، یا از یک نقطهٔ شروع با تغییراتی روی آن بسازید، با هر تنظیماتی که بخواهید. پیشنویس میماند مگر آنکه publish برابر true باشد. |
| updateForm | نام و تنظیمات یک فرم را، که بیدرنگ اعمال میشوند، یا طراحی پیشنویس آن را از راه document تغییر دهید. متنها و سبک کلید به کلید ادغام میشوند، و fields کل فهرست را جایگزین میکند. |
| publishForm | پیشنویس کنونی را همان چیزی کنید که بازدیدکنندگان میبینند، تا فرم ثبتنام بپذیرد. |
| setFormStatus | یک فرم منتشرشده را متوقف کنید، یا دوباره بازش کنید. |
| duplicateForm | یک فرم را در پیشنویسی تازه کپی کنید، بدون ثبتنامهایش. |
| deleteForm | یک فرم و ثبتنامهایش را برای همیشه حذف کنید. پیوند و جاسازیهایش از کار میافتند، و افرادی که افزوده در مخاطبان شما میمانند. |
| getFormAnalytics | بازدیدها، ثبتنامها، افراد افزودهشده و کسانی که هنوز در انتظارند، و نرخ تبدیل در یک بازهٔ زمانی، در مجموع و به تفکیک دقیقه، ساعت یا روز. بازدیدها به تفکیک ساعت نگه داشته میشوند. |
| listFormSubmissions | کسانی که فرمی را پر کردهاند، تازهترین اول، با جوابها و وضعیتشان، صفحه به صفحه. بر پایهٔ نشانی ایمیل جستوجو کنید و بر پایهٔ وضعیت فیلتر کنید. |
| getFormSubmission | یک ثبتنام بهطور کامل: همهٔ جوابها، وضعیتش، زمان رسیدنش و زمانی که شخص افزوده شد، صفحهای که از آن آمده و گروههای مخاطبانش. |
| approveFormSubmission | ثبتنامی را که در انتظار تأیید است بدون ایمیل تأیید بیفزایید. به contacts:write هم نیاز دارد. |
| resendFormConfirmation | برای ثبتنامی که هنوز در انتظار است پیوند تأیید تازهای ایمیل کنید. اگر این فرم در ده دقیقهٔ گذشته به آن نشانی ایمیلی فرستاده باشد، یا آن نشانی در یک روز گذشته پنج پیام تأیید از این فضای کاری گرفته باشد، چیزی فرستاده نمیشود. به emails:send هم نیاز دارد. |
| removeFormSubmissions | تا 200 ثبتنام یک فرم را با شناسه حذف کنید. مخاطبان و گروههای مخاطبان همانطور که هستند میمانند. |
خواندن به forms:read و هر تغییری به forms:write نیاز دارد. هر کاری که باعث شود فرم ایمیل بفرستد به emails:send هم نیاز دارد: روشن کردن تأیید دوگانه، تنظیم فرستنده یا ایمیل تأیید، انتشار یا باز کردن یک فرم با تأیید دوگانه، و ارسال دوبارهٔ پیام تأیید. کلاینتی که از طرف یک عضو عمل میکند فقط فرمهایی را میبیند که همان عضو ساخته، و کلاینتی که به برخی نشانیها محدود است فقط از نشانیهایی که به آنها دسترسی دارد میتواند پیام تأیید بفرستد و فقط به همانها اعلان بدهد.
طراحی فرم از روی یک شرح نوشتهشده در گفتوگوی برنامه انجام میشود. در MCP، طراح خودِ کلاینت است: فیلدها، متنها و سبک را بهصورت document به createForm یا updateForm بدهید، و ابزارها طراحی را مرتب میکنند و میگویند چه چیزی را تغییر دادند.
هفت ابزار روی این سرور تغییری انجام میدهند که REST API آن را با کد تأیید هویت محافظت میکند، و همان کد را میخواهند: createRule، setRuleEnabled، removeDomain، removeDomainAddress، removeAppHost، deleteForm و deleteAudience روی مخاطبانی که خودتان ساختهاید. تا وقتی کلاینت در 60 دقیقهٔ گذشته کدی را تأیید نکرده باشد و شخص هم در حساب ← برنامههای متصل برای آن «اجازهٔ تغییرات برای 60 دقیقه» را انتخاب نکرده باشد، چنین ابزاری با نتیجهای پاسخ میدهد که با Refused (step_up_required): شروع میشود و چیزی را تغییر نمیدهد. emptyAudience هرگز کد نمیخواهد. صفحهٔ احراز هویت API نشان میدهد چگونه کد بخواهید و آن را تأیید کنید.
ابزارها همان قاعدهها و ردشدنهای REST API را اعمال میکنند، و صفحههای /forms در مرجع API هر فیلد را شرح میدهند. listForms به ترتیب آخرین تغییر فهرست میکند، و createForm و updateForm یک document ناقص را مرتب میکنند، در حالی که API آن را کامل میگیرد.