Blame - docs/dyn/youtubereporting_v1.jobs.html - platform/external/python/google-api-python-client

blob: 81bf9d8e2629dd598c38881766f2031499a993e9 [file] [log] [blame]

Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[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
				75	<h1><a href="youtubereporting_v1.html">YouTube Reporting API</a> . <a href="youtubereporting_v1.jobs.html">jobs</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="youtubereporting_v1.jobs.reports.html">reports()</a></code>
				79	</p>
				80	<p class="firstline">Returns the reports Resource.</p>
				81
				82	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	86	<code><a href="#create">create(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	87	<p class="firstline">Creates a job and returns it.</p>
				88	<p class="toc_element">
				89	<code><a href="#delete">delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Deletes a job.</p>
				91	<p class="toc_element">
				92	<code><a href="#get">get(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
				93	<p class="firstline">Gets a job.</p>
				94	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	95	<code><a href="#list">list(includeSystemManaged=None, onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	96	<p class="firstline">Lists jobs.</p>
				97	<p class="toc_element">
				98	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				99	<p class="firstline">Retrieves the next page of results.</p>
				100	<h3>Method Details</h3>
				101	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<code class="details" id="close">close()</code>
				103	<pre>Close httplib2 connections.</pre>
				104	</div>
				105
				106	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	107	<code class="details" id="create">create(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	108	<pre>Creates a job and returns it.
				109
				110	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	body: object, The request body.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	112	The object takes the form of:
				113
				114	{ # A job creating reports of a specific type.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	115	"createTime": "A String", # The creation date/time of the job.
				116	"expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no new reports are generated.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	117	"id": "A String", # The server-generated ID of the job (max. 40 characters).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	118	"name": "A String", # The name of the job (max. 100 characters).
				119	"reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
				120	"systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user; otherwise false.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	121	}
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	122
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	123	onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	124	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	125	Allowed values
				126	1 - v1 error format
				127	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	128
				129	Returns:
				130	An object of the form:
				131
				132	{ # A job creating reports of a specific type.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	133	"createTime": "A String", # The creation date/time of the job.
				134	"expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no new reports are generated.
				135	"id": "A String", # The server-generated ID of the job (max. 40 characters).
				136	"name": "A String", # The name of the job (max. 100 characters).
				137	"reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
				138	"systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user; otherwise false.
				139	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	140	</div>
				141
				142	<div class="method">
				143	<code class="details" id="delete">delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
				144	<pre>Deletes a job.
				145
				146	Args:
				147	jobId: string, The ID of the job to delete. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	148	onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	149	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	150	Allowed values
				151	1 - v1 error format
				152	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	153
				154	Returns:
				155	An object of the form:
				156
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	157	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	158	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	159	</div>
				160
				161	<div class="method">
				162	<code class="details" id="get">get(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
				163	<pre>Gets a job.
				164
				165	Args:
				166	jobId: string, The ID of the job to retrieve. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	167	onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	168	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	169	Allowed values
				170	1 - v1 error format
				171	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	172
				173	Returns:
				174	An object of the form:
				175
				176	{ # A job creating reports of a specific type.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	177	"createTime": "A String", # The creation date/time of the job.
				178	"expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no new reports are generated.
				179	"id": "A String", # The server-generated ID of the job (max. 40 characters).
				180	"name": "A String", # The name of the job (max. 100 characters).
				181	"reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
				182	"systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user; otherwise false.
				183	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	184	</div>
				185
				186	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	187	<code class="details" id="list">list(includeSystemManaged=None, onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	188	<pre>Lists jobs.
				189
				190	Args:
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	191	includeSystemManaged: boolean, If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	192	onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
				193	pageSize: integer, Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	194	pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	195	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	196	Allowed values
				197	1 - v1 error format
				198	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	199
				200	Returns:
				201	An object of the form:
				202
				203	{ # Response message for ReportingService.ListJobs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	204	"jobs": [ # The list of jobs.
				205	{ # A job creating reports of a specific type.
				206	"createTime": "A String", # The creation date/time of the job.
				207	"expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no new reports are generated.
				208	"id": "A String", # The server-generated ID of the job (max. 40 characters).
				209	"name": "A String", # The name of the job (max. 100 characters).
				210	"reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
				211	"systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user; otherwise false.
				212	},
				213	],
				214	"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results.
				215	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	216	</div>
				217
				218	<div class="method">
				219	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				220	<pre>Retrieves the next page of results.
				221
				222	Args:
				223	previous_request: The request for the previous page. (required)
				224	previous_response: The response from the request for the previous page. (required)
				225
				226	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	228	page. Returns None if there are no more items in the collection.
				229	</pre>
				230	</div>
				231
				232	</body></html>