Method: spreadsheets.developerMetadata.search

指定された DataFilter に一致するすべてのデベロッパー メタデータを返します。詳細については、メタデータの読み取り、書き込み、検索をご覧ください。

指定された DataFilter が DeveloperMetadataLookup オブジェクトを表す場合、このオブジェクトによって選択されたすべての DeveloperMetadata エントリが返されます。DataFilter がスプレッドシート内の場所を表す場合、この関数は、そのリージョンと交差する場所に関連付けられているすべてのデベロッパー メタデータを返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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)

返されたデベロッパー メタデータに一致するすべてのフィルタ。