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

blob: 7b43dbdaccf142025eeff9a3ac9dba2168b20612 [file] [log] [blame]

Craig Citro	065b530	2014-08-14 00:47:23 -0700	[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.events.html">events</a></h1>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[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	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	81	<code><a href="#listByPlayer">listByPlayer(maxResults=None, language=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">Returns a list showing the current progress on events in this application for the currently authenticated user.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#listByPlayer_next">listByPlayer_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<p class="toc_element">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	87	<code><a href="#listDefinitions">listDefinitions(pageToken=None, maxResults=None, language=None, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	88	<p class="firstline">Returns a list of the event definitions in this application.</p>
				89	<p class="toc_element">
				90	<code><a href="#listDefinitions_next">listDefinitions_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	93	<code><a href="#record">record(body=None, language=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<p class="firstline">Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	95	<h3>Method Details</h3>
				96	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	97	<code class="details" id="close">close()</code>
				98	<pre>Close httplib2 connections.</pre>
				99	</div>
				100
				101	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	102	<code class="details" id="listByPlayer">listByPlayer(maxResults=None, language=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<pre>Returns a list showing the current progress on events in this application for the currently authenticated user.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	104
				105	Args:
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	106	maxResults: integer, The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	107	language: string, The preferred language to use for strings returned by this method.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	108	pageToken: string, The token returned by the previous request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	109	x__xgafv: string, V1 error format.
				110	Allowed values
				111	1 - v1 error format
				112	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	113
				114	Returns:
				115	An object of the form:
				116
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	117	{ # A ListByPlayer response.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	118	"items": [ # The player events.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	119	{ # An event status resource.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	120	"formattedNumEvents": "A String", # The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	121	"definitionId": "A String", # The ID of the event definition.
				122	"numEvents": "A String", # The current number of times this event has occurred.
				123	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	"playerId": "A String", # The ID of the player.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	125	},
				126	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	127	"nextPageToken": "A String", # The pagination token for the next page of results.
				128	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEventListResponse`.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	129	}</pre>
				130	</div>
				131
				132	<div class="method">
				133	<code class="details" id="listByPlayer_next">listByPlayer_next(previous_request, previous_response)</code>
				134	<pre>Retrieves the next page of results.
				135
				136	Args:
				137	previous_request: The request for the previous page. (required)
				138	previous_response: The response from the request for the previous page. (required)
				139
				140	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	A request object that you can call 'execute()' on to request the next
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	142	page. Returns None if there are no more items in the collection.
				143	</pre>
				144	</div>
				145
				146	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	147	<code class="details" id="listDefinitions">listDefinitions(pageToken=None, maxResults=None, language=None, x__xgafv=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	148	<pre>Returns a list of the event definitions in this application.
				149
				150	Args:
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	151	pageToken: string, The token returned by the previous request.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	152	maxResults: integer, The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified `maxResults`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	153	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]	154	x__xgafv: string, V1 error format.
				155	Allowed values
				156	1 - v1 error format
				157	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	158
				159	Returns:
				160	An object of the form:
				161
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	162	{ # A ListDefinitions response.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	163	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	164	"nextPageToken": "A String", # The pagination token for the next page of results.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	165	"items": [ # The event definitions.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	166	{ # An event definition resource.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	167	"displayName": "A String", # The name to display for the event.
				168	"id": "A String", # The ID of the event.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	169	"imageUrl": "A String", # The base URL for the image that represents the event.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	"childEvents": [ # A list of events that are a child of this event.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	171	{ # An event child relationship resource.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	172	"childId": "A String", # The ID of the child event.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	173	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	174	},
				175	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	176	"visibility": "A String", # The visibility of event being tracked in this definition.
				177	"isDefaultImageUrl": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
				178	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`.
				179	"description": "A String", # Description of what this event represents.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	180	},
				181	],
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	182	}</pre>
				183	</div>
				184
				185	<div class="method">
				186	<code class="details" id="listDefinitions_next">listDefinitions_next(previous_request, previous_response)</code>
				187	<pre>Retrieves the next page of results.
				188
				189	Args:
				190	previous_request: The request for the previous page. (required)
				191	previous_response: The response from the request for the previous page. (required)
				192
				193	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	194	A request object that you can call 'execute()' on to request the next
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	195	page. Returns None if there are no more items in the collection.
				196	</pre>
				197	</div>
				198
				199	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	200	<code class="details" id="record">record(body=None, language=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	201	<pre>Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	202
				203	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	204	body: object, The request body.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	205	The object takes the form of:
				206
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	207	{ # An event period update resource.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	208	"requestId": "A String", # The request ID used to identify this attempt to record events.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	209	"timePeriods": [ # A list of the time period updates being made in this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	210	{ # An event period update resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	211	"updates": [ # The updates being made for this time period.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	212	{ # An event period update resource.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	213	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateRequest`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	214	"updateCount": "A String", # The number of times this event occurred in this time period.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	215	"definitionId": "A String", # The ID of the event being modified in this update.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	216	},
				217	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	218	"timePeriod": { # An event period time range. # The time period being covered by this update.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	219	"periodStartMillis": "A String", # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	220	"periodEndMillis": "A String", # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	221	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	222	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	223	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodUpdate`.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	224	},
				225	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	226	"currentTimeMillis": "A String", # The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	227	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordRequest`.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	228	}
				229
				230	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]	231	x__xgafv: string, V1 error format.
				232	Allowed values
				233	1 - v1 error format
				234	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	235
				236	Returns:
				237	An object of the form:
				238
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	239	{ # An event period update resource.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	240	"eventFailures": [ # Any failures updating a particular event.
				241	{ # An event update failure resource.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	242	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordFailure`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	243	"failureCause": "A String", # The cause for the update failure.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	244	"eventId": "A String", # The ID of the event that was not updated.
				245	},
				246	],
				247	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateResponse`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame^]	248	"batchFailures": [ # Any batch-wide failures which occurred applying updates.
				249	{ # A batch update failure resource.
				250	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventBatchRecordFailure`.
				251	"range": { # An event period time range. # The time range which was rejected; empty for a request-wide failure.
				252	"periodStartMillis": "A String", # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
				253	"periodEndMillis": "A String", # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
				254	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`.
				255	},
				256	"failureCause": "A String", # The cause for the update failure.
				257	},
				258	],
				259	"playerEvents": [ # The current status of any updated events
				260	{ # An event status resource.
				261	"formattedNumEvents": "A String", # The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console.
				262	"definitionId": "A String", # The ID of the event definition.
				263	"numEvents": "A String", # The current number of times this event has occurred.
				264	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.
				265	"playerId": "A String", # The ID of the player.
				266	},
				267	],
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	268	}</pre>
				269	</div>
				270
				271	</body></html>