Blame - docs/dyn/youtube_v3.channels.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

79

<p class="firstline">Returns a collection of zero or more channel resources that match the request criteria.</p>

80

81

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

84

<code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None)</a></code></p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

85

<p class="firstline">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.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

86

<h3>Method Details</h3>

87

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

88

<code class="details" id="list">list(part, categoryId=None, forUsername=None, hl=None, id=None, managedByMe=None, maxResults=None, mine=None, mySubscribers=None, onBehalfOfContentOwner=None, pageToken=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

89

<pre>Returns a collection of zero or more channel resources that match the request criteria.

90

91

Args:

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

92

part: string, The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

93

94

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

95

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

96

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

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

97

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

98

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.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

99

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

100

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

101

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.

102

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

103

mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.

104

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

105

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

106

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

107

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

108

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

109

110

Returns:

111

An object of the form:

112

113

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

114

"etag": "A String", # Etag of this resource.

115

"eventId": "A String", # Serialized EventId of the request which produced this response.

116

"items": [ # A list of channels that match the request criteria.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

117

{ # A channel resource contains information about a YouTube channel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

118

"auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.

119

"communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.

120

"contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.

121

"copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

122

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

123

"brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.

124

"channel": { # Branding properties for the channel view. # Branding properties for the channel view.

125

"country": "A String", # The country of the channel.

126

"defaultLanguage": "A String",

127

"defaultTab": "A String", # Which content tab users should see when viewing the channel.

128

"description": "A String", # Specifies the channel description.

129

"featuredChannelsTitle": "A String", # Title for the featured channels tab.

130

"featuredChannelsUrls": [ # The list of featured channels.

131

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

132

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

133

"keywords": "A String", # Lists keywords associated with the channel, comma-separated.

134

"moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.

135

"profileColor": "A String", # A prominent color that can be rendered on this channel page.

136

"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.

137

"showRelatedChannels": True or False, # Whether related channels should be proposed.

138

"title": "A String", # Specifies the channel title.

139

"trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.

140

"unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

141

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"hints": [ # Additional experimental branding properties.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

143

{ # A pair Property / Value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

144

"property": "A String", # A property.

145

"value": "A String", # The property's value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

146

},

147

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

148

"image": { # Branding properties for images associated with the channel. # Branding properties for branding images.

149

"backgroundImageUrl": { # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.

150

"default": "A String",

151

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

157

"value": "A String",

158

},

159

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

160

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

161

"bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.

162

"bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).

163

"bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).

164

"bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).

165

"bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).

166

"bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).

167

"bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).

168

"bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).

169

"bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).

170

"bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).

171

"bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).

172

"bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).

173

"bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).

174

"bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).

175

"bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).

176

"largeBrandedBannerImageImapScript": { # The image map script for the large banner image.

177

"default": "A String",

178

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

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

189

"default": "A String",

190

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

"smallBrandedBannerImageImapScript": { # The image map script for the small banner image.

201

"default": "A String",

202

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

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

213

"default": "A String",

214

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

"trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.

225

"watchIconImageUrl": "A 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.

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

226

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

"watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page.

228

"backgroundColor": "A String", # The text color for the video watch page's branded area.

229

"featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.

230

"textColor": "A String", # The background color for the video watch page's branded area.

231

},

232

},

233

"contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.

234

"relatedPlaylists": {

235

"favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

236

"likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

237

"uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.

238

"watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

239

"watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

240

},

241

},

242

"contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.

243

"contentOwner": "A String", # The ID of the content owner linked to the channel.

244

"timeLinked": "A String", # 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.

245

},

246

"conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.

247

"pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

248

{ # 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.

249

"context": "A String", # Defines the context of the ping.

250

"conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.

},

],

},

"etag": "A String", # Etag of this resource.

255

"id": "A String", # The ID that YouTube uses to uniquely identify the channel.

256

"invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.

257

"defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.

258

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

259

"offsetMs": "A String", # 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.

260

"type": "A String", # 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.

261

},

262

"items": [ # List of promoted items in decreasing priority.

263

{ # Describes a single promoted item.

264

"customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.

265

"id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.

266

"recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.

267

"type": "A String", # Describes the type of the promoted item.

268

"videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.

269

"websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.

270

},

271

"promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.

272

"timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.

273

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

274

"offsetMs": "A String", # 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.

275

"type": "A String", # 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.

},

},

],

