part STRING Required

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

categoryId STRING

The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category

forUsername STRING

The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username

hl STRING

The hl parameter should be used for filter out the properties that are not in the given language. Used for the brandingSettings part

id STRING

The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID

managedByMe BOOLEAN

Note: This parameter is intended exclusively for YouTube content partners.

Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided

maxResults INTEGER

The maxResults parameter specifies the maximum number of items that should be returned in the result set

mine BOOLEAN

Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user

mySubscribers BOOLEAN

Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers to the authenticated user's channel

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

etag STRING

Etag of this resource

eventId STRING

Serialized EventId of the request which produced this response

items[] OBJECT

A channel resource contains information about a YouTube channel

items[].auditDetails OBJECT

The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process

items[].auditDetails.communityGuidelinesGoodStanding BOOLEAN

Whether or not the channel respects the community guidelines

items[].auditDetails.contentIdClaimsGoodStanding BOOLEAN

Whether or not the channel has any unresolved claims

items[].auditDetails.copyrightStrikesGoodStanding BOOLEAN

Whether or not the channel has any copyright strikes

items[].brandingSettings OBJECT

Branding properties of a YouTube channel

items[].brandingSettings.channel OBJECT

Branding properties for the channel view

items[].brandingSettings.channel.country STRING

The country of the channel

items[].brandingSettings.channel.defaultLanguage STRING

items[].brandingSettings.channel.defaultTab STRING

Which content tab users should see when viewing the channel

items[].brandingSettings.channel.description STRING

Specifies the channel description

items[].brandingSettings.channel.featuredChannelsTitle STRING

Title for the featured channels tab

items[].brandingSettings.channel.featuredChannelsUrls[] STRING

items[].brandingSettings.channel.keywords STRING

Lists keywords associated with the channel, comma-separated

items[].brandingSettings.channel.moderateComments BOOLEAN

Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible

items[].brandingSettings.channel.profileColor STRING

A prominent color that can be rendered on this channel page

items[].brandingSettings.channel.showBrowseView BOOLEAN

Whether the tab to browse the videos should be displayed

items[].brandingSettings.channel.showRelatedChannels BOOLEAN

Whether related channels should be proposed

items[].brandingSettings.channel.title STRING

Specifies the channel title

items[].brandingSettings.channel.trackingAnalyticsAccountId STRING

The ID for a Google Analytics account to track and measure traffic to the channels

items[].brandingSettings.channel.unsubscribedTrailer STRING

The trailer of the channel, for users that are not subscribers

items[].brandingSettings.hints[] OBJECT

A pair Property / Value

items[].brandingSettings.image OBJECT

Branding properties for images associated with the channel

items[].brandingSettings.image.bannerExternalUrl STRING

This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs

items[].brandingSettings.image.bannerImageUrl STRING

Banner image. Desktop size (1060x175)

items[].brandingSettings.image.bannerMobileExtraHdImageUrl STRING

Banner image. Mobile size high resolution (1440x395)

items[].brandingSettings.image.bannerMobileHdImageUrl STRING

Banner image. Mobile size high resolution (1280x360)

items[].brandingSettings.image.bannerMobileImageUrl STRING

Banner image. Mobile size (640x175)

items[].brandingSettings.image.bannerMobileLowImageUrl STRING

Banner image. Mobile size low resolution (320x88)

items[].brandingSettings.image.bannerMobileMediumHdImageUrl STRING

Banner image. Mobile size medium/high resolution (960x263)

items[].brandingSettings.image.bannerTabletExtraHdImageUrl STRING

Banner image. Tablet size extra high resolution (2560x424)

items[].brandingSettings.image.bannerTabletHdImageUrl STRING

Banner image. Tablet size high resolution (2276x377)

items[].brandingSettings.image.bannerTabletImageUrl STRING

Banner image. Tablet size (1707x283)

items[].brandingSettings.image.bannerTabletLowImageUrl STRING

Banner image. Tablet size low resolution (1138x188)

items[].brandingSettings.image.bannerTvHighImageUrl STRING

Banner image. TV size high resolution (1920x1080)

items[].brandingSettings.image.bannerTvImageUrl STRING

Banner image. TV size extra high resolution (2120x1192)

items[].brandingSettings.image.bannerTvLowImageUrl STRING

Banner image. TV size low resolution (854x480)

items[].brandingSettings.image.bannerTvMediumImageUrl STRING

Banner image. TV size medium resolution (1280x720)

items[].brandingSettings.image.trackingImageUrl 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

