REST Resource: spreadsheets.developerMetadata

Resource: DeveloperMetadata

Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata will be deleted too.

JSON representation
{
  "metadataId": number,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object(DeveloperMetadataLocation)
  },
  "visibility": enum(DeveloperMetadataVisibility),
}
Fields
metadataId

number

The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.

metadataKey

string

The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.

metadataValue

string

Data associated with the metadata's key.

location

object(DeveloperMetadataLocation)

The location where the metadata is associated.

visibility

enum(DeveloperMetadataVisibility)

The metadata visibility. Developer metadata must always have a visibility specified.

DeveloperMetadataLocation

A location where metadata may be associated in a spreadsheet.

JSON representation
{
  "locationType": enum(DeveloperMetadataLocationType),

  // Union field location can be only one of the following:
  "spreadsheet": boolean,
  "sheetId": number,
  "dimensionRange": {
    object(DimensionRange)
  },
  // End of list of possible types for union field location.
}
Fields
locationType

enum(DeveloperMetadataLocationType)

The type of location this object represents. This field is read-only.

Union field location. The location where metadata is associated. location can be only one of the following:
spreadsheet

boolean

True when metadata is associated with an entire spreadsheet.

sheetId

number

The ID of the sheet when metadata is associated with an entire sheet.

dimensionRange

object(DimensionRange)

Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns.

DeveloperMetadataLocationType

An enumeration of the types of locations on which developer metadata may be associated.

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Default value.
ROW Developer metadata associated on an entire row dimension.
COLUMN Developer metadata associated on an entire column dimension.
SHEET Developer metadata associated on an entire sheet.
SPREADSHEET Developer metadata associated on the entire spreadsheet.

DimensionRange

A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.

JSON representation
{
  "sheetId": number,
  "dimension": enum(Dimension),
  "startIndex": number,
  "endIndex": number,
}
Fields
sheetId

number

The sheet this span is on.

dimension

enum(Dimension)

The dimension of the span.

startIndex

number

The start (inclusive) of the span, or not set if unbounded.

endIndex

number

The end (exclusive) of the span, or not set if unbounded.

DeveloperMetadataVisibility

An enumeration of possible metadata visibilities.

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Default value.
DOCUMENT Document-visible metadata is accessible from any developer project with access to the document.
PROJECT Project-visible metadata is only visible to and accessible by the developer project that created the metadata.

Methods

get

Returns the developer metadata with the specified ID.

search

Returns all developer metadata matching the specified DataFilter.

Send feedback about...