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

בקטע הזה נספק סקירה כללית של השיטות של 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

Results: הפונקציה מחזירה מערך של אובייקטים מסוג File, אחד לכל קובץ קוד ו-HTML בפרויקט. הרשימה כוללת גם את מניפסט הפרויקט כקובץ JSON. אובייקטים של קבצים מכילים את תוכן המקור של הקובץ (File.source) ומטא-נתונים אחרים, כמו רשימה של הפונקציות בקובץ (File.functionSet).

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

עדכון תוכן הפרויקט

projects.updateContent

תוצאות: שינוי תוכן הקובץ בפרויקט של סקריפט. אתם מספקים את התוכן החדש כמערך של אובייקטים מסוג File. אחד מהאובייקטים File חייב להיות מסוג JSON ולהציג את מניפסט הפרויקט החדש של פרויקט הסקריפט. התוכן החדש נשמר כגרסת ה-HEAD של הפרויקט. הוא משמש כשהסקריפט מופעל כטריגר, בכלי לעריכת סקריפטים, במצב תצוגה מקדימה של התוסף או כאפליקציית אינטרנט או כ-Apps Script API במצב פיתוח.

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

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

קריאת מדדי הפרויקט

projects.getMetrics

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

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