blob: cef2a28f7d24b87462fd2e7ef967caf8d058a377 [file] [log] [blame]
<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 Game Services</a> . <a href="games_v1.snapshots.html">snapshots</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(snapshotId, language=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the metadata for a given snapshot ID.</p>
<p class="toc_element">
<code><a href="#list">list(playerId, maxResults=None, pageToken=None, language=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of snapshots created by your application for the player</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(snapshotId, language=None, x__xgafv=None)</code>
<pre>Retrieves the metadata for a given snapshot ID.
Args:
snapshotId: string, The ID of the snapshot. (required)
language: string, The preferred language to use for strings returned by this method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An snapshot object.
&quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this
# snapshot.
&quot;uniqueName&quot;: &quot;A String&quot;, # The unique name provided when the snapshot was created.
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `games#snapshot`.
&quot;driveId&quot;: &quot;A String&quot;, # The ID of the file underlying this snapshot in the Drive API. Only present
# if the snapshot is a view on a Drive file and the file is owned by the
# caller.
&quot;durationMillis&quot;: &quot;A String&quot;, # The duration associated with this snapshot, in millis.
&quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
&quot;coverImage&quot;: { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `games#snapshotImage`.
&quot;url&quot;: &quot;A String&quot;, # The URL of the image. This URL may be invalidated at any time and should
# not be cached.
&quot;width&quot;: 42, # The width of the image.
&quot;mime_type&quot;: &quot;A String&quot;, # The MIME type of the image.
&quot;height&quot;: 42, # The height of the image.
},
&quot;lastModifiedMillis&quot;: &quot;A String&quot;, # The timestamp (in millis since Unix epoch) of the last modification to this
# snapshot.
&quot;description&quot;: &quot;A String&quot;, # The description of this snapshot.
&quot;type&quot;: &quot;A String&quot;, # The type of this snapshot.
&quot;id&quot;: &quot;A String&quot;, # The ID of the snapshot.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(playerId, maxResults=None, pageToken=None, language=None, x__xgafv=None)</code>
<pre>Retrieves a list of snapshots created by your application for the player
corresponding to the player ID.
Args:
playerId: string, A player ID. A value of `me` may be used in place of the authenticated
player&#x27;s ID. (required)
maxResults: integer, The maximum number of snapshot resources to return in the response, used
for paging. For any response, the actual number of snapshot resources
returned may be less than the specified `maxResults`.
pageToken: string, The token returned by the previous request.
language: string, The preferred language to use for strings returned by this method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A third party list snapshots response.
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token corresponding to the next page of results. If there are no more
# results, the token is omitted.
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `games#snapshotListResponse`.
&quot;items&quot;: [ # The snapshots.
{ # An snapshot object.
&quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this
# snapshot.
&quot;uniqueName&quot;: &quot;A String&quot;, # The unique name provided when the snapshot was created.
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `games#snapshot`.
&quot;driveId&quot;: &quot;A String&quot;, # The ID of the file underlying this snapshot in the Drive API. Only present
# if the snapshot is a view on a Drive file and the file is owned by the
# caller.
&quot;durationMillis&quot;: &quot;A String&quot;, # The duration associated with this snapshot, in millis.
&quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
&quot;coverImage&quot;: { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
&quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed
# string `games#snapshotImage`.
&quot;url&quot;: &quot;A String&quot;, # The URL of the image. This URL may be invalidated at any time and should
# not be cached.
&quot;width&quot;: 42, # The width of the image.
&quot;mime_type&quot;: &quot;A String&quot;, # The MIME type of the image.
&quot;height&quot;: 42, # The height of the image.
},
&quot;lastModifiedMillis&quot;: &quot;A String&quot;, # The timestamp (in millis since Unix epoch) of the last modification to this
# snapshot.
&quot;description&quot;: &quot;A String&quot;, # The description of this snapshot.
&quot;type&quot;: &quot;A String&quot;, # The type of this snapshot.
&quot;id&quot;: &quot;A String&quot;, # The ID of the snapshot.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>