Đố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. Chiến lược phát hành đĩa đơn
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
có tên: 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 cho dịch vụ Cơ sở lưu trú.
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ả tài sản trong cửa hàng Properties hiện tại. |
deleteProperty(key) | Properties | Xoá thuộc tính bằng khoá đã cho trong kho lưu trữ 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 kho lưu trữ 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. |
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,
hoặc không bắt buộc 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ả tài sản 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 bằng khoá đã cho trong kho lưu trữ Properties
hiện tại.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
Tham số
Tên | Loại | Mô tả |
---|---|---|
key | String | khoá để xoá tài sản đó |
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ả 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. Lưu ý rằng
đối tượng trả về không phải là khung hiển thị trực tiếp của cửa hàng. Do đó, việc thay đổi các thuộc tính trên
thì đối tượng được trả về sẽ không tự động cập nhật chúng 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
– một 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.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var 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 để truy xuất |
Cầu thủ trả bóng
String
– giá trị liên kết với khoá đã cho trong cửa hàng 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. var userProperties = PropertiesService.getUserProperties(); var 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ị để đặ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ác cặp khoá-giá trị từ đối tượng đã cho trong kho lưu trữ Properties
hiện tại,
hoặc không bắt buộc 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);
Tham số
Tên | Loại | 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 các thuộc tính
object; false đến không |
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');
Tham số
Tên | Loại | 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