Applications

Represents the metadata for an application.

For a list of methods for this resource, see the end of this page.

Resource representations

This is a JSON template for the Application resource.

{
  "kind": "games#application",
  "id": string,
  "name": string,
  "author": string,
  "description": string,
  "category": {
    "kind": "games#applicationCategory",
    "primary": string,
    "secondary": string
  },
  "assets": [
    {
      "kind": "games#imageAsset",
      "name": string,
      "width": integer,
      "height": integer,
      "url": string
    }
  ],
  "instances": [
    {
      "kind": "games#instance",
      "platformType": string,
      "name": string,
      "turnBasedPlay": boolean,
      "realtimePlay": boolean,
      "acquisitionUri": string,
      "androidInstance": {
        "kind": "games#instanceAndroidDetails",
        "packageName": string,
        "enablePiracyCheck": boolean,
        "preferred": boolean
      },
      "iosInstance": {
        "kind": "games#instanceIosDetails",
        "supportIphone": boolean,
        "supportIpad": boolean,
        "bundleIdentifier": string,
        "itunesAppId": string,
        "preferredForIphone": boolean,
        "preferredForIpad": boolean
      },
      "webInstance": {
        "kind": "games#instanceWebDetails",
        "launchUrl": string,
        "preferred": boolean
      }
    }
  ],
  "lastUpdatedTimestamp": long,
  "achievement_count": integer,
  "leaderboard_count": integer,
  "enabledFeatures": [
    string
  ],
  "themeColor": string
}
Property name Value Description Notes
achievement_count integer The number of achievements visible to the currently authenticated player.
assets[] list The assets of the application.
assets[].height integer The height of the asset.
assets[].kind string Uniquely identifies the type of this resource. Value is always the fixed string games#imageAsset.
assets[].name string The name of the asset.
assets[].url string The URL of the asset.
assets[].width integer The width of the asset.
author string The author of the application.
category nested object The category of the application.
category.kind string Uniquely identifies the type of this resource. Value is always the fixed string games#applicationCategory.
category.primary string The primary category.
category.secondary string The secondary category.
description string The description of the application.
enabledFeatures[] list A list of features that have been enabled for the application.
Possible values are:
  • "SNAPSHOTS" - Snapshots has been enabled
id string The ID of the application.
instances[] list The instances of the application.
instances[].acquisitionUri string URI which shows where a user can acquire this instance.
instances[].androidInstance nested object Platform dependent details for Android.
instances[].androidInstance.enablePiracyCheck boolean Flag indicating whether the anti-piracy check is enabled.
instances[].androidInstance.kind string Uniquely identifies the type of this resource. Value is always the fixed string games#instanceAndroidDetails.
instances[].androidInstance.packageName string Android package name which maps to Google Play URL.
instances[].androidInstance.preferred boolean Indicates that this instance is the default for new installations.
instances[].iosInstance nested object Platform dependent details for iOS.
instances[].iosInstance.bundleIdentifier string Bundle identifier.
instances[].iosInstance.itunesAppId string iTunes App ID.
instances[].iosInstance.kind string Uniquely identifies the type of this resource. Value is always the fixed string games#instanceIosDetails.
instances[].iosInstance.preferredForIpad boolean Indicates that this instance is the default for new installations on iPad devices.
instances[].iosInstance.preferredForIphone boolean Indicates that this instance is the default for new installations on iPhone devices.
instances[].iosInstance.supportIpad boolean Flag to indicate if this instance supports iPad.
instances[].iosInstance.supportIphone boolean Flag to indicate if this instance supports iPhone.
instances[].kind string Uniquely identifies the type of this resource. Value is always the fixed string games#instance.
instances[].name string Localized display name.
instances[].platformType string The platform type.
Possible values are:
  • "ANDROID" - Instance is for Android.
  • "IOS" - Instance is for iOS
  • "WEB_APP" - Instance is for Web App.


Acceptable values are:
  • "ANDROID"
  • "IOS"
  • "WEB_APP"
instances[].realtimePlay boolean Flag to show if this game instance supports realtime play.
instances[].turnBasedPlay boolean Flag to show if this game instance supports turn based play.
instances[].webInstance nested object Platform dependent details for Web.
instances[].webInstance.kind string Uniquely identifies the type of this resource. Value is always the fixed string games#instanceWebDetails.
instances[].webInstance.launchUrl string Launch URL for the game.
instances[].webInstance.preferred boolean Indicates that this instance is the default for new installations.
kind string Uniquely identifies the type of this resource. Value is always the fixed string games#application.
lastUpdatedTimestamp long The last updated timestamp of the application.
leaderboard_count integer The number of leaderboards visible to the currently authenticated player.
name string The name of the application.
themeColor string A hint to the client UI for what color to use as an app-themed color. The color is given as an RGB triplet (e.g. "E0E0E0").

Methods

get
Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.
played
Indicate that the the currently authenticated user is playing your application.
verify
Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.

Send feedback about...

Play Games Services for Web
Play Games Services for Web