docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/games_v1.players.html b/docs/dyn/games_v1.players.html
index 4bdb134..7c849e1 100644
--- a/docs/dyn/games_v1.players.html
+++ b/docs/dyn/games_v1.players.html
@@ -75,23 +75,29 @@
<h1><a href="games_v1.html">Google Play Game Services</a> . <a href="games_v1.players.html">players</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(playerId, language=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Retrieves the Player resource with the given ID. To retrieve the player</p>
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#list">list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(playerId, language=None, x__xgafv=None)</a></code></p>
+<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>
+<p class="toc_element">
+ <code><a href="#list">list(collection, pageToken=None, maxResults=None, language=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get the collection of players for the currently authenticated user.</p>
<p class="toc_element">
<code><a href="#list_next">list_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="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(playerId, language=None, x__xgafv=None)</code>
- <pre>Retrieves the Player resource with the given ID. To retrieve the player
-for the currently authenticated user, set `playerId` to `me`.
+ <pre>Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`.
Args:
- playerId: string, A player ID. A value of `me` may be used in place of the
-authenticated player's ID. (required)
+ playerId: string, A player ID. A value of `me` may be used in place of the authenticated player's ID. (required)
language: string, The preferred language to use for strings returned by this method.
x__xgafv: string, V1 error format.
Allowed values
@@ -102,69 +108,57 @@
An object of the form:
{ # A Player resource.
- "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
"title": "A String", # The player's title rewarded for their game activities.
- "displayName": "A String", # The name to display for the player.
- "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile
- # is visible to other players.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#profileSettings`.
- "friendsListVisibility": "A String",
+ "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.
+ "avatarImageUrl": "A String", # The base URL for the image that represents the player.
+ "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
+ "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.
+ "friendsListVisibility": "A String",
},
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#player`
- "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.
+ "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.
+ "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
"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.
+ "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
+ "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
},
+ "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
- "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.
- "minExperiencePoints": "A String", # The minimum experience points for this level.
- "maxExperiencePoints": "A String", # The maximum experience points for this level.
- "level": 42, # The level for the user.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#playerLevel`.
- },
"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.
- "minExperiencePoints": "A String", # The minimum experience points for this level.
- "maxExperiencePoints": "A String", # The maximum experience points for this level.
+ "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.
"level": 42, # The level for the user.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#playerLevel`.
+ "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#playerLevel`.
},
- "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch
- # UTC.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#playerExperienceInfo`.
+ "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
+ "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#playerLevel`.
+ },
+ "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.
},
- "playerId": "A String", # The ID of the player.
- "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.
+ "displayName": "A String", # The name to display for the player.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(collection, pageToken=None, maxResults=None, language=None, x__xgafv=None)</code>
<pre>Get the collection of players for the currently authenticated user.
Args:
collection: string, Collection of players being retrieved (required)
- language: string, The preferred language to use for strings returned by this method.
+ Allowed values
+ CONNECTED - Retrieve a list of players that are also playing this game in reverse chronological order.
+ VISIBLE - Retrieve a list of players in the user's social graph that are visible to this game.
+ FRIENDS_ALL - Retrieve a list of players who are friends of the user in alphabetical order.
pageToken: string, The token returned by the previous request.
- 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`.
+ 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`.
+ 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
@@ -174,62 +168,47 @@
An object of the form:
{ # A third party player list response.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#playerListResponse`.
+ "nextPageToken": "A String", # Token corresponding to the next page of results.
+ "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerListResponse`.
"items": [ # The players.
{ # A Player resource.
- "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
"title": "A String", # The player's title rewarded for their game activities.
- "displayName": "A String", # The name to display for the player.
- "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile
- # is visible to other players.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#profileSettings`.
- "friendsListVisibility": "A String",
+ "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.
+ "avatarImageUrl": "A String", # The base URL for the image that represents the player.
+ "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
+ "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.
+ "friendsListVisibility": "A String",
},
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#player`
- "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.
+ "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.
+ "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
"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.
+ "givenName": "A String", # The given name of this player. In some places, this is known as the first name.
+ "familyName": "A String", # The family name of this player. In some places, this is known as the last name.
},
+ "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
"experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
- "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.
- "minExperiencePoints": "A String", # The minimum experience points for this level.
- "maxExperiencePoints": "A String", # The maximum experience points for this level.
- "level": 42, # The level for the user.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#playerLevel`.
- },
"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.
- "minExperiencePoints": "A String", # The minimum experience points for this level.
- "maxExperiencePoints": "A String", # The maximum experience points for this level.
+ "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.
"level": 42, # The level for the user.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#playerLevel`.
+ "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#playerLevel`.
},
- "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch
- # UTC.
- "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
- # string `games#playerExperienceInfo`.
+ "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
+ "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#playerLevel`.
+ },
+ "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.
},
- "playerId": "A String", # The ID of the player.
- "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.
+ "displayName": "A String", # The name to display for the player.
},
],
- "nextPageToken": "A String", # Token corresponding to the next page of results.
}</pre>
</div>