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