"position": { # 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. # The spatial position within the video where the promoted item will be displayed.

280

"cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.

281

"type": "A String", # Defines the position type.

282

},

283

"useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.

284

},

285

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

286

"localizations": { # Localizations for different languages

287

"a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.

288

"description": "A String", # The localized strings for channel's description.

289

"title": "A String", # The localized strings for channel's title.

290

},

291

},

292

"snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.

293

"country": "A String", # The country of the channel.

294

"customUrl": "A String", # The custom url of the channel.

295

"defaultLanguage": "A String", # The language of the channel's default title and description.

296

"description": "A String", # The description of the channel.

297

"localized": { # Channel localization setting # Localized title and description, read-only.

298

"description": "A String", # The localized strings for channel's description.

299

"title": "A String", # The localized strings for channel's title.

300

},

301

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

302

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

303

#

304

# When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response.

305

#

306

# Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

307

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

308

"height": 42, # (Optional) Height of the thumbnail image.

309

"url": "A String", # The thumbnail image's URL.

310

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

311

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

312

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

313

"height": 42, # (Optional) Height of the thumbnail image.

314

"url": "A String", # The thumbnail image's URL.

315

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

316

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

317

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

318

"height": 42, # (Optional) Height of the thumbnail image.

319

"url": "A String", # The thumbnail image's URL.

320

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

321

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

322

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

323

"height": 42, # (Optional) Height of the thumbnail image.

324

"url": "A String", # The thumbnail image's URL.

325

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

326

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

327

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

328

"height": 42, # (Optional) Height of the thumbnail image.

329

"url": "A String", # The thumbnail image's URL.

330

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

331

},

332

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

333

"title": "A String", # The channel's title.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

334

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

335

"statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.

336

"commentCount": "A String", # The number of comments for the channel.

337

"hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.

338

"subscriberCount": "A String", # The number of subscribers that the channel has.

339

"videoCount": "A String", # The number of videos uploaded to the channel.

340

"viewCount": "A String", # The number of times the channel has been viewed.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

341

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

342

"status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.

343

"isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.

344

"longUploadsStatus": "A String", # The long uploads status of this channel. See

345

"madeForKids": True or False,

346

"privacyStatus": "A String", # Privacy status of the channel.

347

"selfDeclaredMadeForKids": True or False,

348

},

349

"topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.

350

"topicCategories": [ # A list of Wikipedia URLs that describe the channel's content.

351

"A String",

352

],

353

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

354

"A String",

355

],

Craig Citro

e633be1

2015-03-02 13:40:36 -0800

[diff] [blame]

356

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

357

},

358

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

359

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

360

"nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

361

"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.

362

"resultsPerPage": 42, # The number of results included in the API response.

363

"totalResults": 42, # The total number of results in the result set.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

364

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

365

"prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

366

