REST Resource: spreadsheets.developerMetadata

Источник: DeveloperMetadata

Метаданные разработчика, связанные с местоположением или объектом в электронной таблице. Дополнительную информацию см. в разделе «Чтение, запись и поиск метаданных» .

Метаданные разработчика могут использоваться для связывания произвольных данных с различными частями электронной таблицы, и они остаются связанными в этих местах по мере перемещения данных и редактирования таблицы. Например, если метаданные разработчика связаны со строкой 5, а затем над строкой 5 вставляется другая строка, то исходные метаданные по-прежнему связаны со строкой, с которой они были связаны изначально (теперь это строка 6). Если связанный объект удаляется, то его метаданные также удаляются.

JSON-представление 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Поля
metadataId

integer

Уникальный идентификатор, привязанный к таблице, который идентифицирует метаданные. Идентификаторы могут быть указаны при создании метаданных, в противном случае один из них будет сгенерирован и присвоен случайным образом. Должен быть положительным.

metadataKey

string

Ключ метаданных. В электронной таблице может быть несколько метаданных с одним и тем же ключом. Метаданные для разработчиков всегда должны иметь указанный ключ.

metadataValue

string

Данные, связанные с ключом метаданных.

location

object ( DeveloperMetadataLocation )

Место, где размещены связанные метаданные.

visibility

enum ( DeveloperMetadataVisibility )

Видимость метаданных. Для метаданных разработчика всегда должна быть указана видимость.

Местоположение метаданных разработчика

Место, где могут быть связаны метаданные в электронной таблице.

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

Это верно, если метаданные связаны со всей электронной таблицей целиком.

sheetId

integer

Идентификатор листа, если метаданные связаны со всем листом целиком.

dimensionRange

object ( DimensionRange )

Представляет строку или столбец, если метаданные связаны с измерением. Указанный DimensionRange должен представлять одну строку или столбец. Он не может быть неограниченным или охватывать несколько строк или столбцов.

DeveloperMetadataLocationType

Перечень типов местоположений, к которым могут быть привязаны метаданные разработчика.

Перечисления
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Значение по умолчанию.
ROW Метаданные разработчика, связанные со всей строкой измерения.
COLUMN Метаданные разработчика, связанные со всем измерением столбца.
SHEET Метаданные разработчика, связанные со всей таблицей.
SPREADSHEET Метаданные разработчика, связанные со всей электронной таблицей.

DeveloperMetadataVisibility

Перечень возможных вариантов отображения метаданных.

Перечисления
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Значение по умолчанию.
DOCUMENT Метаданные, видимые в документе, доступны из любого проекта разработчика, имеющего доступ к документу.
PROJECT Метаданные, видимые проекту, доступны только проекту разработчика, который их создал.

Методы

get

 Возвращает метаданные разработчика с указанным идентификатором.
Возвращает все метаданные разработчика, соответствующие указанному DataFilter .