DataFilter

Bộ lọc mô tả dữ liệu cần được chọn hoặc trả về từ một yêu cầu.

Biểu diễn dưới dạng JSON
{

  // Union field filter can be only one of the following:
  "developerMetadataLookup": {
    object (DeveloperMetadataLookup)
  },
  "a1Range": string,
  "gridRange": {
    object (GridRange)
  }
  // End of list of possible types for union field filter.
}
Trường
Trường hợp hợp nhất filter. Các loại bộ lọc có thể giới hạn dữ liệu được chọn. filter chỉ có thể là một trong những loại sau:
developerMetadataLookup

object (DeveloperMetadataLookup)

Chọn dữ liệu liên kết với siêu dữ liệu của nhà phát triển khớp với tiêu chí do DeveloperMetadataLookup này mô tả.

a1Range

string

Chọn dữ liệu khớp với dải ô A1 đã chỉ định.

gridRange

object (GridRange)

Chọn dữ liệu khớp với phạm vi do GridRange mô tả.

DeveloperMetadataLookup

Chọn DeveloperMetadata khớp với tất cả các trường được chỉ định. Ví dụ: nếu chỉ chỉ định mã siêu dữ liệu, thì phương thức này sẽ xem xét DeveloperMetadata có mã nhận dạng duy nhất cụ thể đó. Nếu bạn chỉ định một khoá siêu dữ liệu, thì khoá này sẽ xem xét tất cả siêu dữ liệu nhà phát triển có khoá đó. Nếu bạn chỉ định một khoá, chế độ hiển thị và loại vị trí, thì hệ thống sẽ xem xét tất cả siêu dữ liệu của nhà phát triển có khoá và chế độ hiển thị đó được liên kết với một vị trí thuộc loại đó. Nhìn chung, thao tác này sẽ chọn tất cả DeveloperMetadata khớp với giao điểm của tất cả các trường đã chỉ định; bạn có thể chỉ định bất kỳ trường hoặc tổ hợp trường nào.

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

enum (DeveloperMetadataLocationType)

Giới hạn siêu dữ liệu nhà phát triển đã chọn ở những mục được liên kết với các vị trí thuộc loại đã chỉ định. Ví dụ: khi trường này được chỉ định là ROW, lượt tra cứu này chỉ xem xét siêu dữ liệu nhà phát triển được liên kết trên các hàng. Nếu bạn không chỉ định trường này, tất cả các loại vị trí đều được xem xét. Bạn không thể chỉ định trường này là SPREADSHEET khi locationMatchingStrategy được chỉ định là INTERSECTING (GIAO) hoặc khi metadataLocation được chỉ định là vị trí không phải bảng tính: siêu dữ liệu bảng tính không thể giao nhau với bất kỳ vị trí siêu dữ liệu nhà phát triển nào khác. Bạn cũng không được chỉ định trường này khi locationMatchingStrategy được chỉ định là EXACT.

metadataLocation

object (DeveloperMetadataLocation)

Giới hạn siêu dữ liệu nhà phát triển đã chọn ở những mục đó liên kết với vị trí đã chỉ định. Trường này khớp với vị trí chính xác hoặc tất cả vị trí giao nhau theo locationMatchingStrategy đã chỉ định.

locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

Xác định cách tra cứu này khớp với vị trí. Nếu trường này được chỉ định là CHÍNH XÁC, thì chỉ siêu dữ liệu nhà phát triển được liên kết ở vị trí chính xác được chỉ định mới được so khớp. Nếu trường này được chỉ định là GIAO HỢP, thì siêu dữ liệu nhà phát triển được liên kết trên các vị trí giao nhau cũng sẽ được so khớp. Nếu bạn không chỉ định, trường này sẽ giả định giá trị mặc định là INTERSECTING. Nếu chỉ định trường này, bạn cũng phải chỉ định metadataLocation.

metadataId

integer

Giới hạn siêu dữ liệu nhà phát triển đã chọn ở siêu dữ liệu có DeveloperMetadata.metadata_id trùng khớp.

metadataKey

string

Giới hạn siêu dữ liệu nhà phát triển đã chọn ở siêu dữ liệu có DeveloperMetadata.metadata_key trùng khớp.

metadataValue

string

Giới hạn siêu dữ liệu nhà phát triển đã chọn ở siêu dữ liệu có DeveloperMetadata.metadata_value trùng khớp.

visibility

enum (DeveloperMetadataVisibility)

Giới hạn siêu dữ liệu nhà phát triển đã chọn ở siêu dữ liệu có DeveloperMetadata.visibility trùng khớp. Nếu bạn không chỉ định, tất cả siêu dữ liệu nhà phát triển mà dự án yêu cầu có thể xem sẽ được xem xét.

DeveloperMetadataLocationMatchingStrategy

Liệt kê các chiến lược để so khớp vị trí siêu dữ liệu của nhà phát triển.

Enum
DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED Giá trị mặc định. Không được sử dụng giá trị này.
EXACT_LOCATION Cho biết vị trí được chỉ định phải khớp chính xác. Ví dụ: nếu hàng thứ ba được chỉ định là vị trí, thì chiến lược so khớp này sẽ chỉ so khớp siêu dữ liệu nhà phát triển cũng được liên kết trên hàng thứ ba. Siêu dữ liệu được liên kết trên các vị trí khác sẽ không được xem xét.
INTERSECTING_LOCATION Cho biết một vị trí được chỉ định phải khớp chính xác với vị trí đó cũng như mọi vị trí giao nhau. Ví dụ: nếu hàng ba được chỉ định là vị trí, thì chiến lược so khớp này sẽ so khớp siêu dữ liệu của nhà phát triển được liên kết trên hàng ba cũng như siêu dữ liệu được liên kết trên các vị trí giao nhau với hàng ba. Ví dụ: nếu có siêu dữ liệu nhà phát triển được liên kết trên cột B, thì chiến lược so khớp này cũng sẽ so khớp vị trí đó vì cột B giao nhau với hàng thứ ba.