File: games_v1.metagame.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (153 lines) | stat: -rw-r--r-- 5,135 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="games_v1.html">Google Play Game Services API</a> . <a href="games_v1.metagame.html">metagame</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#getMetagameConfig">getMetagameConfig()</a></code></p>
<p class="firstline">Return the metagame configuration data for the calling application.</p>
<p class="toc_element">
  <code><a href="#listCategoriesByPlayer">listCategoriesByPlayer(playerId, collection, language=None, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List play data aggregated per category for the player corresponding to playerId.</p>
<p class="toc_element">
  <code><a href="#listCategoriesByPlayer_next">listCategoriesByPlayer_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="getMetagameConfig">getMetagameConfig()</code>
  <pre>Return the metagame configuration data for the calling application.

Args:

Returns:
  An object of the form:

    { # This is a JSON template for the metagame config resource
    "kind": "games#metagameConfig", # Uniquely identifies the type of this resource. Value is always the fixed string games#metagameConfig.
    "currentVersion": 42, # Current version of the metagame configuration data. When this data is updated, the version number will be increased by one.
    "playerLevels": [ # The list of player levels.
      { # This is a JSON template for 1P/3P metadata about a user's level.
        "maxExperiencePoints": "A String", # The maximum experience points for this level.
        "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
        "minExperiencePoints": "A String", # The minimum experience points for this level.
        "level": 42, # The level for the user.
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="listCategoriesByPlayer">listCategoriesByPlayer(playerId, collection, language=None, pageToken=None, maxResults=None)</code>
  <pre>List play data aggregated per category for the player corresponding to playerId.

Args:
  playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
  collection: string, The collection of categories for which data will be returned. (required)
    Allowed values
      all - Retrieve data for all categories. This is the default.
  language: string, The preferred language to use for strings returned by this method.
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of category resources to return in the response, used for paging. For any response, the actual number of category resources returned may be less than the specified maxResults.

Returns:
  An object of the form:

    { # This is a JSON template for a list of category data objects.
    "nextPageToken": "A String", # Token corresponding to the next page of results.
    "items": [ # The list of categories with usage data.
      { # This is a JSON template for data related to individual game categories.
        "category": "A String", # The category name.
        "experiencePoints": "A String", # Experience points earned in this category.
        "kind": "games#category", # Uniquely identifies the type of this resource. Value is always the fixed string games#category.
      },
    ],
    "kind": "games#categoryListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#categoryListResponse.
  }</pre>
</div>

<div class="method">
    <code class="details" id="listCategoriesByPlayer_next">listCategoriesByPlayer_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

</body></html>