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ết thêm thông tin, hãy xem bài viết Đọc, ghi và tìm kiếm siêu dữ liệu.

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

  "developerMetadataLookup": {
    object (DeveloperMetadataLookup)
  },
  "a1Range": string,
  "gridRange": {
    object (GridRange)
  }
}
Trường
Trường nhóm 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 được liên kết với siêu dữ liệu nhà phát triển đáp ứng 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 được chỉ định.

gridRange

object (GridRange)

Chọn dữ liệu khớp với phạm vi được mô tả bằng GridRange.

DeveloperMetadataLookup

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

DeveloperMetadataLocationMatchingStrategy

Một danh sách liệt kê các chiến lược để 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. Bạn không được sử dụng giá trị này.
EXACT_LOCATION Cho biết rằng một vị trí được chỉ định phải khớp chính xác. Ví dụ: nếu hàng 3 được chỉ định là một 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 3. Siêu dữ liệu được 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 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 thứ ba được chỉ định là một 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 được liên kết trên hàng thứ ba cũng như siêu dữ liệu được liên kết trên các vị trí giao với hàng thứ ba. Ví dụ: nếu có siêu dữ liệu nhà phát triển được liên kết với 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 với hàng thứ ba.