REST Resource: snapshots
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Snapshot
| JSON representation |
{
"id": string,
"driveId": string,
"kind": string,
"type": enum (SnapshotType),
"title": string,
"description": string,
"lastModifiedMillis": string,
"durationMillis": string,
"coverImage": {
object (SnapshotImage)
},
"uniqueName": string,
"progressValue": string
} |
| Fields |
id |
string
The ID of the snapshot.
|
driveId |
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.
|
kind |
string
Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot.
|
type |
enum (SnapshotType)
The type of this snapshot.
|
title |
string
The title of this snapshot.
|
description |
string
The description of this snapshot.
|
lastModifiedMillis |
string (int64 format)
The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
|
durationMillis |
string (int64 format)
The duration associated with this snapshot, in millis.
|
coverImage |
object (SnapshotImage)
The cover image of this snapshot. May be absent if there is no image.
|
uniqueName |
string
The unique name provided when the snapshot was created.
|
progressValue |
string (int64 format)
The progress value (64-bit integer set by developer) associated with this snapshot.
|
SnapshotType
Define supported snapshot types.
| Enums |
SAVE_GAME |
A snapshot representing a save game. |
SnapshotImage
| JSON representation |
{
"width": integer,
"height": integer,
"mime_type": string,
"url": string,
"kind": string
} |
| Fields |
width |
integer
The width of the image.
|
height |
integer
The height of the image.
|
mime_type |
string
The MIME type of the image.
|
url |
string
The URL of the image. This URL may be invalidated at any time and should not be cached.
|
kind |
string
Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage.
|
Methods |
|
|
Retrieves the metadata for a given snapshot ID. |
|
|
Retrieves a list of snapshots created by your application for the player corresponding to the player ID. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# REST Resource: snapshots\n\n- [Resource: Snapshot](#Snapshot)\n - [JSON representation](#Snapshot.SCHEMA_REPRESENTATION)\n- [SnapshotType](#SnapshotType)\n- [SnapshotImage](#SnapshotImage)\n - [JSON representation](#SnapshotImage.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Snapshot\n------------------\n\nAn snapshot object.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"driveId\": string, \"kind\": string, \"type\": enum (/games/services/web/api/rest/v1/snapshots#SnapshotType), \"title\": string, \"description\": string, \"lastModifiedMillis\": string, \"durationMillis\": string, \"coverImage\": { object (/games/services/web/api/rest/v1/snapshots#SnapshotImage) }, \"uniqueName\": string, \"progressValue\": string } ``` |\n\n| Fields ||\n|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The ID of the snapshot. |\n| `driveId` | `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. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshot`. |\n| `type` | `enum (`[SnapshotType](/games/services/web/api/rest/v1/snapshots#SnapshotType)`)` The type of this snapshot. |\n| `title` | `string` The title of this snapshot. |\n| `description` | `string` The description of this snapshot. |\n| `lastModifiedMillis` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The timestamp (in millis since Unix epoch) of the last modification to this snapshot. |\n| `durationMillis` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The duration associated with this snapshot, in millis. |\n| `coverImage` | `object (`[SnapshotImage](/games/services/web/api/rest/v1/snapshots#SnapshotImage)`)` The cover image of this snapshot. May be absent if there is no image. |\n| `uniqueName` | `string` The unique name provided when the snapshot was created. |\n| `progressValue` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The progress value (64-bit integer set by developer) associated with this snapshot. |\n\nSnapshotType\n------------\n\nDefine supported snapshot types.\n\n| Enums ||\n|-------------|--------------------------------------|\n| `SAVE_GAME` | A snapshot representing a save game. |\n\nSnapshotImage\n-------------\n\nAn image of a snapshot.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------|\n| ``` { \"width\": integer, \"height\": integer, \"mime_type\": string, \"url\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-------------|-----------------------------------------------------------------------------------------------------------------|\n| `width` | `integer` The width of the image. |\n| `height` | `integer` The height of the image. |\n| `mime_type` | `string` The MIME type of the image. |\n| `url` | `string` The URL of the image. This URL may be invalidated at any time and should not be cached. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotImage`. |\n\n| Methods ------- ||\n|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| ### [get](/games/services/web/api/rest/v1/snapshots/get) | Retrieves the metadata for a given snapshot ID. |\n| ### [list](/games/services/web/api/rest/v1/snapshots/list) | Retrieves a list of snapshots created by your application for the player corresponding to the player ID. |"]]
