REST Resource: spreadsheets.developerMetadata

Recurso: DeveloperMetadata

Metadatos del desarrollador asociados con una ubicación o un objeto en una hoja de cálculo. Los metadatos del programador se pueden utilizar para asociar datos arbitrarios con varias partes de una hoja de cálculo y permanecerán asociados en esas ubicaciones a medida que se desplazan y se edita la hoja de cálculo. Por ejemplo, si los metadatos del desarrollador están asociados con la fila 5 y, luego, otra fila se inserta encima de la fila 5, esos metadatos originales seguirán asociados con la fila con la que se asoció por primera vez (lo que ahora se conoce como 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 con permiso de la hoja de cálculo que identifica los metadatos. Los ID se pueden especificar cuando se crean los metadatos; de lo contrario, se generarán y asignarán de forma aleatoria. Debe ser positivo.
metadataKey

string

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 metadatos.
location

object (DeveloperMetadataLocation)

La ubicación a la que están asociados los metadatos.
visibility

enum (DeveloperMetadataVisibility)

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

Ubicación de metadatos del programador

Es una ubicación en la que pueden asociarse los 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)

El tipo de ubicación que representa este objeto. Este campo es de solo lectura.
Campo de unión location. La ubicación a la que están asociados los metadatos. Las direcciones (location) solo pueden ser una de las siguientes opciones:
spreadsheet

boolean

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

integer

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

object (DimensionRange)

Representa la fila o columna cuando los metadatos están asociados con una dimensión. El DimensionRange especificado debe representar una sola fila o columna; no puede estar delimitado ni abarcar varias filas o columnas.

Tipo de ubicación de metadatos del programador

Una enumeración de los tipos de ubicaciones a las que pueden asociarse los metadatos para desarrolladores.

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

Visibilidad de metadatos del programador

Una enumeración de posibles visibilidades de metadatos.

Enumeradores
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Valor predeterminado
DOCUMENT Puedes acceder a los metadatos visibles desde cualquier proyecto de desarrollador que tenga acceso al documento.
PROJECT Solo el proyecto del desarrollador que creó los metadatos puede ver los metadatos visibles para el proyecto.

Métodos

get

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