Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / games_v1.players.html
blob: 8be444292adf5e32638865b2f14e32ba38472cf5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="games_v1.html">Google Play Game Services</a> . <a href="games_v1.players.html">players</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#get">get(playerId, language=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`.</p>
83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]84 <code><a href="#list">list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Get the collection of players for the currently authenticated user.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96 <code class="details" id="get">get(playerId, language=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <pre>Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98
99Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 playerId: string, A player ID. A value of `me` may be used in place of the authenticated player&#x27;s ID. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101 language: string, The preferred language to use for strings returned by this method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106
107Returns:
108 An object of the form:
109
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]110 { # A Player resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]111 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile is visible to other players.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]113 &quot;friendsListVisibility&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]115 &quot;profileVisible&quot;: True or False, # Whether the player&#x27;s profile is visible to the currently signed in player.
116 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]118 &quot;name&quot;: { # A representation of the individual components of the name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first name.
120 &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]122 &quot;friendStatus&quot;: &quot;A String&quot;, # 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.
123 &quot;originalPlayerId&quot;: &quot;A String&quot;, # 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.
124 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;experienceInfo&quot;: { # 1P/3P metadata about the player&#x27;s experience. # An object to represent Play Game experience information for the player.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]127 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
129 &quot;level&quot;: 42, # The level for the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]130 &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
131 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]132 &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]133 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]134 &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]136 &quot;nextLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
137 &quot;level&quot;: 42, # The level for the user.
138 &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
139 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
140 &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
141 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]143 &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
144 &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
145 &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 }</pre>
147</div>
148
149<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]150 <code class="details" id="list">list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151 <pre>Get the collection of players for the currently authenticated user.
152
153Args:
154 collection: string, Collection of players being retrieved (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 Allowed values
156 CONNECTED - Retrieve a list of players that are also playing this game in reverse chronological order.
157 VISIBLE - Retrieve a list of players in the user&#x27;s social graph that are visible to this game.
158 FRIENDS_ALL - Retrieve a list of players who are friends of the user in alphabetical order.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]159 language: string, The preferred language to use for strings returned by this method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 pageToken: string, The token returned by the previous request.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]161 maxResults: integer, The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified `maxResults`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]166
167Returns:
168 An object of the form:
169
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]170 { # A third party player list response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]171 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token corresponding to the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172 &quot;items&quot;: [ # The players.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]173 { # A Player resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]174 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]175 &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile is visible to other players.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]176 &quot;friendsListVisibility&quot;: &quot;A String&quot;,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]177 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]178 &quot;profileVisible&quot;: True or False, # Whether the player&#x27;s profile is visible to the currently signed in player.
179 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]180 &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]181 &quot;name&quot;: { # A representation of the individual components of the name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]182 &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first name.
183 &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]184 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]185 &quot;friendStatus&quot;: &quot;A String&quot;, # 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.
186 &quot;originalPlayerId&quot;: &quot;A String&quot;, # 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.
187 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]188 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 &quot;experienceInfo&quot;: { # 1P/3P metadata about the player&#x27;s experience. # An object to represent Play Game experience information for the player.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]190 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]191 &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
192 &quot;level&quot;: 42, # The level for the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]193 &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
194 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]195 &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]196 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]197 &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]198 &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]199 &quot;nextLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The next level of the player. If the current level is the maximum level, this should be same as the current level.
200 &quot;level&quot;: 42, # The level for the user.
201 &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
202 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
203 &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
204 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]205 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]206 &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
207 &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
208 &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]209 },
210 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]211 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerListResponse`.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]212 }</pre>
213</div>
214
215<div class="method">
216 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
217 <pre>Retrieves the next page of results.
218
219Args:
220 previous_request: The request for the previous page. (required)
221 previous_response: The response from the request for the previous page. (required)
222
223Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 page. Returns None if there are no more items in the collection.
226 </pre>
227</div>
228
229</body></html>