File: games_v1.snapshots.html

package info (click to toggle)
python-googleapi 2.186.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 553,432 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (189 lines) | stat: -rw-r--r-- 7,858 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<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.snapshots.html">snapshots</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<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, language=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of snapshots created by your application for the player corresponding to the player ID.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<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;coverImage&quot;: { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
    &quot;height&quot;: 42, # The height of the image.
    &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotImage`.
    &quot;mime_type&quot;: &quot;A String&quot;, # The MIME type of the image.
    &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;description&quot;: &quot;A String&quot;, # The description of this 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;id&quot;: &quot;A String&quot;, # The ID of the snapshot.
  &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshot`.
  &quot;lastModifiedMillis&quot;: &quot;A String&quot;, # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
  &quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this snapshot.
  &quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
  &quot;type&quot;: &quot;A String&quot;, # The type of this snapshot.
  &quot;uniqueName&quot;: &quot;A String&quot;, # The unique name provided when the snapshot was created.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(playerId, language=None, maxResults=None, pageToken=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)
  language: string, The preferred language to use for strings returned by this method.
  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.
  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;items&quot;: [ # The snapshots.
    { # An snapshot object.
      &quot;coverImage&quot;: { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image.
        &quot;height&quot;: 42, # The height of the image.
        &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotImage`.
        &quot;mime_type&quot;: &quot;A String&quot;, # The MIME type of the image.
        &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;description&quot;: &quot;A String&quot;, # The description of this 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;id&quot;: &quot;A String&quot;, # The ID of the snapshot.
      &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshot`.
      &quot;lastModifiedMillis&quot;: &quot;A String&quot;, # The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
      &quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this snapshot.
      &quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
      &quot;type&quot;: &quot;A String&quot;, # The type of 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#snapshotListResponse`.
  &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.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</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>