DataFilter

Bộ lọc mô tả những dữ liệu 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.
}
Các trường
Trường liên kế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 trạng thái sau:
developerMetadataLookup

object (DeveloperMetadataLookup)

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

a1Range

string

Chọn dữ liệu khớp với phạm vi A1 đã chỉ định.

gridRange

object (GridRange)

Chọn dữ liệu khớp với dải ô được GridRange mô tả.

Tra siêu dữ liệu nhà phát triển

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

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)
}
Các 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 vị trí thuộc loại được chỉ định. Ví dụ: khi bạn chỉ định trường này là ROW, quá trình tra cứu này chỉ xem xét siêu dữ liệu nhà phát triển liên kết với các hàng. Nếu bạn không chỉ định trường này, thì hệ thống sẽ xem xét tất cả các loại vị trí. Không thể chỉ định trường này là SPREADSHEET khi locationMatchingStrategy được chỉ định là INTERSECTING hoặc khi metadataLocation được chỉ định làm vị trí không phải bảng tính: siêu dữ liệu bảng tính không thể giao cắt 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 được liên kết với vị trí đã chỉ định. Trường này so khớp chính xác vị trí hoặc tất cả vị trí giao nhau theo locationMatchingStrategy được 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 liên kết với vị trí chính xác được chỉ định mới khớp với. Nếu trường này được chỉ định cho xen kẽ, siêu dữ liệu nhà phát triển liên kết với 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 một giá trị mặc định là INTERSECTING. Nếu bạn chỉ định trường này thì 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 phù hợ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 phù hợ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 phù hợ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 phù hợp. Nếu bạn không xác định, tất cả siêu dữ liệu nhà phát triển hiển thị với dự án yêu cầu sẽ được xem xét.

DeveloperMetadataLocationMatchMatchStrategy

Bảng liệt kê các chiến lược phù hợp với vị trí của 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 vị trí đã chỉ định phải được so khớp chính xác. Ví dụ: nếu bạn đã chỉ định hàng thứ ba 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 liên kết trên hàng 3. Siêu dữ liệu liên kết với 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ụ thể phải khớp với vị trí chính xác đó cũng như bất kỳ vị trí nào giao nhau. Ví dụ: nếu hàng thứ ba được chỉ định làm vị trí, thì chiến lược so khớp này sẽ so khớp siêu dữ liệu nhà phát triển trên hàng 3 cũng như siêu dữ liệu liên kết trên các vị trí giao nhau với hàng 3. Ví dụ: nếu có siêu dữ liệu nhà phát triển liên kết trên cột B, 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 ba.