REST Resource: spreadsheets.developerMetadata

Recurso: DeveloperMetadata

Son los metadatos para desarrolladores asociados a una ubicación o un objeto en una hoja de cálculo. Para obtener más información, consulta Cómo leer, escribir y buscar metadatos.

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 a la fila 5 y, luego, se inserta otra fila sobre la fila 5, esos metadatos originales seguirán asociados a la fila con la que se asociaron por primera vez (lo que ahora es la fila 6). Si se borra el objeto asociado, también se borrarán sus metadatos.

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

integer

Es el ID único con alcance de 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

Son los datos asociados con la clave de los metadatos.
location

object (DeveloperMetadataLocation)

Es la ubicación con la que se asocian los metadatos.
visibility

enum (DeveloperMetadataVisibility)

Es la visibilidad de los metadatos. Siempre se debe especificar la visibilidad de los metadatos del desarrollador.

DeveloperMetadataLocation

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 con la que se asocian los metadatos. location puede ser solo uno de los parámetros siguientes:
spreadsheet

boolean

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

integer

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

object (DimensionRange)

Representa la fila o la columna cuando los metadatos se asocian a 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 metadatos del desarrollador.

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Valor predeterminado
ROW Son los metadatos del desarrollador asociados a toda una dimensión de fila.
COLUMN Son los metadatos del desarrollador asociados a toda una dimensión de columna.
SHEET Son los metadatos del desarrollador asociados a una hoja completa.
SPREADSHEET Son los metadatos del desarrollador asociados a toda la hoja de cálculo.

DeveloperMetadataVisibility

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

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Valor predeterminado
DOCUMENT Se puede acceder a los metadatos visibles del documento desde cualquier proyecto del desarrollador que tenga acceso al documento.
PROJECT Los metadatos visibles para el proyecto solo son visibles y accesibles para el proyecto del desarrollador que creó los metadatos.

Métodos

get

 Devuelve los metadatos del desarrollador con el ID especificado.
Devuelve todos los metadatos para desarrolladores que coinciden con el DataFilter especificado.