Method: events.listDefinitions

تعرض قائمة بتعريفات الأحداث في هذا التطبيق.

طلب HTTP

GET https://games.googleapis.com/games/v1/eventDefinitions

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

المَعلمات
language

string

اللغة المفضلة للاستخدام للسلاسل التي تعرضها هذه الطريقة.
maxResults

integer

الحد الأقصى لعدد تعريفات الأحداث المطلوب عرضها في الرد، ويُستخدَم في تقسيم النتائج على عدّة صفحات. بالنسبة إلى أيّ ردّ، قد يكون العدد الفعلي لتعريفات الأحداث المطلوب عرضه أقل من الحدّ الأقصى المحدَّد للأحداث maxResults.
pageToken

string

الرمز المميّز الذي عرضه الطلب السابق

نص الطلب

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

نص الاستجابة

رد Listتعريفات (تعريفات قائمة).

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

تمثيل JSON 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
الحقول
kind

string

يحدِّد نوع هذا المورد بشكلٍ فريد. القيمة هي دائمًا السلسلة الثابتة games#eventDefinitionListResponse.
nextPageToken

string

الرمز المميز لتقسيم النتائج على عدّة صفحات للصفحة التالية من النتائج.
items[]

object (EventDefinition)

تعريفات الأحداث

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

EventDefinition

مورد تعريف الحدث.

تمثيل JSON 
{
  "id": string,
  "visibility": enum (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
الحقول
id

string

رقم تعريف الحدث.
visibility

enum (EventVisibility)

مستوى رؤية الحدث الذي يتم تتبّعه في هذا التعريف.
displayName

string

الاسم الذي سيتم عرضه للحدث.
imageUrl

string

تمثّل هذه السمة عنوان URL الأساسي للصورة التي تمثّل الحدث.
childEvents[]

object (EventChild)

قائمة بالأحداث الثانوية لهذا الحدث.
description

string

وصف لما يمثله هذا الحدث
isDefaultImageUrl

boolean

يحدِّد هذا الحقل ما إذا كانت صورة الرمز التي يتم عرضها هي صورة تلقائية، أو مقدَّمة من لعبة.
kind

string

يحدِّد نوع هذا المورد بشكلٍ فريد. القيمة هي دائمًا السلسلة الثابتة games#eventDefinition.

EventVisibility

القيم المحتملة لمستوى رؤية الحدث.

عمليات التعداد
REVEALED يجب أن يظهر هذا الحدث لجميع المستخدمين.
HIDDEN يجب عرض هذا الحدث للمستخدمين الذين سجّلوا هذا الحدث مرة واحدة على الأقل.

EventChild

مورد للعلاقة الثانوية للحدث

تمثيل JSON 
{
  "childId": string,
  "kind": string
}
الحقول
childId

string

رقم تعريف الحدث الفرعي.
kind

string

يحدِّد نوع هذا المورد بشكلٍ فريد. القيمة هي دائمًا السلسلة الثابتة games#eventChild.