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. Để biết thêm thông tin, hãy xem bài viết Đọc, ghi và tìm kiếm siêu dữ liệu.

Siêu dữ liệu 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à dữ liệu này sẽ vẫn được liên kết tại những vị trí đó khi các phần di chuyển và bảng tính được chỉnh sửa. Ví dụ: nếu siêu dữ liệu của nhà phát triển được liên kết với hàng 5 và sau đó một hàng khác được chèn phía trên hàng 5, thì siêu dữ liệu ban đầu đó vẫn được liên kết với hàng mà siêu dữ liệu đó được liên kết lần đầu (hiện là hàng 6). Nếu đối tượng được liên kết bị xoá thì 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 ở phạm vi bảng tính dùng để 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, hệ thống sẽ tạo và chỉ định một mã nhận dạng 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 khoá. Siêu dữ liệu nhà phát triển phải luôn có một khoá được chỉ định.
metadataValue

string

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

object (DeveloperMetadataLocation)

Vị trí mà siêu dữ liệu được liên kết.
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 có chế độ hiển thị được chỉ định.

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 nhóm location. Vị trí mà siêu dữ liệu được liên kết. location chỉ có thể là một trong những trạng thái sau:
spreadsheet

boolean

True khi siêu dữ liệu được liên kết với toàn bộ 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 thể không có ranh giới hoặc trải rộng trên nhiều hàng hoặc cột.

DeveloperMetadataLocationType

Một danh sách liệt kê các loại vị trí mà siêu dữ liệu nhà phát triển có thể được liên kết.

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 với 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 với 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

Một bảng liệt kê các chế độ 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ị trong 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 Siêu dữ liệu hiển thị cho dự án chỉ hiển thị và có thể truy cập được đối với dự án nhà phát triển đã tạo siêu dữ liệu đó.

Phương thức

get

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