Update
|
|||||
|
|
Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your YouTube account
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
- View and manage your assets and associated content on YouTube
Input
This building block consumes 148 input parameters
Name | Format | Description |
---|---|---|
part Required |
STRING |
The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies |
onBehalfOfContentOwner |
STRING |
The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner |
auditDetails |
OBJECT |
The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process |
auditDetails.communityGuidelinesGoodStanding |
BOOLEAN |
Whether or not the channel respects the community guidelines |
auditDetails.contentIdClaimsGoodStanding |
BOOLEAN |
Whether or not the channel has any unresolved claims |
auditDetails.copyrightStrikesGoodStanding |
BOOLEAN |
Whether or not the channel has any copyright strikes |
brandingSettings |
OBJECT |
Branding properties of a YouTube channel |
brandingSettings.channel |
OBJECT |
Branding properties for the channel view |
brandingSettings.channel.country |
STRING |
The country of the channel |
brandingSettings.channel.defaultLanguage |
STRING |
|
brandingSettings.channel.defaultTab |
STRING |
Which content tab users should see when viewing the channel |
brandingSettings.channel.description |
STRING |
Specifies the channel description |
brandingSettings.channel.featuredChannelsTitle |
STRING |
Title for the featured channels tab |
brandingSettings.channel.featuredChannelsUrls[] |
STRING |
|
brandingSettings.channel.keywords |
STRING |
Lists keywords associated with the channel, comma-separated |
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 |
brandingSettings.channel.profileColor |
STRING |
A prominent color that can be rendered on this channel page |
brandingSettings.channel.showBrowseView |
BOOLEAN |
Whether the tab to browse the videos should be displayed |
brandingSettings.channel.showRelatedChannels |
BOOLEAN |
Whether related channels should be proposed |
brandingSettings.channel.title |
STRING |
Specifies the channel title |
brandingSettings.channel.trackingAnalyticsAccountId |
STRING |
The ID for a Google Analytics account to track and measure traffic to the channels |
brandingSettings.channel.unsubscribedTrailer |
STRING |
The trailer of the channel, for users that are not subscribers |
brandingSettings.hints[] |
OBJECT |
A pair Property / Value |
brandingSettings.hints[].property |
STRING |
A property |
brandingSettings.hints[].value |
STRING |
The property's value |
brandingSettings.image |
OBJECT |
Branding properties for images associated with the channel |
brandingSettings.image.backgroundImageUrl |
OBJECT |
|
brandingSettings.image.backgroundImageUrl.default |
STRING |
|
brandingSettings.image.backgroundImageUrl.defaultLanguage |
OBJECT |
|
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 |
brandingSettings.image.bannerImageUrl |
STRING |
Banner image. Desktop size (1060x175) |
brandingSettings.image.bannerMobileExtraHdImageUrl |
STRING |
Banner image. Mobile size high resolution (1440x395) |
brandingSettings.image.bannerMobileHdImageUrl |
STRING |
Banner image. Mobile size high resolution (1280x360) |
brandingSettings.image.bannerMobileImageUrl |
STRING |
Banner image. Mobile size (640x175) |
brandingSettings.image.bannerMobileLowImageUrl |
STRING |
Banner image. Mobile size low resolution (320x88) |
brandingSettings.image.bannerMobileMediumHdImageUrl |
STRING |
Banner image. Mobile size medium/high resolution (960x263) |
brandingSettings.image.bannerTabletExtraHdImageUrl |
STRING |
Banner image. Tablet size extra high resolution (2560x424) |
brandingSettings.image.bannerTabletHdImageUrl |
STRING |
Banner image. Tablet size high resolution (2276x377) |
brandingSettings.image.bannerTabletImageUrl |
STRING |
Banner image. Tablet size (1707x283) |
brandingSettings.image.bannerTabletLowImageUrl |
STRING |
Banner image. Tablet size low resolution (1138x188) |
brandingSettings.image.bannerTvHighImageUrl |
STRING |
Banner image. TV size high resolution (1920x1080) |
brandingSettings.image.bannerTvImageUrl |
STRING |
Banner image. TV size extra high resolution (2120x1192) |
brandingSettings.image.bannerTvLowImageUrl |
STRING |
Banner image. TV size low resolution (854x480) |
brandingSettings.image.bannerTvMediumImageUrl |
STRING |
Banner image. TV size medium resolution (1280x720) |
brandingSettings.image.largeBrandedBannerImageImapScript |
OBJECT |
|
brandingSettings.image.largeBrandedBannerImageImapScript.default |
STRING |
|
brandingSettings.image.largeBrandedBannerImageImapScript.defaultLanguage |
OBJECT |
|
brandingSettings.image.largeBrandedBannerImageUrl |
OBJECT |
|
brandingSettings.image.largeBrandedBannerImageUrl.default |
STRING |
|
brandingSettings.image.largeBrandedBannerImageUrl.defaultLanguage |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageImapScript |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageImapScript.default |
STRING |
|
brandingSettings.image.smallBrandedBannerImageImapScript.defaultLanguage |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageUrl |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageUrl.default |
STRING |
|
brandingSettings.image.smallBrandedBannerImageUrl.defaultLanguage |
OBJECT |
|
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 |
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 |
brandingSettings.watch |
OBJECT |
Branding properties for the watch. All deprecated |
brandingSettings.watch.backgroundColor |
STRING |
The text color for the video watch page's branded area |
brandingSettings.watch.featuredPlaylistId |
STRING |
An ID that uniquely identifies a playlist that displays next to the video player |
brandingSettings.watch.textColor |
STRING |
The background color for the video watch page's branded area |
contentDetails |
OBJECT |
Details about the content of a channel |
contentDetails.relatedPlaylists |
OBJECT |
|
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 |
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 |
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 |
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 |
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 |
contentOwnerDetails |
OBJECT |
The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel |
contentOwnerDetails.contentOwner |
STRING |
The ID of the content owner linked to the channel |
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 |
conversionPings |
OBJECT |
The conversionPings object encapsulates information about conversion pings that need to be respected by the channel |
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 |
conversionPings.pings[].context |
ENUMERATION |
Defines the context of the ping |
conversionPings.pings[].conversionUrl |
STRING |
The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping |
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the channel |
invideoPromotion |
OBJECT |
Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id |
invideoPromotion.defaultTiming |
OBJECT |
Describes a temporal position of a visual widget inside a video |
invideoPromotion.defaultTiming.durationMs |
INTEGER |
Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
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 |
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 |
invideoPromotion.items[] |
OBJECT |
Describes a single promoted item |
invideoPromotion.items[].customMessage |
STRING |
A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website |
invideoPromotion.items[].id |
OBJECT |
Describes a single promoted item id. It is a union of various possible types |
invideoPromotion.items[].id.recentlyUploadedBy |
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 |
invideoPromotion.items[].id.type |
ENUMERATION |
Describes the type of the promoted item |
invideoPromotion.items[].id.videoId |
STRING |
If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video |
invideoPromotion.items[].id.websiteUrl |
STRING |
If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website |
invideoPromotion.items[].promotedByContentOwner |
BOOLEAN |
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 |
invideoPromotion.items[].timing |
OBJECT |
Describes a temporal position of a visual widget inside a video |
invideoPromotion.items[].timing.durationMs |
INTEGER |
Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
invideoPromotion.items[].timing.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 |
invideoPromotion.items[].timing.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 |
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 |
invideoPromotion.position.cornerPosition |
ENUMERATION |
Describes in which corner of the video the visual widget will appear |
invideoPromotion.position.type |
ENUMERATION |
Defines the position type |
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 |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#channel" |
localizations |
OBJECT |
Localizations for different languages |
localizations.customKey |
OBJECT |
Add additional named properties |
localizations.customKey.description |
STRING |
The localized strings for channel's description |
localizations.customKey.title |
STRING |
The localized strings for channel's title |
snippet |
OBJECT |
Basic details about a channel, including title, description and thumbnails |
snippet.country |
STRING |
The country of the channel |
snippet.customUrl |
STRING |
The custom url of the channel |
snippet.defaultLanguage |
STRING |
The language of the channel's default title and description |
snippet.description |
STRING |
The description of the channel |
snippet.localized |
OBJECT |
Channel localization setting |
snippet.localized.description |
STRING |
The localized strings for channel's description |
snippet.localized.title |
STRING |
The localized strings for channel's title |
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 |
snippet.thumbnails |
OBJECT |
Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.default.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.default.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.high |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.high.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.high.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.maxres |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.maxres.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.medium |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.medium.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.standard |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.standard.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.title |
STRING |
The channel's title |
statistics |
OBJECT |
Statistics about a channel: number of subscribers, number of videos in the channel, etc |
statistics.commentCount |
INTEGER |
The number of comments for the channel |
statistics.hiddenSubscriberCount |
BOOLEAN |
Whether or not the number of subscribers is shown for this user |
statistics.subscriberCount |
INTEGER |
The number of subscribers that the channel has |
statistics.videoCount |
INTEGER |
The number of videos uploaded to the channel |
statistics.viewCount |
INTEGER |
The number of times the channel has been viewed |
status |
OBJECT |
JSON template for the status part of a channel |
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 |
status.longUploadsStatus |
ENUMERATION |
The long uploads status of this channel. See |
status.privacyStatus |
ENUMERATION |
Privacy status of the channel |
topicDetails |
OBJECT |
Freebase topic information related to the channel |
topicDetails.topicCategories[] |
STRING |
|
topicDetails.topicIds[] |
STRING |
= Parameter name
= Format
part STRING Required The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies |
onBehalfOfContentOwner STRING The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner |
auditDetails OBJECT The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process |
auditDetails.communityGuidelinesGoodStanding BOOLEAN Whether or not the channel respects the community guidelines |
auditDetails.contentIdClaimsGoodStanding BOOLEAN Whether or not the channel has any unresolved claims |
auditDetails.copyrightStrikesGoodStanding BOOLEAN Whether or not the channel has any copyright strikes |
brandingSettings OBJECT Branding properties of a YouTube channel |
brandingSettings.channel OBJECT Branding properties for the channel view |
brandingSettings.channel.country STRING The country of the channel |
brandingSettings.channel.defaultLanguage STRING |
brandingSettings.channel.defaultTab STRING Which content tab users should see when viewing the channel |
brandingSettings.channel.description STRING Specifies the channel description |
brandingSettings.channel.featuredChannelsTitle STRING Title for the featured channels tab |
brandingSettings.channel.featuredChannelsUrls[] STRING |
brandingSettings.channel.keywords STRING Lists keywords associated with the channel, comma-separated |
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 |
brandingSettings.channel.profileColor STRING A prominent color that can be rendered on this channel page |
brandingSettings.channel.showBrowseView BOOLEAN Whether the tab to browse the videos should be displayed |
brandingSettings.channel.showRelatedChannels BOOLEAN Whether related channels should be proposed |
brandingSettings.channel.title STRING Specifies the channel title |
brandingSettings.channel.trackingAnalyticsAccountId STRING The ID for a Google Analytics account to track and measure traffic to the channels |
brandingSettings.channel.unsubscribedTrailer STRING The trailer of the channel, for users that are not subscribers |
brandingSettings.hints[] OBJECT A pair Property / Value |
brandingSettings.hints[].property STRING A property |
brandingSettings.hints[].value STRING The property's value |
brandingSettings.image OBJECT Branding properties for images associated with the channel |
brandingSettings.image.backgroundImageUrl OBJECT |
brandingSettings.image.backgroundImageUrl.default STRING |
brandingSettings.image.backgroundImageUrl.defaultLanguage OBJECT |
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 |
brandingSettings.image.bannerImageUrl STRING Banner image. Desktop size (1060x175) |
brandingSettings.image.bannerMobileExtraHdImageUrl STRING Banner image. Mobile size high resolution (1440x395) |
brandingSettings.image.bannerMobileHdImageUrl STRING Banner image. Mobile size high resolution (1280x360) |
brandingSettings.image.bannerMobileImageUrl STRING Banner image. Mobile size (640x175) |
brandingSettings.image.bannerMobileLowImageUrl STRING Banner image. Mobile size low resolution (320x88) |
brandingSettings.image.bannerMobileMediumHdImageUrl STRING Banner image. Mobile size medium/high resolution (960x263) |
brandingSettings.image.bannerTabletExtraHdImageUrl STRING Banner image. Tablet size extra high resolution (2560x424) |
brandingSettings.image.bannerTabletHdImageUrl STRING Banner image. Tablet size high resolution (2276x377) |
brandingSettings.image.bannerTabletImageUrl STRING Banner image. Tablet size (1707x283) |
brandingSettings.image.bannerTabletLowImageUrl STRING Banner image. Tablet size low resolution (1138x188) |
brandingSettings.image.bannerTvHighImageUrl STRING Banner image. TV size high resolution (1920x1080) |
brandingSettings.image.bannerTvImageUrl STRING Banner image. TV size extra high resolution (2120x1192) |
brandingSettings.image.bannerTvLowImageUrl STRING Banner image. TV size low resolution (854x480) |
brandingSettings.image.bannerTvMediumImageUrl STRING Banner image. TV size medium resolution (1280x720) |
brandingSettings.image.largeBrandedBannerImageImapScript OBJECT |
brandingSettings.image.largeBrandedBannerImageImapScript.default STRING |
brandingSettings.image.largeBrandedBannerImageImapScript.defaultLanguage OBJECT |
brandingSettings.image.largeBrandedBannerImageUrl OBJECT |
brandingSettings.image.largeBrandedBannerImageUrl.default STRING |
brandingSettings.image.largeBrandedBannerImageUrl.defaultLanguage OBJECT |
brandingSettings.image.smallBrandedBannerImageImapScript OBJECT |
brandingSettings.image.smallBrandedBannerImageImapScript.default STRING |
brandingSettings.image.smallBrandedBannerImageImapScript.defaultLanguage OBJECT |
brandingSettings.image.smallBrandedBannerImageUrl OBJECT |
brandingSettings.image.smallBrandedBannerImageUrl.default STRING |
brandingSettings.image.smallBrandedBannerImageUrl.defaultLanguage OBJECT |
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 |
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 |
brandingSettings.watch OBJECT Branding properties for the watch. All deprecated |
brandingSettings.watch.backgroundColor STRING The text color for the video watch page's branded area |
brandingSettings.watch.featuredPlaylistId STRING An ID that uniquely identifies a playlist that displays next to the video player |
brandingSettings.watch.textColor STRING The background color for the video watch page's branded area |
contentDetails OBJECT Details about the content of a channel |
contentDetails.relatedPlaylists OBJECT |
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 |
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 |
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 |
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 |
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 |
contentOwnerDetails OBJECT The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel |
contentOwnerDetails.contentOwner STRING The ID of the content owner linked to the channel |
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 |
conversionPings OBJECT The conversionPings object encapsulates information about conversion pings that need to be respected by the channel |
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 |
conversionPings.pings[].context ENUMERATION Defines the context of the ping |
conversionPings.pings[].conversionUrl STRING The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping |
etag STRING Etag of this resource |
id STRING The ID that YouTube uses to uniquely identify the channel |
invideoPromotion OBJECT Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id |
invideoPromotion.defaultTiming OBJECT Describes a temporal position of a visual widget inside a video |
invideoPromotion.defaultTiming.durationMs INTEGER Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
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 |
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 |
invideoPromotion.items[] OBJECT Describes a single promoted item |
invideoPromotion.items[].customMessage STRING A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website |
invideoPromotion.items[].id OBJECT Describes a single promoted item id. It is a union of various possible types |
invideoPromotion.items[].id.recentlyUploadedBy 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 |
invideoPromotion.items[].id.type ENUMERATION Describes the type of the promoted item |
invideoPromotion.items[].id.videoId STRING If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video |
invideoPromotion.items[].id.websiteUrl STRING If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website |
invideoPromotion.items[].promotedByContentOwner BOOLEAN 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 |
invideoPromotion.items[].timing OBJECT Describes a temporal position of a visual widget inside a video |
invideoPromotion.items[].timing.durationMs INTEGER Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
invideoPromotion.items[].timing.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 |
invideoPromotion.items[].timing.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 |
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 |
invideoPromotion.position.cornerPosition ENUMERATION Describes in which corner of the video the visual widget will appear |
invideoPromotion.position.type ENUMERATION Defines the position type |
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 |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#channel" |
localizations OBJECT Localizations for different languages |
localizations.customKey OBJECT Add additional named properties |
localizations.customKey.description STRING The localized strings for channel's description |
localizations.customKey.title STRING The localized strings for channel's title |
snippet OBJECT Basic details about a channel, including title, description and thumbnails |
snippet.country STRING The country of the channel |
snippet.customUrl STRING The custom url of the channel |
snippet.defaultLanguage STRING The language of the channel's default title and description |
snippet.description STRING The description of the channel |
snippet.localized OBJECT Channel localization setting |
snippet.localized.description STRING The localized strings for channel's description |
snippet.localized.title STRING The localized strings for channel's title |
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 |
snippet.thumbnails OBJECT Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.default.url STRING The thumbnail image's URL |
snippet.thumbnails.default.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.high OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.high.url STRING The thumbnail image's URL |
snippet.thumbnails.high.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.maxres OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url STRING The thumbnail image's URL |
snippet.thumbnails.maxres.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.medium OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url STRING The thumbnail image's URL |
snippet.thumbnails.medium.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.standard OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url STRING The thumbnail image's URL |
snippet.thumbnails.standard.width INTEGER (Optional) Width of the thumbnail image |
snippet.title STRING The channel's title |
statistics OBJECT Statistics about a channel: number of subscribers, number of videos in the channel, etc |
statistics.commentCount INTEGER The number of comments for the channel |
statistics.hiddenSubscriberCount BOOLEAN Whether or not the number of subscribers is shown for this user |
statistics.subscriberCount INTEGER The number of subscribers that the channel has |
statistics.videoCount INTEGER The number of videos uploaded to the channel |
statistics.viewCount INTEGER The number of times the channel has been viewed |
status OBJECT JSON template for the status part of a channel |
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 |
status.longUploadsStatus ENUMERATION The long uploads status of this channel. See |
status.privacyStatus ENUMERATION Privacy status of the channel |
topicDetails OBJECT Freebase topic information related to the channel |
topicDetails.topicCategories[] STRING |
topicDetails.topicIds[] STRING |
Output
This building block provides 146 output parameters
Name | Format | Description |
---|---|---|
auditDetails |
OBJECT |
The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process |
auditDetails.communityGuidelinesGoodStanding |
BOOLEAN |
Whether or not the channel respects the community guidelines |
auditDetails.contentIdClaimsGoodStanding |
BOOLEAN |
Whether or not the channel has any unresolved claims |
auditDetails.copyrightStrikesGoodStanding |
BOOLEAN |
Whether or not the channel has any copyright strikes |
brandingSettings |
OBJECT |
Branding properties of a YouTube channel |
brandingSettings.channel |
OBJECT |
Branding properties for the channel view |
brandingSettings.channel.country |
STRING |
The country of the channel |
brandingSettings.channel.defaultLanguage |
STRING |
|
brandingSettings.channel.defaultTab |
STRING |
Which content tab users should see when viewing the channel |
brandingSettings.channel.description |
STRING |
Specifies the channel description |
brandingSettings.channel.featuredChannelsTitle |
STRING |
Title for the featured channels tab |
brandingSettings.channel.featuredChannelsUrls[] |
STRING |
|
brandingSettings.channel.keywords |
STRING |
Lists keywords associated with the channel, comma-separated |
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 |
brandingSettings.channel.profileColor |
STRING |
A prominent color that can be rendered on this channel page |
brandingSettings.channel.showBrowseView |
BOOLEAN |
Whether the tab to browse the videos should be displayed |
brandingSettings.channel.showRelatedChannels |
BOOLEAN |
Whether related channels should be proposed |
brandingSettings.channel.title |
STRING |
Specifies the channel title |
brandingSettings.channel.trackingAnalyticsAccountId |
STRING |
The ID for a Google Analytics account to track and measure traffic to the channels |
brandingSettings.channel.unsubscribedTrailer |
STRING |
The trailer of the channel, for users that are not subscribers |
brandingSettings.hints[] |
OBJECT |
A pair Property / Value |
brandingSettings.hints[].property |
STRING |
A property |
brandingSettings.hints[].value |
STRING |
The property's value |
brandingSettings.image |
OBJECT |
Branding properties for images associated with the channel |
brandingSettings.image.backgroundImageUrl |
OBJECT |
|
brandingSettings.image.backgroundImageUrl.default |
STRING |
|
brandingSettings.image.backgroundImageUrl.defaultLanguage |
OBJECT |
|
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 |
brandingSettings.image.bannerImageUrl |
STRING |
Banner image. Desktop size (1060x175) |
brandingSettings.image.bannerMobileExtraHdImageUrl |
STRING |
Banner image. Mobile size high resolution (1440x395) |
brandingSettings.image.bannerMobileHdImageUrl |
STRING |
Banner image. Mobile size high resolution (1280x360) |
brandingSettings.image.bannerMobileImageUrl |
STRING |
Banner image. Mobile size (640x175) |
brandingSettings.image.bannerMobileLowImageUrl |
STRING |
Banner image. Mobile size low resolution (320x88) |
brandingSettings.image.bannerMobileMediumHdImageUrl |
STRING |
Banner image. Mobile size medium/high resolution (960x263) |
brandingSettings.image.bannerTabletExtraHdImageUrl |
STRING |
Banner image. Tablet size extra high resolution (2560x424) |
brandingSettings.image.bannerTabletHdImageUrl |
STRING |
Banner image. Tablet size high resolution (2276x377) |
brandingSettings.image.bannerTabletImageUrl |
STRING |
Banner image. Tablet size (1707x283) |
brandingSettings.image.bannerTabletLowImageUrl |
STRING |
Banner image. Tablet size low resolution (1138x188) |
brandingSettings.image.bannerTvHighImageUrl |
STRING |
Banner image. TV size high resolution (1920x1080) |
brandingSettings.image.bannerTvImageUrl |
STRING |
Banner image. TV size extra high resolution (2120x1192) |
brandingSettings.image.bannerTvLowImageUrl |
STRING |
Banner image. TV size low resolution (854x480) |
brandingSettings.image.bannerTvMediumImageUrl |
STRING |
Banner image. TV size medium resolution (1280x720) |
brandingSettings.image.largeBrandedBannerImageImapScript |
OBJECT |
|
brandingSettings.image.largeBrandedBannerImageImapScript.default |
STRING |
|
brandingSettings.image.largeBrandedBannerImageImapScript.defaultLanguage |
OBJECT |
|
brandingSettings.image.largeBrandedBannerImageUrl |
OBJECT |
|
brandingSettings.image.largeBrandedBannerImageUrl.default |
STRING |
|
brandingSettings.image.largeBrandedBannerImageUrl.defaultLanguage |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageImapScript |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageImapScript.default |
STRING |
|
brandingSettings.image.smallBrandedBannerImageImapScript.defaultLanguage |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageUrl |
OBJECT |
|
brandingSettings.image.smallBrandedBannerImageUrl.default |
STRING |
|
brandingSettings.image.smallBrandedBannerImageUrl.defaultLanguage |
OBJECT |
|
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 |
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 |
brandingSettings.watch |
OBJECT |
Branding properties for the watch. All deprecated |
brandingSettings.watch.backgroundColor |
STRING |
The text color for the video watch page's branded area |
brandingSettings.watch.featuredPlaylistId |
STRING |
An ID that uniquely identifies a playlist that displays next to the video player |
brandingSettings.watch.textColor |
STRING |
The background color for the video watch page's branded area |
contentDetails |
OBJECT |
Details about the content of a channel |
contentDetails.relatedPlaylists |
OBJECT |
|
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 |
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 |
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 |
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 |
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 |
contentOwnerDetails |
OBJECT |
The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel |
contentOwnerDetails.contentOwner |
STRING |
The ID of the content owner linked to the channel |
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 |
conversionPings |
OBJECT |
The conversionPings object encapsulates information about conversion pings that need to be respected by the channel |
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 |
conversionPings.pings[].context |
ENUMERATION |
Defines the context of the ping |
conversionPings.pings[].conversionUrl |
STRING |
The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping |
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the channel |
invideoPromotion |
OBJECT |
Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id |
invideoPromotion.defaultTiming |
OBJECT |
Describes a temporal position of a visual widget inside a video |
invideoPromotion.defaultTiming.durationMs |
INTEGER |
Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
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 |
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 |
invideoPromotion.items[] |
OBJECT |
Describes a single promoted item |
invideoPromotion.items[].customMessage |
STRING |
A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website |
invideoPromotion.items[].id |
OBJECT |
Describes a single promoted item id. It is a union of various possible types |
invideoPromotion.items[].id.recentlyUploadedBy |
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 |
invideoPromotion.items[].id.type |
ENUMERATION |
Describes the type of the promoted item |
invideoPromotion.items[].id.videoId |
STRING |
If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video |
invideoPromotion.items[].id.websiteUrl |
STRING |
If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website |
invideoPromotion.items[].promotedByContentOwner |
BOOLEAN |
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 |
invideoPromotion.items[].timing |
OBJECT |
Describes a temporal position of a visual widget inside a video |
invideoPromotion.items[].timing.durationMs |
INTEGER |
Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
invideoPromotion.items[].timing.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 |
invideoPromotion.items[].timing.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 |
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 |
invideoPromotion.position.cornerPosition |
ENUMERATION |
Describes in which corner of the video the visual widget will appear |
invideoPromotion.position.type |
ENUMERATION |
Defines the position type |
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 |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#channel" |
localizations |
OBJECT |
Localizations for different languages |
localizations.customKey |
OBJECT |
Add additional named properties |
localizations.customKey.description |
STRING |
The localized strings for channel's description |
localizations.customKey.title |
STRING |
The localized strings for channel's title |
snippet |
OBJECT |
Basic details about a channel, including title, description and thumbnails |
snippet.country |
STRING |
The country of the channel |
snippet.customUrl |
STRING |
The custom url of the channel |
snippet.defaultLanguage |
STRING |
The language of the channel's default title and description |
snippet.description |
STRING |
The description of the channel |
snippet.localized |
OBJECT |
Channel localization setting |
snippet.localized.description |
STRING |
The localized strings for channel's description |
snippet.localized.title |
STRING |
The localized strings for channel's title |
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 |
snippet.thumbnails |
OBJECT |
Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.default.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.default.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.high |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.high.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.high.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.maxres |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.maxres.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.medium |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.medium.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.thumbnails.standard |
OBJECT |
A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height |
INTEGER |
(Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url |
STRING |
The thumbnail image's URL |
snippet.thumbnails.standard.width |
INTEGER |
(Optional) Width of the thumbnail image |
snippet.title |
STRING |
The channel's title |
statistics |
OBJECT |
Statistics about a channel: number of subscribers, number of videos in the channel, etc |
statistics.commentCount |
INTEGER |
The number of comments for the channel |
statistics.hiddenSubscriberCount |
BOOLEAN |
Whether or not the number of subscribers is shown for this user |
statistics.subscriberCount |
INTEGER |
The number of subscribers that the channel has |
statistics.videoCount |
INTEGER |
The number of videos uploaded to the channel |
statistics.viewCount |
INTEGER |
The number of times the channel has been viewed |
status |
OBJECT |
JSON template for the status part of a channel |
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 |
status.longUploadsStatus |
ENUMERATION |
The long uploads status of this channel. See |
status.privacyStatus |
ENUMERATION |
Privacy status of the channel |
topicDetails |
OBJECT |
Freebase topic information related to the channel |
topicDetails.topicCategories[] |
STRING |
|
topicDetails.topicIds[] |
STRING |
= Parameter name
= Format
auditDetails OBJECT The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process |
auditDetails.communityGuidelinesGoodStanding BOOLEAN Whether or not the channel respects the community guidelines |
auditDetails.contentIdClaimsGoodStanding BOOLEAN Whether or not the channel has any unresolved claims |
auditDetails.copyrightStrikesGoodStanding BOOLEAN Whether or not the channel has any copyright strikes |
brandingSettings OBJECT Branding properties of a YouTube channel |
brandingSettings.channel OBJECT Branding properties for the channel view |
brandingSettings.channel.country STRING The country of the channel |
brandingSettings.channel.defaultLanguage STRING |
brandingSettings.channel.defaultTab STRING Which content tab users should see when viewing the channel |
brandingSettings.channel.description STRING Specifies the channel description |
brandingSettings.channel.featuredChannelsTitle STRING Title for the featured channels tab |
brandingSettings.channel.featuredChannelsUrls[] STRING |
brandingSettings.channel.keywords STRING Lists keywords associated with the channel, comma-separated |
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 |
brandingSettings.channel.profileColor STRING A prominent color that can be rendered on this channel page |
brandingSettings.channel.showBrowseView BOOLEAN Whether the tab to browse the videos should be displayed |
brandingSettings.channel.showRelatedChannels BOOLEAN Whether related channels should be proposed |
brandingSettings.channel.title STRING Specifies the channel title |
brandingSettings.channel.trackingAnalyticsAccountId STRING The ID for a Google Analytics account to track and measure traffic to the channels |
brandingSettings.channel.unsubscribedTrailer STRING The trailer of the channel, for users that are not subscribers |
brandingSettings.hints[] OBJECT A pair Property / Value |
brandingSettings.hints[].property STRING A property |
brandingSettings.hints[].value STRING The property's value |
brandingSettings.image OBJECT Branding properties for images associated with the channel |
brandingSettings.image.backgroundImageUrl OBJECT |
brandingSettings.image.backgroundImageUrl.default STRING |
brandingSettings.image.backgroundImageUrl.defaultLanguage OBJECT |
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 |
brandingSettings.image.bannerImageUrl STRING Banner image. Desktop size (1060x175) |
brandingSettings.image.bannerMobileExtraHdImageUrl STRING Banner image. Mobile size high resolution (1440x395) |
brandingSettings.image.bannerMobileHdImageUrl STRING Banner image. Mobile size high resolution (1280x360) |
brandingSettings.image.bannerMobileImageUrl STRING Banner image. Mobile size (640x175) |
brandingSettings.image.bannerMobileLowImageUrl STRING Banner image. Mobile size low resolution (320x88) |
brandingSettings.image.bannerMobileMediumHdImageUrl STRING Banner image. Mobile size medium/high resolution (960x263) |
brandingSettings.image.bannerTabletExtraHdImageUrl STRING Banner image. Tablet size extra high resolution (2560x424) |
brandingSettings.image.bannerTabletHdImageUrl STRING Banner image. Tablet size high resolution (2276x377) |
brandingSettings.image.bannerTabletImageUrl STRING Banner image. Tablet size (1707x283) |
brandingSettings.image.bannerTabletLowImageUrl STRING Banner image. Tablet size low resolution (1138x188) |
brandingSettings.image.bannerTvHighImageUrl STRING Banner image. TV size high resolution (1920x1080) |
brandingSettings.image.bannerTvImageUrl STRING Banner image. TV size extra high resolution (2120x1192) |
brandingSettings.image.bannerTvLowImageUrl STRING Banner image. TV size low resolution (854x480) |
brandingSettings.image.bannerTvMediumImageUrl STRING Banner image. TV size medium resolution (1280x720) |
brandingSettings.image.largeBrandedBannerImageImapScript OBJECT |
brandingSettings.image.largeBrandedBannerImageImapScript.default STRING |
brandingSettings.image.largeBrandedBannerImageImapScript.defaultLanguage OBJECT |
brandingSettings.image.largeBrandedBannerImageUrl OBJECT |
brandingSettings.image.largeBrandedBannerImageUrl.default STRING |
brandingSettings.image.largeBrandedBannerImageUrl.defaultLanguage OBJECT |
brandingSettings.image.smallBrandedBannerImageImapScript OBJECT |
brandingSettings.image.smallBrandedBannerImageImapScript.default STRING |
brandingSettings.image.smallBrandedBannerImageImapScript.defaultLanguage OBJECT |
brandingSettings.image.smallBrandedBannerImageUrl OBJECT |
brandingSettings.image.smallBrandedBannerImageUrl.default STRING |
brandingSettings.image.smallBrandedBannerImageUrl.defaultLanguage OBJECT |
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 |
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 |
brandingSettings.watch OBJECT Branding properties for the watch. All deprecated |
brandingSettings.watch.backgroundColor STRING The text color for the video watch page's branded area |
brandingSettings.watch.featuredPlaylistId STRING An ID that uniquely identifies a playlist that displays next to the video player |
brandingSettings.watch.textColor STRING The background color for the video watch page's branded area |
contentDetails OBJECT Details about the content of a channel |
contentDetails.relatedPlaylists OBJECT |
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 |
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 |
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 |
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 |
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 |
contentOwnerDetails OBJECT The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel |
contentOwnerDetails.contentOwner STRING The ID of the content owner linked to the channel |
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 |
conversionPings OBJECT The conversionPings object encapsulates information about conversion pings that need to be respected by the channel |
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 |
conversionPings.pings[].context ENUMERATION Defines the context of the ping |
conversionPings.pings[].conversionUrl STRING The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping |
etag STRING Etag of this resource |
id STRING The ID that YouTube uses to uniquely identify the channel |
invideoPromotion OBJECT Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id |
invideoPromotion.defaultTiming OBJECT Describes a temporal position of a visual widget inside a video |
invideoPromotion.defaultTiming.durationMs INTEGER Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
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 |
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 |
invideoPromotion.items[] OBJECT Describes a single promoted item |
invideoPromotion.items[].customMessage STRING A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website |
invideoPromotion.items[].id OBJECT Describes a single promoted item id. It is a union of various possible types |
invideoPromotion.items[].id.recentlyUploadedBy 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 |
invideoPromotion.items[].id.type ENUMERATION Describes the type of the promoted item |
invideoPromotion.items[].id.videoId STRING If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video |
invideoPromotion.items[].id.websiteUrl STRING If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website |
invideoPromotion.items[].promotedByContentOwner BOOLEAN 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 |
invideoPromotion.items[].timing OBJECT Describes a temporal position of a visual widget inside a video |
invideoPromotion.items[].timing.durationMs INTEGER Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
invideoPromotion.items[].timing.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 |
invideoPromotion.items[].timing.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 |
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 |
invideoPromotion.position.cornerPosition ENUMERATION Describes in which corner of the video the visual widget will appear |
invideoPromotion.position.type ENUMERATION Defines the position type |
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 |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#channel" |
localizations OBJECT Localizations for different languages |
localizations.customKey OBJECT Add additional named properties |
localizations.customKey.description STRING The localized strings for channel's description |
localizations.customKey.title STRING The localized strings for channel's title |
snippet OBJECT Basic details about a channel, including title, description and thumbnails |
snippet.country STRING The country of the channel |
snippet.customUrl STRING The custom url of the channel |
snippet.defaultLanguage STRING The language of the channel's default title and description |
snippet.description STRING The description of the channel |
snippet.localized OBJECT Channel localization setting |
snippet.localized.description STRING The localized strings for channel's description |
snippet.localized.title STRING The localized strings for channel's title |
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 |
snippet.thumbnails OBJECT Internal representation of thumbnails for a YouTube resource |
snippet.thumbnails.default OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.default.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.default.url STRING The thumbnail image's URL |
snippet.thumbnails.default.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.high OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.high.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.high.url STRING The thumbnail image's URL |
snippet.thumbnails.high.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.maxres OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.maxres.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.maxres.url STRING The thumbnail image's URL |
snippet.thumbnails.maxres.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.medium OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.medium.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.medium.url STRING The thumbnail image's URL |
snippet.thumbnails.medium.width INTEGER (Optional) Width of the thumbnail image |
snippet.thumbnails.standard OBJECT A thumbnail is an image representing a YouTube resource |
snippet.thumbnails.standard.height INTEGER (Optional) Height of the thumbnail image |
snippet.thumbnails.standard.url STRING The thumbnail image's URL |
snippet.thumbnails.standard.width INTEGER (Optional) Width of the thumbnail image |
snippet.title STRING The channel's title |
statistics OBJECT Statistics about a channel: number of subscribers, number of videos in the channel, etc |
statistics.commentCount INTEGER The number of comments for the channel |
statistics.hiddenSubscriberCount BOOLEAN Whether or not the number of subscribers is shown for this user |
statistics.subscriberCount INTEGER The number of subscribers that the channel has |
statistics.videoCount INTEGER The number of videos uploaded to the channel |
statistics.viewCount INTEGER The number of times the channel has been viewed |
status OBJECT JSON template for the status part of a channel |
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 |
status.longUploadsStatus ENUMERATION The long uploads status of this channel. See |
status.privacyStatus ENUMERATION Privacy status of the channel |
topicDetails OBJECT Freebase topic information related to the channel |
topicDetails.topicCategories[] STRING |
topicDetails.topicIds[] STRING |