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

blob: b826107e3d9645f716d295946491fc333d266530 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[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
Bu Sun Kim	d059ad8	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	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	81	<code><a href="#get">get(applicationId, language=None, platformType=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">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.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	83	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	84	<code><a href="#getEndPoint">getEndPoint(applicationId=None, endPointType=None, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Returns a URL for the requested end point type.</p>
				86	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	87	<code><a href="#played">played(x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<p class="firstline">Indicate that the currently authenticated user is playing your application.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	89	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	90	<code><a href="#verify">verify(applicationId, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<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	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	92	<h3>Method Details</h3>
				93	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<code class="details" id="close">close()</code>
				95	<pre>Close httplib2 connections.</pre>
				96	</div>
				97
				98	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	99	<code class="details" id="get">get(applicationId, language=None, platformType=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	101
				102	Args:
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	103	applicationId: string, The application ID from the Google Play developer console. (required)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	104	language: string, The preferred language to use for strings returned by this method.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	105	platformType: string, Restrict application details returned to the specific platform.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	Allowed values
				107	PLATFORM_TYPE_UNSPECIFIED - Default value, don't use.
				108	ANDROID - Retrieve applications that can be played on Android.
				109	IOS - Retrieve applications that can be played on iOS.
				110	WEB_APP - Retrieve applications that can be played on desktop web.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	111	x__xgafv: string, V1 error format.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	112	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	113	1 - v1 error format
				114	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	115
				116	Returns:
				117	An object of the form:
				118
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	119	{ # The Application resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	120	"achievement_count": 42, # The number of achievements visible to the currently authenticated player.
				121	"assets": [ # The assets of the application.
				122	{ # An image asset object.
				123	"height": 42, # The height of the asset.
				124	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`.
				125	"name": "A String", # The name of the asset.
				126	"url": "A String", # The URL of the asset.
				127	"width": 42, # The width of the asset.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	128	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	129	],
				130	"author": "A String", # The author of the application.
				131	"category": { # An application category object. # The category of the application.
				132	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`.
				133	"primary": "A String", # The primary category.
				134	"secondary": "A String", # The secondary category.
				135	},
				136	"description": "A String", # The description of the application.
				137	"enabledFeatures": [ # A list of features that have been enabled for the application.
				138	"A String",
				139	],
				140	"id": "A String", # The ID of the application.
				141	"instances": [ # The instances of the application.
				142	{ # The Instance resource.
				143	"acquisitionUri": "A String", # URI which shows where a user can acquire this instance.
				144	"androidInstance": { # The Android instance details resource. # Platform dependent details for Android.
				145	"enablePiracyCheck": True or False, # Flag indicating whether the anti-piracy check is enabled.
				146	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`.
				147	"packageName": "A String", # Android package name which maps to Google Play URL.
				148	"preferred": True or False, # Indicates that this instance is the default for new installations.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	149	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	150	"iosInstance": { # The iOS details resource. # Platform dependent details for iOS.
				151	"bundleIdentifier": "A String", # Bundle identifier.
				152	"itunesAppId": "A String", # iTunes App ID.
				153	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`.
				154	"preferredForIpad": True or False, # Indicates that this instance is the default for new installations on iPad devices.
				155	"preferredForIphone": True or False, # Indicates that this instance is the default for new installations on iPhone devices.
				156	"supportIpad": True or False, # Flag to indicate if this instance supports iPad.
				157	"supportIphone": True or False, # Flag to indicate if this instance supports iPhone.
				158	},
				159	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`.
				160	"name": "A String", # Localized display name.
				161	"platformType": "A String", # The platform type.
				162	"realtimePlay": True or False, # Flag to show if this game instance supports realtime play.
				163	"turnBasedPlay": True or False, # Flag to show if this game instance supports turn based play.
				164	"webInstance": { # The Web details resource. # Platform dependent details for Web.
				165	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceWebDetails`.
				166	"launchUrl": "A String", # Launch URL for the game.
				167	"preferred": True or False, # Indicates that this instance is the default for new installations.
				168	},
				169	},
				170	],
				171	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#application`.
				172	"lastUpdatedTimestamp": "A String", # The last updated timestamp of the application.
				173	"leaderboard_count": 42, # The number of leaderboards visible to the currently authenticated player.
				174	"name": "A String", # The name of the application.
				175	"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").
				176	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	177	</div>
				178
				179	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	180	<code class="details" id="getEndPoint">getEndPoint(applicationId=None, endPointType=None, x__xgafv=None)</code>
				181	<pre>Returns a URL for the requested end point type.
				182
				183	Args:
				184	applicationId: string, The application ID from the Google Play developer console.
				185	endPointType: string, Type of endpoint being requested.
				186	Allowed values
				187	END_POINT_TYPE_UNSPECIFIED - Default value. This value is unused.
				188	PROFILE_CREATION - Request a URL to create a new profile.
				189	PROFILE_SETTINGS - Request a URL for the Settings view.
				190	x__xgafv: string, V1 error format.
				191	Allowed values
				192	1 - v1 error format
				193	2 - v2 error format
				194
				195	Returns:
				196	An object of the form:
				197
				198	{ # Container for a URL end point of the requested type.
				199	"url": "A String", # A URL suitable for loading in a web browser for the requested endpoint.
				200	}</pre>
				201	</div>
				202
				203	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	204	<code class="details" id="played">played(x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	205	<pre>Indicate that the currently authenticated user is playing your application.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	206
				207	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	208	x__xgafv: string, V1 error format.
				209	Allowed values
				210	1 - v1 error format
				211	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	212	</pre>
				213	</div>
				214
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	215	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	216	<code class="details" id="verify">verify(applicationId, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	217	<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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	218
				219	Args:
				220	applicationId: string, The application ID from the Google Play developer console. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	221	x__xgafv: string, V1 error format.
				222	Allowed values
				223	1 - v1 error format
				224	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	225
				226	Returns:
				227	An object of the form:
				228
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	229	{ # A third party application verification response resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	230	"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.)
				231	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`.
				232	"player_id": "A String", # The ID of the player that was issued the auth token used in this request.
				233	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	234	</div>
				235
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	236	</body></html>