Class Properties

נכסים

אובייקט המאפיינים משמש כממשק לגישה למאפייני משתמשים, מסמכים או סקריפטים. סוג המאפיין הספציפי תלוי באחת משלוש השיטות של PropertiesService שהסקריפט קרא לה: PropertiesService.getDocumentProperties(),‏ PropertiesService.getUserProperties() או PropertiesService.getScriptProperties(). אי אפשר לשתף מאפיינים בין סקריפטים. מידע נוסף על סוגי המאפיינים זמין במדריך לשירות Properties.

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
deleteAllProperties()	Properties	מחיקה של כל המלונות בחנות Properties הנוכחית.
deleteProperty(key)	Properties	מחיקה של הנכס עם המפתח שצוין במאגר Properties הנוכחי.
getKeys()	String[]	הצגת כל המפתחות בחנות Properties הנוכחית.
getProperties()	Object	הפונקציה מקבלת עותק של כל צמדי המפתח/ערך בחנות Properties הנוכחית.
getProperty(key)	String	הפונקציה מקבלת את הערך שמשויך למפתח הנתון במאגר Properties הנוכחי, או את הערך null אם לא קיים מפתח כזה.
setProperties(properties)	Properties	הגדרת כל צמדי המפתח/ערך מהאובייקט הנתון במאגר Properties הנוכחי.
setProperties(properties, deleteAllOthers)	Properties	הפונקציה מגדירה את כל צמדי המפתח/ערך מהאובייקט הנתון במאגר Properties הנוכחי, ובאופן אופציונלי מוחקת את כל שאר המאפיינים במאגר.
setProperty(key, value)	Properties	הגדרת צמד המפתח/ערך הנתון במאגר Properties הנוכחי.

מסמכים מפורטים

deleteAllProperties()

מחיקה של כל המלונות בחנות Properties הנוכחית.

// Deletes all user properties.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

חזרה

Properties – החנות Properties הזו, לצורך קישור

---

deleteProperty(key)

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

// Deletes the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

פרמטרים

שם	סוג	תיאור
key	String	המפתח של הנכס שרוצים למחוק

חזרה

Properties – החנות Properties הזו, לצורך קישור

---

getKeys()

הפונקציה מקבלת את כל המפתחות בחנות Properties הנוכחית.

// Sets several properties, then logs the value of each key.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});
const keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (let i = 0; i < keys.length; i++) {
  Logger.log(keys[i]);
}

חזרה

String[] – מערך של כל המפתחות בחנות Properties הנוכחית

---

getProperties()

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

// Sets several script properties, then retrieves them and logs them.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});

const animalSounds = scriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for (const kind in animalSounds) {
  Logger.log('A %s goes %s!', kind, animalSounds[kind]);
}

חזרה

Object – עותק של כל צמדי המפתח-ערך שבמאגר Properties הנוכחי

---

getProperty(key)

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

// Gets the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
const nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

פרמטרים

שם	סוג	תיאור
key	String	המפתח של ערך המאפיין שרוצים לאחזר

חזרה

String – הערך שמשויך למפתח הנתון במאגר Properties הנוכחי

---

setProperties(properties)

הגדרת כל צמדי המפתח/ערך מהאובייקט הנתון במאגר Properties הנוכחי.

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

פרמטרים

שם	סוג	תיאור
properties	Object	אובייקט שמכיל צמדי מפתח/ערך להגדרה

חזרה

Properties – החנות Properties הזו, לצורך קישור

---

setProperties(properties, deleteAllOthers)

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

// Sets multiple user properties at once while deleting all other user
// properties.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties, true);

פרמטרים

שם	סוג	תיאור
properties	Object	אובייקט שמכיל צמדי מפתח/ערך להגדרה
deleteAllOthers	Boolean	true כדי למחוק את כל שאר זוגות המפתח/ערך באובייקט הנכסים, false כדי לא

חזרה

Properties – החנות Properties הזו, לצורך קישור

---

setProperty(key, value)

הגדרת צמד המפתח/ערך הנתון במאגר Properties הנוכחי.

// Sets the user property 'nickname' to 'Bobby'.
const userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

פרמטרים

שם	סוג	תיאור
key	String	המפתח של הנכס
value	String	הערך שרוצים לשייך למפתח

חזרה

Properties – החנות Properties הזו, לצורך קישור