<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
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>
<h1><a href="youtubereporting_v1.html">YouTube Reporting API</a> . <a href="youtubereporting_v1.jobs.html">jobs</a> . <a href="youtubereporting_v1.jobs.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(jobId, reportId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the metadata of a specific report.</p>
<p class="toc_element">
<code><a href="#list">list(jobId, pageSize=None, startTimeAtOrAfter=None, x__xgafv=None, pageToken=None, createdAfter=None, onBehalfOfContentOwner=None, startTimeBefore=None)</a></code></p>
<p class="firstline">Lists reports created by a specific job.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(jobId, reportId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Gets the metadata of a specific report.
Args:
jobId: string, The ID of the job. (required)
reportId: string, The ID of the report to retrieve. (required)
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A report's metadata including the URL from which the report itself can be
# downloaded.
"jobExpireTime": "A String", # The date/time when the job this report belongs to will expire/expired.
"jobId": "A String", # The ID of the job that created this report.
"downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
"startTime": "A String", # The start of the time period that the report instance covers. The value is
# inclusive.
"id": "A String", # The server-generated ID of the report.
"endTime": "A String", # The end of the time period that the report instance covers. The value is
# exclusive.
"createTime": "A String", # The date/time when this report was created.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(jobId, pageSize=None, startTimeAtOrAfter=None, x__xgafv=None, pageToken=None, createdAfter=None, onBehalfOfContentOwner=None, startTimeBefore=None)</code>
<pre>Lists reports created by a specific job.
Returns NOT_FOUND if the job does not exist.
Args:
jobId: string, The ID of the job. (required)
pageSize: integer, Requested page size. Server may return fewer report types than requested.
If unspecified, server will pick an appropriate default.
startTimeAtOrAfter: string, If set, only reports whose start time is greater than or equal the
specified date/time are returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
pageToken: string, A token identifying a page of results the server should return. Typically,
this is the value of
ListReportsResponse.next_page_token
returned in response to the previous call to the `ListReports` method.
createdAfter: string, If set, only reports created after the specified date/time are returned.
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).
startTimeBefore: string, If set, only reports whose start time is smaller than the specified
date/time are returned.
Returns:
An object of the form:
{ # Response message for ReportingService.ListReports.
"nextPageToken": "A String", # A token to retrieve next page of results.
# Pass this value in the
# ListReportsRequest.page_token
# field in the subsequent call to `ListReports` method to retrieve the next
# page of results.
"reports": [ # The list of report types.
{ # A report's metadata including the URL from which the report itself can be
# downloaded.
"jobExpireTime": "A String", # The date/time when the job this report belongs to will expire/expired.
"jobId": "A String", # The ID of the job that created this report.
"downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
"startTime": "A String", # The start of the time period that the report instance covers. The value is
# inclusive.
"id": "A String", # The server-generated ID of the report.
"endTime": "A String", # The end of the time period that the report instance covers. The value is
# exclusive.
"createTime": "A String", # The date/time when this report was created.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>