blob: cd0b14438684ae3b072f83cca73f4d405bdb44d5 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="games_v1.html">Google Play Games Services API</a> . <a href="games_v1.gameStats.html">gameStats</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchRecordEvents">batchRecordEvents(playerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Records a batch of player game events for a specific player. This method allows sending multiple events in a single request.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchRecordEvents">batchRecordEvents(playerId, body=None, x__xgafv=None)</code>
<pre>Records a batch of player game events for a specific player. This method allows sending multiple events in a single request.
Args:
playerId: string, Required. The player ID of the player that performed the events. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PlayerGameEvents.BatchRecordEvents Next ID: 7
&quot;droidGuardBlob&quot;: &quot;A String&quot;, # Optional. The DroidGuard blob generated by the client. This is used to detect abuse signals from the devices
&quot;events&quot;: [ # Required. A list of player game events to be recorded. Maximum of 30 events per batch request.
{ # A representation of a single player game event triggered by a player&#x27;s event in a game. This might be completing a level, unlocking an item, or finishing a match.
&quot;eventId&quot;: &quot;A String&quot;, # Required. A unique client-generated UUID for this specific event instance. Used for server-side idempotency and deduplication. Submitting an event with a previously recorded event_id for the same player will be ignored.
&quot;eventName&quot;: &quot;A String&quot;, # Required. Client-defined name of the event (e.g., &quot;run_completed&quot;, &quot;level_up&quot;). Maximum length: 100 characters.
&quot;eventProperties&quot;: { # Optional. Key-value properties providing details about the event. - Maximum number of properties: 25. - Property key maximum length: 100 characters. - String values within PropertyValue maximum length: 1024 characters.
&quot;a_key&quot;: { # Wrapper for the value.
&quot;boolValue&quot;: True or False, # A boolean value.
&quot;doubleValue&quot;: 3.14, # A double value.
&quot;durationValue&quot;: &quot;A String&quot;, # A duration value.
&quot;intValue&quot;: &quot;A String&quot;, # An integer value.
&quot;stringValue&quot;: &quot;A String&quot;, # A string value.
&quot;timestampValue&quot;: &quot;A String&quot;, # A timestamp value.
},
},
&quot;eventTime&quot;: &quot;A String&quot;, # Required. The time from the client when this specific event was performed.
},
],
&quot;packageName&quot;: &quot;A String&quot;, # Required. Application package name (e.g., &quot;com.example.game&quot;).
&quot;requestTime&quot;: &quot;A String&quot;, # Required. The time from the client when this specific batch of events was submitted.
&quot;salt&quot;: &quot;A String&quot;, # Optional. The salt used to generate content binding for the DroidGuard blob. This is used to prevent replay attacks.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A successful response indicates that the batch of events has been processed.
&quot;failedRequests&quot;: { # Map of failed events, keyed by their zero-based index in `BatchRecordEventsRequest.events`. Omitted keys indicate successful recording.
&quot;a_key&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
</body></html>