Debian Codegraph @

docs/dyn/games_v1.snapshots.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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 Games Services API</a> . <a href="games_v1.snapshots.html">snapshots</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(snapshotId, language=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves the metadata for a given snapshot ID.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(playerId, language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a list of snapshots created by your application for the player corresponding to the player ID.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(snapshotId, language=None, x__xgafv=None)</code>
97 <pre>Retrieves the metadata for a given snapshot ID.
98
99 Args:
100 snapshotId: string, The ID of the snapshot. (required)
101 language: string, The preferred language to use for strings returned by this method.
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # An snapshot object.
111 &quot;coverImage&quot;: { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
112 &quot;height&quot;: 42, # The height of the image.
113 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotImage`.
114 &quot;mime_type&quot;: &quot;A String&quot;, # The MIME type of the image.
115 &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.
116 &quot;width&quot;: 42, # The width of the image.
117 },
118 &quot;description&quot;: &quot;A String&quot;, # The description of this snapshot.
119 &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.
120 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration associated with this snapshot, in millis.
121 &quot;id&quot;: &quot;A String&quot;, # The ID of the snapshot.
122 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshot`.
123 &quot;lastModifiedMillis&quot;: &quot;A String&quot;, # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
124 &quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this snapshot.
125 &quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
126 &quot;type&quot;: &quot;A String&quot;, # The type of this snapshot.
127 &quot;uniqueName&quot;: &quot;A String&quot;, # The unique name provided when the snapshot was created.
128 }</pre>
129 </div>
130
131 <div class="method">
132 <code class="details" id="list">list(playerId, language=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
133 <pre>Retrieves a list of snapshots created by your application for the player corresponding to the player ID.
134
135 Args:
136 playerId: string, A player ID. A value of `me` may be used in place of the authenticated player&#x27;s ID. (required)
137 language: string, The preferred language to use for strings returned by this method.
138 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`.
139 pageToken: string, The token returned by the previous request.
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145 Returns:
146 An object of the form:
147
148 { # A third party list snapshots response.
149 &quot;items&quot;: [ # The snapshots.
150 { # An snapshot object.
151 &quot;coverImage&quot;: { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
152 &quot;height&quot;: 42, # The height of the image.
153 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotImage`.
154 &quot;mime_type&quot;: &quot;A String&quot;, # The MIME type of the image.
155 &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.
156 &quot;width&quot;: 42, # The width of the image.
157 },
158 &quot;description&quot;: &quot;A String&quot;, # The description of this snapshot.
159 &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.
160 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration associated with this snapshot, in millis.
161 &quot;id&quot;: &quot;A String&quot;, # The ID of the snapshot.
162 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshot`.
163 &quot;lastModifiedMillis&quot;: &quot;A String&quot;, # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
164 &quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this snapshot.
165 &quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
166 &quot;type&quot;: &quot;A String&quot;, # The type of this snapshot.
167 &quot;uniqueName&quot;: &quot;A String&quot;, # The unique name provided when the snapshot was created.
168 },
169 ],
170 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotListResponse`.
171 &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.
172 }</pre>
173 </div>
174
175 <div class="method">
176 <code class="details" id="list_next">list_next()</code>
177 <pre>Retrieves the next page of results.
178
179 Args:
180 previous_request: The request for the previous page. (required)
181 previous_response: The response from the request for the previous page. (required)
182
183 Returns:
184 A request object that you can call &#x27;execute()&#x27; on to request the next
185 page. Returns None if there are no more items in the collection.
186 </pre>
187 </div>
188
189 </body></html>