Class Properties

Thuộc tính

Đối tượng thuộc tính đóng vai trò là giao diện để truy cập vào thuộc tính người dùng, tài liệu hoặc tập lệnh. Loại thuộc tính cụ thể phụ thuộc vào phương thức nào trong số 3 phương thức của PropertiesService mà tập lệnh gọi: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() hoặc PropertiesService.getScriptProperties(). Bạn không thể chia sẻ thuộc tính giữa các tập lệnh. Để biết thêm thông tin về các loại tài sản, hãy xem hướng dẫn về Dịch vụ tài sản.

Phương thức

Phương thức	Loại dữ liệu trả về	Mô tả ngắn
deleteAllProperties()	Properties	Xoá tất cả thuộc tính trong kho Properties hiện tại.
deleteProperty(key)	Properties	Xoá thuộc tính có khoá đã cho trong kho Properties hiện tại.
getKeys()	String[]	Lấy tất cả khoá trong kho Properties hiện tại.
getProperties()	Object	Lấy bản sao của tất cả cặp khoá-giá trị trong kho Properties hiện tại.
getProperty(key)	String	Lấy giá trị được liên kết với khoá đã cho trong kho Properties hiện tại hoặc null nếu không có khoá nào như vậy.
setProperties(properties)	Properties	Đặt tất cả cặp khoá-giá trị từ đối tượng đã cho trong kho Properties hiện tại.
setProperties(properties, deleteAllOthers)	Properties	Đặt tất cả cặp khoá-giá trị từ đối tượng đã cho trong cửa hàng Properties hiện tại, có thể xoá tất cả các thuộc tính khác trong cửa hàng.
setProperty(key, value)	Properties	Đặt cặp khoá-giá trị đã cho trong kho Properties hiện tại.

Tài liệu chi tiết

deleteAllProperties()

Xoá tất cả thuộc tính trong kho Properties hiện tại.

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

Cầu thủ trả bóng

Properties – cửa hàng Properties này, để tạo chuỗi

---

deleteProperty(key)

Xoá thuộc tính có khoá đã cho trong kho Properties hiện tại.

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

Tham số

Tên	Loại	Mô tả
key	String	khoá của thuộc tính cần xoá

Cầu thủ trả bóng

Properties – cửa hàng Properties này, để tạo chuỗi

---

getKeys()

Lấy tất cả khoá trong kho Properties hiện tại.

// 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]);
}

Cầu thủ trả bóng

String[] – một mảng gồm tất cả các khoá trong kho Properties hiện tại

---

getProperties()

Lấy bản sao của tất cả cặp khoá-giá trị trong kho Properties hiện tại. Xin lưu ý rằng đối tượng được trả về không phải là chế độ xem trực tiếp của cửa hàng. Do đó, việc thay đổi các thuộc tính trên đối tượng được trả về sẽ không tự động cập nhật các thuộc tính đó trong bộ nhớ hoặc ngược lại.

// 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]);
}

Cầu thủ trả bóng

Object – bản sao của tất cả các cặp khoá-giá trị trong kho Properties hiện tại

---

getProperty(key)

Lấy giá trị được liên kết với khoá đã cho trong kho Properties hiện tại hoặc null nếu không có khoá nào như vậy.

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

Tham số

Tên	Loại	Mô tả
key	String	khoá cho giá trị thuộc tính cần truy xuất

Cầu thủ trả bóng

String – giá trị được liên kết với khoá đã cho trong kho Properties hiện tại

---

setProperties(properties)

Đặt tất cả cặp khoá-giá trị từ đối tượng đã cho trong kho Properties hiện tại.

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

Tham số

Tên	Loại	Mô tả
properties	Object	một đối tượng chứa các cặp khoá-giá trị cần đặt

Cầu thủ trả bóng

Properties – cửa hàng Properties này, để tạo chuỗi

---

setProperties(properties, deleteAllOthers)

Đặt tất cả cặp khoá-giá trị từ đối tượng đã cho trong cửa hàng Properties hiện tại, có thể xoá tất cả các thuộc tính khác trong cửa hàng.

// 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);

Tham số

Tên	Loại	Mô tả
properties	Object	một đối tượng chứa các cặp khoá-giá trị cần đặt
deleteAllOthers	Boolean	true để xoá tất cả các cặp khoá-giá trị khác trong đối tượng thuộc tính; false để không xoá

Cầu thủ trả bóng

Properties – cửa hàng Properties này, để tạo chuỗi

---

setProperty(key, value)

Đặt cặp khoá-giá trị đã cho trong kho Properties hiện tại.

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

Tham số

Tên	Loại	Mô tả
key	String	khoá cho thuộc tính
value	String	giá trị cần liên kết với khoá

Cầu thủ trả bóng

Properties – cửa hàng Properties này, để tạo chuỗi