Method: properties.keyEvents.list

تعرِض هذه الطريقة قائمة بالأحداث الرئيسية في الموقع الرئيسي المحدّد. تعرِض هذه الطريقة قائمة فارغة إذا لم يتم العثور على أي أحداث رئيسية.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المَعلمات
parent

string

الحقل مطلوب. اسم المورد الخاص بالخاصية الرئيسية مثال: 'properties/123'

مَعلمات طلب البحث

المَعلمات
pageSize

integer

اختياريّ. الحد الأقصى لعدد الموارد المطلوب عرضها. إذا لم يتم تحديدها، سيتم عرض 50 موردًا على الأكثر. الحد الأقصى للقيمة هو 200 (سيتم فرض الحد الأقصى على القيم الأعلى)
pageToken

string

اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب keyEvents.list سابق. يجب تقديم هذا الرمز لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى keyEvents.list مع الطلب الذي قدّم رمز الصفحة المميز.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة الردّ على استدعاء إجراء عن بُعد keyEvents.list.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل 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