Interface GoogleApiYouTubeChannelResource

Index

Properties

Properties

public brandingSettings: { channel: { title: string; description: string; keywords: string; defaultTab: string; trackingAnalyticsAccountId: string; moderateComments: boolean; showRelatedChannels: boolean; showBrowseView: boolean; featuredChannelsTitle: string; featuredChannelsUrls: string[]; unsubscribedTrailer: string; }; watch: { textColor: string; backgroundColor: string; featuredPlaylistId: string; }; image: { bannerImageUrl: string; bannerMobileImageUrl: string; backgroundImageUrl: { default: string; localized: { value: string; language: string; }[]; }; largeBrandedBannerImageImapScript: { default: string; localized: { value: string; language: string; }[]; }; largeBrandedBannerImageUrl: { default: string; localized: { value: string; language: string; }[]; }; smallBrandedBannerImageImapScript: { default: string; localized: { value: string; language: string; }[]; }; smallBrandedBannerImageUrl: { default: string; localized: { value: string; language: string; }[]; }; watchIconImageUrl: string; trackingImageUrl: string; bannerTabletLowImageUrl: string; bannerTabletImageUrl: string; bannerTabletHdImageUrl: string; bannerTabletExtraHdImageUrl: string; bannerMobileLowImageUrl: string; bannerMobileMediumImageUrl: string; bannerMobileHdImageUrl: string; bannerMobileExtraHdImageUrl: string; bannerTvImageUrl: string; bannerExternalUrl: string; }; hints: { property: string; value: string; }[]; }

The brandingSettings object encapsulates information about the branding of the channel.

public backgroundImageUrl.default: string

The default value for the property.

public backgroundImageUrl.localized: Array<{ value: string; language: string; }>

A list of objects that specify language-specific values for the property.

public brandingSettings.channel: { title: string; description: string; keywords: string; defaultTab: string; trackingAnalyticsAccountId: string; moderateComments: boolean; showRelatedChannels: boolean; showBrowseView: boolean; featuredChannelsTitle: string; featuredChannelsUrls: string[]; unsubscribedTrailer: string; }

The channel object encapsulates branding properties of the channel page.

public brandingSettings.hints: Array<{ property: string; value: string; }>

The hints object encapsulates additional branding properties

public brandingSettings.image: { bannerImageUrl: string; bannerMobileImageUrl: string; backgroundImageUrl: { default: string; localized: { value: string; language: string; }[]; }; largeBrandedBannerImageImapScript: { default: string; localized: { value: string; language: string; }[]; }; largeBrandedBannerImageUrl: { default: string; localized: { value: string; language: string; }[]; }; smallBrandedBannerImageImapScript: { default: string; localized: { value: string; language: string; }[]; }; smallBrandedBannerImageUrl: { default: string; localized: { value: string; language: string; }[]; }; watchIconImageUrl: string; trackingImageUrl: string; bannerTabletLowImageUrl: string; bannerTabletImageUrl: string; bannerTabletHdImageUrl: string; bannerTabletExtraHdImageUrl: string; bannerMobileLowImageUrl: string; bannerMobileMediumImageUrl: string; bannerMobileHdImageUrl: string; bannerMobileExtraHdImageUrl: string; bannerTvImageUrl: string; bannerExternalUrl: string; }

The image object encapsulates information about images that display on the channels channel page or video watch pages.

public brandingSettings.watch: { textColor: string; backgroundColor: string; featuredPlaylistId: string; }

The watch object encapsulates branding properties of the watch pages for the channels videos.

public channel.defaultTab: string

The content tab that users should display by default when viewers arrive at your channel page.

public channel.description: string

The channel description, which appears in the channel information box on your channel page.

public channel.featuredChannelsTitle: string

The title that displays above the featured channels module.

public channel.featuredChannelsUrls: Array<string>

A list of up to 16 channels that you would like to link to from the featured channels module. The property value is a list of YouTube channel ID values, each of which uniquely identifies a channel.

public channel.keywords: string

Keywords associated with your channel. The value is a comma-separated list of strings.

public channel.moderateComments: boolean

This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false.

public channel.showBrowseView: boolean

This setting indicates whether the channel page should display content in a browse or feed view.

public channel.showRelatedChannels: boolean

This setting indicates whether YouTube should show an algorithmically generated list of related channels on your channel page.

public channel.title: string

The channels title. The title has a maximum length of 30 characters.

public channel.trackingAnalyticsAccountId: string

The ID for a Google Analytics account that you want to use to track and measure traffic to your channel.

public channel.unsubscribedTrailer: string

The video that should play in the featured video module in the channel pages browse view for unsubscribed viewers. Subscribed viewers may see a different view that highlights more recent channel activity.

public image.backgroundImageUrl: { default: string; localized: { value: string; language: string; }[]; }

The backgroundImageUrl object encapsulates settings for the background image shown on the video watch page. The image is 1200px by 615px, with a maximum file size of 128k.

public image.bannerExternalUrl: string

This property specifies the location of the banner image that YouTube will use to generate the various banner image sizes for a channel. To obtain the URL banner images external URL, you must first upload the channel banner image that you want to use by calling the channelBanners.insert method.

public image.bannerImageUrl: string

The URL for the banner image shown on the channel page on the YouTube website. The image is 1060px by 175px.

public image.bannerMobileExtraHdImageUrl: string

The URL for a very high-resolution banner image that displays on the channel page in mobile applications. The image is 1440px by 395px.

public image.bannerMobileHdImageUrl: string

The URL for a high-resolution banner image that displays on the channel page in mobile applications. The image is 1280px by 360px.

public image.bannerMobileImageUrl: string

The URL for the banner image shown on the channel page in mobile applications. The image is 640px by 175px.

public image.bannerMobileLowImageUrl: string

The URL for a low-resolution banner image that displays on the channel page in mobile applications. The image is 320px by 88px.

public image.bannerMobileMediumImageUrl: string

The URL for a medium-resolution banner image that displays on the channel page in mobile applications. The image is 960px by 263px.

public image.bannerTabletExtraHdImageUrl: string

The URL for an insanely high-resolution banner image that displays on the channel page in tablet applications. The image is 2560px by 424px.

public image.bannerTabletHdImageUrl: string

The URL for a high-resolution banner image that displays on the channel page in tablet applications. The image is 2276px by 377px.

public image.bannerTabletImageUrl: string

The URL for a banner image that displays on the channel page in tablet applications. The image is 1707px by 283px.

public image.bannerTabletLowImageUrl: string

The URL for a low-resolution banner image that displays on the channel page in tablet applications. The image is 1138px by 188px.

public image.bannerTvImageUrl: string

The URL for a banner image that displays on the channel page in television applications. The image is 2120px by 1192px.

public image.largeBrandedBannerImageImapScript: { default: string; localized: { value: string; language: string; }[]; }

The largeBrandedBannerImageImapScript object encapsulates information about the image map script for the banner image shown on the channel page.

public image.largeBrandedBannerImageUrl: { default: string; localized: { value: string; language: string; }[]; }

The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.

public image.smallBrandedBannerImageImapScript: { default: string; localized: { value: string; language: string; }[]; }

The image map script for the small banner image. The largeBrandedBannerImageImapScript object encapsulates information about the image map script for the banner image shown on the channel page in mobile applications.

public image.smallBrandedBannerImageUrl: { default: string; localized: { value: string; language: string; }[]; }

The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.

public 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.

public image.watchIconImageUrl: string

The URL for the image that appears above the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels. If you do not provide this image, your channel name will appear instead of an image.

public largeBrandedBannerImageImapScript.default: string

The default value for the property.

public largeBrandedBannerImageImapScript.localized: Array<{ value: string; language: string; }>

A list of objects that specify language-specific values for the property.

public largeBrandedBannerImageUrl.default: string

The default value for the property.

public largeBrandedBannerImageUrl.localized: Array<{ value: string; language: string; }>

A list of objects that specify language-specific values for the property.

public smallBrandedBannerImageImapScript.default: string

The default value for the property.

public smallBrandedBannerImageImapScript.localized: Array<{ value: string; language: string; }>

A list of objects that specify language-specific values for the property.

public smallBrandedBannerImageUrl.default: string

