REST Resource: spreadsheets.developerMetadata

Risorsa: DeveloperMetadata

Metadati dello sviluppatore associati a una posizione o a un oggetto in un foglio di lavoro. I metadati dello sviluppatore possono essere utilizzati per associare dati arbitrari a varie parti di un foglio di lavoro e rimarranno associati a tali posizioni man mano che si spostano e il foglio di lavoro viene modificato. Ad esempio, se i metadati dello sviluppatore sono associati alla riga 5 e successivamente viene inserita un'altra riga sopra la riga 5, quei metadati originali verranno comunque associati alla riga a cui erano stati associati per la prima volta (che ora è la riga 6). Se viene eliminato l'oggetto associato, vengono eliminati anche i relativi metadati.

Rappresentazione JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Campi
metadataId

integer

L'ID univoco basato sul foglio di lavoro che identifica i metadati. È possibile specificare gli ID durante la creazione dei metadati. In caso contrario, ne verrà generato e assegnato uno in modo casuale. Deve essere positivo.
metadataKey

string

La chiave dei metadati. Un foglio di lavoro potrebbe contenere più metadati con la stessa chiave. Per i metadati dello sviluppatore deve essere sempre specificata una chiave.
metadataValue

string

Dati associati alla chiave dei metadati.
location

object (DeveloperMetadataLocation)

La località in cui sono associati i metadati.
visibility

enum (DeveloperMetadataVisibility)

La visibilità dei metadati. Per i metadati dello sviluppatore deve essere sempre specificata una visibilità.

DeveloperMetadataLocation

Una posizione in cui i metadati possono essere associati in un foglio di lavoro.

Rappresentazione 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.
}
Campi
locationType

enum (DeveloperMetadataLocationType)

Il tipo di posizione rappresentato da questo oggetto. Questo campo è di sola lettura.
Campo unione location. La località in cui sono associati i metadati. location può essere solo uno dei seguenti:
spreadsheet

boolean

True quando i metadati sono associati a un intero foglio di lavoro.
sheetId

integer

L'ID del foglio quando i metadati sono associati a un intero foglio.
dimensionRange

object (DimensionRange)

Rappresenta la riga o la colonna quando i metadati sono associati a una dimensione. Il valore DimensionRange specificato deve rappresentare una singola riga o colonna. non può essere illimitato o estendersi su più righe o colonne.

DeveloperMetadataLocationType

Un'enumerazione dei tipi di località a cui possono essere associati i metadati dello sviluppatore.

Enum
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Valore predefinito.
ROW Metadati dello sviluppatore associati a un'intera dimensione di riga.
COLUMN Metadati dello sviluppatore associati a un'intera dimensione di colonna.
SHEET Metadati dello sviluppatore associati su un intero foglio.
SPREADSHEET Metadati dello sviluppatore associati all'intero foglio di lavoro.

DeveloperMetadataVisibility

Un'enumerazione delle possibili visibilità dei metadati.

Enum
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Valore predefinito.
DOCUMENT I metadati visibili al documento sono accessibili da qualsiasi progetto sviluppatore con accesso al documento.
PROJECT I metadati visibili al progetto sono visibili e accessibili solo al progetto sviluppatore che li ha creati.

Metodi

get

 Restituisce i metadati dello sviluppatore con l'ID specificato.
Restituisce tutti i metadati dello sviluppatore corrispondenti all'elemento DataFilter specificato.