Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / games_v1.events.html
blob: 6fb0d04809b31b4daa86671939b085df7b8b8737 [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
75<h1><a href="games_v1.html">Google Play Game Services API</a> . <a href="games_v1.events.html">events</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#listByPlayer">listByPlayer(language=None, maxResults=None, pageToken=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]79<p class="firstline">Returns a list showing the current progress on events in this application for the currently authenticated user.</p>
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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]84 <code><a href="#listDefinitions">listDefinitions(language=None, maxResults=None, pageToken=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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#record">record(body=None, language=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]91<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>
92<h3>Method Details</h3>
93<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94 <code class="details" id="listByPlayer">listByPlayer(language=None, maxResults=None, pageToken=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95 <pre>Returns a list showing the current progress on events in this application for the currently authenticated user.
96
97Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]98 language: string, The preferred language to use for strings returned by this method.
99 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 pageToken: string, The token returned by the previous request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101
102Returns:
103 An object of the form:
104
105 { # This is a JSON template for a ListByPlayer response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]106 &quot;items&quot;: [ # The player events.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]107 { # This is a JSON template for an event status resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event definition.
109 &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.
110 &quot;kind&quot;: &quot;games#playerEvent&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#playerEvent.
111 &quot;numEvents&quot;: &quot;A String&quot;, # The current number of times this event has occurred.
112 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]113 },
114 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;kind&quot;: &quot;games#playerEventListResponse&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#playerEventListResponse.
116 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]117 }</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="listByPlayer_next">listByPlayer_next(previous_request, previous_response)</code>
122 <pre>Retrieves the next page of results.
123
124Args:
125 previous_request: The request for the previous page. (required)
126 previous_response: The response from the request for the previous page. (required)
127
128Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 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]130 page. Returns None if there are no more items in the collection.
131 </pre>
132</div>
133
134<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 <code class="details" id="listDefinitions">listDefinitions(language=None, maxResults=None, pageToken=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]136 <pre>Returns a list of the event definitions in this application.
137
138Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]139 language: string, The preferred language to use for strings returned by this method.
140 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 pageToken: string, The token returned by the previous request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]142
143Returns:
144 An object of the form:
145
146 { # This is a JSON template for a ListDefinitions response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;items&quot;: [ # The event definitions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]148 { # This is a JSON template for an event definition resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &quot;childEvents&quot;: [ # A list of events that are a child of this event.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]150 { # This is a JSON template for an event child relationship resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;childId&quot;: &quot;A String&quot;, # The ID of the child event.
152 &quot;kind&quot;: &quot;games#eventChild&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]153 },
154 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155 &quot;description&quot;: &quot;A String&quot;, # Description of what this event represents.
156 &quot;displayName&quot;: &quot;A String&quot;, # The name to display for the event.
157 &quot;id&quot;: &quot;A String&quot;, # The ID of the event.
158 &quot;imageUrl&quot;: &quot;A String&quot;, # The base URL for the image that represents the event.
159 &quot;isDefaultImageUrl&quot;: True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
160 &quot;kind&quot;: &quot;games#eventDefinition&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinition.
161 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of event being tracked in this definition.
162 # Possible values are:
163 # - &quot;REVEALED&quot;: This event should be visible to all users.
164 # - &quot;HIDDEN&quot;: This event should only be shown to users that have recorded this event at least once.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]165 },
166 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 &quot;kind&quot;: &quot;games#eventDefinitionListResponse&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinitionListResponse.
168 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token for the next page of results.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="listDefinitions_next">listDefinitions_next(previous_request, previous_response)</code>
174 <pre>Retrieves the next page of results.
175
176Args:
177 previous_request: The request for the previous page. (required)
178 previous_response: The response from the request for the previous page. (required)
179
180Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 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]182 page. Returns None if there are no more items in the collection.
183 </pre>
184</div>
185
186<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]187 <code class="details" id="record">record(body=None, language=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]188 <pre>Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.
189
190Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]191 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]192 The object takes the form of:
193
194{ # This is a JSON template for an event period update resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 &quot;currentTimeMillis&quot;: &quot;A String&quot;, # The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).
196 &quot;kind&quot;: &quot;games#eventRecordRequest&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordRequest.
197 &quot;requestId&quot;: &quot;A String&quot;, # The request ID used to identify this attempt to record events.
198 &quot;timePeriods&quot;: [ # A list of the time period updates being made in this request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]199 { # This is a JSON template for an event period update resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]200 &quot;kind&quot;: &quot;games#eventPeriodUpdate&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodUpdate.
201 &quot;timePeriod&quot;: { # This is a JSON template for an event period time range. # The time period being covered by this update.
202 &quot;kind&quot;: &quot;games#eventPeriodRange&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodRange.
203 &quot;periodEndMillis&quot;: &quot;A String&quot;, # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
204 &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 -0700[diff] [blame]205 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;updates&quot;: [ # The updates being made for this time period.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]207 { # This is a JSON template for an event period update resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event being modified in this update.
209 &quot;kind&quot;: &quot;games#eventUpdateRequest&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateRequest.
210 &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]211 },
212 ],
213 },
214 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]215 }
216
217 language: string, The preferred language to use for strings returned by this method.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]218
219Returns:
220 An object of the form:
221
222 { # This is a JSON template for an event period update resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 &quot;batchFailures&quot;: [ # Any batch-wide failures which occurred applying updates.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]224 { # This is a JSON template for a batch update failure resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225 &quot;failureCause&quot;: &quot;A String&quot;, # The cause for the update failure.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]226 # Possible values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 # - &quot;TOO_LARGE&quot;: A batch request was issued with more events than are allowed in a single batch.
228 # - &quot;TIME_PERIOD_EXPIRED&quot;: A batch was sent with data too far in the past to record.
229 # - &quot;TIME_PERIOD_SHORT&quot;: A batch was sent with a time range that was too short.
230 # - &quot;TIME_PERIOD_LONG&quot;: A batch was sent with a time range that was too long.
231 # - &quot;ALREADY_UPDATED&quot;: An attempt was made to record a batch of data which was already seen.
232 # - &quot;RECORD_RATE_HIGH&quot;: An attempt was made to record data faster than the server will apply updates.
233 &quot;kind&quot;: &quot;games#eventBatchRecordFailure&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventBatchRecordFailure.
234 &quot;range&quot;: { # This is a JSON template for an event period time range. # The time range which was rejected; empty for a request-wide failure.
235 &quot;kind&quot;: &quot;games#eventPeriodRange&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodRange.
236 &quot;periodEndMillis&quot;: &quot;A String&quot;, # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
237 &quot;periodStartMillis&quot;: &quot;A String&quot;, # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
238 },
239 },
240 ],
241 &quot;eventFailures&quot;: [ # Any failures updating a particular event.
242 { # This is a JSON template for an event update failure resource.
243 &quot;eventId&quot;: &quot;A String&quot;, # The ID of the event that was not updated.
244 &quot;failureCause&quot;: &quot;A String&quot;, # The cause for the update failure.
245 # Possible values are:
246 # - &quot;NOT_FOUND&quot; - An attempt was made to set an event that was not defined.
247 # - &quot;INVALID_UPDATE_VALUE&quot; - An attempt was made to increment an event by a non-positive value.
248 &quot;kind&quot;: &quot;games#eventRecordFailure&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordFailure.
249 },
250 ],
251 &quot;kind&quot;: &quot;games#eventUpdateResponse&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateResponse.
252 &quot;playerEvents&quot;: [ # The current status of any updated events
253 { # This is a JSON template for an event status resource.
254 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of the event definition.
255 &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.
256 &quot;kind&quot;: &quot;games#playerEvent&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string games#playerEvent.
257 &quot;numEvents&quot;: &quot;A String&quot;, # The current number of times this event has occurred.
258 &quot;playerId&quot;: &quot;A String&quot;, # The ID of the player.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]259 },
260 ],
261 }</pre>
262</div>
263
264</body></html>