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