Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02bae1c909ec28088ebbc4007f3ef9b968b55e0a / . / docs / dyn / games_v1.snapshots.html
blob: a6fcf11918c06b4241a117cf4662bb00e0c6ca6c [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.snapshots.html">snapshots</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]78 <code><a href="#get">get(snapshotId, language=None, consistencyToken=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]79<p class="firstline">Retrieves the metadata for a given snapshot ID.</p>
80<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]81 <code><a href="#list">list(playerId, language=None, pageToken=None, maxResults=None, consistencyToken=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]82<p class="firstline">Retrieves a list of snapshots created by your application for the player corresponding to the player ID.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]88 <code class="details" id="get">get(snapshotId, language=None, consistencyToken=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]89 <pre>Retrieves the metadata for a given snapshot ID.
90
91Args:
92 snapshotId: string, The ID of the snapshot. (required)
93 language: string, The preferred language to use for strings returned by this method.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]94 consistencyToken: string, The last-seen mutation timestamp.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95
96Returns:
97 An object of the form:
98
99 { # This is a JSON template for an snapshot object.
100 "kind": "games#snapshot", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot.
101 "description": "A String", # The description of this snapshot.
102 "title": "A String", # The title of this snapshot.
103 "coverImage": { # This is a JSON template for an image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
104 "url": "A String", # The URL of the image. This URL may be invalidated at any time and should not be cached.
105 "width": 42, # The width of the image.
106 "kind": "games#snapshotImage", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage.
107 "mime_type": "A String", # The MIME type of the image.
108 "height": 42, # The height of the image.
109 },
110 "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111 "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this snapshot.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]112 "driveId": "A String", # 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.
113 "durationMillis": "A String", # The duration associated with this snapshot, in millis.
114 "uniqueName": "A String", # The unique name provided when the snapshot was created.
115 "type": "A String", # The type of this snapshot.
116 # Possible values are:
117 # - "SAVE_GAME" - A snapshot representing a save game.
118 "id": "A String", # The ID of the snapshot.
119 }</pre>
120</div>
121
122<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]123 <code class="details" id="list">list(playerId, language=None, pageToken=None, maxResults=None, consistencyToken=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]124 <pre>Retrieves a list of snapshots created by your application for the player corresponding to the player ID.
125
126Args:
127 playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
128 language: string, The preferred language to use for strings returned by this method.
129 pageToken: string, The token returned by the previous request.
130 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]131 consistencyToken: string, The last-seen mutation timestamp.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]132
133Returns:
134 An object of the form:
135
136 { # This is a JSON template for a list of snapshot objects.
137 "nextPageToken": "A String", # Token corresponding to the next page of results. If there are no more results, the token is omitted.
138 "items": [ # The snapshots.
139 { # This is a JSON template for an snapshot object.
140 "kind": "games#snapshot", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot.
141 "description": "A String", # The description of this snapshot.
142 "title": "A String", # The title of this snapshot.
143 "coverImage": { # This is a JSON template for an image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
144 "url": "A String", # The URL of the image. This URL may be invalidated at any time and should not be cached.
145 "width": 42, # The width of the image.
146 "kind": "games#snapshotImage", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage.
147 "mime_type": "A String", # The MIME type of the image.
148 "height": 42, # The height of the image.
149 },
150 "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]151 "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this snapshot.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]152 "driveId": "A String", # 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.
153 "durationMillis": "A String", # The duration associated with this snapshot, in millis.
154 "uniqueName": "A String", # The unique name provided when the snapshot was created.
155 "type": "A String", # The type of this snapshot.
156 # Possible values are:
157 # - "SAVE_GAME" - A snapshot representing a save game.
158 "id": "A String", # The ID of the snapshot.
159 },
160 ],
161 "kind": "games#snapshotListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotListResponse.
162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
167 <pre>Retrieves the next page of results.
168
169Args:
170 previous_request: The request for the previous page. (required)
171 previous_response: The response from the request for the previous page. (required)
172
173Returns:
174 A request object that you can call 'execute()' on to request the next
175 page. Returns None if there are no more items in the collection.
176 </pre>
177</div>
178
179</body></html>