| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="games_v1.html">Google Play Game Services</a> . <a href="games_v1.snapshots.html">snapshots</a></h1> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#get">get(snapshotId, language=None, x__xgafv=None)</a></code></p> |
| Craig Citro | 065b530 | 2014-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"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(playerId, maxResults=None, pageToken=None, language=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Retrieves a list of snapshots created by your application for the player</p> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 88 | <code class="details" id="get">get(snapshotId, language=None, x__xgafv=None)</code> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 89 | <pre>Retrieves the metadata for a given snapshot ID. |
| 90 | |
| 91 | Args: |
| 92 | snapshotId: string, The ID of the snapshot. (required) |
| 93 | language: string, The preferred language to use for strings returned by this method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 94 | x__xgafv: string, V1 error format. |
| 95 | Allowed values |
| 96 | 1 - v1 error format |
| 97 | 2 - v2 error format |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 98 | |
| 99 | Returns: |
| 100 | An object of the form: |
| 101 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 102 | { # An snapshot object. |
| 103 | "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this |
| 104 | # snapshot. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | "uniqueName": "A String", # The unique name provided when the snapshot was created. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 106 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| 107 | # string `games#snapshot`. |
| 108 | "driveId": "A String", # The ID of the file underlying this snapshot in the Drive API. Only present |
| 109 | # if the snapshot is a view on a Drive file and the file is owned by the |
| 110 | # caller. |
| 111 | "durationMillis": "A String", # The duration associated with this snapshot, in millis. |
| 112 | "title": "A String", # The title of this snapshot. |
| 113 | "coverImage": { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image. |
| 114 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| 115 | # string `games#snapshotImage`. |
| 116 | "url": "A String", # The URL of the image. This URL may be invalidated at any time and should |
| 117 | # not be cached. |
| 118 | "width": 42, # The width of the image. |
| 119 | "mime_type": "A String", # The MIME type of the image. |
| 120 | "height": 42, # The height of the image. |
| 121 | }, |
| 122 | "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this |
| 123 | # snapshot. |
| 124 | "description": "A String", # The description of this snapshot. |
| 125 | "type": "A String", # The type of this snapshot. |
| 126 | "id": "A String", # The ID of the snapshot. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 127 | }</pre> |
| 128 | </div> |
| 129 | |
| 130 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 131 | <code class="details" id="list">list(playerId, maxResults=None, pageToken=None, language=None, x__xgafv=None)</code> |
| 132 | <pre>Retrieves a list of snapshots created by your application for the player |
| 133 | corresponding to the player ID. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 134 | |
| 135 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 136 | playerId: string, A player ID. A value of `me` may be used in place of the authenticated |
| 137 | player's ID. (required) |
| 138 | maxResults: integer, The maximum number of snapshot resources to return in the response, used |
| 139 | for paging. For any response, the actual number of snapshot resources |
| 140 | returned may be less than the specified `maxResults`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | pageToken: string, The token returned by the previous request. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 142 | language: string, The preferred language to use for strings returned by this method. |
| 143 | x__xgafv: string, V1 error format. |
| 144 | Allowed values |
| 145 | 1 - v1 error format |
| 146 | 2 - v2 error format |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 147 | |
| 148 | Returns: |
| 149 | An object of the form: |
| 150 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 151 | { # A third party list snapshots response. |
| 152 | "nextPageToken": "A String", # Token corresponding to the next page of results. If there are no more |
| 153 | # results, the token is omitted. |
| 154 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| 155 | # string `games#snapshotListResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 156 | "items": [ # The snapshots. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 157 | { # An snapshot object. |
| 158 | "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this |
| 159 | # snapshot. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "uniqueName": "A String", # The unique name provided when the snapshot was created. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 161 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| 162 | # string `games#snapshot`. |
| 163 | "driveId": "A String", # The ID of the file underlying this snapshot in the Drive API. Only present |
| 164 | # if the snapshot is a view on a Drive file and the file is owned by the |
| 165 | # caller. |
| 166 | "durationMillis": "A String", # The duration associated with this snapshot, in millis. |
| 167 | "title": "A String", # The title of this snapshot. |
| 168 | "coverImage": { # An image of a snapshot. # The cover image of this snapshot. May be absent if there is no image. |
| 169 | "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed |
| 170 | # string `games#snapshotImage`. |
| 171 | "url": "A String", # The URL of the image. This URL may be invalidated at any time and should |
| 172 | # not be cached. |
| 173 | "width": 42, # The width of the image. |
| 174 | "mime_type": "A String", # The MIME type of the image. |
| 175 | "height": 42, # The height of the image. |
| 176 | }, |
| 177 | "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this |
| 178 | # snapshot. |
| 179 | "description": "A String", # The description of this snapshot. |
| 180 | "type": "A String", # The type of this snapshot. |
| 181 | "id": "A String", # The ID of the snapshot. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 182 | }, |
| 183 | ], |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 184 | }</pre> |
| 185 | </div> |
| 186 | |
| 187 | <div class="method"> |
| 188 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 189 | <pre>Retrieves the next page of results. |
| 190 | |
| 191 | Args: |
| 192 | previous_request: The request for the previous page. (required) |
| 193 | previous_response: The response from the request for the previous page. (required) |
| 194 | |
| 195 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 196 | A request object that you can call 'execute()' on to request the next |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 197 | page. Returns None if there are no more items in the collection. |
| 198 | </pre> |
| 199 | </div> |
| 200 | |
| 201 | </body></html> |