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 はメタデータの作成時に指定できます。指定しない場合は、ランダムに生成されて割り当てられます。正の値である必要があります。
metadataKey

string

メタデータキー。1 つのスプレッドシートに同じキーを持つ複数のメタデータが存在する場合があります。デベロッパー メタデータには必ずキーを指定する必要があります。
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 に一致するすべてのデベロッパー メタデータを返します。