REST Resource: spreadsheets.developerMetadata

Tài nguyên: DeveloperMetadata

Siêu dữ liệu 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ể dùng siêu dữ liệu nhà phát triển để liên kết dữ liệu bất kỳ với nhiều phần của bảng tính và vẫn liên kết dữ liệu đó tại các vị trí đó khi họ di chuyển xung quanh 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à sau đó, hàng khác được chèn vào hàng 5, siêu dữ liệu gốc đó sẽ vẫn được liên kết với hàng lần đầu tiên được liên kết (hiện là hàng 6). Nếu đối tượng 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)
}
Các trường
metadataId

integer

Mã nhận dạng duy nhất trong phạm vi bảng tính 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, một siêu dữ liệu sẽ được tạo ngẫu nhiên và chỉ định. 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 khóa. Siêu dữ liệu nhà phát triển phải luôn có khóa đượ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 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 được chỉ định chế độ hiển thị.

DeveloperMetadataLocation (Vị trí siêu dữ liệu của nhà phát triển)

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.
}
Các trường
locationType

enum (DeveloperMetadataLocationType)

Loại vị trí mà đối tượng này đại diện. Đây là trường chỉ đọc.
Trường liên kết location. Vị trí liên kết siêu dữ liệu. location chỉ có thể là một trong những trạng thá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ộ một trang tính.
dimensionRange

object (DimensionRange)

Thể hiện 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; nó không thể bị ràng buộc hoặc kéo dài qua nhiều hàng hoặc cột.

Loại siêu dữ liệu nhà phát triển

Một bảng liệt kê các loại vị trí mà siêu dữ liệu nhà phát triển có thể 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 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 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 liên kết trên toàn bộ trang tính.
SPREADSHEET Siêu dữ liệu nhà phát triển 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 Có thể truy cập siêu dữ liệu hiển thị 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 Siêu dữ liệu chỉ hiển thị dự án mà chỉ dự án của nhà phát triển đã tạo siêu dữ liệu mới có thể truy cập và truy cập siêu dữ liệu đó.

Phương pháp

get

 Trả về siêu dữ liệu nhà phát triển bằng 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.