Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ed7d3f9b61ac35e08a22b4995076a95451cf7c8 / . / docs / dyn / gamesManagement_v1management.applications.html
blob: cd9be5e8c0b88ab125708945aeb6b61ac98cbc74 [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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]75<h1><a href="gamesManagement_v1management.html">Google Play Game Management</a> . <a href="gamesManagement_v1management.applications.html">applications</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]78 <code><a href="#listHidden">listHidden(applicationId, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]79<p class="firstline">Get the list of players hidden from the given application. This method is</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#listHidden_next">listHidden_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]85 <code class="details" id="listHidden">listHidden(applicationId, pageToken=None, maxResults=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86 <pre>Get the list of players hidden from the given application. This method is
87only available to user accounts for your developer console.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88
89Args:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]90 applicationId: string, The application ID from the Google Play developer console. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]91 pageToken: string, The token returned by the previous request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92 maxResults: integer, The maximum number of player resources to return in the response, used for
93paging. For any response, the actual number of player resources returned
94may be less than the specified `maxResults`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99
100Returns:
101 An object of the form:
102
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103 { # A list of hidden players.
104 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;items&quot;: [ # The players.
106 { # The HiddenPlayer resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;kind&quot;: &quot;A String&quot;, # Output only. Uniquely identifies the type of this resource. Value is always the fixed
108 # string `gamesManagement#hiddenPlayer`.
109 &quot;player&quot;: { # A Player resource. # Output only. The player information.
110 &quot;profileSettings&quot;: { # Profile settings # The player&#x27;s profile settings. Controls whether or not the player&#x27;s profile
111 # is visible to other players.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]112 &quot;profileVisible&quot;: True or False,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
114 # string `gamesManagement#profileSettings`.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;name&quot;: { # An object representation of the individual components of the player&#x27;s name.
117 # For some players, these fields may not be present.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 &quot;familyName&quot;: &quot;A String&quot;, # The family name of this player. In some places, this is known as the last
119 # name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]120 &quot;givenName&quot;: &quot;A String&quot;, # The given name of this player. In some places, this is known as the first
121 # name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]123 &quot;bannerUrlPortrait&quot;: &quot;A String&quot;, # The url to the portrait mode player banner image.
124 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
125 # string `gamesManagement#player`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 &quot;bannerUrlLandscape&quot;: &quot;A String&quot;, # The url to the landscape mode player banner image.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]127 &quot;title&quot;: &quot;A String&quot;, # The player&#x27;s title rewarded for their game activities.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;avatarImageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the player.
129 &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 Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]130 &quot;currentExperiencePoints&quot;: &quot;A String&quot;, # The current number of experience points for the player.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &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,
132 # this should be same as the current level.
133 &quot;level&quot;: 42, # The level for the user.
134 &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
135 &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]136 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;currentLevel&quot;: { # 1P/3P metadata about a user&#x27;s level. # The current level of the player.
138 &quot;level&quot;: 42, # The level for the user.
139 &quot;maxExperiencePoints&quot;: &quot;A String&quot;, # The maximum experience points for this level.
140 &quot;minExperiencePoints&quot;: &quot;A String&quot;, # The minimum experience points for this level.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]141 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 &quot;lastLevelUpTimestampMillis&quot;: &quot;A String&quot;, # The timestamp when the player was leveled up, in millis since Unix epoch
143 # UTC.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]144 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the player.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]146 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;originalPlayerId&quot;: &quot;A String&quot;, # The player ID that was used for this player the first time they signed into
148 # the game in question. This is only populated for calls to player.get for
149 # the requesting player, only if the player ID has subsequently changed, and
150 # only to clients that support remapping player IDs.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]152 &quot;hiddenTimeMillis&quot;: &quot;A String&quot;, # Output only. The time this player was hidden.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 },
154 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]155 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
156 # string `gamesManagement#hiddenPlayerList`.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="listHidden_next">listHidden_next(previous_request, previous_response)</code>
162 <pre>Retrieves the next page of results.
163
164Args:
165 previous_request: The request for the previous page. (required)
166 previous_response: The response from the request for the previous page. (required)
167
168Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 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]170 page. Returns None if there are no more items in the collection.
171 </pre>
172</div>
173
174</body></html>