Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c211bec621911c2d3b448c7e1e5a39cf36f14b3b / . / docs / dyn / youtube_v3.channels.html
blob: 57486013bc1876e6d228fe06c2a57bf9f69c6eb1 [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
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.channels.html">channels</a></h1>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]78 <code><a href="#list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</a></code></p>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]79<p class="firstline">Returns a collection of zero or more channel resources that match the request criteria.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]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">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]85 <code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</code>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]86 <pre>Returns a collection of zero or more channel resources that match the request criteria.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]87
88Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]89 part: string, The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, and topicDetails.
90
91If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. (required)
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]92 onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]93 pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]94 categoryId: string, The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]95 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
96 mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]97 mySubscribers: string, Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel.
98 id: string, The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]99
100Returns:
101 An object of the form:
102
103 { # A paginated list of channels returned as the response to a youtube.channels.list call.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]104 "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
105 "kind": "youtube#channelListResponse", # The type of the API response. For this operation, the value will be youtube#channelListResponse.
106 "items": [ # A list of channels that match the request criteria.
107 { # A channel resource contains information about a YouTube channel.
108 "status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
109 "privacyStatus": "A String", # Privacy status of the channel.
110 },
111 "topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
112 "topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]113 "A String",
114 ],
115 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]116 "kind": "youtube#channel", # The type of the API resource. For channel resources, the value will be youtube#channel.
117 "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
118 "commentCount": "A String", # The number of comments for the channel.
119 "subscriberCount": "A String", # The number of subscribers that the channel has.
120 "videoCount": "A String", # The number of videos uploaded to the channel.
121 "viewCount": "A String", # The number of times the channel has been viewed.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]122 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]123 "contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
124 "relatedPlaylists": { # The relatedPlaylists object is a map that identifies playlists associated with the channel, such as the channel's uploaded videos or favorite videos. You can retrieve any of these playlists using the playlists.list method.
125 "watchLater": "A String", # The ID of the channel's watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
126 "watchHistory": "A String", # The ID of the playlist that contains the channel's watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
127 "likes": "A String", # The ID of the playlist that contains the channel's liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
128 "favorites": "A String", # The ID of the playlist that contains the channel's favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
129 "uploads": "A String", # The ID of the playlist that contains the channel's uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.
130 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]131 "googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
132 },
133 "brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
134 "image": {
135 "largeBrandedBannerImageUrl": { # Represent a property available in different languages.
136 "default": "A String",
137 "localizeds": [
138 { # A localized string.
139 "value": "A String",
140 "language": "A String",
141 },
142 ],
143 },
144 "bannerImageUrl": "A String",
145 "backgroundImageUrl": { # Represent a property available in different languages.
146 "default": "A String",
147 "localizeds": [
148 { # A localized string.
149 "value": "A String",
150 "language": "A String",
151 },
152 ],
153 },
154 "largeBrandedBannerImageImapScript": { # Represent a property available in different languages.
155 "default": "A String",
156 "localizeds": [
157 { # A localized string.
158 "value": "A String",
159 "language": "A String",
160 },
161 ],
162 },
163 "bannerMobileImageUrl": "A String",
164 "smallBrandedBannerImageUrl": { # Represent a property available in different languages.
165 "default": "A String",
166 "localizeds": [
167 { # A localized string.
168 "value": "A String",
169 "language": "A String",
170 },
171 ],
172 },
173 "smallBrandedBannerImageImapScript": { # Represent a property available in different languages.
174 "default": "A String",
175 "localizeds": [
176 { # A localized string.
177 "value": "A String",
178 "language": "A String",
179 },
180 ],
181 },
182 "trackingImageUrl": "A String",
183 "watchIconImageUrl": "A String",
184 },
185 "watch": { # Branding properties for the watch.
186 "textColor": "A String",
187 "featuredPlaylistId": "A String",
188 "backgroundColor": "A String",
189 },
190 "channel": { # Branding properties for the channel view.
191 "description": "A String",
192 "title": "A String",
193 "moderateComments": True or False,
194 "showBrowseView": True or False,
195 "featuredChannelsTitle": "A String",
196 "unsubscribedTrailer": "A String",
197 "keywords": "A String",
198 "defaultTab": "A String",
199 "featuredChannelsUrls": [
200 "A String",
201 ],
202 "trackingAnalyticsAccountId": "A String",
203 "showRelatedChannels": True or False,
204 },
205 "hints": [
206 { # A key value for the experimental branding properties.
207 "property": "A String",
208 "value": "A String",
209 },
210 ],
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]211 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]212 "snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
213 "title": "A String", # The channel's title.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]214 "description": "A String", # The description of the channel.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]215 "publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
216 "thumbnails": { # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]217 "a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]218 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]219 "width": 42, # (Optional) Width of the thumbnail image.
220 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]221 },
222 },
223 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]224 "etag": "A String", # The ETag for the channel resource.
225 "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]226 },
227 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]228 "etag": "A String", # The ETag for the response.
229 "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
230 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
231 "totalResults": 42, # The total number of results in the result set.
232 "resultsPerPage": 42, # The number of results included in the API response.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]233 },
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
239 <pre>Retrieves the next page of results.
240
241Args:
242 previous_request: The request for the previous page. (required)
243 previous_response: The response from the request for the previous page. (required)
244
245Returns:
246 A request object that you can call 'execute()' on to request the next
247 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]248 </pre>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]249</div>
250
251</body></html>