Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d67010d98769c7f0b7792ce26b8ca7527dd3561c / . / docs / dyn / youtube_v3.channels.html
blob: 7104ca97751333c9e34523520f35881ffdee79f6 [file] [log] [blame]
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame^]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="youtube_v3.html">YouTube API</a> . <a href="youtube_v3.channels.html">channels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(part, onBehalfOfContentOwner=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</a></code></p>
79<p class="firstline">Browse the YouTube channel collection. Either the 'id' or 'mine' parameter must be set.</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(part, onBehalfOfContentOwner=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</code>
86 <pre>Browse the YouTube channel collection. Either the 'id' or 'mine' parameter must be set.
87
88Args:
89 part: string, Channel parts to include in the returned response. Valid values are: id, snippet, contentDetails and topicDetails. (required)
90 onBehalfOfContentOwner: string, The authenticated user acts on behalf of this content owner.
91 pageToken: string, Token for the page selection.
92 categoryId: string, Filter to retrieve the channels within the given category ID.
93 maxResults: integer, Maximum number of results to return
94 mine: string, Filter to only channels owned by authenticated user.
95 mySubscribers: string, Filter to channels that subscribed to the channel of the authenticated user.
96 id: string, YouTube IDs of the channels to be returned.
97
98Returns:
99 An object of the form:
100
101 { # A paginated list of channels returned as the response to a youtube.channels.list call.
102 "nextPageToken": "A String", # Token to the next page.
103 "kind": "youtube#channelListResponse", # The type of this API response.
104 "items": [ # List of channels matching the request criteria.
105 { # A channel resource contains information about a single YouTube channel.
106 "topicDetails": { # Freebase topic information related to the channel. # Information about channel topics
107 "topicIds": [ # List of topic ids for this channel *
108 "A String",
109 ],
110 },
111 "kind": "youtube#channel", # The type of this API resource.
112 "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # Statistics about the channel: number of subscribers, views, and comments.
113 "commentCount": "A String", # Number of comments for this channel.
114 "subscriberCount": "A String", # Number of subscribers to this channel.
115 "videoCount": "A String", # Number of videos in the channel.
116 "viewCount": "A String", # Number of times the channel has been viewed.
117 },
118 "contentDetails": { # Details about the content of a channel. # Information about the channel content: upload playlist id, privacy status.
119 "privacyStatus": "A String", # Privacy status of the channel.
120 "uploads": "A String", # The ID of the playlist containing the uploads of this channel.
121 },
122 "snippet": { # Basic details about a channel, including title, description and thumbnails. # Basic details about the channel: title, description, and thumbnails.
123 "title": "A String", # Title of the channel.
124 "channelId": "A String", # Id of the channel.
125 "description": "A String", # Description of the channel.
126 "publishedAt": "A String", # Date and time the channel was published at.
127 "thumbnails": { # Channel thumbnails.
128 "a_key": { # A thumbnail is an image representing a YouTube resource. # A map of thumbnails by their name.
129 "url": "A String", # The URL for the thumbnail.
130 },
131 },
132 },
133 "etag": "A String", # The eTag of the channel.
134 "id": "A String", # The unique ID of the channel.
135 },
136 ],
137 "etag": "A String", # The eTag of the response.
138 "prevPageToken": "A String", # Token to the previous page.
139 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # Paging information for the list result.
140 "totalResults": 42, # The total number of results.
141 "resultsPerPage": 42, # The number of results to display for each page.
142 },
143 }</pre>
144</div>
145
146<div class="method">
147 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
148 <pre>Retrieves the next page of results.
149
150Args:
151 previous_request: The request for the previous page. (required)
152 previous_response: The response from the request for the previous page. (required)
153
154Returns:
155 A request object that you can call 'execute()' on to request the next
156 page. Returns None if there are no more items in the collection.
157 </pre>
158</div>
159
160</body></html>