Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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 | |
Bu Sun Kim | d059ad8 | 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.events.html">events</a></h1> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 81 | <code><a href="#listByPlayer">listByPlayer(language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="firstline">Returns a list showing the current progress on events in this application for the currently authenticated user.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#listByPlayer_next">listByPlayer_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 87 | <code><a href="#listDefinitions">listDefinitions(language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 88 | <p class="firstline">Returns a list of the event definitions in this application.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#listDefinitions_next">listDefinitions_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 93 | <code><a href="#record">record(body=None, language=None, x__xgafv=None)</a></code></p> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 94 | <p class="firstline">Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.</p> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <code class="details" id="close">close()</code> |
| 98 | <pre>Close httplib2 connections.</pre> |
| 99 | </div> |
| 100 | |
| 101 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 102 | <code class="details" id="listByPlayer">listByPlayer(language=None, maxResults=None, pageToken=None, x__xgafv=None)</code> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | <pre>Returns a list showing the current progress on events in this application for the currently authenticated user. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 104 | |
| 105 | Args: |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 106 | language: string, The preferred language to use for strings returned by this method. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 107 | maxResults: integer, The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 108 | pageToken: string, The token returned by the previous request. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 109 | x__xgafv: string, V1 error format. |
| 110 | Allowed values |
| 111 | 1 - v1 error format |
| 112 | 2 - v2 error format |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 113 | |
| 114 | Returns: |
| 115 | An object of the form: |
| 116 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 117 | { # A ListByPlayer response. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 118 | "items": [ # The player events. |
| 119 | { # An event status resource. |
| 120 | "definitionId": "A String", # The ID of the event definition. |
| 121 | "formattedNumEvents": "A String", # The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console. |
| 122 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`. |
| 123 | "numEvents": "A String", # The current number of times this event has occurred. |
| 124 | "playerId": "A String", # The ID of the player. |
| 125 | }, |
| 126 | ], |
| 127 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEventListResponse`. |
| 128 | "nextPageToken": "A String", # The pagination token for the next page of results. |
| 129 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 130 | </div> |
| 131 | |
| 132 | <div class="method"> |
| 133 | <code class="details" id="listByPlayer_next">listByPlayer_next(previous_request, previous_response)</code> |
| 134 | <pre>Retrieves the next page of results. |
| 135 | |
| 136 | Args: |
| 137 | previous_request: The request for the previous page. (required) |
| 138 | previous_response: The response from the request for the previous page. (required) |
| 139 | |
| 140 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | A request object that you can call 'execute()' on to request the next |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 142 | page. Returns None if there are no more items in the collection. |
| 143 | </pre> |
| 144 | </div> |
| 145 | |
| 146 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 147 | <code class="details" id="listDefinitions">listDefinitions(language=None, maxResults=None, pageToken=None, x__xgafv=None)</code> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 148 | <pre>Returns a list of the event definitions in this application. |
| 149 | |
| 150 | Args: |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 151 | language: string, The preferred language to use for strings returned by this method. |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 152 | maxResults: integer, The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified `maxResults`. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 153 | pageToken: string, The token returned by the previous request. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 154 | x__xgafv: string, V1 error format. |
| 155 | Allowed values |
| 156 | 1 - v1 error format |
| 157 | 2 - v2 error format |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 158 | |
| 159 | Returns: |
| 160 | An object of the form: |
| 161 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 162 | { # A ListDefinitions response. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 163 | "items": [ # The event definitions. |
| 164 | { # An event definition resource. |
| 165 | "childEvents": [ # A list of events that are a child of this event. |
| 166 | { # An event child relationship resource. |
| 167 | "childId": "A String", # The ID of the child event. |
| 168 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`. |
| 169 | }, |
| 170 | ], |
| 171 | "description": "A String", # Description of what this event represents. |
| 172 | "displayName": "A String", # The name to display for the event. |
| 173 | "id": "A String", # The ID of the event. |
| 174 | "imageUrl": "A String", # The base URL for the image that represents the event. |
| 175 | "isDefaultImageUrl": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided. |
| 176 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`. |
| 177 | "visibility": "A String", # The visibility of event being tracked in this definition. |
| 178 | }, |
| 179 | ], |
| 180 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`. |
| 181 | "nextPageToken": "A String", # The pagination token for the next page of results. |
| 182 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 183 | </div> |
| 184 | |
| 185 | <div class="method"> |
| 186 | <code class="details" id="listDefinitions_next">listDefinitions_next(previous_request, previous_response)</code> |
| 187 | <pre>Retrieves the next page of results. |
| 188 | |
| 189 | Args: |
| 190 | previous_request: The request for the previous page. (required) |
| 191 | previous_response: The response from the request for the previous page. (required) |
| 192 | |
| 193 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 194 | A request object that you can call 'execute()' on to request the next |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 195 | page. Returns None if there are no more items in the collection. |
| 196 | </pre> |
| 197 | </div> |
| 198 | |
| 199 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 200 | <code class="details" id="record">record(body=None, language=None, x__xgafv=None)</code> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 201 | <pre>Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 202 | |
| 203 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 204 | body: object, The request body. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 205 | The object takes the form of: |
| 206 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 207 | { # An event period update resource. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 208 | "currentTimeMillis": "A String", # The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch). |
| 209 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordRequest`. |
| 210 | "requestId": "A String", # The request ID used to identify this attempt to record events. |
| 211 | "timePeriods": [ # A list of the time period updates being made in this request. |
| 212 | { # An event period update resource. |
| 213 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodUpdate`. |
| 214 | "timePeriod": { # An event period time range. # The time period being covered by this update. |
| 215 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`. |
| 216 | "periodEndMillis": "A String", # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch). |
| 217 | "periodStartMillis": "A String", # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch). |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 218 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 219 | "updates": [ # The updates being made for this time period. |
| 220 | { # An event period update resource. |
| 221 | "definitionId": "A String", # The ID of the event being modified in this update. |
| 222 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateRequest`. |
| 223 | "updateCount": "A String", # The number of times this event occurred in this time period. |
| 224 | }, |
| 225 | ], |
| 226 | }, |
| 227 | ], |
| 228 | } |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 229 | |
| 230 | language: string, The preferred language to use for strings returned by this method. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 231 | x__xgafv: string, V1 error format. |
| 232 | Allowed values |
| 233 | 1 - v1 error format |
| 234 | 2 - v2 error format |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 235 | |
| 236 | Returns: |
| 237 | An object of the form: |
| 238 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 239 | { # An event period update resource. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 240 | "batchFailures": [ # Any batch-wide failures which occurred applying updates. |
| 241 | { # A batch update failure resource. |
| 242 | "failureCause": "A String", # The cause for the update failure. |
| 243 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventBatchRecordFailure`. |
| 244 | "range": { # An event period time range. # The time range which was rejected; empty for a request-wide failure. |
| 245 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`. |
| 246 | "periodEndMillis": "A String", # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch). |
| 247 | "periodStartMillis": "A String", # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 248 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 249 | }, |
| 250 | ], |
| 251 | "eventFailures": [ # Any failures updating a particular event. |
| 252 | { # An event update failure resource. |
| 253 | "eventId": "A String", # The ID of the event that was not updated. |
| 254 | "failureCause": "A String", # The cause for the update failure. |
| 255 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordFailure`. |
| 256 | }, |
| 257 | ], |
| 258 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateResponse`. |
| 259 | "playerEvents": [ # The current status of any updated events |
| 260 | { # An event status resource. |
| 261 | "definitionId": "A String", # The ID of the event definition. |
| 262 | "formattedNumEvents": "A String", # The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console. |
| 263 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`. |
| 264 | "numEvents": "A String", # The current number of times this event has occurred. |
| 265 | "playerId": "A String", # The ID of the player. |
| 266 | }, |
| 267 | ], |
| 268 | }</pre> |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 269 | </div> |
| 270 | |
| 271 | </body></html> |