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 所描述的范围匹配的数据。

开发者元数据查询

选择与所有指定字段匹配的 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 指定为“完全匹配”时,也必须将此字段保留为“未指定”。

metadataLocation

object (DeveloperMetadataLocation)

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

locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

确定此查询与营业地点的匹配方式。如果此字段被指定为“完全匹配”,则仅匹配与指定位置关联的开发者元数据。如果将此字段指定为 INTERSECTING,则系统还会匹配与相交位置关联的开发者元数据。如果未指定,此字段将采用默认值 INTERSECTING。如果指定了此字段,还必须指定 metadataLocation

metadataId

integer

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

metadataKey

string

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

metadataValue

string

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

visibility

enum (DeveloperMetadataVisibility)

将所选开发者元数据限制为具有匹配的 DeveloperMetadata.visibility。如果未指定,则考虑发出请求的项目的所有开发者元数据可见。

开发者元数据位置匹配策略

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

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