The default value for the property.

public smallBrandedBannerImageUrl.localized: Array<{ value: string; language: string; }>

A list of objects that specify language-specific values for the property.

public watch.backgroundColor: string

The text color for the video watch pages branded area.

public watch.featuredPlaylistId: string

An ID that uniquely identifies a playlist that displays next to the video player on the video watch page.

public watch.textColor: string

The background color for the video watch pages branded area.

public contentDetails: { relatedPlaylists: { likes: string; favorites: string; uploads: string; watchHistory: string; watchLater: string; }; googlePlusUserId: string; }

The contentDetails object encapsulates information about the channels content.

public contentDetails.googlePlusUserId: string

The googlePlusUserId object identifies the Google+ profile ID associated with this channel.

public contentDetails.relatedPlaylists: { likes: string; favorites: string; uploads: string; watchHistory: string; watchLater: string; }

The relatedPlaylists object is a map that identifies playlists associated with the channel, such as the channels uploaded videos or favorite videos. You can retrieve any of these playlists using the playlists.list method.

public relatedPlaylists.favorites: string

The ID of the playlist that contains the channels favorite videos.

public relatedPlaylists.likes: string

The ID of the playlist that contains the channels liked videos.

public relatedPlaylists.uploads: string

The ID of the playlist that contains the channels uploaded videos.

public relatedPlaylists.watchHistory: string

The ID of the playlist that contains the channels watch history.

public relatedPlaylists.watchLater: string

The ID of the channels watch later playlist.

public etag: string

The ETag for the channel resource.

public id: string

The ID that YouTube uses to uniquely identify the channel.

public invideoPromotion: { timing: { type: string; offsetMs: number; }; position: { type: string; cornerPosition: string; }; items: { type: string; videoId: string; }[]; }

The invideoPromotion object encapsulates information about a promotional campaign associated with the channel. A channel can use an in-video promotional campaign to display the thumbnail image of a promoted video in the video player during playback of the channels videos

public invideoPromotion.items: Array<{ type: string; videoId: string; }>

The list of promoted items in the order that they will display across different playbacks to the same viewer.

public invideoPromotion.position: { type: string; cornerPosition: string; }

The position object encapsulates information about the spatial position within the video where the promoted item will be displayed.

public invideoPromotion.timing: { type: string; offsetMs: number; }

The timing object encapsulates information about the temporal position within the video when the promoted item will be displayed.

public position.cornerPosition: string

The corner of the player where the promoted item will appear.

public position.type: string

The manner in which the promoted item is positioned in the video player.

public timing.offsetMs: number

The time offset, specified in milliseconds, that determines when the promoted item appears during video playbacks. The type propertys value determines whether the offset is measured from the start or end of the video.

public timing.type: string

The timing method that determines when the promoted item is inserted during the video playback. 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.

public kind: string

The type of the API resource. For channel resources, the value will be youtube#channel.

public snippet: { title: string; description: string; publishedAt: string; thumbnails: GoogleApiYouTubeThumbnailItemResource[]; }

The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.

public snippet.description: string

The channels description.

public snippet.publishedAt: string

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

public snippet.thumbnails: GoogleApiYouTubeThumbnailItemResource[]

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.

public snippet.title: string

The channels title.

public statistics: { viewCount: number; commentCount: number; subscriberCount: number; videoCount: number; }

The statistics object encapsulates statistics for the channel.

public statistics.commentCount: number

The number of comments for the channel.

public statistics.subscriberCount: number

The number of subscribers that the channel has.

public statistics.videoCount: number

The number of videos uploaded to the channel.

public statistics.viewCount: number

The number of times the channel has been viewed.

public status: { privacyStatus: string; isLinked: boolean; }

The status object encapsulates information about the privacy status of the channel.

public status.isLinked: boolean

Indicates whether the channel data identifies a user that is already linked to either a YouTube username or a Google+ account. A user that has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos.

public status.privacyStatus: string

Privacy status of the channel.

public topicDetails: { topicIds: string[]; }

The topicDetails object encapsulates information about Freebase topics associated with the channel.

public topicDetails.topicIds: Array<string>

A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.