REST Resource: spreadsheets.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 .