| 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 | |
| 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"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 78 | <code><a href="#get">get(snapshotId, language=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 | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(playerId, language=None, maxResults=None, pageToken=None)</a></code></p> |
| Craig Citro | 065b530 | 2014-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"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <code class="details" id="get">get(snapshotId, language=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. |
| 94 | |
| 95 | Returns: |
| 96 | An object of the form: |
| 97 | |
| 98 | { # This is a JSON template for an snapshot object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 99 | "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. |
| 100 | "height": 42, # The height of the image. |
| 101 | "kind": "games#snapshotImage", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage. |
| 102 | "mime_type": "A String", # The MIME type of the image. |
| 103 | "url": "A String", # The URL of the image. This URL may be invalidated at any time and should not be cached. |
| 104 | "width": 42, # The width of the image. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 105 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 106 | "description": "A String", # The description of this snapshot. |
| 107 | "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. |
| 108 | "durationMillis": "A String", # The duration associated with this snapshot, in millis. |
| 109 | "id": "A String", # The ID of the snapshot. |
| 110 | "kind": "games#snapshot", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot. |
| 111 | "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this snapshot. |
| 112 | "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this snapshot. |
| 113 | "title": "A String", # The title of this snapshot. |
| 114 | "type": "A String", # The type of this snapshot. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 115 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | # - "SAVE_GAME" - A snapshot representing a save game. |
| 117 | "uniqueName": "A String", # The unique name provided when the snapshot was created. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 118 | }</pre> |
| 119 | </div> |
| 120 | |
| 121 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 122 | <code class="details" id="list">list(playerId, language=None, maxResults=None, pageToken=None)</code> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 123 | <pre>Retrieves a list of snapshots created by your application for the player corresponding to the player ID. |
| 124 | |
| 125 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required) |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 127 | language: string, The preferred language to use for strings returned by this method. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 128 | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | pageToken: string, The token returned by the previous request. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 130 | |
| 131 | Returns: |
| 132 | An object of the form: |
| 133 | |
| 134 | { # This is a JSON template for a list of snapshot objects. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | "items": [ # The snapshots. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 136 | { # This is a JSON template for an snapshot object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | "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. |
| 138 | "height": 42, # The height of the image. |
| 139 | "kind": "games#snapshotImage", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage. |
| 140 | "mime_type": "A String", # The MIME type of the image. |
| 141 | "url": "A String", # The URL of the image. This URL may be invalidated at any time and should not be cached. |
| 142 | "width": 42, # The width of the image. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 143 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | "description": "A String", # The description of this snapshot. |
| 145 | "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. |
| 146 | "durationMillis": "A String", # The duration associated with this snapshot, in millis. |
| 147 | "id": "A String", # The ID of the snapshot. |
| 148 | "kind": "games#snapshot", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot. |
| 149 | "lastModifiedMillis": "A String", # The timestamp (in millis since Unix epoch) of the last modification to this snapshot. |
| 150 | "progressValue": "A String", # The progress value (64-bit integer set by developer) associated with this snapshot. |
| 151 | "title": "A String", # The title of this snapshot. |
| 152 | "type": "A String", # The type of this snapshot. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 153 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 154 | # - "SAVE_GAME" - A snapshot representing a save game. |
| 155 | "uniqueName": "A String", # The unique name provided when the snapshot was created. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 156 | }, |
| 157 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | "kind": "games#snapshotListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotListResponse. |
| 159 | "nextPageToken": "A String", # Token corresponding to the next page of results. If there are no more results, the token is omitted. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 160 | }</pre> |
| 161 | </div> |
| 162 | |
| 163 | <div class="method"> |
| 164 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 165 | <pre>Retrieves the next page of results. |
| 166 | |
| 167 | Args: |
| 168 | previous_request: The request for the previous page. (required) |
| 169 | previous_response: The response from the request for the previous page. (required) |
| 170 | |
| 171 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | 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] | 173 | page. Returns None if there are no more items in the collection. |
| 174 | </pre> |
| 175 | </div> |
| 176 | |
| 177 | </body></html> |