התכונה מאפשרת לסקריפטים לאחסן נתונים פשוטים בזוגות מפתח/ערך בהיקף של סקריפט אחד, משתמש אחד בסקריפט או מסמך אחד שבו נעשה שימוש בתוסף. לא ניתן לשתף מאפיינים בין סקריפטים. כדי לדעת מתי להשתמש בכל סוג נכס, אפשר לעיין במדריך לשירות 'נכסים'.
// Sets three properties of different types.
var documentProperties = PropertiesService.getDocumentProperties();
var scriptProperties = PropertiesService.getScriptProperties();
var userProperties = PropertiesService.getUserProperties();
documentProperties.setProperty('DAYS_TO_FETCH', '5');
scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/MyWeatherService/');
userProperties.setProperty('DISPLAY_UNITS', 'metric');
שיטות
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
getDocumentProperties() | Properties | הפונקציה מקבלת מאגר מאפיינים (לסקריפט הזה בלבד) שכל המשתמשים יכולים לגשת אליו במסמך, בגיליון האלקטרוני או בטופס הפתוחים. |
getScriptProperties() | Properties | מקבל מאגר של נכס שכל המשתמשים יכולים לגשת אליו, אבל רק בתוך הסקריפט הזה. |
getUserProperties() | Properties | מקבל מאגר של נכס שרק המשתמש הנוכחי יכול לגשת אליו, ורק בתוך הסקריפט הזה. |
תיעוד מפורט
getDocumentProperties()
הפונקציה מקבלת מאגר מאפיינים (לסקריפט הזה בלבד) שכל המשתמשים יכולים לגשת אליו במסמך, בגיליון האלקטרוני או בטופס הפתוחים. האפשרות הזו זמינה רק אם הסקריפט מפורסם ומופעל כתוסף, או אם הוא מקושר לסוג קובץ של Google. כשמאפייני המסמך לא זמינים, השיטה הזו מחזירה את הערך null. אי אפשר לגשת למאפייני מסמך שנוצרו על ידי סקריפט מחוץ לסקריפט, גם לא על ידי סקריפטים אחרים שניגשים לאותו מסמך.
החזרות
Properties - אחסון מאפיינים של הסקריפט הזה בלבד שכל המשתמשים במסמך הנוכחי יכולים לגשת אליו. לחלופין, null אם הסקריפט אינו תוסף או מקושר לקובץ Google Workspace
getScriptProperties()
מקבל מאגר של נכס שכל המשתמשים יכולים לגשת אליו, אבל רק בתוך הסקריפט הזה.
החזרות
Properties – מאגר נכסים שכל המשתמשים של הסקריפט יכולים לגשת אליו
getUserProperties()
מקבל מאגר של נכס שרק המשתמש הנוכחי יכול לגשת אליו, ורק בתוך הסקריפט הזה.
החזרות
Properties – מאגר מאפיינים שרק המשתמש הנוכחי של הסקריפט יכול לגשת אליו