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)

فقط خروجی زمانی که این رویداد کلیدی در ملک ایجاد شد.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

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 مراجعه کنید.

روش ها

create

یک رویداد کلیدی ایجاد می کند.

delete

یک رویداد کلیدی را حذف می کند.

get

یک رویداد کلیدی را بازیابی کنید.

list

فهرستی از رویدادهای کلیدی را در ویژگی والد مشخص شده برمی گرداند.

patch

یک رویداد کلیدی را به روز می کند.