Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 15744b1488c8e3a52899531aa0d04b93d572f683 / . / docs / dyn / youtube_v3.channels.html
blob: 54303b76db705a28154a1365fed5d4bed9735966 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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 Data 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=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</a></code></p>
79<p class="firstline">Returns a collection of zero or more channel resources that match the request criteria.</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<p class="toc_element">
84 <code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
85<p class="firstline">Updates a channel's metadata.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="list">list(part=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)</code>
89 <pre>Returns a collection of zero or more channel resources that match the request criteria.
90
91Args:
92 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, topicDetails, and invideoPromotion.
93
94If 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)
95 managedByMe: boolean, Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
96 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.
97 forUsername: string, The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.
98 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.
99 categoryId: string, The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.
100 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
101 mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
102 mySubscribers: boolean, Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel.
103 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.
104
105Returns:
106 An object of the form:
107
108 {
109 "eventId": "A String", # Serialized EventId of the request which produced this response.
110 "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.
111 "kind": "youtube#channelListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse".
112 "visitorId": "A String", # The visitorId identifies the visitor.
113 "items": [ # A list of channels that match the request criteria.
114 { # A channel resource contains information about a YouTube channel.
115 "status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
116 "privacyStatus": "A String", # Privacy status of the channel.
117 "isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]118 "longUploadsStatus": "A String", # The long uploads status of this channel. See
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119 },
120 "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.
121 "defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.
122 "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
123 "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
124 "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
125 },
126 "items": [ # List of promoted items in decreasing priority.
127 { # Describes a single promoted item.
128 "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.
129 "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
130 "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
131 "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
132 },
133 "promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.
134 "customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.
135 "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.
136 "websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.
137 "recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.
138 "type": "A String", # Describes the type of the promoted item.
139 "videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.
140 },
141 },
142 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]143 "useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 "position": { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the promoted item will be displayed.
145 "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
146 "type": "A String", # Defines the position type.
147 },
148 },
149 "kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
150 "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
151 "commentCount": "A String", # The number of comments for the channel.
152 "subscriberCount": "A String", # The number of subscribers that the channel has.
153 "videoCount": "A String", # The number of videos uploaded to the channel.
154 "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
155 "viewCount": "A String", # The number of times the channel has been viewed.
156 },
157 "contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
158 "contentOwner": "A String", # The ID of the content owner linked to the channel.
159 "timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
160 },
161 "topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
162 "topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
163 "A String",
164 ],
165 },
166 "contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
167 "relatedPlaylists": {
168 "watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
169 "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.
170 "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.
171 "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.
172 "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.
173 },
174 "googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
175 },
176 "brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
177 "image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
178 "largeBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the large banner image.
179 "default": "A String", # Default value for the localized property.
180 "localized": [ # The localized values.
181 { # A localized string.
182 "value": "A String", # Value of the property.
183 "language": "A String", # Language associated to this value.
184 },
185 ],
186 },
187 "smallBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
188 "default": "A String", # Default value for the localized property.
189 "localized": [ # The localized values.
190 { # A localized string.
191 "value": "A String", # Value of the property.
192 "language": "A String", # Language associated to this value.
193 },
194 ],
195 },
196 "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
197 "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
198 "largeBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
199 "default": "A String", # Default value for the localized property.
200 "localized": [ # The localized values.
201 { # A localized string.
202 "value": "A String", # Value of the property.
203 "language": "A String", # Language associated to this value.
204 },
205 ],
206 },
207 "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
208 "backgroundImageUrl": { # Represent a property available in different languages. # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.
209 "default": "A String", # Default value for the localized property.
210 "localized": [ # The localized values.
211 { # A localized string.
212 "value": "A String", # Value of the property.
213 "language": "A String", # Language associated to this value.
214 },
215 ],
216 },
217 "smallBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the small banner image.
218 "default": "A String", # Default value for the localized property.
219 "localized": [ # The localized values.
220 { # A localized string.
221 "value": "A String", # Value of the property.
222 "language": "A String", # Language associated to this value.
223 },
224 ],
225 },
226 "bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.
227 "watchIconImageUrl": "A String", # The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.
228 "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
229 "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
230 "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
231 "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
232 "trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
233 "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
234 "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
235 "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
236 "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
237 "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
238 "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
239 "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
240 },
241 "watch": { # Branding properties for the watch. # Branding properties for the watch page.
242 "textColor": "A String", # The background color for the video watch page's branded area.
243 "featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
244 "backgroundColor": "A String", # The text color for the video watch page's branded area.
245 },
246 "channel": { # Branding properties for the channel view. # Branding properties for the channel view.
247 "description": "A String", # Specifies the channel description.
248 "title": "A String", # Specifies the channel title.
249 "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
250 "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
251 "featuredChannelsTitle": "A String", # Title for the featured channels tab.
252 "unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
253 "keywords": "A String", # Lists keywords associated with the channel, comma-separated.
254 "profileColor": "A String", # A prominent color that can be rendered on this channel page.
255 "defaultTab": "A String", # Which content tab users should see when viewing the channel.
256 "featuredChannelsUrls": [ # The list of featured channels.
257 "A String",
258 ],
259 "trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
260 "showRelatedChannels": True or False, # Whether related channels should be proposed.
261 },
262 "hints": [ # Additional experimental branding properties.
263 { # A pair Property / Value.
264 "property": "A String", # A property.
265 "value": "A String", # The property's value.
266 },
267 ],
268 },
269 "conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
270 "pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
271 { # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
272 "conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
273 "context": "A String", # Defines the context of the ping.
274 },
275 ],
276 },
277 "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.
278 "title": "A String", # The channel's title.
279 "description": "A String", # The description of the channel.
280 "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.
281 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
282 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
283 "url": "A String", # The thumbnail image's URL.
284 "width": 42, # (Optional) Width of the thumbnail image.
285 "height": 42, # (Optional) Height of the thumbnail image.
286 },
287 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
288 "url": "A String", # The thumbnail image's URL.
289 "width": 42, # (Optional) Width of the thumbnail image.
290 "height": 42, # (Optional) Height of the thumbnail image.
291 },
292 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
293 "url": "A String", # The thumbnail image's URL.
294 "width": 42, # (Optional) Width of the thumbnail image.
295 "height": 42, # (Optional) Height of the thumbnail image.
296 },
297 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
298 "url": "A String", # The thumbnail image's URL.
299 "width": 42, # (Optional) Width of the thumbnail image.
300 "height": 42, # (Optional) Height of the thumbnail image.
301 },
302 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
303 "url": "A String", # The thumbnail image's URL.
304 "width": 42, # (Optional) Width of the thumbnail image.
305 "height": 42, # (Optional) Height of the thumbnail image.
306 },
307 },
308 },
309 "auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.
310 "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
311 "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
312 "overallGoodStanding": True or False, # Describes the general state of the channel. This field will always show if there are any issues whatsoever with the channel. Currently this field represents the result of the logical and operation over the community guidelines good standing, the copyright strikes good standing and the content ID claims good standing, but this may change in the future.
313 "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
314 },
315 "etag": "A String", # Etag of this resource.
316 "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
317 },
318 ],
319 "tokenPagination": { # Stub token pagination template to suppress results.
320 },
321 "etag": "A String", # Etag of this resource.
322 "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.
323 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
324 "totalResults": 42, # The total number of results in the result set.
325 "resultsPerPage": 42, # The number of results included in the API response.
326 },
327 }</pre>
328</div>
329
330<div class="method">
331 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
332 <pre>Retrieves the next page of results.
333
334Args:
335 previous_request: The request for the previous page. (required)
336 previous_response: The response from the request for the previous page. (required)
337
338Returns:
339 A request object that you can call 'execute()' on to request the next
340 page. Returns None if there are no more items in the collection.
341 </pre>
342</div>
343
344<div class="method">
345 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
346 <pre>Updates a channel's metadata.
347
348Args:
349 part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
350
351The part names that you can include in the parameter value are id and invideoPromotion.
352
353Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. (required)
354 body: object, The request body. (required)
355 The object takes the form of:
356
357{ # A channel resource contains information about a YouTube channel.
358 "status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
359 "privacyStatus": "A String", # Privacy status of the channel.
360 "isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]361 "longUploadsStatus": "A String", # The long uploads status of this channel. See
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]362 },
363 "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.
364 "defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.
365 "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
366 "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
367 "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
368 },
369 "items": [ # List of promoted items in decreasing priority.
370 { # Describes a single promoted item.
371 "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.
372 "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
373 "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
374 "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
375 },
376 "promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.
377 "customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.
378 "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.
379 "websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.
380 "recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.
381 "type": "A String", # Describes the type of the promoted item.
382 "videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.
383 },
384 },
385 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]386 "useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]387 "position": { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the promoted item will be displayed.
388 "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
389 "type": "A String", # Defines the position type.
390 },
391 },
392 "kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
393 "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
394 "commentCount": "A String", # The number of comments for the channel.
395 "subscriberCount": "A String", # The number of subscribers that the channel has.
396 "videoCount": "A String", # The number of videos uploaded to the channel.
397 "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
398 "viewCount": "A String", # The number of times the channel has been viewed.
399 },
400 "contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
401 "contentOwner": "A String", # The ID of the content owner linked to the channel.
402 "timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
403 },
404 "topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
405 "topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
406 "A String",
407 ],
408 },
409 "contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
410 "relatedPlaylists": {
411 "watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
412 "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.
413 "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.
414 "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.
415 "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.
416 },
417 "googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
418 },
419 "brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
420 "image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
421 "largeBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the large banner image.
422 "default": "A String", # Default value for the localized property.
423 "localized": [ # The localized values.
424 { # A localized string.
425 "value": "A String", # Value of the property.
426 "language": "A String", # Language associated to this value.
427 },
428 ],
429 },
430 "smallBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
431 "default": "A String", # Default value for the localized property.
432 "localized": [ # The localized values.
433 { # A localized string.
434 "value": "A String", # Value of the property.
435 "language": "A String", # Language associated to this value.
436 },
437 ],
438 },
439 "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
440 "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
441 "largeBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
442 "default": "A String", # Default value for the localized property.
443 "localized": [ # The localized values.
444 { # A localized string.
445 "value": "A String", # Value of the property.
446 "language": "A String", # Language associated to this value.
447 },
448 ],
449 },
450 "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
451 "backgroundImageUrl": { # Represent a property available in different languages. # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.
452 "default": "A String", # Default value for the localized property.
453 "localized": [ # The localized values.
454 { # A localized string.
455 "value": "A String", # Value of the property.
456 "language": "A String", # Language associated to this value.
457 },
458 ],
459 },
460 "smallBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the small banner image.
461 "default": "A String", # Default value for the localized property.
462 "localized": [ # The localized values.
463 { # A localized string.
464 "value": "A String", # Value of the property.
465 "language": "A String", # Language associated to this value.
466 },
467 ],
468 },
469 "bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.
470 "watchIconImageUrl": "A String", # The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.
471 "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
472 "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
473 "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
474 "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
475 "trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
476 "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
477 "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
478 "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
479 "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
480 "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
481 "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
482 "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
483 },
484 "watch": { # Branding properties for the watch. # Branding properties for the watch page.
485 "textColor": "A String", # The background color for the video watch page's branded area.
486 "featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
487 "backgroundColor": "A String", # The text color for the video watch page's branded area.
488 },
489 "channel": { # Branding properties for the channel view. # Branding properties for the channel view.
490 "description": "A String", # Specifies the channel description.
491 "title": "A String", # Specifies the channel title.
492 "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
493 "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
494 "featuredChannelsTitle": "A String", # Title for the featured channels tab.
495 "unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
496 "keywords": "A String", # Lists keywords associated with the channel, comma-separated.
497 "profileColor": "A String", # A prominent color that can be rendered on this channel page.
498 "defaultTab": "A String", # Which content tab users should see when viewing the channel.
499 "featuredChannelsUrls": [ # The list of featured channels.
500 "A String",
501 ],
502 "trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
503 "showRelatedChannels": True or False, # Whether related channels should be proposed.
504 },
505 "hints": [ # Additional experimental branding properties.
506 { # A pair Property / Value.
507 "property": "A String", # A property.
508 "value": "A String", # The property's value.
509 },
510 ],
511 },
512 "conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
513 "pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
514 { # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
515 "conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
516 "context": "A String", # Defines the context of the ping.
517 },
518 ],
519 },
520 "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.
521 "title": "A String", # The channel's title.
522 "description": "A String", # The description of the channel.
523 "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.
524 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
525 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
526 "url": "A String", # The thumbnail image's URL.
527 "width": 42, # (Optional) Width of the thumbnail image.
528 "height": 42, # (Optional) Height of the thumbnail image.
529 },
530 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
531 "url": "A String", # The thumbnail image's URL.
532 "width": 42, # (Optional) Width of the thumbnail image.
533 "height": 42, # (Optional) Height of the thumbnail image.
534 },
535 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
536 "url": "A String", # The thumbnail image's URL.
537 "width": 42, # (Optional) Width of the thumbnail image.
538 "height": 42, # (Optional) Height of the thumbnail image.
539 },
540 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
541 "url": "A String", # The thumbnail image's URL.
542 "width": 42, # (Optional) Width of the thumbnail image.
543 "height": 42, # (Optional) Height of the thumbnail image.
544 },
545 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
546 "url": "A String", # The thumbnail image's URL.
547 "width": 42, # (Optional) Width of the thumbnail image.
548 "height": 42, # (Optional) Height of the thumbnail image.
549 },
550 },
551 },
552 "auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.
553 "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
554 "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
555 "overallGoodStanding": True or False, # Describes the general state of the channel. This field will always show if there are any issues whatsoever with the channel. Currently this field represents the result of the logical and operation over the community guidelines good standing, the copyright strikes good standing and the content ID claims good standing, but this may change in the future.
556 "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
557 },
558 "etag": "A String", # Etag of this resource.
559 "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
560}
561
562 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.
563
564Returns:
565 An object of the form:
566
567 { # A channel resource contains information about a YouTube channel.
568 "status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
569 "privacyStatus": "A String", # Privacy status of the channel.
570 "isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]571 "longUploadsStatus": "A String", # The long uploads status of this channel. See
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]572 },
573 "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.
574 "defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.
575 "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
576 "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
577 "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
578 },
579 "items": [ # List of promoted items in decreasing priority.
580 { # Describes a single promoted item.
581 "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.
582 "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
583 "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
584 "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
585 },
586 "promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.
587 "customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.
588 "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.
589 "websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.
590 "recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.
591 "type": "A String", # Describes the type of the promoted item.
592 "videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.
593 },
594 },
595 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]596 "useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]597 "position": { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the promoted item will be displayed.
598 "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
599 "type": "A String", # Defines the position type.
600 },
601 },
602 "kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
603 "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
604 "commentCount": "A String", # The number of comments for the channel.
605 "subscriberCount": "A String", # The number of subscribers that the channel has.
606 "videoCount": "A String", # The number of videos uploaded to the channel.
607 "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
608 "viewCount": "A String", # The number of times the channel has been viewed.
609 },
610 "contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.
611 "contentOwner": "A String", # The ID of the content owner linked to the channel.
612 "timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
613 },
614 "topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
615 "topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
616 "A String",
617 ],
618 },
619 "contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
620 "relatedPlaylists": {
621 "watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
622 "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.
623 "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.
624 "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.
625 "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.
626 },
627 "googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
628 },
629 "brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
630 "image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
631 "largeBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the large banner image.
632 "default": "A String", # Default value for the localized property.
633 "localized": [ # The localized values.
634 { # A localized string.
635 "value": "A String", # Value of the property.
636 "language": "A String", # Language associated to this value.
637 },
638 ],
639 },
640 "smallBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
641 "default": "A String", # Default value for the localized property.
642 "localized": [ # The localized values.
643 { # A localized string.
644 "value": "A String", # Value of the property.
645 "language": "A String", # Language associated to this value.
646 },
647 ],
648 },
649 "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
650 "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
651 "largeBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
652 "default": "A String", # Default value for the localized property.
653 "localized": [ # The localized values.
654 { # A localized string.
655 "value": "A String", # Value of the property.
656 "language": "A String", # Language associated to this value.
657 },
658 ],
659 },
660 "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
661 "backgroundImageUrl": { # Represent a property available in different languages. # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.
662 "default": "A String", # Default value for the localized property.
663 "localized": [ # The localized values.
664 { # A localized string.
665 "value": "A String", # Value of the property.
666 "language": "A String", # Language associated to this value.
667 },
668 ],
669 },
670 "smallBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the small banner image.
671 "default": "A String", # Default value for the localized property.
672 "localized": [ # The localized values.
673 { # A localized string.
674 "value": "A String", # Value of the property.
675 "language": "A String", # Language associated to this value.
676 },
677 ],
678 },
679 "bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.
680 "watchIconImageUrl": "A String", # The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.
681 "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
682 "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
683 "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
684 "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
685 "trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
686 "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
687 "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
688 "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
689 "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
690 "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
691 "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
692 "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
693 },
694 "watch": { # Branding properties for the watch. # Branding properties for the watch page.
695 "textColor": "A String", # The background color for the video watch page's branded area.
696 "featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
697 "backgroundColor": "A String", # The text color for the video watch page's branded area.
698 },
699 "channel": { # Branding properties for the channel view. # Branding properties for the channel view.
700 "description": "A String", # Specifies the channel description.
701 "title": "A String", # Specifies the channel title.
702 "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
703 "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
704 "featuredChannelsTitle": "A String", # Title for the featured channels tab.
705 "unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
706 "keywords": "A String", # Lists keywords associated with the channel, comma-separated.
707 "profileColor": "A String", # A prominent color that can be rendered on this channel page.
708 "defaultTab": "A String", # Which content tab users should see when viewing the channel.
709 "featuredChannelsUrls": [ # The list of featured channels.
710 "A String",
711 ],
712 "trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
713 "showRelatedChannels": True or False, # Whether related channels should be proposed.
714 },
715 "hints": [ # Additional experimental branding properties.
716 { # A pair Property / Value.
717 "property": "A String", # A property.
718 "value": "A String", # The property's value.
719 },
720 ],
721 },
722 "conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
723 "pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
724 { # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
725 "conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
726 "context": "A String", # Defines the context of the ping.
727 },
728 ],
729 },
730 "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.
731 "title": "A String", # The channel's title.
732 "description": "A String", # The description of the channel.
733 "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.
734 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # 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.
735 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
736 "url": "A String", # The thumbnail image's URL.
737 "width": 42, # (Optional) Width of the thumbnail image.
738 "height": 42, # (Optional) Height of the thumbnail image.
739 },
740 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
741 "url": "A String", # The thumbnail image's URL.
742 "width": 42, # (Optional) Width of the thumbnail image.
743 "height": 42, # (Optional) Height of the thumbnail image.
744 },
745 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
746 "url": "A String", # The thumbnail image's URL.
747 "width": 42, # (Optional) Width of the thumbnail image.
748 "height": 42, # (Optional) Height of the thumbnail image.
749 },
750 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
751 "url": "A String", # The thumbnail image's URL.
752 "width": 42, # (Optional) Width of the thumbnail image.
753 "height": 42, # (Optional) Height of the thumbnail image.
754 },
755 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
756 "url": "A String", # The thumbnail image's URL.
757 "width": 42, # (Optional) Width of the thumbnail image.
758 "height": 42, # (Optional) Height of the thumbnail image.
759 },
760 },
761 },
762 "auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.
763 "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
764 "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
765 "overallGoodStanding": True or False, # Describes the general state of the channel. This field will always show if there are any issues whatsoever with the channel. Currently this field represents the result of the logical and operation over the community guidelines good standing, the copyright strikes good standing and the content ID claims good standing, but this may change in the future.
766 "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
767 },
768 "etag": "A String", # Etag of this resource.
769 "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
770 }</pre>
771</div>
772
773</body></html>