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 匹配的所有开发者元数据。