DataFilter

Bộ lọc mô tả dữ liệu nào sẽ được chọn hoặc trả về 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 kết hợp 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 trạng thái sau đây:
developerMetadataLookup

object (DeveloperMetadataLookup)

Chọn những dữ liệu liên kết với siêu dữ liệu nhà phát triển khớp với các tiêu chí mà 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 dải ô do GridRange mô tả.

DeveloperMetadataLookup

Chọn DeveloperMetadata khớp với mọi trường được chỉ định. Ví dụ: nếu chỉ có một mã siêu dữ liệu được chỉ định, thì hệ thống sẽ xem xét DeveloperMetadata có mã nhận dạng duy nhất cụ thể đó. Nếu bạn chỉ định khoá siêu dữ liệu, thì khoá siêu dữ liệu sẽ xem xét mọi siêu dữ liệu nhà phát triển có khoá đó. Nếu một khoá, chế độ hiển thị và loại vị trí đều được chỉ định, thì chế độ này sẽ xem xét mọi siêu dữ liệu 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 đó. Nói chung, thao tác này chọn tất cả DeveloperMetadata khớp với giao điểm của tất cả các trường được chỉ định; 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 dành cho nhà phát triển đã chọn ở các mục nhập liên kết với vị trí thuộc loại đã chỉ định. Ví dụ: khi trường này được chỉ định là ROW, quá trình 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 sẽ được xem xét. Không thể chỉ định trường này là SPREADSHEET khi locationMatchingStrategy được chỉ định là GIAO ĐOẠN hoặc khi metadataLocation được chỉ định là một vị trí không phải bảng tính: siêu dữ liệu của bảng tính không được giao cắt với bất kỳ vị trí siêu dữ liệu nào khác dành cho nhà phát triển. Bạn cũng phải để trường này không chỉ định khi locationMatchingStrategy được chỉ định là CHÍNH XÁC.

metadataLocation

object (DeveloperMetadataLocation)

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

locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

Xác định cách tra cứu này so khớp vị trí. Nếu trường này được chỉ định là CHÍNH XÁC, thì chỉ những siêu dữ liệu nhà phát triển liên kết với vị trí chính xác đã chỉ định mới được so khớp. Nếu trường này được chỉ định là GIÁN ĐOẠN, thì siêu dữ liệu nhà phát triển 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

Trong siêu dữ liệu nhà phát triển đã chọn, chỉ những siêu dữ liệu có DeveloperMetadata.metadata_id trùng khớp.

metadataKey

string

Trong siêu dữ liệu nhà phát triển đã chọn, chỉ những siêu dữ liệu có DeveloperMetadata.metadata_key trùng khớp.

metadataValue

string

Trong siêu dữ liệu nhà phát triển đã chọn, chỉ những siêu dữ liệu có DeveloperMetadata.metadata_value trùng khớp.

visibility

enum (DeveloperMetadataVisibility)

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

DeveloperMetadataLocationMatchingStrategy

Bảng liệt kê các chiến lược giúp so khớp vị trí siêu dữ liệu 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 rằng vị trí được chỉ định phải được so khớp chính xác. Ví dụ: nếu hàng 3 được chỉ định làm vị trí, thì chiến lược so khớp này sẽ chỉ khớp với siêu dữ liệu nhà phát triển cũng được liên kết trên hàng 3. Siêu dữ liệu liên kết trên các vị trí khác sẽ không được xem xét.
INTERSECTING_LOCATION Cho biết rằng một vị trí được chỉ định phải khớp với vị trí chính xác đó cũng như mọi vị trí giao nhau. Ví dụ: nếu hàng 3 được chỉ định làm một vị trí, thì chiến lược so khớp này sẽ khớp với siêu dữ liệu nhà phát triển được liên kết trên hàng 3 cũng như siêu dữ liệu được liên kết trên các vị trí giao với hàng 3. Chẳng hạn, nếu cột B có siêu dữ liệu nhà phát triển được liên kết, thì chiến lược so khớp này cũng sẽ khớp với vị trí đó vì cột B giao với hàng 3.