| <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="#list">list(part, pageToken=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, hl=None, maxResults=None, id=None, mySubscribers=None, mine=None, categoryId=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(previous_request, previous_response)</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="list">list(part, pageToken=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, hl=None, maxResults=None, id=None, mySubscribers=None, mine=None, categoryId=None, x__xgafv=None)</code> |
| <pre>Retrieves a list of resources, possibly filtered. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter specifies a |
| comma-separated list of one or more <code>channel</code> resource |
| properties that the API response will include.<br><br>If the parameter |
| identifies a property that contains child properties, the child properties |
| will be included in the response. For example, in a <code>channel</code> |
| resource, the <code>contentDetails</code> property contains other |
| properties, such as the <code>uploads</code> properties. As such, if you |
| set <code><strong>part=contentDetails</strong></code>, the API response |
| will also contain all of those nested properties. (required) (repeated) |
| pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| page in the result set that should be returned. In an API response, the |
| <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| identify other pages that could be retrieved. |
| managedByMe: boolean, Return the channels managed by the authenticated user. |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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. |
| 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). |
| maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| maximum number of items that should be returned in the result set. |
| id: string, Return the channels with the specified IDs. (repeated) |
| mySubscribers: boolean, Return the channels subscribed to the authenticated user |
| mine: boolean, Return the ids of channels owned by the authenticated user. |
| categoryId: string, Return the channels within the specified guide category ID. |
| 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. |
| "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the next page in the result set. |
| "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| "items": [ |
| { # A <code><strong>channel</strong></code> resource contains |
| # information about a YouTube channel. |
| "brandingSettings": { # Branding properties of a YouTube channel. # The <code>brandingSettings</code> object encapsulates information about |
| # the branding of the channel. |
| "watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page. |
| "textColor": "A String", # The background 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. |
| "backgroundColor": "A String", # The text color for the video watch page's branded area. |
| }, |
| "image": { # Branding properties for images associated with the channel. # Branding properties for branding images. |
| "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175). |
| "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080). |
| "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175). |
| "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192). |
| "largeBrandedBannerImageImapScript": { # The image map script for the large banner image. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395). |
| "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. |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360). |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "smallBrandedBannerImageImapScript": { # The image map script for the small banner image. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480). |
| "watchIconImageUrl": "A String", |
| "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88). |
| "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188). |
| "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720). |
| "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283). |
| "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424). |
| "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263). |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "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. |
| "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377). |
| }, |
| "channel": { # Branding properties for the channel view. # Branding properties for the channel view. |
| "featuredChannelsTitle": "A String", # Title for the featured channels tab. |
| "keywords": "A String", # Lists keywords associated with the channel, comma-separated. |
| "featuredChannelsUrls": [ # The list of featured channels. |
| "A String", |
| ], |
| "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. |
| "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed. |
| "defaultTab": "A String", # Which content tab users should see when viewing the channel. |
| "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. |
| "showRelatedChannels": True or False, # Whether related channels should be proposed. |
| "country": "A String", # The country of the channel. |
| "title": "A String", # Specifies the channel title. |
| "description": "A String", # Specifies the channel description. |
| "profileColor": "A String", # A prominent color that can be rendered on this channel page. |
| "defaultLanguage": "A String", |
| }, |
| "hints": [ # Additional experimental branding properties. |
| { # A pair Property / Value. |
| "property": "A String", # A property. |
| "value": "A String", # The property's value. |
| }, |
| ], |
| }, |
| "conversionPings": { # The <code>conversionPings</code> object encapsulates information about # The <code>conversionPings</code> object encapsulates information about |
| # conversion pings that need to be respected by the channel. |
| # 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. |
| }, |
| ], |
| }, |
| "kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#channel"</code>. |
| "contentDetails": { # Details about the content of a channel. # The <code>contentDetails</code> 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 <code> <a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # 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 <code><a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # to add or remove items from that list. |
| "watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the |
| # <code> <a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # 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 <code> <a |
| # href="/youtube/v3/docs/videos/insert">videos.insert</a></code> method to |
| # upload new videos and the <code><a |
| # href="/youtube/v3/docs/videos/delete">videos.delete</a></code> method to |
| # delete previously uploaded videos. |
| "likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the |
| # <code> <a href="/youtube/v3/docs/playlistItems/insert"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # to add or remove items from that list. |
| }, |
| }, |
| "statistics": { # Statistics about a channel: number of subscribers, number of videos in the # The <code>statistics</code> object encapsulates statistics for the channel. |
| # channel, etc. |
| "viewCount": "A String", # The number of times the channel has been viewed. |
| "commentCount": "A String", # The number of comments for the channel. |
| "subscriberCount": "A String", # The number of subscribers that the channel has. |
| "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user. |
| "videoCount": "A String", # The number of videos uploaded to the channel. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel. |
| "topicDetails": { # Freebase topic information related to the channel. # The <code>topicDetails</code> object encapsulates information about |
| # <a href="http://www.freebase.com">Freebase</a> 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 <a |
| # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
| "A String", |
| ], |
| }, |
| "snippet": { # Basic details about a channel, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the channel, |
| # such as its title, description, and thumbnail images. |
| "defaultLanguage": "A String", # The language of the channel's default title and description. |
| "customUrl": "A String", # The custom url of the channel. |
| "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.<br><br> 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 <code>http</code> domain instead of the |
| # <code>https</code> domain in a URL returned in an API response.<br><br> |
| # Beginning in July 2018, channel thumbnail URLs will only be available in |
| # the <code>https</code> 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 <code>http</code> domain. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "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. The value is specified in |
| # < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "title": "A String", # The channel's title. |
| "country": "A String", # The country of the channel. |
| "description": "A String", # The description of the channel. |
| }, |
| "status": { # JSON template for the status part of a channel. # The <code>status</code> object encapsulates information about the privacy |
| # status of the channel. |
| "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. |
| "madeForKids": True or False, |
| "privacyStatus": "A String", # Privacy status of the channel. |
| "longUploadsStatus": "A String", # The long uploads status of this channel. See |
| # https://support.google.com/youtube/answer/71673 for more information. |
| "selfDeclaredMadeForKids": True or False, |
| }, |
| "etag": "A String", # Etag of this resource. |
| "auditDetails": { # The <code>auditDetails</code> object encapsulates channel data that is # The <code>auditionDetails</code> object encapsulates channel data |
| # that is relevant for YouTube Partners during the audition process. |
| # relevant for YouTube Partners during the audit process. |
| "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines. |
| "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes. |
| "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims. |
| }, |
| "contentOwnerDetails": { # The <code>contentOwnerDetails</code> object encapsulates channel data that # The <code>contentOwnerDetails</code> object encapsulates channel data |
| # that is relevant for YouTube Partners linked with the channel. |
| # 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 of when the channel was linked to the content owner. |
| # The value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO |
| # 8601</a> |
| # format. |
| }, |
| "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted # The <code>invideoPromotion</code> object encapsulates information about |
| # promotion campaign associated with the channel. |
| # items. A campaign belongs to a single channel_id. |
| "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. |
| "items": [ # List of promoted items in decreasing priority. |
| { # Describes a single promoted item. |
| "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. |
| "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| # the <code>offsetMs</code> field represents an offset from the start of the |
| # video. If the value is <code>offsetFromEnd</code>, then the |
| # <code>offsetMs</code> field represents an offset from the end of the video. |
| "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| # of <code>type</code> the value of the <code>offsetMs</code> field will |
| # represent a time offset from the start or from the end of the video, |
| # expressed in milliseconds. |
| "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| # displayed. If missing, the client should use the default. |
| }, |
| "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. |
| "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item. |
| "type": "A String", # Describes the type of the promoted item. |
| "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. |
| "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 |
| # <code>type</code> has the value <code>video</code>. |
| "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 |
| # <code>type</code> has the value <code>website</code>. |
| }, |
| "customMessage": "A String", # A custom message to display for this promotion. This field is currently |
| # ignored unless the promoted item is a website. |
| }, |
| ], |
| "position": { # Describes the spatial position of a visual widget inside a video. It is a # The spatial position within the video where the promoted item will be |
| # displayed. |
| # union of various position types, out of which only will be set one. |
| "type": "A String", # Defines the position type. |
| "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear. |
| }, |
| "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 overridden by more specific timing in the item. |
| "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| # the <code>offsetMs</code> field represents an offset from the start of the |
| # video. If the value is <code>offsetFromEnd</code>, then the |
| # <code>offsetMs</code> field represents an offset from the end of the video. |
| "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| # of <code>type</code> the value of the <code>offsetMs</code> field will |
| # represent a time offset from the start or from the end of the video, |
| # expressed in milliseconds. |
| "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| # displayed. If missing, the client should use the default. |
| }, |
| }, |
| "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. |
| }, |
| }, |
| }, |
| ], |
| "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| # parameter to retrieve the previous page in the result set. |
| "eventId": "A String", # Serialized EventId of the request which produced this response. |
| "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information. |
| # available and number of resources returned in a single page. |
| "resultsPerPage": 42, # The number of results included in the API response. |
| "totalResults": 42, # The total number of results in the result set. |
| }, |
| "tokenPagination": { # Stub token pagination template to suppress results. |
| }, |
| "kind": "youtube#channelListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#channelListResponse"</code>. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</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 <code><strong>part</strong></code> 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.<br/><br/>The API currently only allows the parameter value to be |
| set to either <code>brandingSettings</code> or |
| <code>invideoPromotion</code>. (You cannot update both of those parts with |
| a single request.)<br/><br/>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 <code><strong>channel</strong></code> resource contains |
| # information about a YouTube channel. |
| "brandingSettings": { # Branding properties of a YouTube channel. # The <code>brandingSettings</code> object encapsulates information about |
| # the branding of the channel. |
| "watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page. |
| "textColor": "A String", # The background 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. |
| "backgroundColor": "A String", # The text color for the video watch page's branded area. |
| }, |
| "image": { # Branding properties for images associated with the channel. # Branding properties for branding images. |
| "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175). |
| "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080). |
| "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175). |
| "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192). |
| "largeBrandedBannerImageImapScript": { # The image map script for the large banner image. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395). |
| "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. |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360). |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "smallBrandedBannerImageImapScript": { # The image map script for the small banner image. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480). |
| "watchIconImageUrl": "A String", |
| "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88). |
| "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188). |
| "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720). |
| "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283). |
| "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424). |
| "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263). |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "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. |
| "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377). |
| }, |
| "channel": { # Branding properties for the channel view. # Branding properties for the channel view. |
| "featuredChannelsTitle": "A String", # Title for the featured channels tab. |
| "keywords": "A String", # Lists keywords associated with the channel, comma-separated. |
| "featuredChannelsUrls": [ # The list of featured channels. |
| "A String", |
| ], |
| "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. |
| "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed. |
| "defaultTab": "A String", # Which content tab users should see when viewing the channel. |
| "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. |
| "showRelatedChannels": True or False, # Whether related channels should be proposed. |
| "country": "A String", # The country of the channel. |
| "title": "A String", # Specifies the channel title. |
| "description": "A String", # Specifies the channel description. |
| "profileColor": "A String", # A prominent color that can be rendered on this channel page. |
| "defaultLanguage": "A String", |
| }, |
| "hints": [ # Additional experimental branding properties. |
| { # A pair Property / Value. |
| "property": "A String", # A property. |
| "value": "A String", # The property's value. |
| }, |
| ], |
| }, |
| "conversionPings": { # The <code>conversionPings</code> object encapsulates information about # The <code>conversionPings</code> object encapsulates information about |
| # conversion pings that need to be respected by the channel. |
| # 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. |
| }, |
| ], |
| }, |
| "kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#channel"</code>. |
| "contentDetails": { # Details about the content of a channel. # The <code>contentDetails</code> 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 <code> <a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # 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 <code><a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # to add or remove items from that list. |
| "watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the |
| # <code> <a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # 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 <code> <a |
| # href="/youtube/v3/docs/videos/insert">videos.insert</a></code> method to |
| # upload new videos and the <code><a |
| # href="/youtube/v3/docs/videos/delete">videos.delete</a></code> method to |
| # delete previously uploaded videos. |
| "likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the |
| # <code> <a href="/youtube/v3/docs/playlistItems/insert"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # to add or remove items from that list. |
| }, |
| }, |
| "statistics": { # Statistics about a channel: number of subscribers, number of videos in the # The <code>statistics</code> object encapsulates statistics for the channel. |
| # channel, etc. |
| "viewCount": "A String", # The number of times the channel has been viewed. |
| "commentCount": "A String", # The number of comments for the channel. |
| "subscriberCount": "A String", # The number of subscribers that the channel has. |
| "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user. |
| "videoCount": "A String", # The number of videos uploaded to the channel. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel. |
| "topicDetails": { # Freebase topic information related to the channel. # The <code>topicDetails</code> object encapsulates information about |
| # <a href="http://www.freebase.com">Freebase</a> 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 <a |
| # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
| "A String", |
| ], |
| }, |
| "snippet": { # Basic details about a channel, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the channel, |
| # such as its title, description, and thumbnail images. |
| "defaultLanguage": "A String", # The language of the channel's default title and description. |
| "customUrl": "A String", # The custom url of the channel. |
| "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.<br><br> 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 <code>http</code> domain instead of the |
| # <code>https</code> domain in a URL returned in an API response.<br><br> |
| # Beginning in July 2018, channel thumbnail URLs will only be available in |
| # the <code>https</code> 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 <code>http</code> domain. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "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. The value is specified in |
| # < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "title": "A String", # The channel's title. |
| "country": "A String", # The country of the channel. |
| "description": "A String", # The description of the channel. |
| }, |
| "status": { # JSON template for the status part of a channel. # The <code>status</code> object encapsulates information about the privacy |
| # status of the channel. |
| "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. |
| "madeForKids": True or False, |
| "privacyStatus": "A String", # Privacy status of the channel. |
| "longUploadsStatus": "A String", # The long uploads status of this channel. See |
| # https://support.google.com/youtube/answer/71673 for more information. |
| "selfDeclaredMadeForKids": True or False, |
| }, |
| "etag": "A String", # Etag of this resource. |
| "auditDetails": { # The <code>auditDetails</code> object encapsulates channel data that is # The <code>auditionDetails</code> object encapsulates channel data |
| # that is relevant for YouTube Partners during the audition process. |
| # relevant for YouTube Partners during the audit process. |
| "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines. |
| "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes. |
| "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims. |
| }, |
| "contentOwnerDetails": { # The <code>contentOwnerDetails</code> object encapsulates channel data that # The <code>contentOwnerDetails</code> object encapsulates channel data |
| # that is relevant for YouTube Partners linked with the channel. |
| # 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 of when the channel was linked to the content owner. |
| # The value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO |
| # 8601</a> |
| # format. |
| }, |
| "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted # The <code>invideoPromotion</code> object encapsulates information about |
| # promotion campaign associated with the channel. |
| # items. A campaign belongs to a single channel_id. |
| "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. |
| "items": [ # List of promoted items in decreasing priority. |
| { # Describes a single promoted item. |
| "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. |
| "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| # the <code>offsetMs</code> field represents an offset from the start of the |
| # video. If the value is <code>offsetFromEnd</code>, then the |
| # <code>offsetMs</code> field represents an offset from the end of the video. |
| "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| # of <code>type</code> the value of the <code>offsetMs</code> field will |
| # represent a time offset from the start or from the end of the video, |
| # expressed in milliseconds. |
| "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| # displayed. If missing, the client should use the default. |
| }, |
| "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. |
| "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item. |
| "type": "A String", # Describes the type of the promoted item. |
| "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. |
| "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 |
| # <code>type</code> has the value <code>video</code>. |
| "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 |
| # <code>type</code> has the value <code>website</code>. |
| }, |
| "customMessage": "A String", # A custom message to display for this promotion. This field is currently |
| # ignored unless the promoted item is a website. |
| }, |
| ], |
| "position": { # Describes the spatial position of a visual widget inside a video. It is a # The spatial position within the video where the promoted item will be |
| # displayed. |
| # union of various position types, out of which only will be set one. |
| "type": "A String", # Defines the position type. |
| "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear. |
| }, |
| "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 overridden by more specific timing in the item. |
| "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| # the <code>offsetMs</code> field represents an offset from the start of the |
| # video. If the value is <code>offsetFromEnd</code>, then the |
| # <code>offsetMs</code> field represents an offset from the end of the video. |
| "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| # of <code>type</code> the value of the <code>offsetMs</code> field will |
| # represent a time offset from the start or from the end of the video, |
| # expressed in milliseconds. |
| "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| # displayed. If missing, the client should use the default. |
| }, |
| }, |
| "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. |
| }, |
| }, |
| } |
| |
| onBehalfOfContentOwner: string, The <code><strong>onBehalfOfContentOwner</strong></code> 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 <code><strong>channel</strong></code> resource contains |
| # information about a YouTube channel. |
| "brandingSettings": { # Branding properties of a YouTube channel. # The <code>brandingSettings</code> object encapsulates information about |
| # the branding of the channel. |
| "watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page. |
| "textColor": "A String", # The background 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. |
| "backgroundColor": "A String", # The text color for the video watch page's branded area. |
| }, |
| "image": { # Branding properties for images associated with the channel. # Branding properties for branding images. |
| "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175). |
| "bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080). |
| "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175). |
| "bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192). |
| "largeBrandedBannerImageImapScript": { # The image map script for the large banner image. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395). |
| "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. |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360). |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "smallBrandedBannerImageImapScript": { # The image map script for the small banner image. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "value": "A String", |
| }, |
| }, |
| "bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480). |
| "watchIconImageUrl": "A String", |
| "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88). |
| "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188). |
| "bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720). |
| "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283). |
| "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424). |
| "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263). |
| "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. |
| "localized": [ |
| { |
| "language": "A String", |
| "value": "A String", |
| }, |
| ], |
| "default": "A String", |
| "defaultLanguage": { # The language of the default property. |
| "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. |
| "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377). |
| }, |
| "channel": { # Branding properties for the channel view. # Branding properties for the channel view. |
| "featuredChannelsTitle": "A String", # Title for the featured channels tab. |
| "keywords": "A String", # Lists keywords associated with the channel, comma-separated. |
| "featuredChannelsUrls": [ # The list of featured channels. |
| "A String", |
| ], |
| "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. |
| "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed. |
| "defaultTab": "A String", # Which content tab users should see when viewing the channel. |
| "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. |
| "showRelatedChannels": True or False, # Whether related channels should be proposed. |
| "country": "A String", # The country of the channel. |
| "title": "A String", # Specifies the channel title. |
| "description": "A String", # Specifies the channel description. |
| "profileColor": "A String", # A prominent color that can be rendered on this channel page. |
| "defaultLanguage": "A String", |
| }, |
| "hints": [ # Additional experimental branding properties. |
| { # A pair Property / Value. |
| "property": "A String", # A property. |
| "value": "A String", # The property's value. |
| }, |
| ], |
| }, |
| "conversionPings": { # The <code>conversionPings</code> object encapsulates information about # The <code>conversionPings</code> object encapsulates information about |
| # conversion pings that need to be respected by the channel. |
| # 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. |
| }, |
| ], |
| }, |
| "kind": "youtube#channel", # Identifies what kind of resource this is. Value: the fixed string |
| # <code>"youtube#channel"</code>. |
| "contentDetails": { # Details about the content of a channel. # The <code>contentDetails</code> 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 <code> <a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # 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 <code><a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # to add or remove items from that list. |
| "watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the |
| # <code> <a |
| # href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code> |
| # and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # 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 <code> <a |
| # href="/youtube/v3/docs/videos/insert">videos.insert</a></code> method to |
| # upload new videos and the <code><a |
| # href="/youtube/v3/docs/videos/delete">videos.delete</a></code> method to |
| # delete previously uploaded videos. |
| "likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the |
| # <code> <a href="/youtube/v3/docs/playlistItems/insert"> |
| # playlistItems.insert</a></code> and <code> <a |
| # href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code> |
| # to add or remove items from that list. |
| }, |
| }, |
| "statistics": { # Statistics about a channel: number of subscribers, number of videos in the # The <code>statistics</code> object encapsulates statistics for the channel. |
| # channel, etc. |
| "viewCount": "A String", # The number of times the channel has been viewed. |
| "commentCount": "A String", # The number of comments for the channel. |
| "subscriberCount": "A String", # The number of subscribers that the channel has. |
| "hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user. |
| "videoCount": "A String", # The number of videos uploaded to the channel. |
| }, |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel. |
| "topicDetails": { # Freebase topic information related to the channel. # The <code>topicDetails</code> object encapsulates information about |
| # <a href="http://www.freebase.com">Freebase</a> 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 <a |
| # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
| "A String", |
| ], |
| }, |
| "snippet": { # Basic details about a channel, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the channel, |
| # such as its title, description, and thumbnail images. |
| "defaultLanguage": "A String", # The language of the channel's default title and description. |
| "customUrl": "A String", # The custom url of the channel. |
| "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.<br><br> 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 <code>http</code> domain instead of the |
| # <code>https</code> domain in a URL returned in an API response.<br><br> |
| # Beginning in July 2018, channel thumbnail URLs will only be available in |
| # the <code>https</code> 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 <code>http</code> domain. |
| "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| "width": 42, # (Optional) Width of the thumbnail image. |
| "url": "A String", # The thumbnail image's URL. |
| "height": 42, # (Optional) Height of the thumbnail image. |
| }, |
| }, |
| "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. The value is specified in |
| # < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # format. |
| "title": "A String", # The channel's title. |
| "country": "A String", # The country of the channel. |
| "description": "A String", # The description of the channel. |
| }, |
| "status": { # JSON template for the status part of a channel. # The <code>status</code> object encapsulates information about the privacy |
| # status of the channel. |
| "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. |
| "madeForKids": True or False, |
| "privacyStatus": "A String", # Privacy status of the channel. |
| "longUploadsStatus": "A String", # The long uploads status of this channel. See |
| # https://support.google.com/youtube/answer/71673 for more information. |
| "selfDeclaredMadeForKids": True or False, |
| }, |
| "etag": "A String", # Etag of this resource. |
| "auditDetails": { # The <code>auditDetails</code> object encapsulates channel data that is # The <code>auditionDetails</code> object encapsulates channel data |
| # that is relevant for YouTube Partners during the audition process. |
| # relevant for YouTube Partners during the audit process. |
| "communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines. |
| "copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes. |
| "contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims. |
| }, |
| "contentOwnerDetails": { # The <code>contentOwnerDetails</code> object encapsulates channel data that # The <code>contentOwnerDetails</code> object encapsulates channel data |
| # that is relevant for YouTube Partners linked with the channel. |
| # 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 of when the channel was linked to the content owner. |
| # The value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO |
| # 8601</a> |
| # format. |
| }, |
| "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted # The <code>invideoPromotion</code> object encapsulates information about |
| # promotion campaign associated with the channel. |
| # items. A campaign belongs to a single channel_id. |
| "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. |
| "items": [ # List of promoted items in decreasing priority. |
| { # Describes a single promoted item. |
| "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. |
| "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| # the <code>offsetMs</code> field represents an offset from the start of the |
| # video. If the value is <code>offsetFromEnd</code>, then the |
| # <code>offsetMs</code> field represents an offset from the end of the video. |
| "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| # of <code>type</code> the value of the <code>offsetMs</code> field will |
| # represent a time offset from the start or from the end of the video, |
| # expressed in milliseconds. |
| "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| # displayed. If missing, the client should use the default. |
| }, |
| "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. |
| "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item. |
| "type": "A String", # Describes the type of the promoted item. |
| "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. |
| "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 |
| # <code>type</code> has the value <code>video</code>. |
| "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 |
| # <code>type</code> has the value <code>website</code>. |
| }, |
| "customMessage": "A String", # A custom message to display for this promotion. This field is currently |
| # ignored unless the promoted item is a website. |
| }, |
| ], |
| "position": { # Describes the spatial position of a visual widget inside a video. It is a # The spatial position within the video where the promoted item will be |
| # displayed. |
| # union of various position types, out of which only will be set one. |
| "type": "A String", # Defines the position type. |
| "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear. |
| }, |
| "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 overridden by more specific timing in the item. |
| "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| # the <code>offsetMs</code> field represents an offset from the start of the |
| # video. If the value is <code>offsetFromEnd</code>, then the |
| # <code>offsetMs</code> field represents an offset from the end of the video. |
| "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| # of <code>type</code> the value of the <code>offsetMs</code> field will |
| # represent a time offset from the start or from the end of the video, |
| # expressed in milliseconds. |
| "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| # displayed. If missing, the client should use the default. |
| }, |
| }, |
| "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. |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |