سرور MCP را برای Google Analytics امتحان کنید. از
GitHub نصب کنید و برای جزئیات بیشتر به
اطلاعیه مراجعه کنید.
REST Resource: properties.keyEvents
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
منبع: KeyEvent
یک رویداد کلیدی در ویژگی Google Analytics.
| نمایندگی JSON |
|---|
{
"name": string,
"eventName": string,
"createTime": string,
"deletable": boolean,
"custom": boolean,
"countingMethod": enum (CountingMethod),
"defaultValue": {
object (DefaultValue)
}
} |
| فیلدها |
|---|
name | string فقط خروجی نام منبع این رویداد کلیدی. قالب: خواص/{property}/keyEvents/{keyEvent} |
eventName | string تغییرناپذیر. نام رویداد برای این رویداد کلیدی. مثال‌ها: «کلیک»، «خرید» |
createTime | string ( Timestamp format) فقط خروجی زمانی که این رویداد کلیدی در ملک ایجاد شد. از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" . |
deletable | boolean فقط خروجی اگر روی true تنظیم شود، این رویداد قابل حذف است. |
custom | boolean فقط خروجی اگر روی true تنظیم شود، این رویداد کلیدی به یک رویداد سفارشی اشاره دارد. اگر روی false تنظیم شود، این رویداد کلیدی به یک رویداد پیش‌فرض در GA اشاره می‌کند. رویدادهای پیش‌فرض معمولاً در GA معنای خاصی دارند. رویدادهای پیش‌فرض معمولاً توسط سیستم GA برای شما ایجاد می‌شوند، اما در برخی موارد می‌توانند توسط مدیران دارایی ایجاد شوند. رویدادهای سفارشی برای حداکثر تعداد رویدادهای کلیدی سفارشی که ممکن است در هر ویژگی ایجاد شوند، حساب می‌شوند. |
countingMethod | enum ( CountingMethod ) مورد نیاز. روشی که با آن رویدادهای کلیدی در چندین رویداد در یک جلسه شمارش می‌شوند. |
defaultValue | object ( DefaultValue ) اختیاری. مقدار/ارز پیش‌فرض را برای یک رویداد کلیدی تعریف می‌کند. |
روش شمارش
روشی که با آن رویدادهای کلیدی در چندین رویداد در یک جلسه شمارش می‌شوند.
| Enums |
|---|
COUNTING_METHOD_UNSPECIFIED | روش شمارش مشخص نشده است. |
ONCE_PER_EVENT | هر نمونه رویداد به عنوان یک رویداد کلیدی در نظر گرفته می شود. |
ONCE_PER_SESSION | یک نمونه رویداد حداکثر یک بار در هر جلسه برای هر کاربر یک رویداد کلیدی در نظر گرفته می شود. |
مقدار پیش فرض
مقدار/ارز پیش‌فرض را برای یک رویداد کلیدی تعریف می‌کند.
| نمایندگی JSON |
|---|
{
"numericValue": number,
"currencyCode": string
} |
| فیلدها |
|---|
numericValue | number مورد نیاز. این برای پر کردن پارامتر "value" برای همه رخدادهای این رویداد کلیدی (مشخص شده توسط eventName) در جایی که آن پارامتر تنظیم نشده است، استفاده خواهد شد. |
currencyCode | string مورد نیاز. هنگامی که یک رویداد از این رویداد کلیدی (مشخص شده توسط eventName) فاقد ارز تنظیم شده باشد، این ارز به عنوان پیش‌فرض اعمال می‌شود. باید در قالب کد ارز ISO 4217 باشد. برای اطلاعات بیشتر به https://en.wikipedia.org/wiki/ISO_4217 مراجعه کنید. |
روش ها |
|---|
| یک رویداد کلیدی ایجاد می کند. |
| یک رویداد کلیدی را حذف می کند. |
| یک رویداد کلیدی را بازیابی کنید. |
| فهرستی از رویدادهای کلیدی را در ویژگی والد مشخص شده برمی گرداند. |
| یک رویداد کلیدی را به روز می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eKey Events are actions or interactions within a Google Analytics property that can be tracked and analyzed, with options for how they are counted during a session.\u003c/p\u003e\n"],["\u003cp\u003eYou can define a default numeric value and currency for a Key Event to automatically populate these parameters for instances where they are not explicitly set.\u003c/p\u003e\n"],["\u003cp\u003eThere are methods available to create, retrieve, update, and delete Key Events within a property via the API.\u003c/p\u003e\n"],["\u003cp\u003eKey Events can be either custom, defined by property admins, or default, with pre-defined meanings within Google Analytics.\u003c/p\u003e\n"]]],["Key Events in Google Analytics are defined by an event name and can be associated with a counting method (once per event or session). Each Key Event includes attributes like its creation time, custom status, and deletable status. They have optional default values, consisting of a numeric value and currency code. Key Events can be created, deleted, retrieved, listed, and updated using provided methods. The resource includes JSON schema for the data structure.\n"],null,["# REST Resource: properties.keyEvents\n\n- [Resource: KeyEvent](#KeyEvent)\n - [JSON representation](#KeyEvent.SCHEMA_REPRESENTATION)\n- [CountingMethod](#CountingMethod)\n- [DefaultValue](#DefaultValue)\n - [JSON representation](#DefaultValue.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: KeyEvent\n------------------\n\nA key event in a Google Analytics property.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"eventName\": string, \"createTime\": string, \"deletable\": boolean, \"custom\": boolean, \"countingMethod\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#CountingMethod), \"defaultValue\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#DefaultValue) } } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{keyEvent} |\n| `eventName` | `string` Immutable. The event name for this key event. Examples: 'click', 'purchase' |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. Time when this key event was created in the property. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `deletable` | `boolean` Output only. If set to true, this event can be deleted. |\n| `custom` | `boolean` Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property. |\n| `countingMethod` | `enum (`[CountingMethod](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#CountingMethod)`)` Required. The method by which Key Events will be counted across multiple events within a session. |\n| `defaultValue` | `object (`[DefaultValue](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#DefaultValue)`)` Optional. Defines a default value/currency for a key event. |\n\nCountingMethod\n--------------\n\nThe method by which Key Events will be counted across multiple events within a session.\n\n| Enums ||\n|-------------------------------|--------------------------------------------------------------------------------|\n| `COUNTING_METHOD_UNSPECIFIED` | Counting method not specified. |\n| `ONCE_PER_EVENT` | Each Event instance is considered a Key Event. |\n| `ONCE_PER_SESSION` | An Event instance is considered a Key Event at most once per session per user. |\n\nDefaultValue\n------------\n\nDefines a default value/currency for a key event.\n\n| JSON representation |\n|------------------------------------------------------------|\n| ``` { \"numericValue\": number, \"currencyCode\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `numericValue` | `number` Required. This will be used to populate the \"value\" parameter for all occurrences of this Key Event (specified by eventName) where that parameter is unset. |\n| `currencyCode` | `string` Required. When an occurrence of this Key Event (specified by eventName) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See \u003chttps://en.wikipedia.org/wiki/ISO_4217\u003e for more information. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------------|----------------------------------------------------------------|\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/create) | Creates a Key Event. |\n| ### [delete](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/delete) | Deletes a Key Event. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/get) | Retrieve a single Key Event. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/list) | Returns a list of Key Events in the specified parent property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/patch) | Updates a Key Event. |"]]
