Blame - docs/dyn/games_v1.applications.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

82

<p class="firstline">Indicate that the the currently authenticated user is playing your application.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

83

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<code><a href="#verify">verify(applicationId)</a></code></p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

85

<p class="firstline">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.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

86

<h3>Method Details</h3>

87

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<code class="details" id="get">get(applicationId, language=None, platformType=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

89

<pre>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.

90

91

Args:

Craig Citro

e633be1

2015-03-02 13:40:36 -0800

[diff] [blame]

92

applicationId: string, The application ID from the Google Play developer console. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

93

language: string, The preferred language to use for strings returned by this method.

94

platformType: string, Restrict application details returned to the specific platform.

95

Allowed values

96

ANDROID - Retrieve applications that can be played on Android.

97

IOS - Retrieve applications that can be played on iOS.

98

WEB_APP - Retrieve applications that can be played on desktop web.

99

100

Returns:

101

An object of the form:

102

103

{ # This is a JSON template for the Application resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

104

"achievement_count": 42, # The number of achievements visible to the currently authenticated player.

105

"assets": [ # The assets of the application.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

106

{ # This is a JSON template for an image asset object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

107

"height": 42, # The height of the asset.

108

"kind": "games#imageAsset", # Uniquely identifies the type of this resource. Value is always the fixed string games#imageAsset.

109

"name": "A String", # The name of the asset.

110

"url": "A String", # The URL of the asset.

111

"width": 42, # The width of the asset.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

112

},

113

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

114

"author": "A String", # The author of the application.

115

"category": { # This is a JSON template for an application category object. # The category of the application.

116

"kind": "games#applicationCategory", # Uniquely identifies the type of this resource. Value is always the fixed string games#applicationCategory.

117

"primary": "A String", # The primary category.

118

"secondary": "A String", # The secondary category.

119

},

120

"description": "A String", # The description of the application.

121

"enabledFeatures": [ # A list of features that have been enabled for the application.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

122

# Possible values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

123

# - "SNAPSHOTS" - Snapshots has been enabled

124

"A String",

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

125

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

126

"id": "A String", # The ID of the application.

127

"instances": [ # The instances of the application.

128

{ # This is a JSON template for the Instance resource.

129

"acquisitionUri": "A String", # URI which shows where a user can acquire this instance.

130

"androidInstance": { # This is a JSON template for the Android instance details resource. # Platform dependent details for Android.

131

"enablePiracyCheck": True or False, # Flag indicating whether the anti-piracy check is enabled.

132

"kind": "games#instanceAndroidDetails", # Uniquely identifies the type of this resource. Value is always the fixed string games#instanceAndroidDetails.

133

"packageName": "A String", # Android package name which maps to Google Play URL.

134

"preferred": True or False, # Indicates that this instance is the default for new installations.

135

},

136

"iosInstance": { # This is a JSON template for the iOS details resource. # Platform dependent details for iOS.

137

"bundleIdentifier": "A String", # Bundle identifier.

138

"itunesAppId": "A String", # iTunes App ID.

139

"kind": "games#instanceIosDetails", # Uniquely identifies the type of this resource. Value is always the fixed string games#instanceIosDetails.

140

"preferredForIpad": True or False, # Indicates that this instance is the default for new installations on iPad devices.

141

"preferredForIphone": True or False, # Indicates that this instance is the default for new installations on iPhone devices.

142

"supportIpad": True or False, # Flag to indicate if this instance supports iPad.

143

"supportIphone": True or False, # Flag to indicate if this instance supports iPhone.

144

},

145

"kind": "games#instance", # Uniquely identifies the type of this resource. Value is always the fixed string games#instance.

146

"name": "A String", # Localized display name.

147

"platformType": "A String", # The platform type.

148

# Possible values are:

149

# - "ANDROID" - Instance is for Android.

150

# - "IOS" - Instance is for iOS

151

# - "WEB_APP" - Instance is for Web App.

152

"realtimePlay": True or False, # Flag to show if this game instance supports realtime play.

153

"turnBasedPlay": True or False, # Flag to show if this game instance supports turn based play.

154

"webInstance": { # This is a JSON template for the Web details resource. # Platform dependent details for Web.

155

"kind": "games#instanceWebDetails", # Uniquely identifies the type of this resource. Value is always the fixed string games#instanceWebDetails.

156

"launchUrl": "A String", # Launch URL for the game.

157

"preferred": True or False, # Indicates that this instance is the default for new installations.

},

},

],

"kind": "games#application", # Uniquely identifies the type of this resource. Value is always the fixed string games#application.

162

"lastUpdatedTimestamp": "A String", # The last updated timestamp of the application.

163

"leaderboard_count": 42, # The number of leaderboards visible to the currently authenticated player.

164

"name": "A String", # The name of the application.

165

"themeColor": "A 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").

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

170

<code class="details" id="played">played()</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

171

<pre>Indicate that the the currently authenticated user is playing your application.

Args:

</pre>

</div>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

177

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

178

<code class="details" id="verify">verify(applicationId)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

179

<pre>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.

180

181

Args:

182

applicationId: string, The application ID from the Google Play developer console. (required)

183

184

Returns:

185

An object of the form:

186

187

{ # This is a JSON template for a third party application verification response resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

188

"alternate_player_id": "A String", # An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.)

189

"kind": "games#applicationVerifyResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#applicationVerifyResponse.

190

"player_id": "A String", # The ID of the player that was issued the auth token used in this request.

Jon Wayne Parrott