Dịch vụ thuộc tính

Dịch vụ Thuộc tính lưu trữ dữ liệu dưới dạng cặp khoá-giá trị được phạm vi giới hạn cho một tập lệnh, một người dùng tập lệnh hoặc một tài liệu sử dụng tiện ích bổ sung. Dịch vụ này thường được dùng để lưu trữ cấu hình của nhà phát triển hoặc lựa chọn ưu tiên của người dùng. Các thuộc tính không bao giờ được chia sẻ giữa các tập lệnh.

Để xem hạn mức hằng ngày và giới hạn bộ nhớ cho dịch vụ Thuộc tính, hãy xem bài viết Hạn mức cho các dịch vụ của Google.

So sánh các kho thuộc tính

Đối tượng chung PropertiesService cung cấp 3 phương thức. Mỗi phương thức trả về một đối tượng Properties tương tự nhưng có quyền truy cập khác nhau, như minh hoạ trong bảng sau:

	Thuộc tính của tập lệnh	Thuộc tính người dùng	Thuộc tính tài liệu
Phương thức truy cập	`getScriptProperties()`	`getUserProperties()`	`getDocumentProperties()`
Dữ liệu được chia sẻ giữa	Tất cả người dùng tập lệnh, tiện ích bổ sung hoặc ứng dụng web	Người dùng hiện tại của tập lệnh, tiện ích bổ sung hoặc ứng dụng web	Tất cả người dùng tiện ích bổ sung trong tài liệu đang mở
Thường dùng cho	Dữ liệu cấu hình trên toàn ứng dụng, chẳng hạn như tên người dùng và mật khẩu cho cơ sở dữ liệu bên ngoài của nhà phát triển	Các chế độ cài đặt dành riêng cho người dùng, chẳng hạn như đơn vị đo lường Anh hoặc hệ mét	Dữ liệu dành riêng cho tài liệu, chẳng hạn như URL nguồn cho biểu đồ được nhúng

Định dạng dữ liệu

Dịch vụ Thuộc tính lưu trữ tất cả dữ liệu dưới dạng chuỗi trong cặp khoá-giá trị. Các loại dữ liệu chưa phải là chuỗi sẽ tự động được chuyển đổi thành chuỗi, bao gồm cả các phương thức có trong đối tượng đã lưu.

Tiết kiệm dữ liệu

Để lưu một giá trị duy nhất, hãy gọi phương thức Properties.setProperty(key, value) của kho thích hợp, như minh hoạ trong ví dụ sau:

service/propertyService.gs

Xem trên GitHub

try {
  // Set a property in each of the three property stores.
  const scriptProperties = PropertiesService.getScriptProperties();
  const userProperties = PropertiesService.getUserProperties();
  const documentProperties = PropertiesService.getDocumentProperties();

  scriptProperties.setProperty("SERVER_URL", "http://www.example.com/");
  userProperties.setProperty("DISPLAY_UNITS", "metric");
  documentProperties.setProperty(
    "SOURCE_DATA_ID",
    "1j3GgabZvXUF177W0Zs_2v--H6SPCQb4pmZ6HsTZYT5k",
  );
} catch (err) {
  // TODO (developer) - Handle exception
  console.log("Failed with error %s", err.message);
}

Để lưu dữ liệu hàng loạt, hãy truyền một bản đồ cặp khoá-giá trị đến Properties.setProperties(properties). Mỗi cặp khoá-giá trị của đối tượng trong tham số được lưu trữ dưới dạng một thuộc tính riêng biệt:

service/propertyService.gs

Xem trên GitHub

try {
  // Set multiple script properties in one call.
  const scriptProperties = PropertiesService.getScriptProperties();
  scriptProperties.setProperties({
    cow: "moo",
    sheep: "baa",
    chicken: "cluck",
  });
} catch (err) {
  // TODO (developer) - Handle exception
  console.log("Failed with error %s", err.message);
}

Đọc dữ liệu

Để truy xuất một giá trị duy nhất mà bạn đã lưu trước đó, hãy gọi Properties.getProperty:

service/propertyService.gs

Xem trên GitHub

try {
  // Get the value for the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  const units = userProperties.getProperty("DISPLAY_UNITS");
  console.log("values of units %s", units);
} catch (err) {
  // TODO (developer) - Handle exception
  console.log("Failed with error %s", err.message);
}

Để truy xuất tất cả giá trị trong kho thuộc tính hiện tại, hãy gọi Properties.getProperties:

service/propertyService.gs

Xem trên GitHub

try {
  // Get multiple script properties in one call, then log them all.
  const scriptProperties = PropertiesService.getScriptProperties();
  const data = scriptProperties.getProperties();
  for (const key in data) {
    console.log("Key: %s, Value: %s", key, data[key]);
  }
} catch (err) {
  // TODO (developer) - Handle exception
  console.log("Failed with error %s", err.message);
}

