Prueba el servidor de MCP para Google Analytics. Instala desde
GitHub y consulta el
anuncio para obtener más detalles.
REST Resource: properties.calculatedMetrics
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: CalculatedMetric
Es una definición de una métrica calculada.
Representación JSON |
{
"name": string,
"description": string,
"displayName": string,
"calculatedMetricId": string,
"metricUnit": enum (MetricUnit ),
"restrictedMetricType": [
enum (RestrictedMetricType )
],
"formula": string,
"invalidMetricReference": boolean
} |
Campos |
name |
string
Solo salida. Nombre del recurso para esta CalculatedMetric. Formato: “properties/{property_id}/CalculateMetrics/{CalculateMetricId}”
|
description |
string
Opcional. Descripción de esta métrica calculada. La longitud máxima es de 4,096 caracteres.
|
displayName |
string
Obligatorio. Es el nombre visible de esta métrica calculada como se muestra en la IU de Google Analytics. Debe tener una longitud máxima de 82 caracteres.
|
calculatedMetricId |
string
Solo salida. El ID que se usará para la métrica calculada. En la IU, se hace referencia a esto como el “nombre de la API”. CalculaMetricId se usa cuando se hace referencia a esta métrica calculada desde APIs externas. Por ejemplo, "calcMetric:{CalculateMetricId}".
|
metricUnit |
enum (MetricUnit )
Obligatorio. El tipo para el valor de la métrica calculada.
|
restrictedMetricType[] |
enum (RestrictedMetricType )
Solo salida. Son los tipos de datos restringidos que contiene esta métrica.
|
formula |
string
Obligatorio. Es la definición de la métrica calculada. La cantidad máxima de métricas personalizadas de referencia únicas es 5. Las fórmulas admiten las siguientes operaciones: + (suma), - (resta), - (negativa), * (multiplicación), / (división), () (paréntesis). Se acepta cualquier número real válido que quepa en un formato largo (número entero de 64 bits) o doble (número de punto flotante de 64 bits). Fórmula de ejemplo: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"
|
invalidMetricReference |
boolean
Solo salida. Si es verdadero, esta métrica calculada tiene una referencia de métrica no válida. Cualquier elemento que use una métrica calculada con invalidMetricReference configurado como verdadero puede fallar, generar advertencias o resultados inesperados.
|
MetricUnit
Tipos posibles para representar el valor de la métrica calculada.
Enumeraciones |
METRIC_UNIT_UNSPECIFIED |
MetricUnit no especificada o faltante. |
STANDARD |
Esta métrica usa unidades predeterminadas. |
CURRENCY |
Esta métrica mide una moneda. |
FEET |
Esta métrica mide los pies. |
MILES |
Esta métrica mide las millas. |
METERS |
Esta métrica mide en metros. |
KILOMETERS |
Esta métrica mide kilómetros. |
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. |
RestrictedMetricType
Etiquetas que marcan los datos en la métrica calculada que se usan junto con los roles del usuario que restringen el acceso a las métricas de costos o ingresos.
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 |
|
Crea una CalculatedMetric. |
|
Borra una CalculatedMetric en una propiedad. |
|
Búsqueda de una sola CalculatedMetric. |
|
Muestra una lista de CalculatedMetrics en una propiedad. |
|
Actualiza una CalculatedMetric 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\u003e\u003ccode\u003eCalculatedMetric\u003c/code\u003e allows you to create custom metrics using formulas based on existing metrics and parameters, with options for units like currency, time, or distance.\u003c/p\u003e\n"],["\u003cp\u003eYou can define the display name, description, and formula for your custom metric, along with specifying its unit of measurement.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Analytics provides a dedicated resource and API for managing calculated metrics, allowing you to create, update, delete, and list them within your properties.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCalculatedMetric\u003c/code\u003e resources have fields indicating if they contain cost or revenue data or have invalid metric references.\u003c/p\u003e\n"]]],["Calculated metrics are defined with a name, description, display name, and a unique ID. They also specify a `metricUnit` (e.g., standard, currency, feet) and can contain `restrictedMetricTypes` (cost or revenue data). The `formula` field defines the metric's calculation, supporting basic arithmetic. Methods include creating, deleting, retrieving, listing, and updating calculated metrics. Metrics can reference up to five custom metrics. `invalidMetricReference` flag indicates issues.\n"],null,["- [Resource: CalculatedMetric](#CalculatedMetric)\n - [JSON representation](#CalculatedMetric.SCHEMA_REPRESENTATION)\n- [MetricUnit](#MetricUnit)\n- [RestrictedMetricType](#RestrictedMetricType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CalculatedMetric A definition for a calculated metric.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"description\": string, \"displayName\": string, \"calculatedMetricId\": string, \"metricUnit\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#MetricUnit), \"restrictedMetricType\": [ enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#RestrictedMetricType) ], \"formula\": string, \"invalidMetricReference\": boolean } ``` |\n\n| Fields ||\n|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}' |\n| `description` | `string` Optional. Description for this calculated metric. Max length of 4096 characters. |\n| `displayName` | `string` Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters. |\n| `calculatedMetricId` | `string` Output only. The ID to use for the calculated metric. In the UI, this is referred to as the \"API name.\" The calculatedMetricId is used when referencing this calculated metric from external APIs. For example, \"calcMetric:{calculatedMetricId}\". |\n| `metricUnit` | `enum (`[MetricUnit](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#MetricUnit)`)` Required. The type for the calculated metric's value. |\n| `restrictedMetricType[]` | `enum (`[RestrictedMetricType](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#RestrictedMetricType)`)` Output only. Types of restricted data that this metric contains. |\n| `formula` | `string` Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), \\* (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: \"( customEvent:parameterName + cartPurchaseQuantity ) / 2.0\" |\n| `invalidMetricReference` | `boolean` Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalidMetricReference set to true may fail, produce warnings, or produce unexpected results. |\n\nMetricUnit Possible types of representing the calculated metric's value.\n\n| Enums ||\n|---------------------------|------------------------------------|\n| `METRIC_UNIT_UNSPECIFIED` | MetricUnit unspecified or missing. |\n| `STANDARD` | This metric uses default units. |\n| `CURRENCY` | This metric measures a currency. |\n| `FEET` | This metric measures feet. |\n| `MILES` | This metric measures miles. |\n| `METERS` | This metric measures meters. |\n| `KILOMETERS` | This metric measures kilometers. |\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\nRestrictedMetricType Labels that mark the data in calculated metric used in conjunction with user roles that restrict access to cost and/or revenue metrics.\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| [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics/create) | Creates a CalculatedMetric. |\n| [delete](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics/delete) | Deletes a CalculatedMetric on a property. |\n| [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics/get) | Lookup for a single CalculatedMetric. |\n| [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics/list) | Lists CalculatedMetrics on a property. |\n| [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics/patch) | Updates a CalculatedMetric on a property. |"]]