Method: events.listDefinitions

इस ऐप्लिकेशन में इवेंट की परिभाषाओं की सूची दिखाता है.

एचटीटीपी अनुरोध

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

इवेंट को दिखाने वाली इमेज का बेस यूआरएल.

childEvents[]

object (EventChild)

उन इवेंट की सूची जो इस इवेंट के चाइल्ड हैं.

description

string

इस इवेंट के बारे में जानकारी.

isDefaultImageUrl

boolean

इससे पता चलता है कि दिखाई जा रही आइकॉन इमेज एक डिफ़ॉल्ट इमेज है या गेम से मिली इमेज है.

kind

string

इस संसाधन के टाइप की अलग-अलग पहचान करता है. यह वैल्यू हमेशा तय की गई स्ट्रिंग games#eventDefinition होती है.

EventVisibility

इवेंट किसको दिखे, इसके लिए संभावित वैल्यू.

Enums
REVEALED यह इवेंट सभी उपयोगकर्ताओं को दिखना चाहिए.
HIDDEN यह इवेंट सिर्फ़ उन उपयोगकर्ताओं को दिखाया जाना चाहिए जिन्होंने इस इवेंट को कम से कम एक बार रिकॉर्ड किया है.

EventChild

किसी इवेंट के बच्चों के संबंध में जानकारी देने वाला संसाधन.

JSON के काेड में दिखाना
{
  "childId": string,
  "kind": string
}
फ़ील्ड
childId

string

चाइल्ड इवेंट का आईडी.

kind

string

इस संसाधन के टाइप की अलग-अलग पहचान करता है. यह वैल्यू हमेशा तय की गई स्ट्रिंग games#eventChild होती है.