"tokenPagination": { # Stub token pagination template to suppress results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

367

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

368

"visitorId": "A String", # The visitorId identifies the visitor.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

374

<pre>Retrieves the next page of results.

375

376

Args:

377

previous_request: The request for the previous page. (required)

378

previous_response: The response from the request for the previous page. (required)

379

380

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

381

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

382

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

387

<code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

389

390

Args:

391

part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.

392

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

393

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

394

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

395

Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

396

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

397

The object takes the form of:

398

399

{ # A channel resource contains information about a YouTube channel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

400

"auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.

401

"communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.

402

"contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.

403

"copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

404

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

405

"brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.

406

"channel": { # Branding properties for the channel view. # Branding properties for the channel view.

407

"country": "A String", # The country of the channel.

408

"defaultLanguage": "A String",

409

"defaultTab": "A String", # Which content tab users should see when viewing the channel.

410

"description": "A String", # Specifies the channel description.

411

"featuredChannelsTitle": "A String", # Title for the featured channels tab.

412

"featuredChannelsUrls": [ # The list of featured channels.

413

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

414

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

415

"keywords": "A String", # Lists keywords associated with the channel, comma-separated.

416

"moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.

417

"profileColor": "A String", # A prominent color that can be rendered on this channel page.

418

"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.

419

"showRelatedChannels": True or False, # Whether related channels should be proposed.

420

"title": "A String", # Specifies the channel title.

421

"trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.

422

"unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

423

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

424

"hints": [ # Additional experimental branding properties.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

425

{ # A pair Property / Value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

"property": "A String", # A property.

427

"value": "A String", # The property's value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

428

},

429

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

430

"image": { # Branding properties for images associated with the channel. # Branding properties for branding images.

431

"backgroundImageUrl": { # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.

432

"default": "A String",

433

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

439

"value": "A String",

440

},

441

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

443

"bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.

444

"bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).

445

"bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).

446

"bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).

447

"bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).

448

"bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).

449

"bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).

450

"bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).

451

"bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).

452

"bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).

453

"bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).

454

"bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).

455

"bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).

456

"bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).

457

"bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).

458

"largeBrandedBannerImageImapScript": { # The image map script for the large banner image.

459

"default": "A String",

460

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

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

471

"default": "A String",

472

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

"smallBrandedBannerImageImapScript": { # The image map script for the small banner image.

483

"default": "A String",

484

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

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

495

"default": "A String",

496

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

"trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.

507

"watchIconImageUrl": "A 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.

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

508

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

509

"watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page.

510

"backgroundColor": "A String", # The text color for the video watch page's branded area.

511

"featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.

512

"textColor": "A String", # The background color for the video watch page's branded area.

513

},

514

},

515

"contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.

516

"relatedPlaylists": {

517

"favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

518

"likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

519

"uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.

520

"watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

521

"watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

522

},

523

},

524

"contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.

525

"contentOwner": "A String", # The ID of the content owner linked to the channel.

526

"timeLinked": "A String", # 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.

527

},

528

"conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.

529

"pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

530

{ # 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.

531

"context": "A String", # Defines the context of the ping.

532

"conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.

},

],

},

"etag": "A String", # Etag of this resource.

537

"id": "A String", # The ID that YouTube uses to uniquely identify the channel.

538

"invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.

539

"defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.

540

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

541

"offsetMs": "A String", # 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.

542

"type": "A String", # 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.

543

},

544

"items": [ # List of promoted items in decreasing priority.

545

{ # Describes a single promoted item.

546

"customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.

547

"id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.

548

"recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.

549

"type": "A String", # Describes the type of the promoted item.

550

"videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.

551

"websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.

552

},

553

"promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.

554

"timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.

555

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

556

"offsetMs": "A String", # 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.

557

"type": "A String", # 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.

},

},

],

"position": { # 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. # The spatial position within the video where the promoted item will be displayed.

562

"cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.

563

"type": "A String", # Defines the position type.

564

},

565

"useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.

566

},

567

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

568

"localizations": { # Localizations for different languages

569

"a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.

570

"description": "A String", # The localized strings for channel's description.

571

"title": "A String", # The localized strings for channel's title.

572

},

573

},

574

"snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.

575

"country": "A String", # The country of the channel.

576

"customUrl": "A String", # The custom url of the channel.

577

"defaultLanguage": "A String", # The language of the channel's default title and description.

578

"description": "A String", # The description of the channel.

579

"localized": { # Channel localization setting # Localized title and description, read-only.

580

"description": "A String", # The localized strings for channel's description.

581

"title": "A String", # The localized strings for channel's title.

582

},

583

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

584

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

585

#

586

# When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response.

587

#

588

# Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

589

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

590

"height": 42, # (Optional) Height of the thumbnail image.

591

"url": "A String", # The thumbnail image's URL.

592

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

593

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

594

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

595

"height": 42, # (Optional) Height of the thumbnail image.

596

"url": "A String", # The thumbnail image's URL.

597

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

598

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

599

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

600

"height": 42, # (Optional) Height of the thumbnail image.

601

