REST Resource: spreadsheets.developerMetadata

Ressource : DeveloperMetadata

Métadonnées de développeur associées à un établissement ou à un objet dans une feuille de calcul. Pour en savoir plus, consultez Lire, écrire et rechercher des métadonnées.

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. Elles resteront associées à ces emplacements lorsqu'ils seront déplacés et que la feuille de calcul sera modifiée. Par exemple, si des 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, les métadonnées d'origine restent associées à la ligne à laquelle elles étaient initialement associées (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. Les ID peuvent être spécifiés lors de la création des métadonnées. Sinon, un ID 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 avec 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 auquel les métadonnées sont associées.
visibility

enum (DeveloperMetadataVisibility)

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

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 à une feuille de calcul entière.
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. Le 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éveloppeur peuvent être associées.

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Valeur par défaut.
ROW Métadonnées de développement associées à une dimension de ligne entière.
COLUMN Métadonnées de développement 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 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éveloppement ayant accès au document.
PROJECT Les métadonnées visibles au niveau du 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éveloppeur avec l'ID spécifié.
Renvoie toutes les métadonnées de développeur correspondant à l'DataFilter spécifié.