1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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 75 <h1><a href="games_v1.html">Google Play Game Services API</a> . <a href="games_v1.leaderboards.html">leaderboards</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#get">get(leaderboardId, language=None, consistencyToken=None)</a></code></p> 79 <p class="firstline">Retrieves the metadata of the leaderboard with the given ID.</p> 80 <p class="toc_element"> 81 <code><a href="#list">list(pageToken=None, language=None, maxResults=None, consistencyToken=None)</a></code></p> 82 <p class="firstline">Lists all the leaderboard metadata for your application.</p> 83 <p class="toc_element"> 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 <div class="method"> 88 <code class="details" id="get">get(leaderboardId, language=None, consistencyToken=None)</code> 89 <pre>Retrieves the metadata of the leaderboard with the given ID. 90 91 Args: 92 leaderboardId: string, The ID of the leaderboard. (required) 93 language: string, The preferred language to use for strings returned by this method. 94 consistencyToken: string, The last-seen mutation timestamp. 95 96 Returns: 97 An object of the form: 98 99 { # This is a JSON template for the Leaderboard resource. 100 "kind": "games#leaderboard", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard. 101 "isIconUrlDefault": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided. 102 "name": "A String", # The name of the leaderboard. 103 "id": "A String", # The leaderboard ID. 104 "iconUrl": "A String", # The icon for the leaderboard. 105 "order": "A String", # How scores are ordered. 106 # Possible values are: 107 # - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order. 108 # - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order. 109 }</pre> 110 </div> 111 112 <div class="method"> 113 <code class="details" id="list">list(pageToken=None, language=None, maxResults=None, consistencyToken=None)</code> 114 <pre>Lists all the leaderboard metadata for your application. 115 116 Args: 117 pageToken: string, The token returned by the previous request. 118 language: string, The preferred language to use for strings returned by this method. 119 maxResults: integer, The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults. 120 consistencyToken: string, The last-seen mutation timestamp. 121 122 Returns: 123 An object of the form: 124 125 { # This is a JSON template for a list of leaderboard objects. 126 "nextPageToken": "A String", # Token corresponding to the next page of results. 127 "items": [ # The leaderboards. 128 { # This is a JSON template for the Leaderboard resource. 129 "kind": "games#leaderboard", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard. 130 "isIconUrlDefault": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided. 131 "name": "A String", # The name of the leaderboard. 132 "id": "A String", # The leaderboard ID. 133 "iconUrl": "A String", # The icon for the leaderboard. 134 "order": "A String", # How scores are ordered. 135 # Possible values are: 136 # - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order. 137 # - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order. 138 }, 139 ], 140 "kind": "games#leaderboardListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardListResponse. 141 }</pre> 142 </div> 143 144 <div class="method"> 145 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 146 <pre>Retrieves the next page of results. 147 148 Args: 149 previous_request: The request for the previous page. (required) 150 previous_response: The response from the request for the previous page. (required) 151 152 Returns: 153 A request object that you can call 'execute()' on to request the next 154 page. Returns None if there are no more items in the collection. 155 </pre> 156 </div> 157 158 </body></html>
