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 与第 3 行相交。