リソース: DeveloperMetadata
スプレッドシート内の場所またはオブジェクトに関連付けられているデベロッパー メタデータ。デベロッパー メタデータは、スプレッドシートのデータをさまざまな要素に関連付けるために使用でき、スプレッドシートの移動や編集が行われても、その場所に関連付けたままになります。たとえば、デベロッパー メタデータが行 5 に関連付けられ、その後別の行が 5 行目の上に挿入された場合でも、元のメタデータは最初に関連付けられた行(6 行目)に関連付けられます。関連付けられたオブジェクトを削除すると、そのメタデータも削除されます。
JSON 表現 |
---|
{ "metadataId": integer, "metadataKey": string, "metadataValue": string, "location": { object ( |
フィールド | |
---|---|
metadataId |
メタデータを識別するスプレッドシート スコープの一意の ID。メタデータの作成時に ID を指定できます。指定しない場合、ランダムに生成されて割り当てられます。正の値である必要があります。 |
metadataKey |
メタデータキー。同じキーの複数のメタデータがスプレッドシートに含まれている可能性があります。デベロッパー メタデータには常に鍵を指定する必要があります。 |
metadataValue |
メタデータのキーに関連付けられているデータ。 |
location |
メタデータが関連付けられている場所。 |
visibility |
メタデータの公開設定。デベロッパー メタデータには常に可視性を指定する必要があります。 |
デベロッパー メタデータの場所
スプレッドシート内でメタデータを関連付けできる場所。
JSON 表現 |
---|
{ "locationType": enum ( |
フィールド | |
---|---|
locationType |
このオブジェクトが表している場所のタイプ。このフィールドは読み取り専用です。 |
共用体フィールド location 。メタデータが関連付けられている場所。location は次のいずれかになります。 |
|
spreadsheet |
メタデータがスプレッドシート全体に関連付けられている場合は true。 |
sheetId |
メタデータがシート全体に関連付けられているときのシートの ID。 |
dimensionRange |
メタデータがディメンションに関連付けられている場合の行または列を表します。指定する |
DeveloperMetadataLocationType
デベロッパーのメタデータを関連付けできる場所の種類の列挙型。
列挙型 | |
---|---|
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED |
デフォルト値。 |
ROW |
行ディメンション全体に関連付けられたデベロッパー メタデータ。 |
COLUMN |
列ディメンション全体に関連付けられたデベロッパー メタデータ。 |
SHEET |
シート全体に関連付けられているデベロッパー メタデータ。 |
SPREADSHEET |
スプレッドシート全体に関連付けられているデベロッパー メタデータ。 |
デベロッパー メタデータの可視化
メタデータの公開設定の列挙。
列挙型 | |
---|---|
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED |
デフォルト値。 |
DOCUMENT |
ドキュメント公開メタデータは、そのドキュメントにアクセスできるすべてのデベロッパー プロジェクトからアクセス可能です。 |
PROJECT |
プロジェクト公開メタデータは、メタデータを作成したデベロッパー プロジェクトのみが表示、アクセスできます。 |
Methods |
|
---|---|
|
指定された ID のデベロッパー メタデータを返します。 |
|
指定された DataFilter に一致するすべてのデベロッパー メタデータを返します。 |