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 に一致するすべてのデベロッパー メタデータを返します。