• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, 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
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, 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> . <a href="youtubereporting_v1.jobs.reports.html">reports</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(jobId, reportId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the metadata of a specific report.</p>
80<p class="toc_element">
81  <code><a href="#list">list(jobId, pageSize=None, startTimeAtOrAfter=None, x__xgafv=None, pageToken=None, createdAfter=None, onBehalfOfContentOwner=None, startTimeBefore=None)</a></code></p>
82<p class="firstline">Lists reports created by a specific job.</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(jobId, reportId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
89  <pre>Gets the metadata of a specific report.
90
91Args:
92  jobId: string, The ID of the job. (required)
93  reportId: string, The ID of the report to retrieve. (required)
94  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
95not set, the user is acting for himself (his own channel).
96  x__xgafv: string, V1 error format.
97    Allowed values
98      1 - v1 error format
99      2 - v2 error format
100
101Returns:
102  An object of the form:
103
104    { # A report's metadata including the URL from which the report itself can be
105      # downloaded.
106    "jobExpireTime": "A String", # The date/time when the job this report belongs to will expire/expired.
107    "jobId": "A String", # The ID of the job that created this report.
108    "downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
109    "startTime": "A String", # The start of the time period that the report instance covers. The value is
110        # inclusive.
111    "id": "A String", # The server-generated ID of the report.
112    "endTime": "A String", # The end of the time period that the report instance covers. The value is
113        # exclusive.
114    "createTime": "A String", # The date/time when this report was created.
115  }</pre>
116</div>
117
118<div class="method">
119    <code class="details" id="list">list(jobId, pageSize=None, startTimeAtOrAfter=None, x__xgafv=None, pageToken=None, createdAfter=None, onBehalfOfContentOwner=None, startTimeBefore=None)</code>
120  <pre>Lists reports created by a specific job.
121Returns NOT_FOUND if the job does not exist.
122
123Args:
124  jobId: string, The ID of the job. (required)
125  pageSize: integer, Requested page size. Server may return fewer report types than requested.
126If unspecified, server will pick an appropriate default.
127  startTimeAtOrAfter: string, If set, only reports whose start time is greater than or equal the
128specified date/time are returned.
129  x__xgafv: string, V1 error format.
130    Allowed values
131      1 - v1 error format
132      2 - v2 error format
133  pageToken: string, A token identifying a page of results the server should return. Typically,
134this is the value of
135ListReportsResponse.next_page_token
136returned in response to the previous call to the `ListReports` method.
137  createdAfter: string, If set, only reports created after the specified date/time are returned.
138  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
139not set, the user is acting for himself (his own channel).
140  startTimeBefore: string, If set, only reports whose start time is smaller than the specified
141date/time are returned.
142
143Returns:
144  An object of the form:
145
146    { # Response message for ReportingService.ListReports.
147    "nextPageToken": "A String", # A token to retrieve next page of results.
148        # Pass this value in the
149        # ListReportsRequest.page_token
150        # field in the subsequent call to `ListReports` method to retrieve the next
151        # page of results.
152    "reports": [ # The list of report types.
153      { # A report's metadata including the URL from which the report itself can be
154          # downloaded.
155        "jobExpireTime": "A String", # The date/time when the job this report belongs to will expire/expired.
156        "jobId": "A String", # The ID of the job that created this report.
157        "downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
158        "startTime": "A String", # The start of the time period that the report instance covers. The value is
159            # inclusive.
160        "id": "A String", # The server-generated ID of the report.
161        "endTime": "A String", # The end of the time period that the report instance covers. The value is
162            # exclusive.
163        "createTime": "A String", # The date/time when this report was created.
164      },
165    ],
166  }</pre>
167</div>
168
169<div class="method">
170    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
171  <pre>Retrieves the next page of results.
172
173Args:
174  previous_request: The request for the previous page. (required)
175  previous_response: The response from the request for the previous page. (required)
176
177Returns:
178  A request object that you can call 'execute()' on to request the next
179  page. Returns None if there are no more items in the collection.
180    </pre>
181</div>
182
183</body></html>