Blame - docs/dyn/games_v1.players.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

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>

Bu Sun Kim

2020-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 Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

78

<code><a href="#get">get(playerId, language=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Retrieves the Player resource with the given ID. To retrieve the player</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

81

<code><a href="#list">list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

82

<p class="firstline">Get the collection of players for the currently authenticated user.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

<h3>Method Details</h3>

87

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

88

<code class="details" id="get">get(playerId, language=None, x__xgafv=None)</code>

89

<pre>Retrieves the Player resource with the given ID. To retrieve the player

90

for the currently authenticated user, set `playerId` to `me`.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

91

92

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

93

playerId: string, A player ID. A value of `me` may be used in place of the

94

authenticated player's ID. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

95

language: string, The preferred language to use for strings returned by this method.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

96

x__xgafv: string, V1 error format.

97

Allowed values

98

1 - v1 error format

99

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

100

101

Returns:

102

An object of the form:

103

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

104

{ # A Player resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

106

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

107

"title": "A String", # The player's title rewarded for their game activities.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

108

"displayName": "A String", # The name to display for the player.

109

"profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile

110

# is visible to other players.

111

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

112

# string `games#profileSettings`.

113

"friendsListVisibility": "A String",

114

"profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.

115

},

116

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

117

# string `games#player`

118

"friendStatus": "A String", # The friend status of the given player, relative to the requester. This is

119

# unset if the player is not sharing their friends list with the game.

120

"name": { # A representation of the individual components of the name.

121

"familyName": "A String", # The family name of this player. In some places, this is known as the last

122

# name.

123

"givenName": "A String", # The given name of this player. In some places, this is known as the first

124

# name.

125

},

126

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

127

"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.

128

"nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level,

129

# this should be same as the current level.

130

"minExperiencePoints": "A String", # The minimum experience points for this level.

131

"maxExperiencePoints": "A String", # The maximum experience points for this level.

132

"level": 42, # The level for the user.

133

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

134

# string `games#playerLevel`.

135

},

136

"currentExperiencePoints": "A String", # The current number of experience points for the player.

137

"currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.

138

"minExperiencePoints": "A String", # The minimum experience points for this level.

139

"maxExperiencePoints": "A String", # The maximum experience points for this level.

140

"level": 42, # The level for the user.

141

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

142

# string `games#playerLevel`.

143

},

144

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch

145

# UTC.

146

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

147

# string `games#playerExperienceInfo`.

148

},

149

"playerId": "A String", # The ID of the player.

150

"originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into

151

# the game in question. This is only populated for calls to player.get for

152

# the requesting player, only if the player ID has subsequently changed, and

153

# only to clients that support remapping player IDs.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

158

<code class="details" id="list">list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

159

<pre>Get the collection of players for the currently authenticated user.

160

161

Args:

162

collection: string, Collection of players being retrieved (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

163

language: string, The preferred language to use for strings returned by this method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

164

pageToken: string, The token returned by the previous request.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

165

maxResults: integer, The maximum number of player resources to return in the response, used for

166

paging. For any response, the actual number of player resources returned

167

may be less than the specified `maxResults`.

168

x__xgafv: string, V1 error format.

169

Allowed values

170

1 - v1 error format

171

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

172

173

Returns:

174

An object of the form:

175

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

176

{ # A third party player list response.

177

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

178

# string `games#playerListResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

179

"items": [ # The players.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

180

{ # A Player resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

181

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

182

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

183

"title": "A String", # The player's title rewarded for their game activities.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

184

"displayName": "A String", # The name to display for the player.

185

"profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile

186

# is visible to other players.

187

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

188

# string `games#profileSettings`.

189

"friendsListVisibility": "A String",

190

"profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.

191

},

192

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

193

# string `games#player`

194

"friendStatus": "A String", # The friend status of the given player, relative to the requester. This is

195

# unset if the player is not sharing their friends list with the game.

196

"name": { # A representation of the individual components of the name.

197

"familyName": "A String", # The family name of this player. In some places, this is known as the last

198

# name.

199

"givenName": "A String", # The given name of this player. In some places, this is known as the first

200

# name.

201

},

202

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

203

"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.

204

"nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level,

205

# this should be same as the current level.

206

"minExperiencePoints": "A String", # The minimum experience points for this level.

207

"maxExperiencePoints": "A String", # The maximum experience points for this level.

208

"level": 42, # The level for the user.

209

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

210

# string `games#playerLevel`.

211

},

212

"currentExperiencePoints": "A String", # The current number of experience points for the player.

213

"currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.

214

"minExperiencePoints": "A String", # The minimum experience points for this level.

215

"maxExperiencePoints": "A String", # The maximum experience points for this level.

216

"level": 42, # The level for the user.

217

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

218

# string `games#playerLevel`.

219

},

220

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch

221

# UTC.

222

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

223

# string `games#playerExperienceInfo`.

224

},

225

"playerId": "A String", # The ID of the player.

226

"originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into

227

# the game in question. This is only populated for calls to player.get for

228

# the requesting player, only if the player ID has subsequently changed, and

229

# only to clients that support remapping player IDs.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

230

},

231

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

"nextPageToken": "A String", # Token corresponding to the next page of results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

238

<pre>Retrieves the next page of results.

239

240

Args:

241

previous_request: The request for the previous page. (required)

242

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

243

244

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

A request object that you can call 'execute()' on to request the next

John Asmuth