Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / af918e8ef422438aaca0c468de8b3b2c184d884e / . / docs / dyn / games_v1.events.html
blob: e9011b15c0849290b9f0d0aaa22cf833396583ec [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">
Dmitry Frenkel3e17f892020-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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]81 <code><a href="#listByPlayer">listByPlayer(maxResults=None, pageToken=None, language=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-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 Citro065b5302014-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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]87 <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]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 Kimd059ad82020-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 Frenkel3e17f892020-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]102 <code class="details" id="listByPlayer">listByPlayer(maxResults=None, pageToken=None, language=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]104
105Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]106 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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]107 pageToken: string, The token returned by the previous request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 language: string, The preferred language to use for strings returned by this method.
Bu Sun Kimd059ad82020-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]113
114Returns:
115 An object of the form:
116
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 { # A ListByPlayer response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 &quot;items&quot;: [ # The player events.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]119 { # An event status resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]120 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]121 &quot;numEvents&quot;: &quot;A String&quot;, # The current number of times this event has occurred.
122 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event definition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]123 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]125 },
126 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]127 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
128 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEventListResponse`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]129 }</pre>
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
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 -0700[diff] [blame]141 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]142 page. Returns None if there are no more items in the collection.
143 </pre>
144</div>
145
146<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]147 <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]148 <pre>Returns a list of the event definitions in this application.
149
150Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]151 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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]152 pageToken: string, The token returned by the previous request.
153 language: string, The preferred language to use for strings returned by this method.
Bu Sun Kimd059ad82020-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]158
159Returns:
160 An object of the form:
161
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 { # A ListDefinitions response.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]163 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
164 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;items&quot;: [ # The event definitions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]166 { # An event definition resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]167 &quot;description&quot;: &quot;A String&quot;, # Description of what this event represents.
168 &quot;isDefaultImageUrl&quot;: True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
169 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`.
170 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of event being tracked in this definition.
171 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the event.
172 &quot;id&quot;: &quot;A String&quot;, # The ID of the event.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &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]174 { # An event child relationship resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]175 &quot;childId&quot;: &quot;A String&quot;, # The ID of the child event.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]176 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]177 },
178 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]179 &quot;imageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the event.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]180 },
181 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 }</pre>
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
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 -0700[diff] [blame]194 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]195 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 -0700[diff] [blame]200 <code class="details" id="record">record(body=None, language=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]202
203Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]204 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]205 The object takes the form of:
206
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]207{ # An event period update resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &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]209 { # An event period update resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 &quot;updates&quot;: [ # The updates being made for this time period.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]211 { # An event period update resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]212 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event being modified in this update.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]213 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateRequest`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]214 &quot;updateCount&quot;: &quot;A String&quot;, # The number of times this event occurred in this time period.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]215 },
216 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]217 &quot;timePeriod&quot;: { # An event period time range. # The time period being covered by this update.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]218 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]219 &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 -0800[diff] [blame]220 &quot;periodEndMillis&quot;: &quot;A String&quot;, # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]222 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodUpdate`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]223 },
224 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]225 &quot;currentTimeMillis&quot;: &quot;A String&quot;, # The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]226 &quot;requestId&quot;: &quot;A String&quot;, # The request ID used to identify this attempt to record events.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]227 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordRequest`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]228 }
229
230 language: string, The preferred language to use for strings returned by this method.
Bu Sun Kimd059ad82020-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]235
236Returns:
237 An object of the form:
238
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]239 { # An event period update resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]240 &quot;playerEvents&quot;: [ # The current status of any updated events
241 { # An event status resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]242 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]243 &quot;numEvents&quot;: &quot;A String&quot;, # The current number of times this event has occurred.
244 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event definition.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]245 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]246 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]247 },
248 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]249 &quot;batchFailures&quot;: [ # Any batch-wide failures which occurred applying updates.
250 { # A batch update failure resource.
251 &quot;range&quot;: { # An event period time range. # The time range which was rejected; empty for a request-wide failure.
252 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`.
253 &quot;periodStartMillis&quot;: &quot;A String&quot;, # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
254 &quot;periodEndMillis&quot;: &quot;A String&quot;, # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
255 },
256 &quot;failureCause&quot;: &quot;A String&quot;, # The cause for the update failure.
257 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventBatchRecordFailure`.
258 },
259 ],
260 &quot;eventFailures&quot;: [ # Any failures updating a particular event.
261 { # An event update failure resource.
262 &quot;failureCause&quot;: &quot;A String&quot;, # The cause for the update failure.
263 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordFailure`.
264 &quot;eventId&quot;: &quot;A String&quot;, # The ID of the event that was not updated.
265 },
266 ],
267 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateResponse`.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]268 }</pre>
269</div>
270
271</body></html>