| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.channels.html">channels</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame^] | 78 | <code><a href="#list">list(part, mine=None, contentOwnerId=None, id=None)</a></code></p> |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 79 | <p class="firstline">Browse the YouTube channel collection. Either the 'id' or 'mine' parameter must be set.</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame^] | 82 | <code class="details" id="list">list(part, mine=None, contentOwnerId=None, id=None)</code> |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 83 | <pre>Browse the YouTube channel collection. Either the 'id' or 'mine' parameter must be set. |
| 84 | |
| 85 | Args: |
| 86 | part: string, Parts of the channel resource to be returned. (required) |
| 87 | mine: string, Flag indicating only return the channel ids of the authenticated user. |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame^] | 88 | contentOwnerId: string, The authenticated user acts on behalf of this content owner. |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 89 | id: string, YouTube IDs of the channels to be returned. |
| 90 | |
| 91 | Returns: |
| 92 | An object of the form: |
| 93 | |
| 94 | { # JSON template for a ChannelService.List() response. |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 95 | "channels": { # Map of channels matching the request criteria, keyed by channel id. |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame^] | 96 | "a_key": { # JSON template for a YouTube Channel. # An entry in the "channels" map: the key is the channel id, the value is the channel resource. |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 97 | "kind": "youtube#channel", # The type of this API resource. |
| 98 | "statistics": { # JSON template for the statistics part of a channel. # Statistics about the channel: number of subscribers, views, and comments. |
| 99 | "commentCount": "A String", # Number of comments for this channel. |
| 100 | "subscriberCount": "A String", # Number of subscribers to this channel. |
| 101 | "videoCount": "A String", # Number of videos in the channel. |
| 102 | "viewCount": "A String", # Number of times the channel has been viewed. |
| 103 | }, |
| 104 | "contentDetails": { # JSON template for the content details part of a channel. # Information about the channel content: upload playlist id, privacy status. |
| 105 | "privacyStatus": "A String", # Privacy status of the channel. |
| 106 | "uploads": "A String", # The ID of the playlist containing the uploads of this channel. |
| 107 | }, |
| 108 | "snippet": { # JSON template for the snippet part of a channel. # Basic details about the channel: title, description, and thumbnails. |
| 109 | "title": "A String", # Title of the channel. |
| 110 | "description": "A String", # Description of the channel. |
| 111 | "thumbnails": { # Channel thumbnails. |
| 112 | "a_key": { # JSON template for a thumbnail. # The name of the thumbnail. |
| 113 | "url": "A String", # The URL for the thumbnail. |
| 114 | }, |
| 115 | }, |
| 116 | }, |
| 117 | "etag": "A String", # The eTag of the channel. |
| 118 | "id": "A String", # The unique ID of the channel. |
| 119 | }, |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 120 | }, |
| Joe Gregorio | 075572b | 2012-07-09 16:53:09 -0400 | [diff] [blame] | 121 | "kind": "youtube#channelListResponse", # The type of this API response. |
| 122 | "etag": "A String", # The eTag of the response. |
| 123 | }</pre> |
| 124 | </div> |
| 125 | |
| 126 | </body></html> |