• 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.reportTypes.html">reportTypes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None, includeSystemManaged=None)</a></code></p>
79<p class="firstline">Lists report types.</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None, includeSystemManaged=None)</code>
86  <pre>Lists report types.
87
88Args:
89  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
90not set, the user is acting for himself (his own channel).
91  pageSize: integer, Requested page size. Server may return fewer report types than requested.
92If unspecified, server will pick an appropriate default.
93  pageToken: string, A token identifying a page of results the server should return. Typically,
94this is the value of
95ListReportTypesResponse.next_page_token
96returned in response to the previous call to the `ListReportTypes` method.
97  x__xgafv: string, V1 error format.
98    Allowed values
99      1 - v1 error format
100      2 - v2 error format
101  includeSystemManaged: boolean, If set to true, also system-managed report types will be returned;
102otherwise only the report types that can be used to create new reporting
103jobs will be returned.
104
105Returns:
106  An object of the form:
107
108    { # Response message for ReportingService.ListReportTypes.
109    "nextPageToken": "A String", # A token to retrieve next page of results.
110        # Pass this value in the
111        # ListReportTypesRequest.page_token
112        # field in the subsequent call to `ListReportTypes` method to retrieve the next
113        # page of results.
114    "reportTypes": [ # The list of report types.
115      { # A report type.
116        "deprecateTime": "A String", # The date/time when this report type was/will be deprecated.
117        "systemManaged": True or False, # True if this a system-managed report type; otherwise false. Reporting jobs
118            # for system-managed report types are created automatically and can thus not
119            # be used in the `CreateJob` method.
120        "name": "A String", # The name of the report type (max. 100 characters).
121        "id": "A String", # The ID of the report type (max. 100 characters).
122      },
123    ],
124  }</pre>
125</div>
126
127<div class="method">
128    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
129  <pre>Retrieves the next page of results.
130
131Args:
132  previous_request: The request for the previous page. (required)
133  previous_response: The response from the request for the previous page. (required)
134
135Returns:
136  A request object that you can call 'execute()' on to request the next
137  page. Returns None if there are no more items in the collection.
138    </pre>
139</div>
140
141</body></html>