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

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

[diff] [blame]

81

<code><a href="#list">list(collection, language=None, maxResults=None, pageToken=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

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

88

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

John Asmuth

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

[diff] [blame]

89

<pre>Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.

90

91

Args:

Bu Sun Kim

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

[diff] [blame]

92

playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)

John Asmuth

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

[diff] [blame]

93

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

94

95

Returns:

96

An object of the form:

97

98

{ # This is a JSON template for a Player resource.

Bu Sun Kim

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

[diff] [blame]

99

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

100

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

101

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

102

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

103

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

104

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

105

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

106

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

107

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

108

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

109

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

110

},

Bu Sun Kim

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

[diff] [blame]

111

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

112

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

113

"nextLevel": { # This is a JSON template for 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.

114

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

115

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

116

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

117

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

118

},

119

},

Bu Sun Kim

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

[diff] [blame]

120

"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.

121

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

122

"lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.

123

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

124

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

125

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

126

},

127

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

128

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

129

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

130

},

131

"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.

132

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

133

"profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.

134

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

135

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

136

"profileVisible": True or False,

137

},

138

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

143

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

John Asmuth

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

[diff] [blame]

144

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

145

146

Args:

147

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

148

Allowed values

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

149

connected - (DEPRECATED) Retrieve a list of players that are also playing this game in reverse chronological order.

150

friends_all - Retrieve a list of players who are friends of the user in alphabetical order.

151

playedWith - (DEPRECATED) Retrieve a list of players you have played a multiplayer game (realtime or turn-based) with recently.

152

played_with - (DEPRECATED) Retrieve a list of players you have played a multiplayer game (realtime or turn-based) with recently.

Bu Sun Kim

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

[diff] [blame]

153

visible - (DEPRECATED: please use FRIENDS_ALL) Retrieve a list of players in the user's social graph that are visible to this game.

John Asmuth

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

[diff] [blame]

154

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

155

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 Kim

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

[diff] [blame]

156

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

John Asmuth

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

[diff] [blame]

157

158

Returns:

159

An object of the form:

160

161

{ # This is a JSON template for a third party player list response.

Bu Sun Kim

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

[diff] [blame]

162

"items": [ # The players.

John Asmuth

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

[diff] [blame]

163

{ # This is a JSON template for a Player resource.

Bu Sun Kim

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

[diff] [blame]

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

172

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

173

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

174

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

175

},

Bu Sun Kim

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

[diff] [blame]

176

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

177

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

178

"nextLevel": { # This is a JSON template for 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.

179

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

180

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

181

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

182

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

183

},

184

},

Bu Sun Kim

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

[diff] [blame]

185

"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.

186

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

187

"lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.

188

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

189

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

190

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

191

},

192

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

193

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

194

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

195

},

196

"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.

197

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

198

"profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.

199

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

200

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

201

"profileVisible": True or False,

202

},

203

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

John Asmuth