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

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

نمای کلی روش API
پروژه ها را ایجاد کنید

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

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

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

فراداده پروژه را بخوانید

projects.get

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

مطالب پروژه را بخوانید

projects.getContent

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

گزینه‌ها : می‌توانید تعیین کنید که کدام نسخه از محتوا با یک پارامتر پرس و جو بازیابی شود.

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

projects.updateContent

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

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

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

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

projects.getMetrics

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

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

،

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

نمای کلی روش API
پروژه ها را ایجاد کنید

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

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

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

فراداده پروژه را بخوانید

projects.get

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

مطالب پروژه را بخوانید

projects.getContent

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

گزینه‌ها : می‌توانید تعیین کنید که کدام نسخه از محتوا با یک پارامتر پرس و جو بازیابی شود.

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

projects.updateContent

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

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

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

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

projects.getMetrics

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

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