Method: spreadsheets.developerMetadata.search

返回与指定 DataFilter 匹配的所有开发者元数据。如果提供的 DataFilter 表示一个 DeveloperMetadataLookup 对象,这将返回它选择的所有 DeveloperMetadata 条目。如果 DataFilter 表示电子表格中的位置,将返回与该区域相交的位置关联的所有开发者元数据。

HTTP 请求

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata:search

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

从中检索元数据的电子表格的 ID。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
字段
dataFilters[]

object (DataFilter)

数据过滤器,用于描述要返回哪些 DeveloperMetadata 条目时的条件。响应中会匹配任意指定过滤条件的 DeveloperMetadata。

响应正文

对开发者元数据搜索请求的回复。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "matchedDeveloperMetadata": [
    {
      object (MatchedDeveloperMetadata)
    }
  ]
}
字段
matchedDeveloperMetadata[]

object (MatchedDeveloperMetadata)

与搜索请求的条件匹配的元数据。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

如需了解详情,请参阅授权指南

MatchedDeveloperMetadata

开发者元数据条目以及与原始请求中指定的数据过滤条件匹配的条目。

JSON 表示法
{
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
字段
developerMetadata

object (DeveloperMetadata)

与指定过滤条件匹配的开发者元数据。

dataFilters[]

object (DataFilter)

与返回的开发者元数据匹配的所有过滤条件。