DataFilter

描述应从请求中选择或返回哪些数据的过滤器。

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.
}
字段
联合字段 filter。哪些类型的过滤条件可能会限制所选数据。filter 只能是下列其中一项:
developerMetadataLookup

object (DeveloperMetadataLookup)

选择与符合此 DeveloperMetadataLookup 所描述条件的开发者元数据相关联的数据。

a1Range

string

选择与指定的 A1 范围匹配的数据。

gridRange

object (GridRange)

选择与 GridRange 所描述范围匹配的数据。

DeveloperMetadataLookup

选择与所有指定字段匹配的 DeveloperMetadata。例如,如果仅指定了元数据 ID,则会被视为具有该特定唯一 ID 的 DeveloperMetadata。如果指定了元数据键,则此字段会考虑具有该键的所有开发者元数据。如果指定了密钥、可见性和位置类型,系统会考虑与该类型位置相关联的所有包含该密钥和可见性的开发者元数据。通常,这会选择与所有指定字段的交集匹配的所有 DeveloperMetadata;可以指定任何字段或字段组合。

JSON 表示法
{
  "locationType": enum (DeveloperMetadataLocationType),
  "metadataLocation": {
    object (DeveloperMetadataLocation)
  },
  "locationMatchingStrategy": enum (DeveloperMetadataLocationMatchingStrategy),
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "visibility": enum (DeveloperMetadataVisibility)
}
字段
locationType

enum (DeveloperMetadataLocationType)

将所选开发者元数据限制为与指定类型的位置相关联的条目。例如,当此字段指定为 ROW 时,此查询仅考虑与行关联的开发者元数据。如果未指定该字段,则系统会考虑所有位置类型。当 locationMatchingStrategy 指定为 INTERSECTING 或 metadataLocation 被指定为非电子表格位置时,此字段无法指定为 SPREADSHEET:电子表格元数据不能与任何其他开发者元数据位置相交。当 locationMatchingStrategy 指定为 EXACT 时,此字段也必须保持未指定状态。

metadataLocation

object (DeveloperMetadataLocation)

将所选开发者元数据限制为与指定位置相关联的条目。此字段会根据指定的 locationMatchingStrategy 匹配确切位置或所有相交位置。

locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

确定此查询如何与营业地点匹配。如果将此字段指定为“EXACT”,则只会匹配与指定确切位置关联的开发者元数据。如果将此字段指定为 INTERSECTING,则系统还会匹配与相交位置关联的开发者元数据。如果未指定,此字段会假定默认值为 INTERSECTING。如果指定此字段,还必须指定 metadataLocation

metadataId

integer

将选定的开发者元数据限制为具有匹配 DeveloperMetadata.metadata_id 的开发者元数据。

metadataKey

string

将选定的开发者元数据限制为具有匹配 DeveloperMetadata.metadata_key 的开发者元数据。

metadataValue

string

将选定的开发者元数据限制为具有匹配 DeveloperMetadata.metadata_value 的开发者元数据。

visibility

enum (DeveloperMetadataVisibility)

将选定的开发者元数据限制为具有匹配 DeveloperMetadata.visibility 的开发者元数据。如果未指定,系统会考虑向发出请求的项目显示的所有开发者元数据。

DeveloperMetadataLocationMatchingStrategy

用于匹配开发者元数据位置的策略枚举。

枚举
DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED 默认值。不得使用此值。
EXACT_LOCATION 表示指定地理位置应完全匹配。例如,如果将第 3 行指定为位置,此匹配策略将仅匹配同样关联到第 3 行的开发者元数据。系统不会考虑在其他营业地点关联的元数据。
INTERSECTING_LOCATION 指明指定位置应匹配该确切位置以及任何交叉位置。例如,如果将第 3 行指定为位置,此匹配策略将匹配第 3 行关联的开发者元数据,以及与第 3 行相交的位置关联的元数据。例如,如果 B 列有关联的开发者元数据,则此匹配策略还会匹配该位置,因为 B 列与第三行相交。