items[].brandingSettings.image.watchIconImageUrl STRING

The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels

items[].brandingSettings.watch OBJECT

Branding properties for the watch. All deprecated

items[].brandingSettings.watch.backgroundColor STRING

The text color for the video watch page's branded area

items[].brandingSettings.watch.featuredPlaylistId STRING

An ID that uniquely identifies a playlist that displays next to the video player

items[].brandingSettings.watch.textColor STRING

The background color for the video watch page's branded area

items[].contentDetails OBJECT

Details about the content of a channel

items[].contentDetails.relatedPlaylists OBJECT

items[].contentDetails.relatedPlaylists.favorites 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

items[].contentDetails.relatedPlaylists.likes 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

items[].contentDetails.relatedPlaylists.uploads 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

items[].contentDetails.relatedPlaylists.watchHistory 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

items[].contentDetails.relatedPlaylists.watchLater 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

items[].contentOwnerDetails OBJECT

The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel

items[].contentOwnerDetails.contentOwner STRING

The ID of the content owner linked to the channel

items[].contentOwnerDetails.timeLinked DATE_TIME

The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format

items[].conversionPings OBJECT

The conversionPings object encapsulates information about conversion pings that need to be respected by the channel

items[].conversionPings.pings[] OBJECT

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

items[].etag STRING

Etag of this resource

items[].id STRING

The ID that YouTube uses to uniquely identify the channel

items[].invideoPromotion OBJECT

Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id

items[].invideoPromotion.defaultTiming OBJECT

Describes a temporal position of a visual widget inside a video

items[].invideoPromotion.defaultTiming.durationMs INTEGER

Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default

items[].invideoPromotion.defaultTiming.offsetMs INTEGER

Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds

items[].invideoPromotion.defaultTiming.type ENUMERATION

Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video

items[].invideoPromotion.items[] OBJECT

Describes a single promoted item

items[].invideoPromotion.position OBJECT

Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one

items[].invideoPromotion.position.cornerPosition ENUMERATION

Describes in which corner of the video the visual widget will appear

items[].invideoPromotion.position.type ENUMERATION

Defines the position type

items[].invideoPromotion.useSmartTiming BOOLEAN

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[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#channel"

items[].localizations OBJECT

Localizations for different languages

items[].localizations.customKey OBJECT

Add additional named properties

items[].localizations.customKey.description STRING

The localized strings for channel's description

items[].localizations.customKey.title STRING

The localized strings for channel's title

items[].snippet OBJECT

Basic details about a channel, including title, description and thumbnails

items[].snippet.country STRING

The country of the channel

items[].snippet.customUrl STRING

The custom url of the channel

items[].snippet.defaultLanguage STRING

The language of the channel's default title and description

items[].snippet.description STRING

The description of the channel

items[].snippet.localized OBJECT

Channel localization setting

items[].snippet.localized.description STRING

The localized strings for channel's description

items[].snippet.localized.title STRING

The localized strings for channel's title

items[].snippet.publishedAt DATE_TIME

The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format

items[].snippet.thumbnails OBJECT

Internal representation of thumbnails for a YouTube resource

items[].snippet.title STRING

The channel's title

items[].statistics OBJECT

Statistics about a channel: number of subscribers, number of videos in the channel, etc

items[].statistics.commentCount INTEGER

The number of comments for the channel

items[].statistics.hiddenSubscriberCount BOOLEAN

Whether or not the number of subscribers is shown for this user

items[].statistics.subscriberCount INTEGER

The number of subscribers that the channel has

items[].statistics.videoCount INTEGER

The number of videos uploaded to the channel

items[].statistics.viewCount INTEGER

The number of times the channel has been viewed

items[].status OBJECT

JSON template for the status part of a channel

items[].status.isLinked BOOLEAN

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

items[].status.longUploadsStatus ENUMERATION

The long uploads status of this channel. See

items[].status.privacyStatus ENUMERATION

Privacy status of the channel

items[].topicDetails OBJECT

Freebase topic information related to the channel

items[].topicDetails.topicCategories[] STRING

items[].topicDetails.topicIds[] STRING

kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse"

nextPageToken STRING

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set

pageInfo OBJECT

Paging details for lists of resources, including total number of items available and number of resources returned in a single page

pageInfo.resultsPerPage INTEGER

The number of results included in the API response

pageInfo.totalResults INTEGER

The total number of results in the result set

prevPageToken STRING

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set

tokenPagination OBJECT

Stub token pagination template to suppress results

visitorId STRING

The visitorId identifies the visitor