REST Resource: spreadsheets.developerMetadata

Ressource: DeveloperMetadata

Métadonnées de développement associées à un lieu ou à un objet dans une feuille de calcul. Les métadonnées de développeur peuvent être utilisées pour associer des données arbitraires à différentes parties d'une feuille de calcul et restent associées à ces emplacements lorsqu'ils se déplacent et que la feuille de calcul est modifiée. Par exemple, si des métadonnées de développement 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 (qui est désormais 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

ID unique au niveau de la feuille de calcul qui identifie les métadonnées. Vous pouvez spécifier des ID lors de la création des métadonnées. Sinon, un identifiant sera généré et attribué de manière aléatoire. Doit être positive.
metadataKey

string

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

string

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

object (DeveloperMetadataLocation)

Emplacement où les métadonnées sont associées.
visibility

enum (DeveloperMetadataVisibility)

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

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 où les métadonnées sont associées. location ne peut être qu'un des éléments suivants :
spreadsheet

boolean

Vrai lorsque les métadonnées sont associées à l'ensemble d'une feuille de calcul.
sheetId

integer

ID 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 des métadonnées sont associées à une dimension. L'élément DimensionRange spécifié doit représenter une seule ligne ou colonne. elle ne peut pas être illimitée ni s'étendre sur plusieurs lignes ou colonnes.

DeveloperMetadataLocationType

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

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

DeveloperMetadataVisibility

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

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Valeur par défaut.
DOCUMENT Les métadonnées visibles par le document sont accessibles depuis n'importe quel projet de développement 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é.