Sửa đổi dữ liệu

Các phương thức getProperty và getProperties trả về một bản sao của dữ liệu đã lưu trữ, chứ không phải chế độ xem trực tiếp. Vì vậy, việc thay đổi đối tượng được trả về sẽ không cập nhật giá trị trong kho thuộc tính. Để cập nhật dữ liệu trong kho, hãy lưu lại dữ liệu đó:

service/propertyService.gs

Xem trên GitHub

try {
  // Change the unit type in the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  let units = userProperties.getProperty("DISPLAY_UNITS");
  units = "imperial"; // Only changes local value, not stored value.
  userProperties.setProperty("DISPLAY_UNITS", units); // Updates stored value.
} catch (err) {
  // TODO (developer) - Handle exception
  console.log("Failed with error %s", err.message);
}

Xoá dữ liệu

Để xoá một giá trị duy nhất, hãy gọi Properties.deleteProperty:

service/propertyService.gs

Xem trên GitHub

try {
  // Delete the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty("DISPLAY_UNITS");
} catch (err) {
  // TODO (developer) - Handle exception
  console.log("Failed with error %s", err.message);
}

Để xoá tất cả thuộc tính trong kho hiện tại, hãy gọi Properties.deleteAllProperties:

service/propertyService.gs

Xem trên GitHub

try {
  // Get user properties in the current script.
  const userProperties = PropertiesService.getUserProperties();
  // Delete all user properties in the current script.
  userProperties.deleteAllProperties();
} catch (err) {
  // TODO (developer) - Handle exception
  console.log("Failed with error %s", err.message);
}

Quản lý thuộc tính của tập lệnh theo cách thủ công

Thêm tối đa 50 thuộc tính tuỳ chỉnh theo cách thủ công, dưới dạng chuỗi trong cặp khoá-giá trị, từ trang cài đặt dự án. Để thêm nhiều hơn 50 thuộc tính, hãy thêm các thuộc tính đó theo phương thức lập trình bằng các phương thức được mô tả trong phần trước trong bài viết Tiết kiệm dữ liệu. Khi bạn đặt thuộc tính của tập lệnh từ trang cài đặt dự án, đừng tham chiếu đến các biến tập lệnh.

Thêm thuộc tính của tập lệnh

Mở dự án Google Apps Script.
Ở bên trái, hãy nhấp vào Cài đặt dự án .
Để thêm thuộc tính đầu tiên, trong phần Thuộc tính của tập lệnh , hãy nhấp vào Thêm thuộc tính của tập lệnh.
Để thêm thuộc tính thứ hai và các thuộc tính tiếp theo, trong phần Thuộc tính của tập lệnh , hãy nhấp vào Chỉnh sửa thuộc tính của tập lệnh > Thêm thuộc tính của tập lệnh.
Đối với Thuộc tính, hãy nhập tên khoá.
Đối với Giá trị, hãy nhập giá trị cho khoá.
(Không bắt buộc) Để thêm nhiều thuộc tính, hãy nhấp vào Thêm thuộc tính của tập lệnh.
Nhấp vào Lưu thuộc tính của tập lệnh.

Chỉnh sửa thuộc tính của tập lệnh

Mở dự án Apps Script.
Ở bên trái, hãy nhấp vào Cài đặt dự án .
Trong phần Thuộc tính của tập lệnh, hãy nhấp vào Chỉnh sửa thuộc tính của tập lệnh.
Thay đổi tên khoá và giá trị khoá cho từng thuộc tính mà bạn muốn thay đổi.
Nhấp vào Lưu thuộc tính của tập lệnh.

Xoá thuộc tính của tập lệnh

Mở dự án Apps Script.
Ở bên trái, hãy nhấp vào Cài đặt dự án .
Trong phần Thuộc tính của tập lệnh, hãy nhấp vào Chỉnh sửa thuộc tính của tập lệnh.
Bên cạnh thuộc tính mà bạn muốn xoá, hãy nhấp vào biểu tượng Xoá .
Nhấp vào Lưu thuộc tính của tập lệnh.

Dịch vụ thuộc tính Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

So sánh các kho thuộc tính

Định dạng dữ liệu

Tiết kiệm dữ liệu

Đọc dữ liệu

Sửa đổi dữ liệu

Xoá dữ liệu

Quản lý thuộc tính của tập lệnh theo cách thủ công

Thêm thuộc tính của tập lệnh

Chỉnh sửa thuộc tính của tập lệnh

Xoá thuộc tính của tập lệnh

Dịch vụ thuộc tính