Class DeveloperMetadata

DeveloperMetadata

Accéder aux métadonnées du développeur et les modifier. Pour créer des métadonnées de développeur, utilisez Range.addDeveloperMetadata(key), Sheet.addDeveloperMetadata(key) ou Spreadsheet.addDeveloperMetadata(key).

Méthodes

MéthodeType renvoyéBrève description
getId()IntegerRenvoie l'ID unique associé à ces métadonnées de développeur.
getKey()StringRenvoie la clé associée à ces métadonnées de développeur.
getLocation()DeveloperMetadataLocationRenvoie l'emplacement de ces métadonnées de développement.
getValue()StringRenvoie la valeur associée à ces métadonnées de développeur ou null si ces métadonnées n'ont pas de valeur.
getVisibility()DeveloperMetadataVisibilityRenvoie la visibilité de ces métadonnées de développement.
moveToColumn(column)DeveloperMetadataDéplace ces métadonnées de développeur vers la colonne spécifiée.
moveToRow(row)DeveloperMetadataDéplace ces métadonnées de développement vers la ligne spécifiée.
moveToSheet(sheet)DeveloperMetadataDéplace ces métadonnées de développement vers la feuille spécifiée.
moveToSpreadsheet()DeveloperMetadataDéplace ces métadonnées de développement vers la feuille de calcul de premier niveau.
remove()voidSupprime ces métadonnées.
setKey(key)DeveloperMetadataDéfinit la clé de ces métadonnées de développement sur la valeur spécifiée.
setValue(value)DeveloperMetadataDéfinit la valeur associée à ces métadonnées de développeur sur la valeur spécifiée.
setVisibility(visibility)DeveloperMetadataDéfinit la visibilité de ces métadonnées de développement sur la visibilité spécifiée.

Documentation détaillée

getId()

Renvoie l'ID unique associé à ces métadonnées de développeur.

Renvois

Integer : ID unique associé à ces métadonnées de développement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getKey()

Renvoie la clé associée à ces métadonnées de développeur.

Renvois

String : clé associée à ces métadonnées de développeur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLocation()

Renvoie l'emplacement de ces métadonnées de développement.

Renvois

DeveloperMetadataLocation : emplacement de ces métadonnées de développement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getValue()

Renvoie la valeur associée à ces métadonnées de développeur ou null si ces métadonnées n'ont pas de valeur.

Renvois

String : valeur associée à ces métadonnées de développement ou null si ces métadonnées n'ont aucune valeur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getVisibility()

Renvoie la visibilité de ces métadonnées de développement.

Renvois

DeveloperMetadataVisibility : visibilité de ces métadonnées de développement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToColumn(column)

Déplace ces métadonnées de développeur vers la colonne spécifiée. Si la plage spécifiée ne représente pas une seule colonne, une exception est générée.

Paramètres

NomTypeDescription
columnRangePlage représentant la colonne qui constitue le nouvel emplacement de ces métadonnées de développeur.

Renvois

DeveloperMetadata : métadonnées du développeur, pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToRow(row)

Déplace ces métadonnées de développement vers la ligne spécifiée. Si la plage spécifiée ne représente pas une seule ligne, une exception est générée.

Paramètres

NomTypeDescription
rowRangePlage représentant la ligne qui constitue le nouvel emplacement de ces métadonnées de développement.

Renvois

DeveloperMetadata : métadonnées du développeur, pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSheet(sheet)

Déplace ces métadonnées de développement vers la feuille spécifiée.

Paramètres

NomTypeDescription
sheetSheetFeuille qui constitue le nouvel emplacement de ces métadonnées de développement.

Renvois

DeveloperMetadata : métadonnées du développeur, pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToSpreadsheet()

Déplace ces métadonnées de développement vers la feuille de calcul de premier niveau.

Renvois

DeveloperMetadata : métadonnées du développeur, pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

Supprime ces métadonnées.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setKey(key)

Définit la clé de ces métadonnées de développement sur la valeur spécifiée.

Paramètres

NomTypeDescription
keyStringNouvelle clé à définir pour ces métadonnées.

Renvois

DeveloperMetadata : métadonnées du développeur, pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

Définit la valeur associée à ces métadonnées de développeur sur la valeur spécifiée.

Paramètres

NomTypeDescription
valueStringNouvelle valeur à définir pour ces métadonnées.

Renvois

DeveloperMetadata : métadonnées du développeur, pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVisibility(visibility)

Définit la visibilité de ces métadonnées de développement sur la visibilité spécifiée.

Paramètres

NomTypeDescription
visibilityDeveloperMetadataVisibilityNouvelle visibilité à définir pour ces métadonnées.

Renvois

DeveloperMetadata : métadonnées du développeur, pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets