REST Resource: properties.keyEvents

منبع: KeyEvent

یک رویداد کلیدی در یک ویژگی گوگل آنالیتیکس.

نمایش JSON 
{
  "name": string,
  "eventName": string,
  "createTime": string,
  "deletable": boolean,
  "custom": boolean,
  "countingMethod": enum (CountingMethod),
  "defaultValue": {
    object (DefaultValue)
  }
}
فیلدها
name

string

فقط خروجی. نام منبع این رویداد کلید. قالب: properties/{property}/keyEvents/{keyEvent}

eventName

string

تغییرناپذیر. نام رویداد برای این رویداد کلیدی. مثال‌ها: «کلیک»، «خرید»

createTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

deletable

boolean

فقط خروجی. اگر روی درست تنظیم شود، این رویداد می‌تواند حذف شود.

custom

boolean

فقط خروجی. اگر روی true تنظیم شود، این رویداد کلیدی به یک رویداد سفارشی اشاره دارد. اگر روی false تنظیم شود، این رویداد کلیدی به یک رویداد پیش‌فرض در GA اشاره دارد. رویدادهای پیش‌فرض معمولاً معنای خاصی در GA دارند. رویدادهای پیش‌فرض معمولاً توسط سیستم GA برای شما ایجاد می‌شوند، اما در برخی موارد می‌توانند توسط مدیران ویژگی ایجاد شوند. رویدادهای سفارشی جزو حداکثر تعداد رویدادهای کلیدی سفارشی هستند که ممکن است برای هر ویژگی ایجاد شوند.

countingMethod

enum ( CountingMethod )

الزامی. روشی که رویدادهای کلیدی در چندین رویداد در یک جلسه شمارش می‌شوند.

defaultValue

object ( DefaultValue )

اختیاری. یک مقدار/ارز پیش‌فرض برای یک رویداد کلیدی تعریف می‌کند.

روش شمارش

روشی که رویدادهای کلیدی در چندین رویداد در یک جلسه شمارش می‌شوند.

انوم‌ها
COUNTING_METHOD_UNSPECIFIED روش شمارش مشخص نشده است.
ONCE_PER_EVENT هر نمونه رویداد، یک رویداد کلیدی (Key Event) محسوب می‌شود.
ONCE_PER_SESSION یک نمونه رویداد، حداکثر یک بار در هر جلسه برای هر کاربر، به عنوان رویداد کلیدی در نظر گرفته می‌شود.

مقدار پیش‌فرض

یک مقدار/ارز پیش‌فرض برای یک رویداد کلیدی تعریف می‌کند.

نمایش JSON 
{
  "numericValue": number,
  "currencyCode": string
}
فیلدها
numericValue

number

الزامی. این برای پر کردن پارامتر "مقدار" برای همه موارد وقوع این رویداد کلیدی (که توسط eventName مشخص شده است) در جایی که آن پارامتر تنظیم نشده است، استفاده خواهد شد.

currencyCode

string

الزامی. هنگامی که وقوع این رویداد کلیدی (مشخص شده توسط eventName) هیچ ارز مشخصی نداشته باشد، این ارز به عنوان پیش‌فرض اعمال می‌شود. باید در قالب کد ارز ISO 4217 باشد.

برای اطلاعات بیشتر به https://en.wikipedia.org/wiki/ISO_4217 مراجعه کنید.

روش‌ها

create

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

delete

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

get

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

list

 لیستی از رویدادهای کلیدی (Key Events) را در ویژگی والد مشخص شده برمی‌گرداند.

patch

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