REST Resource: spreadsheets.developerMetadata

Recurso: DeveloperMetadata

Son metadatos del desarrollador asociados con una ubicación o un objeto en una hoja de cálculo. Los metadatos del desarrollador se pueden usar para asociar datos arbitrarios con varias partes de una hoja de cálculo y permanecerán asociados en esas ubicaciones a medida que se muevan y se edite la hoja de cálculo. Por ejemplo, si los metadatos del desarrollador están asociados con la fila 5 y, posteriormente, se inserta otra fila sobre la fila 5, esos metadatos originales seguirán asociados con la fila con la que se asociaron por primera vez (la que ahora es la fila 6). Si se borra el objeto asociado, también se borran sus metadatos.

Representación JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Campos
metadataId

integer

El ID único centrado en la hoja de cálculo que identifica los metadatos. Los IDs se pueden especificar cuando se crean los metadatos; de lo contrario, se generará y asignará uno de forma aleatoria. Debe ser positivo.
metadataKey

string

Es la clave de metadatos. Puede haber varios metadatos en una hoja de cálculo con la misma clave. Los metadatos del desarrollador siempre deben tener una clave especificada.
metadataValue

string

Datos asociados con la clave de los metadatos.
location

object (DeveloperMetadataLocation)

Es la ubicación donde se asocian los metadatos.
visibility

enum (DeveloperMetadataVisibility)

La visibilidad de los metadatos. Los metadatos del desarrollador siempre deben tener una visibilidad especificada.

DeveloperMetadataLocation

Es una ubicación en la que se pueden asociar metadatos en una hoja de cálculo.

Representación 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.
}
Campos
locationType

enum (DeveloperMetadataLocationType)

Es el tipo de ubicación que representa este objeto. Este campo es de solo lectura.
Campo de unión location. Es la ubicación donde se asocian los metadatos. Las direcciones (location) solo pueden ser una de las siguientes opciones:
spreadsheet

boolean

Es verdadero cuando los metadatos están asociados con una hoja de cálculo completa.
sheetId

integer

Es el ID de la hoja cuando los metadatos están asociados con una hoja completa.
dimensionRange

object (DimensionRange)

Representa la fila o columna cuando los metadatos se asocian con una dimensión. El DimensionRange especificado debe representar una sola fila o columna; no puede ser ilimitado ni abarcar varias filas o columnas.

DeveloperMetadataLocationType

Es una enumeración de los tipos de ubicaciones en las que se pueden asociar los metadatos del desarrollador.

Enumeraciones
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Valor predeterminado
ROW Metadatos del desarrollador asociados a una dimensión de fila completa.
COLUMN Metadatos del desarrollador asociados a una dimensión de columna completa.
SHEET Metadatos del desarrollador asociados en una hoja completa
SPREADSHEET Metadatos del desarrollador asociados en toda la hoja de cálculo

DeveloperMetadataVisibility

Es una enumeración de las posibles visibilidades de los metadatos.

Enumeraciones
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Valor predeterminado
DOCUMENT Se puede acceder a los metadatos visibles del documento desde cualquier proyecto de desarrollador que tenga acceso al documento.
PROJECT Solo el proyecto del desarrollador que creó los metadatos puede verlos y acceder a ellos.

Métodos

get

 Muestra los metadatos del desarrollador con el ID especificado.
Muestra todos los metadatos del desarrollador que coincidan con el DataFilter especificado.