REST Resource: spreadsheets.developerMetadata

Tài nguyên: DeveloperMetadata

Siêu dữ liệu nhà phát triển được liên kết với một vị trí hoặc đối tượng trong bảng tính. Siêu dữ liệu của nhà phát triển có thể được dùng để liên kết dữ liệu tuỳ ý với nhiều phần của bảng tính và sẽ vẫn được liên kết tại những vị trí đó khi chúng di chuyển và bảng tính được chỉnh sửa. Ví dụ: nếu siêu dữ liệu nhà phát triển được liên kết với hàng 5 và một hàng khác sau đó được chèn vào phía trên hàng 5, thì siêu dữ liệu ban đầu đó vẫn sẽ liên kết với hàng đã liên kết đầu tiên (hiện là hàng 6). Nếu đối tượng được liên kết bị xoá, siêu dữ liệu của đối tượng đó cũng sẽ bị xoá.

Biểu diễn dưới dạng JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Trường
metadataId

integer

Mã nhận dạng duy nhất trong phạm vi bảng tính giúp xác định siêu dữ liệu. Bạn có thể chỉ định mã nhận dạng khi tạo siêu dữ liệu, nếu không thì mã sẽ được tạo và chỉ định ngẫu nhiên. Phải là số dương.
metadataKey

string

Khoá siêu dữ liệu. Có thể có nhiều siêu dữ liệu trong một bảng tính có cùng một khoá. Siêu dữ liệu nhà phát triển phải luôn có khoá được chỉ định.
metadataValue

string

Dữ liệu liên kết với khoá của siêu dữ liệu.
location

object (DeveloperMetadataLocation)

Vị trí liên kết với siêu dữ liệu.
visibility

enum (DeveloperMetadataVisibility)

Chế độ hiển thị siêu dữ liệu. Siêu dữ liệu nhà phát triển phải luôn chỉ định chế độ hiển thị.

DeveloperMetadataLocation

Vị trí mà siêu dữ liệu có thể được liên kết trong bảng tính.

Biểu diễn dưới dạng JSON 
{
  "locationType": enum (DeveloperMetadataLocationType),

  // Union field location can be only one of the following:
  "spreadsheet": boolean,
  "sheetId": integer,
  "dimensionRange": {
    object (DimensionRange)
  }
  // End of list of possible types for union field location.
}
Trường
locationType

enum (DeveloperMetadataLocationType)

Loại vị trí mà đối tượng này đại diện. Trường này ở chế độ chỉ đọc.
Trường kết hợp location. Vị trí liên kết với siêu dữ liệu. location chỉ có thể là một trong những trạng thái sau đây:
spreadsheet

boolean

Đúng khi siêu dữ liệu được liên kết với toàn bộ một bảng tính.
sheetId

integer

Mã nhận dạng của trang tính khi siêu dữ liệu được liên kết với toàn bộ trang tính.
dimensionRange

object (DimensionRange)

Biểu thị hàng hoặc cột khi siêu dữ liệu được liên kết với một phương diện. DimensionRange được chỉ định phải đại diện cho một hàng hoặc cột duy nhất; không được không bị ràng buộc hoặc kéo dài trên nhiều hàng hoặc cột.

DeveloperMetadataLocationType

Bảng liệt kê các loại vị trí có thể liên kết siêu dữ liệu nhà phát triển.

Enum
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Giá trị mặc định.
ROW Siêu dữ liệu nhà phát triển được liên kết trên toàn bộ phương diện hàng.
COLUMN Siêu dữ liệu nhà phát triển được liên kết trên toàn bộ phương diện cột.
SHEET Siêu dữ liệu nhà phát triển được liên kết trên toàn bộ trang tính.
SPREADSHEET Siêu dữ liệu nhà phát triển được liên kết trên toàn bộ bảng tính.

DeveloperMetadataVisibility

Bảng liệt kê các lượt hiển thị siêu dữ liệu có thể có.

Enum
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Giá trị mặc định.
DOCUMENT Siêu dữ liệu hiển thị tài liệu có thể truy cập được từ mọi dự án của nhà phát triển có quyền truy cập vào tài liệu.
PROJECT Chỉ dự án của nhà phát triển đã tạo siêu dữ liệu mới có thể xem và truy cập vào siêu dữ liệu trong dự án.

Phương thức

get

 Trả về siêu dữ liệu nhà phát triển với mã nhận dạng đã chỉ định.
Trả về tất cả siêu dữ liệu nhà phát triển khớp với DataFilter đã chỉ định.