REST Resource: spreadsheets.developerMetadata

リソース: DeveloperMetadata

スプレッドシート内の場所またはオブジェクトに関連付けられたデベロッパー メタデータ。詳細については、メタデータの読み取り、書き込み、検索をご覧ください。

デベロッパー メタデータを使用すると、スプレッドシートのさまざまな部分に任意のデータを関連付けることができます。関連付けられたデータは、スプレッドシートの移動や編集が行われても、その場所に残ります。たとえば、デベロッパー メタデータが行 5 に関連付けられていて、その後に行 5 の上に別の行が挿入された場合、元のメタデータは最初に関連付けられた行（現在は行 6）に引き続き関連付けられます。関連付けられたオブジェクトが削除されると、そのメタデータも削除されます。

JSON 表現 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
フィールド
metadataId

integer

メタデータを識別するスプレッドシート スコープの一意の ID。メタデータの作成時に ID を指定できます。指定しない場合は、ランダムに生成された ID が割り当てられます。正の値である必要があります。
metadataKey

string

メタデータキー。スプレッドシートには、同じキーを持つメタデータが複数存在する場合があります。デベロッパー メタデータには、常にキーを指定する必要があります。
metadataValue

string

メタデータのキーに関連付けられたデータ。
location

object (DeveloperMetadataLocation)

メタデータが関連付けられている場所。
visibility

enum (DeveloperMetadataVisibility)

メタデータの公開設定。デベロッパー メタデータには、常に公開設定を指定する必要があります。

DeveloperMetadataLocation

スプレッドシートでメタデータを関連付けることができる場所。

JSON 表現 
{
  "locationType": enum (DeveloperMetadataLocationType),

  // Union field location can be only one of the following:
  "spreadsheet": boolean,
  "sheetId": integer,
  "dimensionRange": {
    object (DimensionRange)
  }
  // End of list of possible types for union field location.
}
フィールド
locationType

enum (DeveloperMetadataLocationType)

このオブジェクトが表す場所のタイプ。このフィールドは読み取り専用です。
共用体フィールド location。メタデータが関連付けられている場所。location は次のいずれかになります。
spreadsheet

boolean

メタデータがスプレッドシート全体に関連付けられている場合は true。
sheetId

integer

メタデータがシート全体に関連付けられている場合のシートの ID。
dimensionRange

object (DimensionRange)

メタデータがディメンションに関連付けられている場合、行または列を表します。指定された DimensionRange は、単一行または単一列を表す必要があります。境界なしにしたり、複数の行や列にまたがったりすることはできません。

DeveloperMetadataLocationType

デベロッパー メタデータを関連付けることができる場所のタイプを列挙します。

列挙型
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED デフォルト値。
ROW 行ディメンション全体に関連付けられたデベロッパー メタデータ。
COLUMN 列ディメンション全体に関連付けられたデベロッパー メタデータ。
SHEET シート全体に関連付けられたデベロッパー メタデータ。
SPREADSHEET スプレッドシート全体に関連付けられたデベロッパー メタデータ。

DeveloperMetadataVisibility

メタデータの可視性の列挙。

列挙型
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED デフォルト値。
DOCUMENT ドキュメントにアクセスできるデベロッパー プロジェクトからは、ドキュメントに表示されるメタデータにアクセスできます。
PROJECT プロジェクトで表示可能なメタデータは、メタデータを作成したデベロッパー プロジェクトでのみ表示およびアクセスできます。

メソッド

get

 指定された ID のデベロッパー メタデータを返します。
指定された DataFilter に一致するすべてのデベロッパー メタデータを返します。