"url": "A String", # The thumbnail image's URL.

602

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

603

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

604

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

605

"height": 42, # (Optional) Height of the thumbnail image.

606

"url": "A String", # The thumbnail image's URL.

607

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

608

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

609

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

610

"height": 42, # (Optional) Height of the thumbnail image.

611

"url": "A String", # The thumbnail image's URL.

612

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

613

},

614

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

615

"title": "A String", # The channel's title.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

616

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

617

"statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.

618

"commentCount": "A String", # The number of comments for the channel.

619

"hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.

620

"subscriberCount": "A String", # The number of subscribers that the channel has.

621

"videoCount": "A String", # The number of videos uploaded to the channel.

622

"viewCount": "A String", # The number of times the channel has been viewed.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

623

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

624

"status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.

625

"isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.

626

"longUploadsStatus": "A String", # The long uploads status of this channel. See

627

"madeForKids": True or False,

628

"privacyStatus": "A String", # Privacy status of the channel.

629

"selfDeclaredMadeForKids": True or False,

630

},

631

"topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.

632

"topicCategories": [ # A list of Wikipedia URLs that describe the channel's content.

633

"A String",

634

],

635

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

636

"A String",

637

],

Craig Citro

e633be1

2015-03-02 13:40:36 -0800

[diff] [blame]

638

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

639

}

640

641

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.

642

643

Returns:

644

An object of the form:

645

646

{ # A channel resource contains information about a YouTube channel.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

647

"auditDetails": { # The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process. # The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.

648

"communityGuidelinesGoodStanding": True or False, # Whether or not the channel respects the community guidelines.

649

"contentIdClaimsGoodStanding": True or False, # Whether or not the channel has any unresolved claims.

650

"copyrightStrikesGoodStanding": True or False, # Whether or not the channel has any copyright strikes.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

651

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

652

"brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.

653

"channel": { # Branding properties for the channel view. # Branding properties for the channel view.

654

"country": "A String", # The country of the channel.

655

"defaultLanguage": "A String",

656

"defaultTab": "A String", # Which content tab users should see when viewing the channel.

657

"description": "A String", # Specifies the channel description.

658

"featuredChannelsTitle": "A String", # Title for the featured channels tab.

659

"featuredChannelsUrls": [ # The list of featured channels.

660

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

661

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

662

"keywords": "A String", # Lists keywords associated with the channel, comma-separated.

663

"moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.

664

"profileColor": "A String", # A prominent color that can be rendered on this channel page.

665

"showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.

666

"showRelatedChannels": True or False, # Whether related channels should be proposed.

667

"title": "A String", # Specifies the channel title.

668

"trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.

669

"unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

670

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

671

"hints": [ # Additional experimental branding properties.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

672

{ # A pair Property / Value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

673

"property": "A String", # A property.

674

"value": "A String", # The property's value.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

675

},

676

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

677

"image": { # Branding properties for images associated with the channel. # Branding properties for branding images.

678

"backgroundImageUrl": { # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.

679

"default": "A String",

680

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

686

"value": "A String",

687

},

688

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

689

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

690

"bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.

691

"bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).

692

"bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).

693

"bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).

694

"bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).

695

"bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).

696

"bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).

697

"bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).

698

"bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).

699

"bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).

700

"bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).

701

"bannerTvHighImageUrl": "A String", # Banner image. TV size high resolution (1920x1080).

702

"bannerTvImageUrl": "A String", # Banner image. TV size extra high resolution (2120x1192).

703

"bannerTvLowImageUrl": "A String", # Banner image. TV size low resolution (854x480).

704

"bannerTvMediumImageUrl": "A String", # Banner image. TV size medium resolution (1280x720).

705

"largeBrandedBannerImageImapScript": { # The image map script for the large banner image.

706

"default": "A String",

707

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

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

718

"default": "A String",

719

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

"smallBrandedBannerImageImapScript": { # The image map script for the small banner image.

730

"default": "A String",

731

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

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

742

"default": "A String",

743

"defaultLanguage": { # The language of the default property.

"value": "A String",

},

"localized": [

{

"language": "A String",

"value": "A String",

},

],

},

"trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.

754

"watchIconImageUrl": "A 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.

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

755

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

756

"watch": { # Branding properties for the watch. All deprecated. # Branding properties for the watch page.

757

"backgroundColor": "A String", # The text color for the video watch page's branded area.

758

"featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.

759

"textColor": "A String", # The background color for the video watch page's branded area.

760

},

761

},

762

"contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.

763

"relatedPlaylists": {

764

"favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

765

"likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

766

"uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.

767

"watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

768

"watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

769

},

770

},

771

"contentOwnerDetails": { # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel. # The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.

772

"contentOwner": "A String", # The ID of the content owner linked to the channel.

773

"timeLinked": "A String", # 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.

774

},

775

"conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.

776

"pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

777

{ # 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.

778

"context": "A String", # Defines the context of the ping.

779

"conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.

},

],

},

"etag": "A String", # Etag of this resource.

784

"id": "A String", # The ID that YouTube uses to uniquely identify the channel.

785

"invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.

786

"defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.

787

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

788

"offsetMs": "A String", # 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.

789

"type": "A String", # 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.

790

},

791

"items": [ # List of promoted items in decreasing priority.

792

{ # Describes a single promoted item.

793

"customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.

794

"id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.

795

"recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.

796

"type": "A String", # Describes the type of the promoted item.

797

"videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.

798

"websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.

799

},

800

"promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.

801

"timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.

802

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

803

"offsetMs": "A String", # 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.

804

"type": "A String", # 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.

},

},

],

