blob: 1bd13af0470c935e0a26610dc03ae853464d0868 [file] [log] [blame]
<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="youtubeAnalytics_v1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1.batchReports.html">batchReports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(batchReportDefinitionId, onBehalfOfContentOwner)</a></code></p>
<p class="firstline">Retrieves a list of processed batch reports.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(batchReportDefinitionId, onBehalfOfContentOwner)</code>
<pre>Retrieves a list of processed batch reports.
Args:
batchReportDefinitionId: string, The batchReportDefinitionId parameter specifies the ID of the batch reportort definition for which you are retrieving reports. (required)
onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)
Returns:
An object of the form:
{ # A paginated list of batchReport resources returned in response to a youtubeAnalytics.batchReport.list request.
"items": [ # A list of batchReport resources that match the request criteria.
{ # Contains single batchReport resource.
"kind": "youtubeAnalytics#batchReport", # This value specifies the type of data of this item. For batch report the kind property value is youtubeAnalytics#batchReport.
"timeSpan": { # Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.
"endTime": "A String", # End of the period included in the report. Inclusive. For reports containing all entities endTime is not set.
"startTime": "A String", # Start of the period included in the report. Inclusive.
},
"outputs": [ # Report outputs.
{
"downloadUrl": "A String", # Cloud storage URL to download this report. This URL is valid for 30 minutes.
"type": "cloudStorageOutput", # Type of the output.
"format": "A String", # Format of the output.
},
],
"reportId": "A String", # The ID of the the report definition.
"timeUpdated": "A String", # The time when the report was updated.
"id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report.
},
],
"kind": "youtubeAnalytics#batchReportList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportList.
}</pre>
</div>
</body></html>