REST Resource: spreadsheets.developerMetadata

Risorsa: DeveloperMetadata

I 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 rimangono associati in queste posizioni mentre si muovono 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 era stata associata per la prima volta (cosa è ora la riga 6). Se l'oggetto associato viene eliminato, 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 con ambito a livello di foglio di lavoro che identifica i metadati. Gli ID possono essere specificati al momento della creazione dei metadati, altrimenti ne verrà uno generato e assegnato in modo casuale. Deve essere positivo.
metadataKey

string

La chiave dei metadati. In un foglio di lavoro potrebbero essere presenti più metadati con la stessa chiave. I metadati dello sviluppatore devono sempre avere una chiave specificata.
metadataValue

string

Dati associati alla chiave dei metadati.
location

object (DeveloperMetadataLocation)

La località a cui sono associati i metadati.
visibility

enum (DeveloperMetadataVisibility)

La visibilità dei metadati. È necessario specificare sempre la visibilità dei metadati dello sviluppatore.

Località metadati sviluppatore

Una posizione in cui i metadati potrebbero essere associati a 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 di unione location. La località a 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 DimensionRange specificato deve rappresentare una singola riga o colonna; non può essere senza limiti o includere più righe o colonne.

Tipo di posizione dello sviluppatore

Un elenco 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 della colonna.
SHEET Metadati dello sviluppatore associati in un intero foglio.
SPREADSHEET I metadati dello sviluppatore associati all'intero foglio di lavoro.

Visibilità dello sviluppatore dei metadati

Un elenco di 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 di sviluppatore che ha creato i metadati.

Metodi

get

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