blob: af0aedf3cd3355f6cf87f73e95c445808a6bc47f [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<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 -070075<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 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080081 <code><a href="#listByPlayer">listByPlayer(language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Returns a list showing the current progress on events in this application for the currently authenticated user.</p>
Craig Citro065b5302014-08-14 00:47:23 -070083<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 Botcc94ec82021-01-15 07:10:04 -080087 <code><a href="#listDefinitions">listDefinitions(language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070088<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 Kimd059ad82020-07-22 17:02:09 -070093 <code><a href="#record">record(body=None, language=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094<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 Citro065b5302014-08-14 00:47:23 -070095<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800102 <code class="details" id="listByPlayer">listByPlayer(language=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <pre>Returns a list showing the current progress on events in this application for the currently authenticated user.
Craig Citro065b5302014-08-14 00:47:23 -0700104
105Args:
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800106 language: string, The preferred language to use for strings returned by this method.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800107 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 Botb6971b02020-11-26 17:16:03 -0800108 pageToken: string, The token returned by the previous request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700113
114Returns:
115 An object of the form:
116
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700117 { # A ListByPlayer response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800118 &quot;items&quot;: [ # The player events.
119 { # An event status resource.
120 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event definition.
121 &quot;formattedNumEvents&quot;: &quot;A String&quot;, # 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 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.
123 &quot;numEvents&quot;: &quot;A String&quot;, # The current number of times this event has occurred.
124 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
125 },
126 ],
127 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEventListResponse`.
128 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
129}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700130</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
136Args:
137 previous_request: The request for the previous page. (required)
138 previous_response: The response from the request for the previous page. (required)
139
140Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citro065b5302014-08-14 00:47:23 -0700142 page. Returns None if there are no more items in the collection.
143 </pre>
144</div>
145
146<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800147 <code class="details" id="listDefinitions">listDefinitions(language=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700148 <pre>Returns a list of the event definitions in this application.
149
150Args:
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800151 language: string, The preferred language to use for strings returned by this method.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800152 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 Bot0bf565c2020-12-09 08:56:03 -0800153 pageToken: string, The token returned by the previous request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700158
159Returns:
160 An object of the form:
161
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700162 { # A ListDefinitions response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800163 &quot;items&quot;: [ # The event definitions.
164 { # An event definition resource.
165 &quot;childEvents&quot;: [ # A list of events that are a child of this event.
166 { # An event child relationship resource.
167 &quot;childId&quot;: &quot;A String&quot;, # The ID of the child event.
168 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`.
169 },
170 ],
171 &quot;description&quot;: &quot;A String&quot;, # Description of what this event represents.
172 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the event.
173 &quot;id&quot;: &quot;A String&quot;, # The ID of the event.
174 &quot;imageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the event.
175 &quot;isDefaultImageUrl&quot;: True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
176 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`.
177 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of event being tracked in this definition.
178 },
179 ],
180 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`.
181 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
182}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700183</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
189Args:
190 previous_request: The request for the previous page. (required)
191 previous_response: The response from the request for the previous page. (required)
192
193Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citro065b5302014-08-14 00:47:23 -0700195 page. Returns None if there are no more items in the collection.
196 </pre>
197</div>
198
199<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700200 <code class="details" id="record">record(body=None, language=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700201 <pre>Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.
Craig Citro065b5302014-08-14 00:47:23 -0700202
203Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700204 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700205 The object takes the form of:
206
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700207{ # An event period update resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800208 &quot;currentTimeMillis&quot;: &quot;A String&quot;, # The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).
209 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordRequest`.
210 &quot;requestId&quot;: &quot;A String&quot;, # The request ID used to identify this attempt to record events.
211 &quot;timePeriods&quot;: [ # A list of the time period updates being made in this request.
212 { # An event period update resource.
213 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodUpdate`.
214 &quot;timePeriod&quot;: { # An event period time range. # The time period being covered by this update.
215 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`.
216 &quot;periodEndMillis&quot;: &quot;A String&quot;, # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
217 &quot;periodStartMillis&quot;: &quot;A String&quot;, # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
Craig Citro065b5302014-08-14 00:47:23 -0700218 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800219 &quot;updates&quot;: [ # The updates being made for this time period.
220 { # An event period update resource.
221 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event being modified in this update.
222 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateRequest`.
223 &quot;updateCount&quot;: &quot;A String&quot;, # The number of times this event occurred in this time period.
224 },
225 ],
226 },
227 ],
228}
Craig Citro065b5302014-08-14 00:47:23 -0700229
230 language: string, The preferred language to use for strings returned by this method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700231 x__xgafv: string, V1 error format.
232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700235
236Returns:
237 An object of the form:
238
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700239 { # An event period update resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800240 &quot;batchFailures&quot;: [ # Any batch-wide failures which occurred applying updates.
241 { # A batch update failure resource.
242 &quot;failureCause&quot;: &quot;A String&quot;, # The cause for the update failure.
243 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventBatchRecordFailure`.
244 &quot;range&quot;: { # An event period time range. # The time range which was rejected; empty for a request-wide failure.
245 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`.
246 &quot;periodEndMillis&quot;: &quot;A String&quot;, # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
247 &quot;periodStartMillis&quot;: &quot;A String&quot;, # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800248 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800249 },
250 ],
251 &quot;eventFailures&quot;: [ # Any failures updating a particular event.
252 { # An event update failure resource.
253 &quot;eventId&quot;: &quot;A String&quot;, # The ID of the event that was not updated.
254 &quot;failureCause&quot;: &quot;A String&quot;, # The cause for the update failure.
255 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordFailure`.
256 },
257 ],
258 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateResponse`.
259 &quot;playerEvents&quot;: [ # The current status of any updated events
260 { # An event status resource.
261 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event definition.
262 &quot;formattedNumEvents&quot;: &quot;A String&quot;, # 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 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.
264 &quot;numEvents&quot;: &quot;A String&quot;, # The current number of times this event has occurred.
265 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
266 },
267 ],
268}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700269</div>
270
271</body></html>