REST Resource: spreadsheets.developerMetadata

Tài nguyên: DeveloperMetadata

Siêu dữ liệu dành cho nhà phát triển liên kết với một vị trí hoặc đối tượng trong một bảng tính. Siêu dữ liệu dành cho 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. Dữ liệu này vẫn sẽ được liên kết tại những vị trí đó khi chúng di chuyển và chỉnh sửa bảng tính. 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 đó một hàng khác được chèn vào hàng 5, thì siêu dữ liệu ban đầu đó sẽ vẫn được liên kết với hàng được liên kết lần đầu tiên (hiện là hàng 6). Nếu đối tượng liên kết bị xoá, thì siêu dữ liệu của đối tượng đó cũng 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, mã sẽ được tạo và chỉ định 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 của 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 siêu dữ liệu.
visibility

enum (DeveloperMetadataVisibility)

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

DeveloperMetadataLocation

Vị trí nơi siêu dữ liệu có thể được liên kết trong một 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.
Trường hợp 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ộ 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; không được bị giới hạn hoặc kéo dài 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 dành cho nhà phát triển liên kết trên toàn bộ một phương diện hàng.
COLUMN Siêu dữ liệu dành cho 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 dành cho nhà phát triển liên kết trên toàn bộ trang tính.
SPREADSHEET Siêu dữ liệu dành cho nhà phát triển liên kết trên toàn bộ bảng tính.

DeveloperMetadataVisibility

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

Enum
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Giá trị mặc định.
DOCUMENT Siêu dữ liệu hiển thị cho tài liệu luôn có thể truy cập được 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 có thể xem và truy cập vào 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ề mọi siêu dữ liệu dành cho nhà phát triển khớp với DataFilter đã chỉ định.