REST Resource: spreadsheets.developerMetadata

Ressource: DeveloperMetadata

Métadonnées de développement associées à un emplacement ou à un objet dans une feuille de calcul. Les métadonnées de développement peuvent être utilisées pour associer des données arbitraires à différentes parties d'une feuille de calcul. Elles resteront associées à ces emplacements lorsqu'ils se déplacent et que la feuille de calcul est modifiée. Par exemple, si les métadonnées de développeur sont associées à la ligne 5 et qu'une autre ligne est ensuite insérée au-dessus de la ligne 5, ces métadonnées d'origine seront toujours associées à la ligne à laquelle elles ont été associées en premier (c'est-à-dire maintenant la ligne 6). Si l'objet associé est supprimé, ses métadonnées le sont également.

Représentation JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Champs
metadataId

integer

Identifiant unique à l'échelle de la feuille de calcul qui identifie les métadonnées. Des ID peuvent être spécifiés lors de la création des métadonnées. Sinon, l'un d'eux sera généré et attribué de manière aléatoire. Doit être positive.
metadataKey

string

Clé des métadonnées. Une feuille de calcul peut contenir plusieurs métadonnées avec la même clé. Une clé doit toujours être spécifiée pour les métadonnées de développeur.
metadataValue

string

Données associées à la clé des métadonnées.
location

object (DeveloperMetadataLocation)

Emplacement auquel les métadonnées sont associées.
visibility

enum (DeveloperMetadataVisibility)

La visibilité des métadonnées. Une visibilité doit toujours être spécifiée pour les métadonnées de développement.

DeveloperMetadataLocation

Emplacement où des métadonnées peuvent être associées dans une feuille de calcul.

Représentation 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.
}
Champs
locationType

enum (DeveloperMetadataLocationType)

Type de lieu représenté par cet objet. Ce champ est en lecture seule.
Champ d'union location. Emplacement auquel les métadonnées sont associées. location ne peut être qu'un des éléments suivants :
spreadsheet

boolean

Vrai lorsque des métadonnées sont associées à l'intégralité d'une feuille de calcul.
sheetId

integer

Identifiant de la feuille lorsque les métadonnées sont associées à une feuille entière.
dimensionRange

object (DimensionRange)

Représente la ligne ou la colonne lorsque les métadonnées sont associées à une dimension. L'élément DimensionRange spécifié doit représenter une seule ligne ou colonne ; il ne peut pas être illimité ni s'étendre sur plusieurs lignes ou colonnes.

DeveloperMetadataLocationType

Énumération des types d'emplacements auxquels les métadonnées de développeur peuvent être associées.

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Valeur par défaut.
ROW Métadonnées du développeur associées à une dimension de ligne entière.
COLUMN Métadonnées du développeur associées à une dimension de colonne entière.
SHEET Métadonnées du développeur associées à une feuille entière.
SPREADSHEET Métadonnées du développeur associées à l'ensemble de la feuille de calcul.

DeveloperMetadataVisibility

Énumération des visibilités possibles des métadonnées.

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Valeur par défaut.
DOCUMENT Les métadonnées visibles dans le document sont accessibles depuis n'importe quel projet de développeur ayant accès au document.
PROJECT Les métadonnées visibles par le projet ne sont visibles et accessibles que par le projet de développement qui les a créées.

Méthodes

get

 Renvoie les métadonnées de développement avec l'ID spécifié.
Renvoie toutes les métadonnées de développement correspondant au DataFilter spécifié.