"position": { # 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. # The spatial position within the video where the promoted item will be displayed.

809

"cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.

810

"type": "A String", # Defines the position type.

811

},

812

"useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.

813

},

814

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

815

"localizations": { # Localizations for different languages

816

"a_key": { # Channel localization setting # The language tag, using string since map_key require simple types.

817

"description": "A String", # The localized strings for channel's description.

818

"title": "A String", # The localized strings for channel's title.

819

},

820

},

821

"snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.

822

"country": "A String", # The country of the channel.

823

"customUrl": "A String", # The custom url of the channel.

824

"defaultLanguage": "A String", # The language of the channel's default title and description.

825

"description": "A String", # The description of the channel.

826

"localized": { # Channel localization setting # Localized title and description, read-only.

827

"description": "A String", # The localized strings for channel's description.

828

"title": "A String", # The localized strings for channel's title.

829

},

830

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

831

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

832

#

833

# When displaying thumbnails in your application, make sure that your code uses the image URLs exactly as they are returned in API responses. For example, your application should not use the http domain instead of the https domain in a URL returned in an API response.

834

#

835

# Beginning in July 2018, channel thumbnail URLs will only be available in the https domain, which is how the URLs appear in API responses. After that time, you might see broken images in your application if it tries to load YouTube images from the http domain.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

836

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

837

"height": 42, # (Optional) Height of the thumbnail image.

838

"url": "A String", # The thumbnail image's URL.

839

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

840

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

841

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

842

"height": 42, # (Optional) Height of the thumbnail image.

843

"url": "A String", # The thumbnail image's URL.

844

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

845

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

846

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

847

"height": 42, # (Optional) Height of the thumbnail image.

848

"url": "A String", # The thumbnail image's URL.

849

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

850

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

851

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

852

"height": 42, # (Optional) Height of the thumbnail image.

853

"url": "A String", # The thumbnail image's URL.

854

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

855

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

856

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

857

"height": 42, # (Optional) Height of the thumbnail image.

858

"url": "A String", # The thumbnail image's URL.

859

"width": 42, # (Optional) Width of the thumbnail image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

860

},

861

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

862

"title": "A String", # The channel's title.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

863

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

864

"statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.

865

"commentCount": "A String", # The number of comments for the channel.

866

"hiddenSubscriberCount": True or False, # Whether or not the number of subscribers is shown for this user.

867

"subscriberCount": "A String", # The number of subscribers that the channel has.

868

"videoCount": "A String", # The number of videos uploaded to the channel.

869

"viewCount": "A String", # The number of times the channel has been viewed.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

870

},

Bu Sun Kim