مدیریت پروژه ها

این بخش مروری بر متدهای API مربوط به Apps Script ارائه می‌دهد که می‌توانید برای ایجاد، خواندن، تغییر و نظارت بر پروژه‌های Apps Script خود از آنها استفاده کنید. صفحه نمونه‌های مدیریت پروژه ، نمونه‌هایی از درخواست‌های مدیریت API را نشان می‌دهد. مستندات مرجع برای هر متد، جزئیات پیاده‌سازی را ارائه می‌دهد.

مرور کلی متدهای API
ایجاد پروژه‌ها

پروژه‌ها.ایجاد

نتایج : یک پروژه پایه و خالی بدون هیچ فایل پروژه و یک مانیفست پروژه پیش‌فرض ایجاد کنید.

گزینه‌ها : می‌توانید عنوان پروژه را وارد کنید. همچنین می‌توانید با وارد کردن شناسه گوگل درایو یک فایل Google Docs، Google Sheets، Google Forms یا Slides، یک اسکریپت محدود ایجاد کنید تا به عنوان والد اسکریپت عمل کند.

خواندن متادیتای پروژه

پروژه‌ها.دریافت

نتایج : یک شیء Project را بازیابی می‌کند که نشان‌دهنده‌ی فراداده‌های پروژه است. این داده‌ها شامل عنوان پروژه، شناسه‌ی اسکریپت، کاربر در حال ایجاد، زمان ایجاد و سایر جزئیات است.

محتوای پروژه را بخوانید

پروژه‌ها.دریافت محتوا

نتایج : آرایه‌ای از اشیاء File را برمی‌گرداند، یکی برای هر کد و فایل HTML در پروژه. این لیست همچنین شامل مانیفست پروژه به عنوان یک فایل JSON است. اشیاء File حاوی محتوای منبع فایل ( File.source ) و سایر فراداده‌ها، مانند لیستی از توابع موجود در فایل ( File.functionSet ) هستند.

گزینه‌ها : می‌توانید با استفاده از یک پارامتر کوئری، مشخص کنید که کدام نسخه از محتوا بازیابی شود.

به‌روزرسانی محتوای پروژه

پروژه‌ها.به‌روزرسانی محتوا

نتایج : محتوای فایل را در یک پروژه اسکریپت تغییر می‌دهد. شما محتوای جدید را به عنوان آرایه‌ای از اشیاء File ارائه می‌دهید. یکی از این اشیاء File باید از نوع JSON باشد و نشان‌دهنده‌ی مانیفست پروژه جدید اسکریپت باشد. محتوای جدید به عنوان نسخه HEAD پروژه ذخیره می‌شود. این محتوا زمانی استفاده می‌شود که اسکریپت به عنوان یک تریگر، در ویرایشگر اسکریپت، در حالت پیش‌نمایش افزونه یا به عنوان یک برنامه وب یا API اسکریپت برنامه‌ها در حالت توسعه اجرا می‌شود.

نکته : هنگام به‌روزرسانی محتوای پروژه اسکریپت، روش معمول این است که ابتدا یک درخواست projects.getContent برای بازیابی آرایه‌ای از File های موجود صادر شود، به آن اشیاء میل شود، سپس از File ها به عنوان ورودی برای درخواست projects.updateContent استفاده شود.

هشدار: محتوای جدید جایگزین تمام فایل‌های موجود در پروژه اسکریپت می‌شود. فایل‌هایی که با درخواست به‌روزرسانی نشده‌اند، حذف می‌شوند.

خواندن معیارهای پروژه

پروژه‌ها.getMetrics

نتایج : معیارهای خاصی را در مورد یک پروژه بخوانید. این معیارها شامل تعداد کاربران، تعداد کل اجراها، تعداد کل خطاهای اجرا و سایر جزئیات است. از یک MetricType برای مشخص کردن اطلاعات مورد نظر خود استفاده کنید.

گزینه‌ها : با استفاده از MetricsFilter، نتایج را به پیاده‌سازی‌های خاص یا توابع اسکریپت محدود کنید. همچنین می‌توانید با استفاده از MetricsIntervalConfig یک بازه معیار خاص تعریف کنید.