سرور MCP را برای Google Analytics امتحان کنید. از
GitHub نصب کنید و برای جزئیات بیشتر به
اطلاعیه مراجعه کنید.
REST Resource: properties.calculatedMetrics
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
منبع: CalculatedMetric
تعریفی برای یک متریک محاسبه شده
| نمایندگی JSON |
|---|
{
"name": string,
"description": string,
"displayName": string,
"calculatedMetricId": string,
"metricUnit": enum (MetricUnit),
"restrictedMetricType": [
enum (RestrictedMetricType)
],
"formula": string,
"invalidMetricReference": boolean
} |
| فیلدها |
|---|
name | string فقط خروجی نام منبع برای این CalculatedMetric. قالب: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}' |
description | string اختیاری. توضیحات برای این متریک محاسبه شده. حداکثر طول 4096 کاراکتر. |
displayName | string مورد نیاز. نام نمایشی برای این معیار محاسبه شده همانطور که در رابط کاربری Google Analytics نشان داده شده است. حداکثر طول 82 کاراکتر. |
calculatedMetricId | string فقط خروجی شناسه مورد استفاده برای متریک محاسبه شده. در UI، این به عنوان "نام API" نامیده می شود. محاسبه‌شدهMetricId هنگام ارجاع به این معیار محاسبه‌شده از APIهای خارجی استفاده می‌شود. به عنوان مثال، "calcMetric:{calculatedMetricId}". |
metricUnit | enum ( MetricUnit ) مورد نیاز. نوع مقدار متریک محاسبه شده. |
restrictedMetricType[] | enum ( RestrictedMetricType ) فقط خروجی انواع داده های محدود شده که این معیار شامل می شود. |
formula | string مورد نیاز. تعریف متریک محاسبه شده حداکثر تعداد معیارهای سفارشی مرجع منحصر به فرد 5 است. فرمول ها از عملیات زیر پشتیبانی می کنند: + (جمع)، - (تفریق)، - (منفی)، * (ضرب)، / (تقسیم)، () (پرانتز). هر عدد واقعی معتبری قابل قبول است که در یک Long (عدد صحیح 64 بیتی) یا یک دو (عدد ممیز شناور 64 بیتی) قرار گیرد. فرمول مثال: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0" |
invalidMetricReference | boolean فقط خروجی اگر درست باشد، این معیار محاسبه شده دارای یک مرجع متریک نامعتبر است. هر چیزی که از یک متریک محاسبه‌شده استفاده می‌کند و invalidMetricReference روی درست تنظیم شده است، ممکن است شکست بخورد، اخطار ایجاد کند یا نتایج غیرمنتظره ایجاد کند. |
واحد متریک
انواع احتمالی نمایش مقدار متریک محاسبه شده.
| Enums |
|---|
METRIC_UNIT_UNSPECIFIED | واحد متریک مشخص نشده یا وجود ندارد. |
STANDARD | این معیار از واحدهای پیش فرض استفاده می کند. |
CURRENCY | این معیار یک واحد پولی را اندازه گیری می کند. |
FEET | این متریک پاها را اندازه گیری می کند. |
MILES | این متریک مایل ها را اندازه گیری می کند. |
METERS | این متریک متر را اندازه گیری می کند. |
KILOMETERS | این متریک کیلومتر را اندازه گیری می کند. |
MILLISECONDS | این متریک میلی ثانیه را اندازه گیری می کند. |
SECONDS | این متریک ثانیه ها را اندازه گیری می کند. |
MINUTES | این متریک دقیقه ها را اندازه گیری می کند. |
HOURS | این متریک ساعت ها را اندازه گیری می کند. |
RestrictedMetricType
برچسب‌هایی که داده‌ها را در معیارهای محاسبه‌شده علامت‌گذاری می‌کنند، در ارتباط با نقش‌های کاربر که دسترسی به معیارهای هزینه و/یا درآمد را محدود می‌کنند، استفاده می‌شوند.
| Enums |
|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED | تایپ ناشناخته یا نامشخص |
COST_DATA | داده های هزینه گزارش های متریک |
REVENUE_DATA | Metric داده های درآمد را گزارش می دهد. |
روش ها |
|---|
| یک CalculatedMetric ایجاد می کند. |
| یک متریک محاسبه شده را در یک ویژگی حذف می کند. |
| جستجو برای یک CalculatedMetric واحد. |
| CalculatedMetrics را در یک ویژگی فهرست می کند. |
| یک متریک محاسبه شده را در یک ویژگی به روز می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\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,["# REST Resource: properties.calculatedMetrics\n\n- [Resource: CalculatedMetric](#CalculatedMetric)\n - [JSON representation](#CalculatedMetric.SCHEMA_REPRESENTATION)\n- [MetricUnit](#MetricUnit)\n- [RestrictedMetricType](#RestrictedMetricType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CalculatedMetric\n--------------------------\n\nA 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\n----------\n\nPossible 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\n--------------------\n\nLabels 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. |"]]
