ספריות

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

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

קבלת גישה לספרייה

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

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

הוספת ספרייה לפרויקט הסקריפטים

1. מימין לעורך Apps Script, לצד 'ספריות'. לוחצים על 'הוספה לספרייה.
2. בקטע 'מזהה סקריפט' בשדה, מדביקים את מזהה הסקריפט של הספרייה.
3. לוחצים על חיפוש.
   אם תיתקלו בשגיאה, עליכם לוודא להיות בעלי גישה לפחות ברמת התצוגה לפרויקט שאתם מנסים לבצע כוללים.
4. לוחצים על התפריט הנפתח גרסה ובוחרים את גרסת הספרייה. לשימוש.
5. בודקים אם ערך ברירת המחדל של 'מזהה' הוא הוא השם שרוצים לשימוש בספרייה הזו. זה השם שבו הסקריפט משתמש כדי להתייחס לספרייה. לדוגמה, אם הגדרת את הערך Test, תוכל קוראים ל-method של הספרייה הזו, באופן הבא: Test.libraryMethod().
   אם משתמשים בשם מזהה שתואם לשם של שירות שכבר קיים, כמו MailApp, או בעבר הספרייה שהוספת לאחרונה, אם הספרייה שהוספת לאחרונה מבטלת את על ידי הוספת השירות או הספרייה הקיימים.
6. לוחצים על הוספה.

שימוש בספרייה

משתמשים בספרייה הכלולה כמו שמשתמשים בשירות ברירת מחדל. עבור לדוגמה, אם Test הוא המזהה של הספרייה, צריך להקליד Test ומיד אחריה נקודה כדי לראות את רשימת השיטות בספרייה.

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

בצד ימין של עורך הסקריפטים, לצד שם הספרייה, לוחצים על סמל האפשרויות הנוספות > פתיחה בכרטיסייה חדשה.

הסרת ספרייה

בצד ימין של עורך הסקריפטים, לצד שם הספרייה, לוחצים על סמל האפשרויות הנוספות > הסרה > הסרת הספרייה

אם ספרייה נמחקה על ידי המחבר, עדיין עליך להסיר אותו מרשימת הספריות הכלולות.

עדכון ספרייה

אפשר לשנות את גרסת הספרייה או לעדכן את המזהה שלה.

1. מימין לעורך, בקטע 'ספריות', לוחצים על שם הספרייה.
2. מבצעים את השינויים הרצויים ולוחצים על שמירה.

יצירה ושיתוף של ספרייה

כדי להשתמש בפרויקט הסקריפט ולשתף אותו כספרייה, צריך לפעול לפי השלבים הבאים.

1. יצירת פריסה עם גרסאות של הסקריפט.
2. כדאי לשתף גישה ברמת תצוגה לפחות עם כל המשתמשים הפוטנציאליים בספרייה.
3. נותנים למשתמשים האלה את מזהה הסקריפט, שמופיע בפרויקט הגדרות .

שיטות מומלצות

הנה כמה הנחיות לכתיבת ספרייה:

1. לבחור שם בעל משמעות לפרויקט כי הוא משמש כברירת מחדל, כשהספרייה שלכם כלולה על ידי אחרים.
2. אם רוצים שאחת או יותר מהשיטות של הסקריפט לא יהיו גלויות (וגם שימושי) למשתמשי הספרייה, תוכל לסיים את שם ה-method באמצעות קו תחתון. לדוגמה, myPrivateMethod_().
3. רק נכסים גלובליים שניתנים לספירה גלויים למשתמשי הספרייה. זה כולל פונקציה הצהרות, משתנים שנוצרו מחוץ לפונקציה עם var ומאפיינים שהוגדרו במפורש על האובייקט הגלובלי. לדוגמה, Object.defineProperty() עם enumerable מוגדר ל-false יוצר סמל שבו ניתן להשתמש בספרייה, אבל המשתמשים לא יכולים לגשת לסמל.

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

   /**
    * Raises a number to the given power, and returns the result.
    *
    * @param {number} base the number we're raising to a power
    * @param {number} exp the exponent we're raising the base to
    * @return {number} the result of the exponential calculation
    */
   function power(base, exp) { ... }
   

קביעת היקף המשאבים

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

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

  function getLibraryProperty(key) {
    return ScriptProperties.getProperty(key);
  }

בתרשים הבא מוצג משאב לא משותף, באמצעות הדוגמה של מאפייני סקריפט:

בטבלה הזו מפורטים המשאבים המשותפים והמשאבים שלא משותפים לעיונך:

משאב	משותף*	לא משותף**	הערות
נעילה			אותו מופע גלוי לכל, כולל הסקריפטים כשהם נוצרים ב- בספרייה.
מאפייני הסקריפט			אותו מופע גלוי לכל, כולל הסקריפטים כשהם נוצרים ב- בספרייה.
מטמון			אותו מופע גלוי לכל, כולל הסקריפטים כשהם נוצרים ב- בספרייה.
טריגרים			טריגרים פשוטים שנוצרים בספרייה לא מופעלים על ידי הכלל סקריפט.
ScriptApp
UiApp
מאפייני המשתמש
תמליל ותמליל הביצוע
Google Sites, Sheets ומאגרים אחרים			קריאה ל-getActive() מחזירה את הקונטיינר של כולל סקריפט.
MailApp ו-GmailApp
* המשמעות היא שלספרייה אין מופע משלה ובמקום זאת הוא משתמש במשאב שנוצר על ידי הסקריפט שהפעיל אותה. ** כלומר, לספרייה יש מופע משלה של המשאב או התכונה ושכל הסקריפטים שמשתמשים בספרייה משתפים ויש להם גישה אותו מופע.

בדיקת ספרייה

כדי לבדוק את הספרייה, צריך להשתמש בפריסת כותרת. כל מי שיש לו הרשאת עריכה גישה לסקריפט יכולה להשתמש בפריסת כותרת.

עדיין נדרשת לפחות גרסה אחת של הספרייה נשמר.

ניפוי באגים בספרייה

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