Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / games_v1.snapshotsExtended.html
blob: 0b7e9f8fa72787980be713646932824c251a3f29 [file] [log] [blame]
Bu Sun Kim673ec5c2020-11-16 11:05:03 -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</a> . <a href="games_v1.snapshotsExtended.html">snapshotsExtended</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="#resolveSnapshotHead">resolveSnapshotHead(snapshotName, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Resolves any potential conflicts according to the resolution policy specified in the request and returns the snapshot head after the resolution.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
90 <code class="details" id="resolveSnapshotHead">resolveSnapshotHead(snapshotName, body=None, x__xgafv=None)</code>
91 <pre>Resolves any potential conflicts according to the resolution policy specified in the request and returns the snapshot head after the resolution.
92
93Args:
94 snapshotName: string, Required. Name of the snapshot. (required)
95 body: object, The request body.
96 The object takes the form of:
97
98{ # Request for ResolveSnapshotHead RPC.
99 &quot;resolutionPolicy&quot;: &quot;A String&quot;, # Required. The automatic resolution policy. All conflicts are resolved in chronological order, starting from the/ least recent. If the comparison metric is equal for the tentative head and the conflict, the head wins.
100 }
101
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 { # Response for ResolveSnapshotHead RPC.
111 &quot;snapshot&quot;: { # A snapshot represents a saved game state referred to using the developer-provided snapshot_id (think of it as a file&#x27;s path). The set of attributes and binary data for a specific state is called a revision. Each revision is itself immutable, and referred to by a snapshot_revision_id. At any time, a snapshot has a &quot;head&quot; revision, and updates are made against that revision. If a snapshot update is received that isn&#x27;t against the current head revision, then instead of changing the head revision it will result in a conflicting revision that must be specifically resolved. # The state of the snapshot.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]112 &quot;headRevision&quot;: { # A Snapshot revision resource. Snapshot revisions are immutable. # The current head revision (the canonical revision as understood by the server).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]113 &quot;metadata&quot;: { # Metadata about a snapshot revision. Snapshot metadata is immutable - a metadata change corresponds to a new snapshot revision. # Metadata for this snapshot revision.
114 &quot;duration&quot;: &quot;A String&quot;, # The duration associated with this snapshot. Values with sub-millisecond precision can be rounded or trimmed to the closest millisecond.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]115 &quot;deviceName&quot;: &quot;A String&quot;, # The device that created the current revision.
116 &quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
117 &quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this snapshot.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]118 &quot;lastModifyTime&quot;: &quot;A String&quot;, # The timestamp of the last modification to this snapshot. Values with sub-millisecond precision can be rounded or trimmed to the closest millisecond.
119 &quot;description&quot;: &quot;A String&quot;, # The description of this snapshot.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]120 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]121 &quot;id&quot;: &quot;A String&quot;, # Output only. A server generated identifier of the snapshot revision.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]122 &quot;blob&quot;: { # Identifies a snapshot data resource. The data is provided by the game. # Reference to the game provided blob for this revision.
123 &quot;contentHash&quot;: &quot;A String&quot;, # Output only. Hash-like weak identifier of the uploaded blob, consistent per player per application. Within the context of a single player/application, it&#x27;s guaranteed that two identical blobs coming from two different uploads will have the same content hash. It&#x27;s extremely likely, though not guaranteed, that if two content hashes are equal, the blobs are identical.
124 &quot;resourceId&quot;: &quot;A String&quot;, # The ID of the blob resource. It&#x27;s guaranteed that if two IDs are equal then the contents are equal as well. It&#x27;s not guaranteed that two identical blobs coming from separate uploads have the same resource ID. The resource ID can only be used within the application, user and resource type it was originally returned for. For example, it&#x27;s not possible to use SnapshotDataResource&#x27;s resource ID as the resource_id of a SnapshotCoverImageResource, even if the blob is a valid image file.
125 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. A URL that the client can use to download the blob. May vary across requests, and only guaranteed to be valid for a short time after it is returned.
126 &quot;size&quot;: &quot;A String&quot;, # Size of the saved game blob in bytes.
127 },
128 &quot;coverImage&quot;: { # Identifies a snapshot cover image resource. The image is provided by the game. # Reference to the cover image for this revision.
129 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. A URL the client can use to download the image. May vary across requests, and only guaranteed to be valid for a short time after it is returned.
130 &quot;width&quot;: 42, # Output only. The width of the image in pixels.
131 &quot;contentHash&quot;: &quot;A String&quot;, # Output only. Hash-like weak identifier of the uploaded image bytes, consistent per player per application. Within the context of a single player/application, it&#x27;s guaranteed that two identical blobs coming from two different uploads will have the same content hash. It&#x27;s extremely likely, though not guaranteed, that if two content hashes are equal, the images are identical.
132 &quot;mimeType&quot;: &quot;A String&quot;, # Output only. The MIME type of the image.
133 &quot;height&quot;: 42, # Output only. The height of the image in pixels.
134 &quot;resourceId&quot;: &quot;A String&quot;, # The ID of the image resource. It&#x27;s guaranteed that if two IDs are equal then the contents are equal as well. It&#x27;s not guaranteed that two identical blobs coming from separate uploads have the same ID. The resource ID can only be used within the application, user and resource type it was originally returned for. For example, it&#x27;s not possible to use SnapshotDataResource&#x27;s resource ID as the resource_id of a SnapshotCoverImageResource, even if the blob is a valid image file.
135 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]136 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]137 &quot;hasConflictingRevisions&quot;: True or False, # An indicator whether the snapshot has any conflicting revisions or not. Always set.
138 &quot;name&quot;: &quot;A String&quot;, # An identifier of the snapshot,developer-specified.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]139 &quot;conflictingRevisions&quot;: [ # A list of conflicting revisions. Only set if explicitly requested (e.g. using a field mask or a request flag), or if the RPC guarantees that this field is set. The conflicting revisions are sorted chronologically by their server creation time (oldest first). If there are too many conflicting revisions to return all of them in a single request this will only contain the first batch. In such case, the presented conflicting revisions must be resolved first in order to fetch the next batch.
140 { # A Snapshot revision resource. Snapshot revisions are immutable.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]141 &quot;metadata&quot;: { # Metadata about a snapshot revision. Snapshot metadata is immutable - a metadata change corresponds to a new snapshot revision. # Metadata for this snapshot revision.
142 &quot;duration&quot;: &quot;A String&quot;, # The duration associated with this snapshot. Values with sub-millisecond precision can be rounded or trimmed to the closest millisecond.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]143 &quot;deviceName&quot;: &quot;A String&quot;, # The device that created the current revision.
144 &quot;title&quot;: &quot;A String&quot;, # The title of this snapshot.
145 &quot;progressValue&quot;: &quot;A String&quot;, # The progress value (64-bit integer set by developer) associated with this snapshot.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]146 &quot;lastModifyTime&quot;: &quot;A String&quot;, # The timestamp of the last modification to this snapshot. Values with sub-millisecond precision can be rounded or trimmed to the closest millisecond.
147 &quot;description&quot;: &quot;A String&quot;, # The description of this snapshot.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]148 },
149 &quot;id&quot;: &quot;A String&quot;, # Output only. A server generated identifier of the snapshot revision.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]150 &quot;blob&quot;: { # Identifies a snapshot data resource. The data is provided by the game. # Reference to the game provided blob for this revision.
151 &quot;contentHash&quot;: &quot;A String&quot;, # Output only. Hash-like weak identifier of the uploaded blob, consistent per player per application. Within the context of a single player/application, it&#x27;s guaranteed that two identical blobs coming from two different uploads will have the same content hash. It&#x27;s extremely likely, though not guaranteed, that if two content hashes are equal, the blobs are identical.
152 &quot;resourceId&quot;: &quot;A String&quot;, # The ID of the blob resource. It&#x27;s guaranteed that if two IDs are equal then the contents are equal as well. It&#x27;s not guaranteed that two identical blobs coming from separate uploads have the same resource ID. The resource ID can only be used within the application, user and resource type it was originally returned for. For example, it&#x27;s not possible to use SnapshotDataResource&#x27;s resource ID as the resource_id of a SnapshotCoverImageResource, even if the blob is a valid image file.
153 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. A URL that the client can use to download the blob. May vary across requests, and only guaranteed to be valid for a short time after it is returned.
154 &quot;size&quot;: &quot;A String&quot;, # Size of the saved game blob in bytes.
155 },
156 &quot;coverImage&quot;: { # Identifies a snapshot cover image resource. The image is provided by the game. # Reference to the cover image for this revision.
157 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. A URL the client can use to download the image. May vary across requests, and only guaranteed to be valid for a short time after it is returned.
158 &quot;width&quot;: 42, # Output only. The width of the image in pixels.
159 &quot;contentHash&quot;: &quot;A String&quot;, # Output only. Hash-like weak identifier of the uploaded image bytes, consistent per player per application. Within the context of a single player/application, it&#x27;s guaranteed that two identical blobs coming from two different uploads will have the same content hash. It&#x27;s extremely likely, though not guaranteed, that if two content hashes are equal, the images are identical.
160 &quot;mimeType&quot;: &quot;A String&quot;, # Output only. The MIME type of the image.
161 &quot;height&quot;: 42, # Output only. The height of the image in pixels.
162 &quot;resourceId&quot;: &quot;A String&quot;, # The ID of the image resource. It&#x27;s guaranteed that if two IDs are equal then the contents are equal as well. It&#x27;s not guaranteed that two identical blobs coming from separate uploads have the same ID. The resource ID can only be used within the application, user and resource type it was originally returned for. For example, it&#x27;s not possible to use SnapshotDataResource&#x27;s resource ID as the resource_id of a SnapshotCoverImageResource, even if the blob is a valid image file.
163 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]164 },
165 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]166 },
167 }</pre>
168</div>
169
170</body></html>