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