ניהול פרויקטים

בקטע הזה מופיעה סקירה כללית של שיטות Apps Script API שבהן אפשר להשתמש כדי ליצור, לקרוא, לשנות ולנטר את פרויקטי Apps Script. בדף הדוגמאות של Project Management מופיעות דוגמאות לבקשות לניהול API. במסמכי התיעוד של כל שיטה מפורטים פרטי ההטמעה.

סקירה כללית של שיטת API
יצירת פרויקטים

projects.create

תוצאות: יצירת פרויקט בסיסי וריק ללא קבצי פרויקט ועם מניפסט פרויקט שמוגדר כברירת מחדל.

אפשרויות: אפשר לציין שם לפרויקט. אפשר גם ליצור סקריפט שקשור לקובץ על ידי ציון מזהה 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 של הפרויקט. הוא משמש כשמריצים את הסקריפט כטריגר, בכלי לעריכת סקריפטים, במצב תצוגה מקדימה של תוסף, או כאפליקציית אינטרנט או כ-API של Apps Script במצב פיתוח.

הערה: כשמעדכנים תוכן של פרויקט סקריפט, נהוג קודם לשלוח בקשה של projects.getContent כדי לאחזר מערך של אובייקטים מסוג File, לבצע את השינויים הרצויים באובייקטים האלה ואז להשתמש באובייקטים מסוג File כקלט לבקשה של projects.updateContent.

אזהרה: התוכן החדש מחליף את כל הקבצים הקיימים בפרויקט הסקריפט. קבצים שלא עודכנו על ידי הבקשה מוסרים.

קריאת מדדים של פרויקט

projects.getMetrics

תוצאות: קריאת מדדים מסוימים לגבי פרויקט. המדדים האלה כוללים את מספר המשתמשים, המספר הכולל של ההפעלות, המספר הכולל של שגיאות ההפעלה ופרטים נוספים. משתמשים ב- MetricType כדי לציין את המידע שרוצים לקבל.

אפשרויות: הגבלת התוצאות לפריסות ספציפיות או לפונקציות סקריפט באמצעות MetricsFilter. אפשר גם להגדיר מרווח זמן ספציפי למדד באמצעות MetricsIntervalConfig.