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