Đối tượng thuộc tính đóng vai trò là giao diện để truy cập vào các 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 là: 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ức | Kiểu dữ liệu trả về | Mô tả ngắn |
---|---|---|
deleteAllProperties() | Properties | Xoá tất cả thuộc tính trong cửa hàng Properties hiện tại. |
deleteProperty(key) | Properties | Xoá thuộc tính có khoá đã cho trong cửa hàng Properties hiện tại. |
getKeys() | String[] | Lấy tất cả khoá trong cửa hàng Properties hiện tại. |
getProperties() | Object | Lấy bản sao của tất cả các cặp khoá-giá trị trong cửa hàng Properties hiện tại. |
getProperty(key) | String | Lấy giá trị 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á nào như vậy tồn tại. |
setProperties(properties) | Properties | Đặt mọi cặp khoá-giá trị của đối tượng đã cho trong kho lưu trữ Properties hiện tại. |
setProperties(properties, deleteAllOthers) | Properties | Đặt mọi cặp khoá-giá trị của đối tượng đã cho trong cửa hàng Properties hiện tại, tuỳ ý xoá tất 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 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 cửa hàng Properties
hiện tại.
// Deletes all user properties. var 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 cửa hàng Properties
hiện tại.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
key | String | khoá cho thuộc tính đó để 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 cửa hàng Properties
hiện tại.
// 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]); }
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 cửa hàng Properties
hiện tại. 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. 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]); }
Cầu thủ trả bóng
Object
– bản sao của tất cả các cặp khoá-giá trị trong cửa hàng Properties
hiện tại
getProperty(key)
Lấy giá trị 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á nào như vậy tồn tại.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var nickname = userProperties.getProperty('nickname'); Logger.log(nickname);
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
key | String | khoá cho giá trị thuộc tính để 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 mọi cặp khoá-giá trị của đối tượng đã cho trong kho lưu trữ Properties
hiện tại.
// Sets multiple user properties at once. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties);
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
properties | Object | một đối tượng chứa các cặp khoá-giá trị để đặt |
Cầu thủ trả bóng
Properties
— cửa hàng Properties
này, để tạo chuỗi
setProperties(properties, deleteAllOthers)
Đặt mọi cặp khoá-giá trị của đối tượng đã cho trong cửa hàng Properties
hiện tại, tuỳ ý xoá tất cả thuộc tính khác trong cửa hàng.
// 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);
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
properties | Object | một đối tượng chứa các cặp khoá-giá trị để đặ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 lưu trữ Properties
hiện tại.
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
key | String | khoá cho thuộc tính |
value | String | giá trị để 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