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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
|
<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 Games Services API</a> . <a href="games_v1.scores.html">scores</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, `leaderboardId` can be set to `ALL` to retrieve data for all leaderboards in a given time span. `NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.</p>
<p class="toc_element">
<code><a href="#get_next">get_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list">list(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the scores in a leaderboard, starting from the top.</p>
<p class="toc_element">
<code><a href="#listWindow">listWindow(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, resultsAbove=None, returnTopIfAbsent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the scores in a leaderboard around (and including) a player's score.</p>
<p class="toc_element">
<code><a href="#listWindow_next">listWindow_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#submit">submit(leaderboardId, score, language=None, scoreTag=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submits a score to the specified leaderboard.</p>
<p class="toc_element">
<code><a href="#submitMultiple">submitMultiple(body=None, language=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submits multiple scores to leaderboards.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, `leaderboardId` can be set to `ALL` to retrieve data for all leaderboards in a given time span. `NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.
Args:
playerId: string, A player ID. A value of `me` may be used in place of the authenticated player's ID. (required)
leaderboardId: string, The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application. (required)
timeSpan: string, The time span for the scores and ranks you're requesting. (required)
Allowed values
ALL - Get the high scores for all time spans. If this is used, maxResults values will be ignored.
ALL_TIME - Get the all time high score.
WEEKLY - List the top scores for the current day.
DAILY - List the top scores for the current week.
includeRankType: string, The types of ranks to return. If the parameter is omitted, no ranks will be returned.
Allowed values
ALL - Retrieve all supported ranks. In HTTP, this parameter value can also be specified as `ALL`.
PUBLIC - Retrieve public ranks, if the player is sharing their gameplay activity publicly.
SOCIAL - (Obsolete) Retrieve the social rank.
FRIENDS - Retrieve the rank on the friends collection.
language: string, The preferred language to use for strings returned by this method.
maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of player leaderboard scores.
"items": [ # The leaderboard scores.
{ # A player leaderboard score object.
"friendsRank": { # A score rank in a leaderboard. # The rank of the score in the friends collection for this leaderboard.
"formattedNumScores": "A String", # The number of scores in the leaderboard as a string.
"formattedRank": "A String", # The rank in the leaderboard as a string.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.
"numScores": "A String", # The number of scores in the leaderboard.
"rank": "A String", # The rank in the leaderboard.
},
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScore`.
"leaderboard_id": "A String", # The ID of the leaderboard this score is in.
"publicRank": { # A score rank in a leaderboard. # The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.
"formattedNumScores": "A String", # The number of scores in the leaderboard as a string.
"formattedRank": "A String", # The rank in the leaderboard as a string.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.
"numScores": "A String", # The number of scores in the leaderboard.
"rank": "A String", # The rank in the leaderboard.
},
"scoreString": "A String", # The formatted value of this score.
"scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"scoreValue": "A String", # The numerical value of this score.
"socialRank": { # A score rank in a leaderboard. # The social rank of the score in this leaderboard.
"formattedNumScores": "A String", # The number of scores in the leaderboard as a string.
"formattedRank": "A String", # The rank in the leaderboard as a string.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.
"numScores": "A String", # The number of scores in the leaderboard.
"rank": "A String", # The rank in the leaderboard.
},
"timeSpan": "A String", # The time span of this score.
"writeTimestamp": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
},
],
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScoreListResponse`.
"nextPageToken": "A String", # The pagination token for the next page of results.
"player": { # A Player resource. # The Player resources for the owner of this score.
"avatarImageUrl": "A String", # The base URL for the image that represents the player.
"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
"displayName": "A String", # The name to display for the player.
"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
"currentExperiencePoints": "A String", # The current number of experience points for the player.
"currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
"nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
},
"friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
"gamePlayerId": "A String", # Per-application unique player identifier.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
"name": { # A representation of the individual components of the name.
"familyName": "A String", # The family name of this player. In some places, this is known as the last name.
"givenName": "A String", # The given name of this player. In some places, this is known as the first name.
},
"originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
"playerId": "A String", # The ID of the player.
"profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
"friendsListVisibility": "A String",
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
"profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
},
"title": "A String", # The player's title rewarded for their game activities.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get_next">get_next()</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>
<div class="method">
<code class="details" id="list">list(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the scores in a leaderboard, starting from the top.
Args:
leaderboardId: string, The ID of the leaderboard. (required)
collection: string, The collection of scores you're requesting. (required)
Allowed values
PUBLIC - List all scores in the public leaderboard.
SOCIAL - (Obsolete) Legacy G+ social scores.
FRIENDS - List only scores of friends.
timeSpan: string, Required. The time span for the scores and ranks you're requesting. (required)
Allowed values
ALL_TIME - The score is an all-time score.
WEEKLY - The score is a weekly score.
DAILY - The score is a daily score.
language: string, The preferred language to use for strings returned by this method.
maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.
pageToken: string, The token returned by the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A ListScores response.
"items": [ # The scores in the leaderboard.
{ # The Leaderboard Entry resource.
"formattedScore": "A String", # The localized string for the numerical value of this score.
"formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
"player": { # A Player resource. # The player who holds this score.
"avatarImageUrl": "A String", # The base URL for the image that represents the player.
"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
"displayName": "A String", # The name to display for the player.
"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
"currentExperiencePoints": "A String", # The current number of experience points for the player.
"currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
"nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
},
"friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
"gamePlayerId": "A String", # Per-application unique player identifier.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
"name": { # A representation of the individual components of the name.
"familyName": "A String", # The family name of this player. In some places, this is known as the last name.
"givenName": "A String", # The given name of this player. In some places, this is known as the first name.
},
"originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
"playerId": "A String", # The ID of the player.
"profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
"friendsListVisibility": "A String",
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
"profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
},
"title": "A String", # The player's title rewarded for their game activities.
},
"scoreRank": "A String", # The rank of this score for this leaderboard.
"scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"scoreValue": "A String", # The numerical value of this score.
"timeSpan": "A String", # The time span of this high score.
"writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
},
],
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScores`.
"nextPageToken": "A String", # The pagination token for the next page of results.
"numScores": "A String", # The total number of scores in the leaderboard.
"playerScore": { # The Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the `scoreRank`and `formattedScoreRank` values will not be present.
"formattedScore": "A String", # The localized string for the numerical value of this score.
"formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
"player": { # A Player resource. # The player who holds this score.
"avatarImageUrl": "A String", # The base URL for the image that represents the player.
"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
"displayName": "A String", # The name to display for the player.
"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
"currentExperiencePoints": "A String", # The current number of experience points for the player.
"currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
"nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
},
"friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
"gamePlayerId": "A String", # Per-application unique player identifier.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
"name": { # A representation of the individual components of the name.
"familyName": "A String", # The family name of this player. In some places, this is known as the last name.
"givenName": "A String", # The given name of this player. In some places, this is known as the first name.
},
"originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
"playerId": "A String", # The ID of the player.
"profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
"friendsListVisibility": "A String",
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
"profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
},
"title": "A String", # The player's title rewarded for their game activities.
},
"scoreRank": "A String", # The rank of this score for this leaderboard.
"scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"scoreValue": "A String", # The numerical value of this score.
"timeSpan": "A String", # The time span of this high score.
"writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
},
"prevPageToken": "A String", # The pagination token for the previous page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="listWindow">listWindow(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None, resultsAbove=None, returnTopIfAbsent=None, x__xgafv=None)</code>
<pre>Lists the scores in a leaderboard around (and including) a player's score.
Args:
leaderboardId: string, The ID of the leaderboard. (required)
collection: string, The collection of scores you're requesting. (required)
Allowed values
PUBLIC - List all scores in the public leaderboard.
SOCIAL - (Obsolete) Legacy G+ social scores.
FRIENDS - List only scores of friends.
timeSpan: string, Required. The time span for the scores and ranks you're requesting. (required)
Allowed values
ALL_TIME - The score is an all-time score.
WEEKLY - The score is a weekly score.
DAILY - The score is a daily score.
language: string, The preferred language to use for strings returned by this method.
maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.
pageToken: string, The token returned by the previous request.
resultsAbove: integer, The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
returnTopIfAbsent: boolean, True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A ListScores response.
"items": [ # The scores in the leaderboard.
{ # The Leaderboard Entry resource.
"formattedScore": "A String", # The localized string for the numerical value of this score.
"formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
"player": { # A Player resource. # The player who holds this score.
"avatarImageUrl": "A String", # The base URL for the image that represents the player.
"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
"displayName": "A String", # The name to display for the player.
"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
"currentExperiencePoints": "A String", # The current number of experience points for the player.
"currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
"nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
},
"friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
"gamePlayerId": "A String", # Per-application unique player identifier.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
"name": { # A representation of the individual components of the name.
"familyName": "A String", # The family name of this player. In some places, this is known as the last name.
"givenName": "A String", # The given name of this player. In some places, this is known as the first name.
},
"originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
"playerId": "A String", # The ID of the player.
"profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
"friendsListVisibility": "A String",
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
"profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
},
"title": "A String", # The player's title rewarded for their game activities.
},
"scoreRank": "A String", # The rank of this score for this leaderboard.
"scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"scoreValue": "A String", # The numerical value of this score.
"timeSpan": "A String", # The time span of this high score.
"writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
},
],
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScores`.
"nextPageToken": "A String", # The pagination token for the next page of results.
"numScores": "A String", # The total number of scores in the leaderboard.
"playerScore": { # The Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the `scoreRank`and `formattedScoreRank` values will not be present.
"formattedScore": "A String", # The localized string for the numerical value of this score.
"formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
"player": { # A Player resource. # The player who holds this score.
"avatarImageUrl": "A String", # The base URL for the image that represents the player.
"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
"displayName": "A String", # The name to display for the player.
"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
"currentExperiencePoints": "A String", # The current number of experience points for the player.
"currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
"nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
"level": 42, # The level for the user.
"maxExperiencePoints": "A String", # The maximum experience points for this level.
"minExperiencePoints": "A String", # The minimum experience points for this level.
},
},
"friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.
"gamePlayerId": "A String", # Per-application unique player identifier.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
"name": { # A representation of the individual components of the name.
"familyName": "A String", # The family name of this player. In some places, this is known as the last name.
"givenName": "A String", # The given name of this player. In some places, this is known as the first name.
},
"originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
"playerId": "A String", # The ID of the player.
"profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
"friendsListVisibility": "A String",
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
"profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
},
"title": "A String", # The player's title rewarded for their game activities.
},
"scoreRank": "A String", # The rank of this score for this leaderboard.
"scoreTag": "A String", # Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"scoreValue": "A String", # The numerical value of this score.
"timeSpan": "A String", # The time span of this high score.
"writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
},
"prevPageToken": "A String", # The pagination token for the previous page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="listWindow_next">listWindow_next()</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>
<div class="method">
<code class="details" id="list_next">list_next()</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>
<div class="method">
<code class="details" id="submit">submit(leaderboardId, score, language=None, scoreTag=None, x__xgafv=None)</code>
<pre>Submits a score to the specified leaderboard.
Args:
leaderboardId: string, The ID of the leaderboard. (required)
score: string, Required. The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units. (required)
language: string, The preferred language to use for strings returned by this method.
scoreTag: string, Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of leaderboard entry resources.
"beatenScoreTimeSpans": [ # The time spans where the submitted score is better than the existing score for that time span.
"A String",
],
"formattedScore": "A String", # The formatted value of the submitted score.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreResponse`.
"leaderboardId": "A String", # The leaderboard ID that this score was submitted to.
"scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"unbeatenScores": [ # The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's `DAILY` score, but not better than the player's scores for the `WEEKLY` or `ALL_TIME` time spans.
{ # A player score.
"formattedScore": "A String", # The formatted score for this player score.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScore`.
"score": "A String", # The numerical value for this player score.
"scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"timeSpan": "A String", # The time span for this player score.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="submitMultiple">submitMultiple(body=None, language=None, x__xgafv=None)</code>
<pre>Submits multiple scores to leaderboards.
Args:
body: object, The request body.
The object takes the form of:
{ # A list of score submission requests.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreSubmissionList`.
"scores": [ # The score submissions.
{ # A request to submit a score to leaderboards.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#scoreSubmission`.
"leaderboardId": "A String", # The leaderboard this score is being submitted to.
"score": "A String", # The new score being submitted.
"scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"signature": "A String", # Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986.
},
],
}
language: string, The preferred language to use for strings returned by this method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of score submission statuses.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreListResponse`.
"submittedScores": [ # The score submissions statuses.
{ # A list of leaderboard entry resources.
"beatenScoreTimeSpans": [ # The time spans where the submitted score is better than the existing score for that time span.
"A String",
],
"formattedScore": "A String", # The formatted value of the submitted score.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreResponse`.
"leaderboardId": "A String", # The leaderboard ID that this score was submitted to.
"scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"unbeatenScores": [ # The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's `DAILY` score, but not better than the player's scores for the `WEEKLY` or `ALL_TIME` time spans.
{ # A player score.
"formattedScore": "A String", # The formatted score for this player score.
"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScore`.
"score": "A String", # The numerical value for this player score.
"scoreTag": "A String", # Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
"timeSpan": "A String", # The time span for this player score.
},
],
},
],
}</pre>
</div>
</body></html>
|
