Method: events.listDefinitions

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

طلب HTTP

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

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

المعلمات
language

string

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

integer

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

string

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

نص الطلب

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

نص الاستجابة

يشير ذلك المصطلح إلى رد في قائمة التعريفات.

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

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