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

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

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

Bu Sun Kim

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.applications.html">applications</a></h1>

John Asmuth

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

78

<code><a href="#get">get(applicationId, platformType=None, language=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Retrieves the metadata of the application with the given ID. If the</p>

John Asmuth

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

[diff] [blame]

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

81

<code><a href="#played">played(x__xgafv=None)</a></code></p>

82

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

Jon Wayne Parrott

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

[diff] [blame]

83

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

84

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

85

<p class="firstline">Verifies the auth token provided with this request is for the application</p>

John Asmuth

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

[diff] [blame]

86

<h3>Method Details</h3>

87

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

88

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

89

<pre>Retrieves the metadata of the application with the given ID. If the

90

requested application is not available for the specified

91

`platformType`, the returned response will not include any

92

instance data.

John Asmuth

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

[diff] [blame]

93

94

Args:

Craig Citro

e633be1

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

[diff] [blame]

95

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

John Asmuth

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

[diff] [blame]

96

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

97

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

98

x__xgafv: string, V1 error format.

John Asmuth

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

[diff] [blame]

99

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

100

1 - v1 error format

101

2 - v2 error format

John Asmuth

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

[diff] [blame]

102

103

Returns:

104

An object of the form:

105

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

106

{ # The Application resource.

107

"themeColor": "A String", # A hint to the client UI for what color to use as an app-themed color. The

108

# color is given as an RGB triplet (e.g. "E0E0E0").

109

"category": { # An application category object. # The category of the application.

110

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

111

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

112

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

113

# string `games#applicationCategory`.

114

},

115

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

116

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

117

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

118

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

119

# string `games#application`.

120

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

121

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

Bu Sun Kim

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

[diff] [blame]

122

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

123

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

124

{ # The Instance resource.

125

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

126

"webInstance": { # The Web details resource. # Platform dependent details for Web.

127

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

128

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

129

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

130

# string `games#instanceWebDetails`.

131

},

132

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

133

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

134

# string `games#instance`.

135

"androidInstance": { # The Android instance details resource. # Platform dependent details for Android.

136

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

137

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

138

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

139

# string `games#instanceAndroidDetails`.

140

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

141

},

142

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

143

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

144

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

145

"iosInstance": { # The iOS details resource. # Platform dependent details for iOS.

146

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

147

# devices.

148

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

149

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

150

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

151

# devices.

152

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

153

# string `games#instanceIosDetails`.

154

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

155

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

},

},

],

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

Bu Sun Kim

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

[diff] [blame]

160

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

161

{ # An image asset object.

Bu Sun Kim

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

[diff] [blame]

162

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

163

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

164

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

165

# string `games#imageAsset`.

Bu Sun Kim

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

[diff] [blame]

166

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

167

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

John Asmuth

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

[diff] [blame]

168

},

169

],

Bu Sun Kim

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

[diff] [blame]

170

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

Bu Sun Kim

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

[diff] [blame]

171

"A String",

Craig Citro

065b530

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

[diff] [blame]

172

],

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

177

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

178

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

179

application.

John Asmuth

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

[diff] [blame]

180

181

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

182

x__xgafv: string, V1 error format.

183

Allowed values

184

1 - v1 error format

185

2 - v2 error format

John Asmuth

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

[diff] [blame]

</pre>

</div>

Jon Wayne Parrott

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

[diff] [blame]

189

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

190

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

191

<pre>Verifies the auth token provided with this request is for the application

192

with the specified ID, and returns the ID of the player it was granted for.

Jon Wayne Parrott

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

[diff] [blame]

193

194

Args:

195

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

196

x__xgafv: string, V1 error format.

197

Allowed values

198

1 - v1 error format

199

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

200

201

Returns:

202

An object of the form:

203

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

204

{ # A third party application verification response resource.

Bu Sun Kim

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

[diff] [blame]

205

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

206

"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed

207

# string `games#applicationVerifyResponse`.

208

"alternate_player_id": "A String", # An alternate ID that was once used for the player that was issued the auth

209

# token used in this request. (This field is not normally populated.)

Jon Wayne Parrott