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 表示应与指定地点完全匹配。例如,如果第三行被指定为地理位置,则此匹配策略只会与第三行中也关联的开发者元数据匹配。不在考虑其他地理位置关联的元数据。
INTERSECTING_LOCATION 表示指定地点应与该确切地点以及任何相交地点相符。例如,如果第三行被指定为地理位置,此匹配策略将匹配与第三行关联的开发者元数据,以及与与第三行相交的地理位置关联的元数据。例如,如果列 B 上有关联的开发者元数据,则此匹配策略也会与该位置匹配,因为列 B 与第三行相交。