1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.channels.html">channels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(part, categoryId=None, forHandle=None, forUsername=None, hl=None, id=None, managedByMe=None, maxResults=None, mine=None, mySubscribers=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(part, categoryId=None, forHandle=None, forUsername=None, hl=None, id=None, managedByMe=None, maxResults=None, mine=None, mySubscribers=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
part: string, The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If 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) (repeated)
categoryId: string, Return the channels within the specified guide category ID.
forHandle: string, Return the channel associated with a YouTube handle.
forUsername: string, Return the channel associated with a YouTube username.
hl: string, Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).
id: string, Return the channels with the specified IDs. (repeated)
managedByMe: boolean, Return the channels managed by the authenticated user.
maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
mine: boolean, Return the ids of channels owned by the authenticated user.
mySubscribers: boolean, Return the channels subscribed to the authenticated user
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # Etag of this resource.
"eventId": "A String", # Serialized EventId of the request which produced this response.
"items": [
{ # A *channel* resource contains information about a YouTube channel.
"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.
"communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
"contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
"copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
},
"brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
"channel": { # Branding properties for the channel view. # Branding properties for the channel view.
"country": "A String", # The country of the channel.
"defaultLanguage": "A String",
"defaultTab": "A String", # Which content tab users should see when viewing the channel.
"description": "A String", # Specifies the channel description.
"featuredChannelsTitle": "A String", # Title for the featured channels tab.
"featuredChannelsUrls": [ # The list of featured channels.
"A String",
],
"keywords": "A String", # Lists keywords associated with the channel, comma-separated.
"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.
"profileColor": "A String", # A prominent color that can be rendered on this channel page.
"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
"showRelatedChannels": True or False, # Whether related channels should be proposed.
"title": "A String", # Specifies the channel title.
"trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
"unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
},
"hints": [ # Additional experimental branding properties.
{ # A pair Property / Value.
"property": "A String", # A property.
"value": "A String", # The property's value.
},
],
"image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
"backgroundImageUrl": { # 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.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"bannerExternalUrl": "A String", # This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
"bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
"bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
"bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
"bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
"bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
"bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
"bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
"bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
"bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
"bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
"bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
"bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
"bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
"bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
"largeBrandedBannerImageImapScript": { # The image map script for the large banner image.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"largeBrandedBannerImageUrl": { # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"smallBrandedBannerImageImapScript": { # The image map script for the small banner image.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"smallBrandedBannerImageUrl": { # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. 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.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"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.
"watchIconImageUrl": "A String",
},
"watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page.
"backgroundColor": "A String", # The text color for the video watch page's branded area.
"featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
"textColor": "A String", # The background color for the video watch page's branded area.
},
},
"contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
"relatedPlaylists": {
"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.
"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.
"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.
"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.
"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.
},
},
"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.
"contentOwner": "A String", # The ID of the content owner linked to the channel.
"timeLinked": "A String", # The date and time when the channel was linked to the content owner.
},
"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.
"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.
{ # 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.
"context": "A String", # Defines the context of the ping.
"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.
},
],
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the channel.
"kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
"localizations": { # Localizations for different languages
"a_key": { # Channel localization setting
"description": "A String", # The localized strings for channel's description.
"title": "A String", # The localized strings for channel's title.
},
},
"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.
"country": "A String", # The country of the channel.
"customUrl": "A String", # The custom url of the channel.
"defaultLanguage": "A String", # The language of the channel's default title and description.
"description": "A String", # The description of the channel.
"localized": { # Channel localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for channel's description.
"title": "A String", # The localized strings for channel's title.
},
"publishedAt": "A String", # The date and time that the channel was created.
"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. When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response. Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain. Thumbnail images might be empty for newly created channels and might take up to one day to populate.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The channel's title.
},
"statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
"commentCount": "A String", # The number of comments for the channel.
"hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
"subscriberCount": "A String", # The number of subscribers that the channel has.
"videoCount": "A String", # The number of videos uploaded to the channel.
"viewCount": "A String", # The number of times the channel has been viewed.
},
"status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
"isChannelMonetizationEnabled": True or False, # Whether the channel is considered ypp monetization enabled. See go/yppornot for more details.
"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.
"longUploadsStatus": "A String", # The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.
"madeForKids": True or False,
"privacyStatus": "A String", # Privacy status of the channel.
"selfDeclaredMadeForKids": True or False,
},
"topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
"topicCategories": [ # A list of Wikipedia URLs that describe the channel's content.
"A String",
],
"topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
},
],
"kind": "youtube#channelListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse".
"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.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
"resultsPerPage": 42, # The number of results included in the API response.
"totalResults": 42, # The total number of results in the result set.
},
"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.
"tokenPagination": { # Stub token pagination template to suppress results.
},
"visitorId": "A String", # The visitorId identifies the visitor.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Updates an existing resource.
Args:
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. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. (required) (repeated)
body: object, The request body.
The object takes the form of:
{ # A *channel* resource contains information about a YouTube channel.
"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.
"communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
"contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
"copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
},
"brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
"channel": { # Branding properties for the channel view. # Branding properties for the channel view.
"country": "A String", # The country of the channel.
"defaultLanguage": "A String",
"defaultTab": "A String", # Which content tab users should see when viewing the channel.
"description": "A String", # Specifies the channel description.
"featuredChannelsTitle": "A String", # Title for the featured channels tab.
"featuredChannelsUrls": [ # The list of featured channels.
"A String",
],
"keywords": "A String", # Lists keywords associated with the channel, comma-separated.
"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.
"profileColor": "A String", # A prominent color that can be rendered on this channel page.
"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
"showRelatedChannels": True or False, # Whether related channels should be proposed.
"title": "A String", # Specifies the channel title.
"trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
"unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
},
"hints": [ # Additional experimental branding properties.
{ # A pair Property / Value.
"property": "A String", # A property.
"value": "A String", # The property's value.
},
],
"image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
"backgroundImageUrl": { # 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.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"bannerExternalUrl": "A String", # This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
"bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
"bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
"bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
"bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
"bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
"bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
"bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
"bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
"bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
"bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
"bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
"bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
"bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
"bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
"largeBrandedBannerImageImapScript": { # The image map script for the large banner image.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"largeBrandedBannerImageUrl": { # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"smallBrandedBannerImageImapScript": { # The image map script for the small banner image.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"smallBrandedBannerImageUrl": { # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. 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.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"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.
"watchIconImageUrl": "A String",
},
"watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page.
"backgroundColor": "A String", # The text color for the video watch page's branded area.
"featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
"textColor": "A String", # The background color for the video watch page's branded area.
},
},
"contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
"relatedPlaylists": {
"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.
"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.
"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.
"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.
"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.
},
},
"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.
"contentOwner": "A String", # The ID of the content owner linked to the channel.
"timeLinked": "A String", # The date and time when the channel was linked to the content owner.
},
"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.
"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.
{ # 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.
"context": "A String", # Defines the context of the ping.
"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.
},
],
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the channel.
"kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
"localizations": { # Localizations for different languages
"a_key": { # Channel localization setting
"description": "A String", # The localized strings for channel's description.
"title": "A String", # The localized strings for channel's title.
},
},
"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.
"country": "A String", # The country of the channel.
"customUrl": "A String", # The custom url of the channel.
"defaultLanguage": "A String", # The language of the channel's default title and description.
"description": "A String", # The description of the channel.
"localized": { # Channel localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for channel's description.
"title": "A String", # The localized strings for channel's title.
},
"publishedAt": "A String", # The date and time that the channel was created.
"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. When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response. Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain. Thumbnail images might be empty for newly created channels and might take up to one day to populate.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The channel's title.
},
"statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
"commentCount": "A String", # The number of comments for the channel.
"hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
"subscriberCount": "A String", # The number of subscribers that the channel has.
"videoCount": "A String", # The number of videos uploaded to the channel.
"viewCount": "A String", # The number of times the channel has been viewed.
},
"status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
"isChannelMonetizationEnabled": True or False, # Whether the channel is considered ypp monetization enabled. See go/yppornot for more details.
"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.
"longUploadsStatus": "A String", # The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.
"madeForKids": True or False,
"privacyStatus": "A String", # Privacy status of the channel.
"selfDeclaredMadeForKids": True or False,
},
"topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
"topicCategories": [ # A list of Wikipedia URLs that describe the channel's content.
"A String",
],
"topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
}
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A *channel* resource contains information about a YouTube channel.
"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.
"communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.
"contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.
"copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.
},
"brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
"channel": { # Branding properties for the channel view. # Branding properties for the channel view.
"country": "A String", # The country of the channel.
"defaultLanguage": "A String",
"defaultTab": "A String", # Which content tab users should see when viewing the channel.
"description": "A String", # Specifies the channel description.
"featuredChannelsTitle": "A String", # Title for the featured channels tab.
"featuredChannelsUrls": [ # The list of featured channels.
"A String",
],
"keywords": "A String", # Lists keywords associated with the channel, comma-separated.
"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.
"profileColor": "A String", # A prominent color that can be rendered on this channel page.
"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
"showRelatedChannels": True or False, # Whether related channels should be proposed.
"title": "A String", # Specifies the channel title.
"trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
"unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
},
"hints": [ # Additional experimental branding properties.
{ # A pair Property / Value.
"property": "A String", # A property.
"value": "A String", # The property's value.
},
],
"image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
"backgroundImageUrl": { # 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.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"bannerExternalUrl": "A String", # This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
"bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
"bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
"bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
"bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
"bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
"bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
"bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
"bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
"bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
"bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
"bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).
"bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).
"bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).
"bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).
"largeBrandedBannerImageImapScript": { # The image map script for the large banner image.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"largeBrandedBannerImageUrl": { # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"smallBrandedBannerImageImapScript": { # The image map script for the small banner image.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"smallBrandedBannerImageUrl": { # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. 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.
"default": "A String",
"defaultLanguage": { # The language of the default property.
"value": "A String",
},
"localized": [
{
"language": "A String",
"value": "A String",
},
],
},
"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.
"watchIconImageUrl": "A String",
},
"watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page.
"backgroundColor": "A String", # The text color for the video watch page's branded area.
"featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
"textColor": "A String", # The background color for the video watch page's branded area.
},
},
"contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
"relatedPlaylists": {
"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.
"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.
"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.
"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.
"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.
},
},
"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.
"contentOwner": "A String", # The ID of the content owner linked to the channel.
"timeLinked": "A String", # The date and time when the channel was linked to the content owner.
},
"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.
"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.
{ # 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.
"context": "A String", # Defines the context of the ping.
"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.
},
],
},
"etag": "A String", # Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the channel.
"kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string "youtube#channel".
"localizations": { # Localizations for different languages
"a_key": { # Channel localization setting
"description": "A String", # The localized strings for channel's description.
"title": "A String", # The localized strings for channel's title.
},
},
"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.
"country": "A String", # The country of the channel.
"customUrl": "A String", # The custom url of the channel.
"defaultLanguage": "A String", # The language of the channel's default title and description.
"description": "A String", # The description of the channel.
"localized": { # Channel localization setting # Localized title and description, read-only.
"description": "A String", # The localized strings for channel's description.
"title": "A String", # The localized strings for channel's title.
},
"publishedAt": "A String", # The date and time that the channel was created.
"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. When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response. Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain. Thumbnail images might be empty for newly created channels and might take up to one day to populate.
"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
"height": 42, # (Optional) Height of the thumbnail image.
"url": "A String", # The thumbnail image's URL.
"width": 42, # (Optional) Width of the thumbnail image.
},
},
"title": "A String", # The channel's title.
},
"statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
"commentCount": "A String", # The number of comments for the channel.
"hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.
"subscriberCount": "A String", # The number of subscribers that the channel has.
"videoCount": "A String", # The number of videos uploaded to the channel.
"viewCount": "A String", # The number of times the channel has been viewed.
},
"status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
"isChannelMonetizationEnabled": True or False, # Whether the channel is considered ypp monetization enabled. See go/yppornot for more details.
"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.
"longUploadsStatus": "A String", # The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.
"madeForKids": True or False,
"privacyStatus": "A String", # Privacy status of the channel.
"selfDeclaredMadeForKids": True or False,
},
"topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
"topicCategories": [ # A list of Wikipedia URLs that describe the channel's content.
"A String",
],
"topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
"A String",
],
},
}</pre>
</div>
</body></html>
|
