header.banner.text
Documentation de service Web / Catégories / Services des propriétés / Ajouter une mesure personnalisée
Ajouter une mesure personnalisée
Mise à jour le 26 février 2024
Description
Ce service Web ajoute une nouvelle mesure personnalisée conformément aux renseignements fournis dans la demande XML pour une propriété donnée. La propriété doit déjà être partagée avec vous. Le bien doit déjà être partagé avec vous. Vous pouvez définir un maximum de 3 mesures personnalisées par propriété.
Version
22.0
Méthode HTTP
POST
URL de la ressource
/property/(propertyId)/customMetrics/(customMetricSlot)
En-tête
| Nom du champ | Valeur | Commentaires |
|---|---|---|
| Autorisation | Basic authentifiant | |
| Type de contenu | application/xml |
Autorisation requise
Oui
Paramètres
| Nom du paramètre | Description |
|---|---|
| customMetricSlot | Numéro de l'emplacement ou de la position (tel qu'affiché dans l'interface utilisateur) qui détermine la mesure personnalisée. |
| propertyId | identifiant de la propriété |
Schémas XML
| Demande/réponse | Nom de schéma |
|---|---|
| Demande | customMetrics.xsd |
| Réponse | response.xsd |
Exemple de demande
L'exemple suivant ajoute la mesure personnalisée (qui s'affiche en premier dans l'interface utilisateur) qui appartient à une propriété dont l'identifiant est 14. Le nom de la mesure personnalisée est généré automatiquement s'il est omis.
POST /property/14/customMetrics/1<?xml version="1.0" encoding="UTF-8"?> <customMetric> <name>Consommation d'énergie du site par ordinateur</name> <numeratorMetricId> 272</numeratorMetricId> <denominatorDetailTypeId>2</denominatorDetailTypeId> </customMetric>
Exemple de réponse
L'exemple suivant indique que la mesure personnalisée a été créée.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<links>
<link linkDescription="This is the GET url for this Custom Metric." link="/property/14/customMetrics/1" httpMethod="GET"/>
</links>
</response>
