Prueba el servidor de MCP para Google Analytics. Instala desde
GitHub y consulta el
anuncio para obtener más detalles.
REST Resource: properties.customMetrics
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: CustomMetric
Es una definición de una métrica personalizada.
Representación JSON |
{
"name": string,
"parameterName": string,
"displayName": string,
"description": string,
"measurementUnit": enum (MeasurementUnit ),
"scope": enum (MetricScope ),
"restrictedMetricType": [
enum (RestrictedMetricType )
]
} |
Campos |
name |
string
Solo salida. Nombre del recurso para este recurso CustomMetric. Formato: properties/{property}/customMetrics/{customMetric}
|
parameterName |
string
Obligatorio. Inmutable. Nombre de etiquetado de esta métrica personalizada. Si esta es una métrica centrada en el evento, este es el nombre del parámetro del evento. Solo puede contener caracteres alfanuméricos y guiones bajos, que comiencen con una letra. La longitud máxima es de 40 caracteres para las métricas centradas en el evento.
|
displayName |
string
Obligatorio. Es el nombre visible de esta métrica personalizada como se muestra en la IU de Analytics. Debe tener una longitud máxima de 82 caracteres, con caracteres alfanuméricos más espacios y guiones bajos que comiencen con una letra. Los nombres visibles heredados que genera el sistema pueden contener corchetes, pero las actualizaciones de este campo nunca permitirán los corchetes.
|
description |
string
Opcional. Es la descripción de esta dimensión personalizada. Debe tener una longitud máxima de 150 caracteres.
|
measurementUnit |
enum (MeasurementUnit )
Obligatorio. El tipo para el valor de la métrica personalizada.
|
scope |
enum (MetricScope )
Obligatorio. Inmutable. El alcance de esta métrica personalizada.
|
restrictedMetricType[] |
enum (RestrictedMetricType )
Opcional. Tipos de datos restringidos que puede contener esta métrica. Obligatorio para las métricas con la unidad de medida CURRENCY. Debe estar vacío para las métricas con una unidad de medida que no sea CURRENCY.
|
MeasurementUnit
Tipos posibles para representar el valor de la métrica personalizada.
La representación de la moneda puede cambiar en el futuro y requerir un cambio rotundo en la API.
Enumeraciones |
MEASUREMENT_UNIT_UNSPECIFIED |
MeasurementUnit no especificado o faltante. |
STANDARD |
Esta métrica usa unidades predeterminadas. |
CURRENCY |
Esta métrica mide una moneda. |
FEET |
Esta métrica mide los pies. |
METERS |
Esta métrica mide en metros. |
KILOMETERS |
Esta métrica mide kilómetros. |
MILES |
Esta métrica mide las millas. |
MILLISECONDS |
Esta métrica mide milisegundos. |
SECONDS |
Esta métrica mide los segundos. |
MINUTES |
Esta métrica mide los minutos. |
HOURS |
Esta métrica mide las horas. |
MetricScope
El alcance de esta métrica.
Enumeraciones |
METRIC_SCOPE_UNSPECIFIED |
Alcance desconocido o no especificado. |
EVENT |
Métrica que se limita a un evento. |
RestrictedMetricType
Etiquetas que marcan los datos en esta métrica personalizada como datos que deben restringirse a usuarios específicos.
Enumeraciones |
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
Tipo desconocido o sin especificar. |
COST_DATA |
La métrica informa datos de costos. |
REVENUE_DATA |
La métrica informa datos de ingresos. |
Métodos |
|
Archiva una CustomMetric en una propiedad. |
|
Crea una CustomMetric. |
|
Busca una sola CustomMetric. |
|
Muestra una lista de CustomMetrics en una propiedad. |
|
Actualiza una CustomMetric en una propiedad. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003eA \u003ccode\u003eCustomMetric\u003c/code\u003e defines custom metrics for data analysis within Google Analytics, allowing users to track specific events and parameters relevant to their business needs.\u003c/p\u003e\n"],["\u003cp\u003eThese metrics can be defined with various units of measurement (\u003ccode\u003eMeasurementUnit\u003c/code\u003e) including standard, currency, time, and distance, catering to diverse data types.\u003c/p\u003e\n"],["\u003cp\u003eThe scope of a custom metric can be specified (\u003ccode\u003eMetricScope\u003c/code\u003e) to be associated with an event, dictating the context in which the metric is collected.\u003c/p\u003e\n"],["\u003cp\u003eCustom metrics can also be designated as containing restricted data types such as cost or revenue (\u003ccode\u003eRestrictedMetricType\u003c/code\u003e) for enhanced privacy and access control.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Analytics provides methods to manage custom metrics: \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, allowing for comprehensive control over these custom data points.\u003c/p\u003e\n"]]],["CustomMetrics are defined by a name, parameter name, display name, description, measurement unit, scope, and restricted metric type. Measurement units include standard, currency, distance, and time. Metric scopes can be event-based. Restricted metric types include cost and revenue data. Key actions involve creating, retrieving, listing, updating, and archiving custom metrics, utilizing methods for each of these operations, like create, get, list, patch, and archive.\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/v1alpha/properties.customMetrics#MeasurementUnit), \"scope\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#MetricScope), \"restrictedMetricType\": [ enum (/analytics/devguides/config/admin/v1/rest/v1alpha/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/v1alpha/properties.customMetrics#MeasurementUnit)`)` Required. The type for the custom metric's value. |\n| `scope` | `enum (`[MetricScope](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#MetricScope)`)` Required. Immutable. The scope of this custom metric. |\n| `restrictedMetricType[]` | `enum (`[RestrictedMetricType](/analytics/devguides/config/admin/v1/rest/v1alpha/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/v1alpha/properties.customMetrics/archive) | Archives a CustomMetric on a property. |\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/create) | Creates a CustomMetric. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/get) | Lookup for a single CustomMetric. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/list) | Lists CustomMetrics on a property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/patch) | Updates a CustomMetric on a property. |"]]