Essayez le serveur MCP pour Google Analytics. Installez-le depuis
GitHub et consultez l'
annonce pour en savoir plus.
REST Resource: properties.customMetrics
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: CustomMetric
Définition d'une métrique personnalisée.
Représentation JSON |
{
"name": string,
"parameterName": string,
"displayName": string,
"description": string,
"measurementUnit": enum (MeasurementUnit ),
"scope": enum (MetricScope ),
"restrictedMetricType": [
enum (RestrictedMetricType )
]
} |
Champs |
name |
string
Uniquement en sortie. Nom de ressource de cette ressource de métrique personnalisée. Format: Properties/{property}/customMetrics/{customMetric}
|
parameterName |
string
Obligatoire. Immuable. Nom du taggage pour cette métrique personnalisée. S'il s'agit d'une métrique de portée événement, il s'agit du nom du paramètre d'événement. Ne doit contenir que des caractères alphanumériques et des traits de soulignement, et commencer par une lettre. Longueur maximale de 40 caractères pour les métriques de portée événement.
|
displayName |
string
Obligatoire. Nom à afficher pour cette métrique personnalisée, comme indiqué dans l'interface utilisateur d'Analytics. Longueur maximale de 82 caractères, caractères alphanumériques, espaces et traits de soulignement commençant par une lettre. Les anciens noms à afficher générés par le système peuvent contenir des crochets, mais les modifications apportées à ce champ ne les autoriseront jamais.
|
description |
string
Facultatif. Description de cette dimension personnalisée. Longueur maximale : 150 caractères.
|
measurementUnit |
enum (MeasurementUnit )
Obligatoire. Type de la valeur de la métrique personnalisée.
|
scope |
enum (MetricScope )
Obligatoire. Immuable. Champ d'application de cette métrique personnalisée.
|
restrictedMetricType[] |
enum (RestrictedMetricType )
Facultatif. Types de données restreintes que cette métrique peut contenir. Obligatoire pour les métriques avec l'unité de mesure CURRENCY. Doit être vide pour les métriques utilisant une unité de mesure autre que CURRENCY.
|
MeasurementUnit
Types possibles de représentation de la valeur de la métrique personnalisée.
La représentation des devises est susceptible de changer à l'avenir, ce qui nécessitera une modification destructive de l'API.
Enums |
MEASUREMENT_UNIT_UNSPECIFIED |
MeasurementUnit non spécifié ou manquant. |
STANDARD |
Cette métrique utilise les unités par défaut. |
CURRENCY |
Cette métrique mesure une devise. |
FEET |
Cette métrique est exprimée en pieds. |
METERS |
Cette métrique mesure des mètres. |
KILOMETERS |
Cette métrique mesure les kilomètres. |
MILES |
Cette métrique mesure les miles. |
MILLISECONDS |
Cette métrique mesure la milliseconde. |
SECONDS |
Cette métrique mesure les secondes. |
MINUTES |
Cette métrique mesure les minutes. |
HOURS |
Cette métrique mesure les heures. |
MetricScope
Champ d'application de cette métrique.
Enums |
METRIC_SCOPE_UNSPECIFIED |
Champ d'application inconnu ou non spécifié. |
EVENT |
Métrique limitée à un événement. |
RestrictedMetricType
Libellés indiquant que les données de cette métrique personnalisée doivent être limitées à des utilisateurs spécifiques.
Enums |
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
Type inconnu ou non spécifié. |
COST_DATA |
Les métriques enregistrent les données de coût. |
REVENUE_DATA |
La métrique fournit des données sur les revenus. |
Méthodes |
|
Archive une métrique personnalisée sur une propriété. |
|
Crée une métrique personnalisée. |
|
Recherche d'une seule métrique personnalisée. |
|
Répertorie les CustomMetrics sur une propriété. |
|
Met à jour une métrique personnalisée sur une propriété. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eCustomMetric\u003c/code\u003e resource allows you to define custom metrics with specific parameters, display names, descriptions, measurement units, and scopes within Google Analytics.\u003c/p\u003e\n"],["\u003cp\u003eThese custom metrics can have various measurement units like \u003ccode\u003eSTANDARD\u003c/code\u003e, \u003ccode\u003eCURRENCY\u003c/code\u003e, \u003ccode\u003eFEET\u003c/code\u003e, \u003ccode\u003eMETERS\u003c/code\u003e, and more, alongside scopes such as \u003ccode\u003eEVENT\u003c/code\u003e to tailor data collection to specific events.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage your custom metrics with dedicated methods, including \u003ccode\u003earchive\u003c/code\u003e, \u003ccode\u003ecreate\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, and \u003ccode\u003epatch\u003c/code\u003e to control their lifecycle and properties directly through the API.\u003c/p\u003e\n"],["\u003cp\u003eRestricted data like cost and revenue can be tracked by labeling the metric with specific \u003ccode\u003eRestrictedMetricType\u003c/code\u003e values, ensuring appropriate access controls.\u003c/p\u003e\n"]]],["CustomMetrics are defined by `name`, `parameterName`, `displayName`, `description`, `measurementUnit`, `scope`, and `restrictedMetricType`. `MeasurementUnit` options include standard, currency, and various distance/time units. `MetricScope` can be event-based. `RestrictedMetricType` marks data like cost or revenue. Methods allow creating, retrieving, listing, updating, and archiving custom metrics. These metrics are structured with specific field requirements, such as length and character restrictions.\n"],null,["# REST Resource: properties.customMetrics\n\n- [Resource: CustomMetric](#CustomMetric)\n - [JSON representation](#CustomMetric.SCHEMA_REPRESENTATION)\n- [MeasurementUnit](#MeasurementUnit)\n- [MetricScope](#MetricScope)\n- [RestrictedMetricType](#RestrictedMetricType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CustomMetric\n----------------------\n\nA definition for a custom metric.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"parameterName\": string, \"displayName\": string, \"description\": string, \"measurementUnit\": enum (/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#MeasurementUnit), \"scope\": enum (/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#MetricScope), \"restrictedMetricType\": [ enum (/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#RestrictedMetricType) ] } ``` |\n\n| Fields ||\n|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} |\n| `parameterName` | `string` Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. |\n| `displayName` | `string` Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |\n| `description` | `string` Optional. Description for this custom dimension. Max length of 150 characters. |\n| `measurementUnit` | `enum (`[MeasurementUnit](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#MeasurementUnit)`)` Required. The type for the custom metric's value. |\n| `scope` | `enum (`[MetricScope](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#MetricScope)`)` Required. Immutable. The scope of this custom metric. |\n| `restrictedMetricType[]` | `enum (`[RestrictedMetricType](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#RestrictedMetricType)`)` Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. |\n\nMeasurementUnit\n---------------\n\nPossible types of representing the custom metric's value.\n\nCurrency representation may change in the future, requiring a breaking API change.\n\n| Enums ||\n|--------------------------------|-----------------------------------------|\n| `MEASUREMENT_UNIT_UNSPECIFIED` | MeasurementUnit unspecified or missing. |\n| `STANDARD` | This metric uses default units. |\n| `CURRENCY` | This metric measures a currency. |\n| `FEET` | This metric measures feet. |\n| `METERS` | This metric measures meters. |\n| `KILOMETERS` | This metric measures kilometers. |\n| `MILES` | This metric measures miles. |\n| `MILLISECONDS` | This metric measures milliseconds. |\n| `SECONDS` | This metric measures seconds. |\n| `MINUTES` | This metric measures minutes. |\n| `HOURS` | This metric measures hours. |\n\nMetricScope\n-----------\n\nThe scope of this metric.\n\n| Enums ||\n|----------------------------|---------------------------------|\n| `METRIC_SCOPE_UNSPECIFIED` | Scope unknown or not specified. |\n| `EVENT` | Metric scoped to an event. |\n\nRestrictedMetricType\n--------------------\n\nLabels that mark the data in this custom metric as data that should be restricted to specific users.\n\n| Enums ||\n|--------------------------------------|------------------------------|\n| `RESTRICTED_METRIC_TYPE_UNSPECIFIED` | Type unknown or unspecified. |\n| `COST_DATA` | Metric reports cost data. |\n| `REVENUE_DATA` | Metric reports revenue data. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------------|----------------------------------------|\n| ### [archive](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics/archive) | Archives a CustomMetric on a property. |\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics/create) | Creates a CustomMetric. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics/get) | Lookup for a single CustomMetric. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics/list) | Lists CustomMetrics on a property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics/patch) | Updates a CustomMetric on a property. |"]]