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

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