דף זה תורגם על ידי Cloud Translation API.

Class Properties

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

שיטות

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

תיעוד מפורט

`deleteAllProperties()`

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

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

החזרות

Properties – החנות הזו ב-Properties, לשרשרת

`deleteProperty(key)`

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

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

פרמטרים

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

החזרות

Properties – החנות הזו ב-Properties, לשרשרת

`getKeys()`

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

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

החזרות

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

`getProperties()`

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

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

var animalSounds = scriptProperties.getProperties();

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

החזרות

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

`getProperty(key)`

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

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

פרמטרים

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

החזרות

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

`setProperties(properties)`

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

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

פרמטרים

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

החזרות

Properties – החנות הזו ב-Properties, לשרשרת

`setProperties(properties, deleteAllOthers)`

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

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

פרמטרים

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

החזרות

Properties – החנות הזו ב-Properties, לשרשרת

`setProperty(key, value)`

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

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

פרמטרים

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

החזרות

Properties – החנות הזו ב-Properties, לשרשרת