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 của 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 3 phương thức của PropertiesService mà tập lệnh đã gọi: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() hoặc PropertiesService.getScriptProperties(). 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 thuộc tính, hãy xem hướng dẫn về dịch vụ Thuộc tính.

Phương thức

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

Tài liệu chi tiết

deleteAllProperties()

Xoá tất cả thuộc tính trong kho lưu trữ Properties hiện tại. 

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

Cầu thủ trả bóng

Properties – kho lưu trữ Properties này, để tạo chuỗi

deleteProperty(key)

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

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

Tham số

TênLoạiMô tả
keyStringkhoá cho thuộc tính cần xoá

Cầu thủ trả bóng

Properties – kho lưu trữ Properties này, để tạo chuỗi

getKeys()

Lấy tất cả khoá trong kho lưu trữ 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 lưu trữ Properties hiện tại

getProperties()

Lấy bản sao của tất cả các cặp khoá-giá trị trong kho lưu trữ 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 kho lưu trữ. 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 lưu trữ Properties hiện tại

getProperty(key)

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

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

Tham số

TênLoạiMô tả
keyStringkhoá 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 lưu trữ Properties hiện tại

setProperties(properties)

Đặt tất cả các cặp khoá-giá trị từ đối tượng đã cho trong kho lưu trữ 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ênLoạiMô tả
propertiesObjectmột đối tượng chứa các cặp khoá-giá trị cần đặt

Cầu thủ trả bóng

Properties – kho lưu trữ Properties này, để tạo chuỗi

setProperties(properties, deleteAllOthers)

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

// 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ênLoạiMô tả
propertiesObjectmột đối tượng chứa các cặp khoá-giá trị cần đặt
deleteAllOthersBooleantrue để 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 – kho lưu trữ Properties này, để tạo chuỗi

setProperty(key, value)

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

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

Tham số

TênLoạiMô tả
keyStringkhoá cho thuộc tính
valueStringgiá trị cần liên kết với khoá

Cầu thủ trả bóng

Properties – kho lưu trữ Properties này, để tạo chuỗi