Service Propriétés

Le service Propriétés vous permet de stocker Des données simples dans des paires clé-valeur limitées à un script, à un utilisateur d'un script Document dans lequel un module complémentaire est utilisé Il est généralement utilisé pour stocker la configuration du développeur ou les préférences utilisateur. Propriétés ne sont jamais partagés entre les scripts.

Pour afficher les quotas quotidiens et les limites de stockage du service Propriétés, consultez Quotas pour les services Google

Comparaison des magasins de propriétés

La PropertiesService global propose trois méthodes, chacune renvoyant un code Properties mais avec des droits d'accès différents, comme indiqué dans le tableau suivant:

Format des données

Le service Propriétés stocke toutes les données sous forme de chaînes dans des paires clé/valeur. Types de données qui ne sont pas déjà des chaînes sont automatiquement converties en chaînes, y compris contenues dans les objets enregistrés.

Économie de données

Pour enregistrer une seule valeur, appelez la méthode Properties.setProperty(key, value). du magasin approprié, comme illustré dans l'exemple suivant:

try {
  // Set a property in each of the three property stores.
  const scriptProperties = PropertiesService.getScriptProperties();
  const userProperties = PropertiesService.getUserProperties();
  const documentProperties = PropertiesService.getDocumentProperties();

  scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/');
  userProperties.setProperty('DISPLAY_UNITS', 'metric');
  documentProperties.setProperty('SOURCE_DATA_ID',
      '1j3GgabZvXUF177W0Zs_2v--H6SPCQb4pmZ6HsTZYT5k');
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Pour enregistrer des données de manière groupée, transmettez un mappage de paires clé-valeur Properties.setProperties(properties) Chaque paire clé-valeur de l'objet dans le paramètre est stockée sous la forme :

try {
  // Set multiple script properties in one call.
  const scriptProperties = PropertiesService.getScriptProperties();
  scriptProperties.setProperties({
    'cow': 'moo',
    'sheep': 'baa',
    'chicken': 'cluck'
  });
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Lire des données

Pour récupérer une valeur unique que vous avez enregistrée précédemment, appelez Properties.getProperty(key):

try {
  // Get the value for the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  const units = userProperties.getProperty('DISPLAY_UNITS');
  console.log('values of units %s', units);
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Pour récupérer toutes les valeurs du magasin de propriétés actuel, appelez Properties.getProperties():

try {
  // Get multiple script properties in one call, then log them all.
  const scriptProperties = PropertiesService.getScriptProperties();
  const data = scriptProperties.getProperties();
  for (const key in data) {
    console.log('Key: %s, Value: %s', key, data[key]);
  }
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Modifier les données

Les méthodes getProperty() et getProperties() renvoient une copie de la classe stockée et non une vue en direct. Par conséquent, modifier l'objet renvoyé ne mettra pas à jour la valeur dans le magasin de propriétés. Pour mettre à jour les données dans la boutique, enregistrez-les simplement à nouveau:

try {
  // Change the unit type in the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  let units = userProperties.getProperty('DISPLAY_UNITS');
  units = 'imperial'; // Only changes local value, not stored value.
  userProperties.setProperty('DISPLAY_UNITS', units); // Updates stored value.
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Supprimer des données

Pour supprimer une seule valeur, appelez Properties.deleteProperty(key):

try {
  // Delete the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty('DISPLAY_UNITS');
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Pour supprimer toutes les propriétés du magasin actuel, appelez Properties.deleteAllProperties():

try {
  // Get user properties in the current script.
  const userProperties = PropertiesService.getUserProperties();
  // Delete all user properties in the current script.
  userProperties.deleteAllProperties();
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Gérer manuellement les propriétés de script

Vous pouvez ajouter manuellement jusqu'à 50 propriétés personnalisées, sous forme de chaînes dans une clé-valeur. sur la page des paramètres du projet. Pour ajouter plus de 50 établissements, vous devez les ajouter par programmation à l'aide des méthodes décrites ci-dessus dans Enregistrement des données : Lorsque vous définissez des propriétés de script à partir de la page des paramètres du projet, vous ne pouvez pas les variables de script de référence.

Ajouter des propriétés de script

1. Ouvrez votre projet Apps Script.
2. Sur la gauche, cliquez sur Paramètres du projet .
3. Pour ajouter la première propriété, sous Propriétés du script, cliquez sur Ajoutez une propriété de script.
4. Pour ajouter une deuxième propriété et des propriétés suivantes, sous Propriétés du script, cliquez sur Modifier les propriétés de script > Ajouter une propriété de script.
5. Dans le champ Propriété, saisissez le nom de la clé.
6. Dans le champ Valeur, saisissez la valeur de la clé.
7. (Facultatif) Pour ajouter d'autres propriétés, cliquez sur Ajouter une propriété de script.
8. Cliquez sur Enregistrer les propriétés du script.

Modifier les propriétés de script

1. Ouvrez votre projet Apps Script.
2. Sur la gauche, cliquez sur Paramètres du projet .
3. Sous Propriétés du script, cliquez sur Modifier les propriétés du script.
4. Modifiez le nom et la valeur de la clé pour chaque propriété que vous souhaitez modifier.
5. Cliquez sur Enregistrer les propriétés du script.

Supprimer les propriétés de script

1. Ouvrez votre projet Apps Script.
2. Sur la gauche, cliquez sur Paramètres du projet .
3. Sous Propriétés du script, cliquez sur Modifier les propriétés du script.
4. À côté de la propriété que vous souhaitez supprimer, cliquez sur Supprimer close.
5. Cliquez sur Enregistrer les propriétés du script.