资源:DeveloperMetadata
与电子表格中的位置或对象相关联的开发者元数据。开发者元数据可用于将任意数据与电子表格的各个部分相关联,并会在这些位置移动和编辑电子表格时在这些位置保持关联。例如,如果开发者元数据已与第 5 行关联,而后又又插入了第 5 行,那么原始元数据仍会与其最初关联的行(即现在的第 6 行)相关联。如果关联的对象被删除,其元数据也会删除。
JSON 表示法 |
---|
{ "metadataId": integer, "metadataKey": string, "metadataValue": string, "location": { object ( |
字段 | |
---|---|
metadataId |
电子表格范围的唯一 ID,用于标识元数据。创建元数据时可指定 ID,否则将随机生成并分配 ID。必须为正值。 |
metadataKey |
元数据键。电子表格中可能包含多个具有相同键的元数据。开发者元数据必须始终指定密钥。 |
metadataValue |
与元数据的键关联的数据。 |
location |
元数据的关联位置。 |
visibility |
元数据公开范围。开发者元数据必须始终指定公开范围。 |
开发者元数据位置
电子表格中可能关联元数据的位置。
JSON 表示法 |
---|
{ "locationType": enum ( |
字段 | |
---|---|
locationType |
此对象表示的位置类型。此字段为只读字段。 |
联合字段 location 。元数据的关联位置。location 只能是下列其中一项: |
|
spreadsheet |
如果元数据与整个电子表格相关联,则为 true。 |
sheetId |
元数据与整个工作表关联时工作表的 ID。 |
dimensionRange |
表示元数据与维度关联的行或列。指定的 |
开发者元数据位置类型
与开发者元数据相关联的营业地点类型的枚举。
枚举 | |
---|---|
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED |
默认值。 |
ROW |
与整个行维度关联的开发者元数据。 |
COLUMN |
与整个列维度关联的开发者元数据。 |
SHEET |
与整个工作表关联的开发者元数据。 |
SPREADSHEET |
与整个电子表格关联的开发者元数据。 |
开发者元数据可见性
枚举可能的元数据可见性。
枚举 | |
---|---|
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED |
默认值。 |
DOCUMENT |
任何有权访问该文档的开发者项目都可以访问文档可见的元数据。 |
PROJECT |
项目元数据仅对创建元数据的开发者项目可见并可供其访问。 |
方法 |
|
---|---|
|
返回具有指定 ID 的开发者元数据。 |
|
返回与指定的 DataFilter 匹配的所有开发者元数据。 |