Method: properties.keyEvents.list

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

درخواست HTTP

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/keyEvents

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
parent

string

الزامی. نام منبعِ ویژگیِ والد. مثال: 'properties/123'

پارامترهای پرس و جو

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد منابعی که باید برگردانده شوند. اگر مشخص نشود، حداکثر ۵۰ منبع برگردانده خواهد شد. حداکثر مقدار ۲۰۰ است؛ (مقادیر بالاتر به حداکثر مقدار خود محدود می‌شوند)

pageToken

string

اختیاری. یک توکن صفحه، که از فراخوانی قبلی keyEvents.list دریافت شده است. این را برای بازیابی صفحه بعدی ارائه دهید. هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده به keyEvents.list باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای keyEvents.list RPC.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "keyEvents": [
    {
      object (KeyEvent)
    }
  ],
  "nextPageToken": string
}
فیلدها
keyEvents[]

object ( KeyEvent )

رویدادهای کلیدی درخواستی

nextPageToken

string

یک توکن، که می‌تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این فیلد حذف شود، صفحات بعدی وجود نخواهند داشت.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit