REST Resource: spreadsheets.developerMetadata

Tài nguyên: DeveloperMetadata

Siêu dữ liệu của nhà phát triển liên kết với một vị trí hoặc đối tượng trong bảng tính. Bạn có thể sử dụng siêu dữ liệu nhà phát triển để liên kết dữ liệu tuỳ ý với nhiều phần của bảng tính và siêu dữ liệu này sẽ vẫn được liên kết tại các vị trí đó khi dữ liệu được di chuyển và bảng tính được chỉnh sửa. Ví dụ: nếu siêu dữ liệu dành cho 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 sẽ đượ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 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, hệ thống sẽ tạo và chỉ định một mã nhận dạng ngẫu nhiên. Phải 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 được liên kết với khoá của siêu dữ liệu.
location

object (DeveloperMetadataLocation)

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

enum (DeveloperMetadataVisibility)

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

boolean

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

integer

Mã 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)

Đại diện cho 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 có giới hạn hoặc trải dài nhiều hàng hoặc cột.

DeveloperMetadataLocationType

Liệt kê các loại vị trí mà siêu dữ liệu của 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 trên một phương diện toàn bộ 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

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 Bạn có thể truy cập siêu dữ liệu hiển thị trong tài liệu từ bất kỳ dự án nhà phát triển nào 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 xem và truy cập được siêu dữ liệu hiển thị trong dự án.

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.