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

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

[diff] [blame]

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

84

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

85

<p class="firstline">Updates an existing resource.</p>

John Asmuth

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

[diff] [blame]

86

<h3>Method Details</h3>

87

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

88

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

89

<pre>Retrieves a list of resources, possibly filtered.

John Asmuth

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

[diff] [blame]

90

91

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

92

part: string, The <code><strong>part</strong></code> parameter specifies a

93

comma-separated list of one or more <code>channel</code> resource

94

properties that the API response will include.<br><br>If the parameter

95

identifies a property that contains child properties, the child properties

96

will be included in the response. For example, in a <code>channel</code>

97

resource, the <code>contentDetails</code> property contains other

98

properties, such as the <code>uploads</code> properties. As such, if you

99

set <code><strong>part=contentDetails</strong></code>, the API response

100

will also contain all of those nested properties. (required) (repeated)

101

pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific

102

page in the result set that should be returned. In an API response, the

103

<code>nextPageToken</code> and <code>prevPageToken</code> properties

104

identify other pages that could be retrieved.

105

managedByMe: boolean, Return the channels managed by the authenticated user.

106

onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube

107

content partners.<br><br>The

108

<code><strong>onBehalfOfContentOwner</strong></code> parameter indicates

109

that the

110

request's authorization credentials identify a YouTube CMS user who is

111

acting on behalf of the content owner specified in the parameter value.

112

This parameter is intended for YouTube content partners that own and manage

113

many different YouTube channels. It allows content owners to authenticate

114

once and get access to all their video and channel data, without having to

115

provide authentication credentials for each individual channel. The CMS

116

account that the user authenticates with must be linked to the specified

117

YouTube content owner.

118

forUsername: string, Return the channel associated with a YouTube username.

119

hl: string, Stands for "host language". Specifies the localization language of the

120

metadata to be filled into snippet.localized. The field is filled with the

121

default metadata if there is no localization in the specified language.

122

The parameter value must be a language code included in the list returned

123

by the i18nLanguages.list method (e.g. en_US, es_MX).

124

maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the

125

maximum number of items that should be returned in the result set.

126

id: string, Return the channels with the specified IDs. (repeated)

127

mySubscribers: boolean, Return the channels subscribed to the authenticated user

128

mine: boolean, Return the ids of channels owned by the authenticated user.

129

categoryId: string, Return the channels within the specified guide category ID.

130

x__xgafv: string, V1 error format.

131

Allowed values

132

1 - v1 error format

133

2 - v2 error format

John Asmuth

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

[diff] [blame]

134

135

Returns:

136

An object of the form:

137

138

{

Bu Sun Kim

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

[diff] [blame]

139

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

140

"nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>

141

# parameter to retrieve the next page in the result set.

142

"visitorId": "A String", # The <code>visitorId</code> identifies the visitor.

143

"items": [

144

{ # A <code><strong>channel</strong></code> resource contains

145

# information about a YouTube channel.

146

"brandingSettings": { # Branding properties of a YouTube channel. # The <code>brandingSettings</code> object encapsulates information about

147

# the branding of the channel.

148

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

149

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

150

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

151

# player.

152

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

153

},

154

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

155

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

156

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

157

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

158

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

159

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

160

"localized": [

161

{

162

"language": "A String",

"value": "A String",

},

],

"default": "A String",

167

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

"value": "A String",

},

},

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

172

"bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to

173

# generate all of the above banner URLs.

174

"largeBrandedBannerImageUrl": { # The URL for the 854px by 70px image that appears below the video player in

175

# the expanded video view of the video watch page.

176

"localized": [

177

{

178

"language": "A String",

"value": "A String",

},

],

"default": "A String",

183

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

"value": "A String",

},

},

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

188

"smallBrandedBannerImageUrl": { # The URL for the 640px by 70px banner image that appears below the video

189

# player in the default view of the video watch page.

190

# The URL for the image that appears above the top-left corner of the video

191

# player. This is a 25-pixel-high image with a flexible width that cannot

# exceed 170 pixels.

"localized": [

{

"language": "A String",

"value": "A String",

},

],

"default": "A String",

200

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

"value": "A String",

},

},

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

205

"localized": [

206

{

207

"language": "A String",

"value": "A String",

},

],

"default": "A String",

212

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

"value": "A String",

},

},

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

217

"watchIconImageUrl": "A String",

218

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

219

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

220

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

221

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

222

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

223

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

224

"backgroundImageUrl": { # The URL for the background image shown on the video watch page. The image

225

# should be 1200px by 615px, with a maximum file size of 128k.

226

"localized": [

227

{

228

"language": "A String",

"value": "A String",

},

],

"default": "A String",

233

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

"value": "A String",

},

},

"trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect

238

# statistics for views of the channel or video pages.

239

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

240

},

241

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

242

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

243

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

244

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

245

"A String",

246

],

247

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

248

# channels.

249

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

250

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

251

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

252

"moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be

253

# approved by the channel owner to be publicly visible.

254

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

255

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

256

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

257

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

258

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

259

"defaultLanguage": "A String",

260

},

261

"hints": [ # Additional experimental branding properties.

262

{ # A pair Property / Value.

263

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

264

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

},

],

},

"conversionPings": { # The <code>conversionPings</code> object encapsulates information about # The <code>conversionPings</code> object encapsulates information about

269

# conversion pings that need to be respected by the channel.

270

# conversion pings that need to be respected by the channel.

271

"pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping

272

# has a context, in which the app must fire the ping, and a url identifying

273

# the ping.

274

{ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping

275

# has a context, in which the app must fire the ping, and a url identifying the

276

# ping.

277

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

278

"conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to.

279

# It's at caller's descretion to decide which schema to use (http vs https)

280

# Example of a returned url: //googleads.g.doubleclick.net/pagead/

281

# viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D

282

# cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default

283

# The caller must append biscotti authentication (ms param in case of

284

# mobile, for example) to this ping.

},

],

},

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

289

# <code>"youtube#channel"</code>.

290

"contentDetails": { # Details about the content of a channel. # The <code>contentDetails</code> object encapsulates information about the

291

# channel's content.

292

"relatedPlaylists": {

293

"favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use

294

# the <code> <a

295

# href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code>

296

# and <code> <a

297

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

298

# to add or remove items from that list.

299

"watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist.

300

# Use the <code><a

301

# href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code>

302

# and <code> <a

303

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

304

# to add or remove items from that list.

305

"watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the

306

# <code> <a

307

# href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code>

308

# and <code> <a

309

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

310

# to add or remove items from that list.

311

"uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use

312

# the <code> <a

313

# href="/youtube/v3/docs/videos/insert">videos.insert</a></code> method to

314

# upload new videos and the <code><a

315

# href="/youtube/v3/docs/videos/delete">videos.delete</a></code> method to

316

# delete previously uploaded videos.

317

"likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the

318

# <code> <a href="/youtube/v3/docs/playlistItems/insert">

319

# playlistItems.insert</a></code> and <code> <a

320

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

321

# to add or remove items from that list.

322

},

323

},

324

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

325

# channel, etc.

326

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

327

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

328

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

329

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

330

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

331

},

332

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

333

"topicDetails": { # Freebase topic information related to the channel. # The <code>topicDetails</code> object encapsulates information about

334

# <a href="http://www.freebase.com">Freebase</a> topics associated with the

335

# channel.

336

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

Bu Sun Kim

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

[diff] [blame]

337

"A String",

John Asmuth

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

[diff] [blame]

338

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

339

"topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve

340

# information about each topic using the <a

341

# href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>.

342

"A String",

343

],

John Asmuth

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

[diff] [blame]

344

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

345

"snippet": { # Basic details about a channel, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the channel,

346

# such as its title, description, and thumbnail images.

347

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

348

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

349

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in

350

# the map, the key is the name of the thumbnail image, and the value is an

351

# object that contains other information about the thumbnail.<br><br> When

352

# displaying thumbnails in your application, make sure that your code uses

353

# the image URLs exactly as they are returned in API responses. For example,

354

# your application should not use the <code>http</code> domain instead of the

355

# <code>https</code> domain in a URL returned in an API response.<br><br>

356

# Beginning in July 2018, channel thumbnail URLs will only be available in

357

# the <code>https</code> domain, which is how the URLs appear in API

358

# responses. After that time, you might see broken images in your application

359

# if it tries to load YouTube images from the <code>http</code> domain.

360

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

361

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

362

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

363

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

Bu Sun Kim

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

[diff] [blame]

364

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

365

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

366

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

367

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

368

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

369

},

370

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

371

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

372

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

373

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

374

},

375

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

376

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

377

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

378

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

379

},

380

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

381

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

382

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

383

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

384

},

385

},

386

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

387

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

388

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

389

},

390

"publishedAt": "A String", # The date and time that the channel was created. The value is specified in

391

# < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

392

# format.

393

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

394

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

395

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

396

},

397

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

398

# status of the channel.

399

"isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+

400

# account. Otherwise, the user doesn't have a public YouTube identity.

401

"madeForKids": True or False,

402

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

403

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

404

# https://support.google.com/youtube/answer/71673 for more information.

405

"selfDeclaredMadeForKids": True or False,

406

},

407

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

408

"auditDetails": { # The <code>auditDetails</code> object encapsulates channel data that is # The <code>auditionDetails</code> object encapsulates channel data

409

# that is relevant for YouTube Partners during the audition process.

410

# relevant for YouTube Partners during the audit process.

411

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

412

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

413

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

414

},

415

"contentOwnerDetails": { # The <code>contentOwnerDetails</code> object encapsulates channel data that # The <code>contentOwnerDetails</code> object encapsulates channel data

416

# that is relevant for YouTube Partners linked with the channel.

417

# is relevant for YouTube Partners linked with the channel.

418

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

419

"timeLinked": "A String", # The date and time of when the channel was linked to the content owner.

420

# The value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO

# 8601</a>

# format.

},

"invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted # The <code>invideoPromotion</code> object encapsulates information about

425

# promotion campaign associated with the channel.

426

# items. A campaign belongs to a single channel_id.

427

"useSmartTiming": True or False, # Indicates whether the channel's promotional campaign uses "smart timing."

428

# This feature attempts to show promotions at a point in the video when they

429

# are more likely to be clicked and less likely to disrupt the viewing

430

# experience. This feature also picks up a single promotion to show on each

431

# video.

432

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

433

{ # Describes a single promoted item.

434

"timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be

435

# displayed. If present, it overrides the default timing.

436

"type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then

437

# the <code>offsetMs</code> field represents an offset from the start of the

438

# video. If the value is <code>offsetFromEnd</code>, then the

439

# <code>offsetMs</code> field represents an offset from the end of the video.

440

"offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value

441

# of <code>type</code> the value of the <code>offsetMs</code> field will

442

# represent a time offset from the start or from the end of the video,

443

# expressed in milliseconds.

444

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be

445

# displayed. If missing, the client should use the default.

Bu Sun Kim

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

[diff] [blame]

446

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

447

"promotedByContentOwner": True or False, # If true, the content owner's name will be used when displaying the

448

# promotion. This field can only be set when the update is made on behalf of

449

# the content owner.

450

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

451

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

452

"recentlyUploadedBy": "A String", # If type is recentUpload, this field identifies the channel from which to

453

# take the recent upload. If missing, the channel is assumed to be the same

454

# channel for which the invideoPromotion is set.

455

"videoId": "A String", # If the promoted item represents a video, this field represents the unique

456

# YouTube ID identifying it. This field will be present only if

457

# <code>type</code> has the value <code>video</code>.

458

"websiteUrl": "A String", # If the promoted item represents a website, this field represents the url

459

# pointing to the website. This field will be present only if

460

# <code>type</code> has the value <code>website</code>.

Bu Sun Kim

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

[diff] [blame]

461

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

462

"customMessage": "A String", # A custom message to display for this promotion. This field is currently

463

# ignored unless the promoted item is a website.

Bu Sun Kim

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

[diff] [blame]

464

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

465

],

466

"position": { # Describes the spatial position of a visual widget inside a video. It is a # The spatial position within the video where the promoted item will be

467

# displayed.

468

# union of various position types, out of which only will be set one.

469

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

470

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

Bu Sun Kim

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

[diff] [blame]

471

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

472

"defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will

473

# be displayed. Can be overridden by more specific timing in the item.

474

"type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then

475

# the <code>offsetMs</code> field represents an offset from the start of the

476

# video. If the value is <code>offsetFromEnd</code>, then the

477

# <code>offsetMs</code> field represents an offset from the end of the video.

478

"offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value

479

# of <code>type</code> the value of the <code>offsetMs</code> field will

480

# represent a time offset from the start or from the end of the video,

481

# expressed in milliseconds.

482

"durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be

483

# displayed. If missing, the client should use the default.

John Asmuth

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

[diff] [blame]

484

},

485

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

486

"localizations": { # Localizations for different languages

487

"a_key": { # Channel localization setting

488

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

489

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

490

},

491

},

John Asmuth

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

[diff] [blame]

492

},

John Asmuth

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

[diff] [blame]

493

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

494

"prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>

495

# parameter to retrieve the previous page in the result set.

496

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

497

"pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.

498

# available and number of resources returned in a single page.

Bu Sun Kim

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

[diff] [blame]

499

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

500

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

John Asmuth

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

[diff] [blame]

501

},

Bu Sun Kim

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

[diff] [blame]

502

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

John Asmuth

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

[diff] [blame]

503

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

504

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

505

# <code>"youtube#channelListResponse"</code>.

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>

511

<pre>Retrieves the next page of results.

512

513

Args:

514

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

515

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

516

517

Returns:

Bu Sun Kim

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

[diff] [blame]

518

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

John Asmuth

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

[diff] [blame]

519

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

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

524

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

525

<pre>Updates an existing resource.

John Asmuth

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

[diff] [blame]

526

527

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

528

part: string, The <code><strong>part</strong></code> parameter serves two purposes in

529

this operation. It identifies the properties that the write operation will

530

set as well as the properties that the API response will

531

include.<br/><br/>The API currently only allows the parameter value to be

532

set to either <code>brandingSettings</code> or

533

<code>invideoPromotion</code>. (You cannot update both of those parts with

534

a single request.)<br/><br/>Note that this method overrides the existing

535

values for all of the mutable properties that are contained in any parts

536

that the parameter value specifies. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

537

body: object, The request body.

John Asmuth

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

[diff] [blame]

538

The object takes the form of:

539

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

540

{ # A <code><strong>channel</strong></code> resource contains

541

# information about a YouTube channel.

542

"brandingSettings": { # Branding properties of a YouTube channel. # The <code>brandingSettings</code> object encapsulates information about

543

# the branding of the channel.

544

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

545

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

546

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

547

# player.

548

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

John Asmuth

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

[diff] [blame]

549

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

550

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

551

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

552

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

553

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

554

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

555

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

556

"localized": [

557

{

558

"language": "A String",

"value": "A String",

},

],

"default": "A String",

563

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

Bu Sun Kim

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

[diff] [blame]

564

"value": "A String",

565

},

Bu Sun Kim

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

[diff] [blame]

566

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

567

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

568

"bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to

569

# generate all of the above banner URLs.

570

"largeBrandedBannerImageUrl": { # The URL for the 854px by 70px image that appears below the video player in

571

# the expanded video view of the video watch page.

572

"localized": [

573

{

574

"language": "A String",

"value": "A String",

},

],

"default": "A String",

579

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

Bu Sun Kim

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

[diff] [blame]

580

"value": "A String",

581

},

Bu Sun Kim

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

[diff] [blame]

582

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

583

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

584

"smallBrandedBannerImageUrl": { # The URL for the 640px by 70px banner image that appears below the video

585

# player in the default view of the video watch page.

586

# The URL for the image that appears above the top-left corner of the video

587

# player. This is a 25-pixel-high image with a flexible width that cannot

# exceed 170 pixels.

"localized": [

{

"language": "A String",

"value": "A String",

},

],

"default": "A String",

596

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

Bu Sun Kim

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

[diff] [blame]

597

"value": "A String",

598

},

Bu Sun Kim

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

[diff] [blame]

599

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

600

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

601

"localized": [

602

{

603

"language": "A String",

"value": "A String",

},

],

"default": "A String",

608

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

Bu Sun Kim

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

[diff] [blame]

609

"value": "A String",

610

},

Bu Sun Kim

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

[diff] [blame]

611

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

612

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

613

"watchIconImageUrl": "A String",

614

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

615

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

616

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

617

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

618

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

619

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

620

"backgroundImageUrl": { # The URL for the background image shown on the video watch page. The image

621

# should be 1200px by 615px, with a maximum file size of 128k.

622

"localized": [

623

{

624

"language": "A String",

"value": "A String",

},

],

"default": "A String",

629

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

Bu Sun Kim

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

[diff] [blame]

630

"value": "A String",

631

},

Bu Sun Kim

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

[diff] [blame]

632

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

633

"trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect

634

# statistics for views of the channel or video pages.

635

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

Bu Sun Kim

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

[diff] [blame]

636

},

Bu Sun Kim

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

[diff] [blame]

637

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

Bu Sun Kim

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

[diff] [blame]

638

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

639

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

Bu Sun Kim

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

[diff] [blame]

640

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

641

"A String",

John Asmuth

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

[diff] [blame]

642

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

643

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

644

# channels.

Bu Sun Kim

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

[diff] [blame]

645

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

646

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

647

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

648

"moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be

649

# approved by the channel owner to be publicly visible.

650

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

651

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

652

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

653

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

654

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

655

"defaultLanguage": "A String",

John Asmuth

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

[diff] [blame]

656

},

Bu Sun Kim

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

[diff] [blame]

657

"hints": [ # Additional experimental branding properties.

John Asmuth

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

[diff] [blame]

658

{ # A pair Property / Value.

Bu Sun Kim

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

[diff] [blame]

659

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

660

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

John Asmuth

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

[diff] [blame]

661

},

662

],

Bu Sun Kim

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

[diff] [blame]

663

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

664

"conversionPings": { # The <code>conversionPings</code> object encapsulates information about # The <code>conversionPings</code> object encapsulates information about

665

# conversion pings that need to be respected by the channel.

666

# conversion pings that need to be respected by the channel.

667

"pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping

668

# has a context, in which the app must fire the ping, and a url identifying

669

# the ping.

670

{ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping

671

# has a context, in which the app must fire the ping, and a url identifying the

672

# ping.

Bu Sun Kim

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

[diff] [blame]

673

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

674

"conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to.

675

# It's at caller's descretion to decide which schema to use (http vs https)

676

# Example of a returned url: //googleads.g.doubleclick.net/pagead/

677

# viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D

678

# cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default

679

# The caller must append biscotti authentication (ms param in case of

680

# mobile, for example) to this ping.

Bu Sun Kim

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

[diff] [blame]

681

},

682

],

683

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

684

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

685

# <code>"youtube#channel"</code>.

686

"contentDetails": { # Details about the content of a channel. # The <code>contentDetails</code> object encapsulates information about the

687

# channel's content.

688

"relatedPlaylists": {

689

"favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use

690

# the <code> <a

691

# href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code>

692

# and <code> <a

693

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

694

# to add or remove items from that list.

695

"watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist.

696

# Use the <code><a

697

# href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code>

698

# and <code> <a

699

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

700

# to add or remove items from that list.

701

"watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the

702

# <code> <a

703

# href="/youtube/v3/docs/playlistItems/insert">playlistItems.insert</a></code>

704

# and <code> <a

705

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

706

# to add or remove items from that list.

707

"uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use

708

# the <code> <a

709

# href="/youtube/v3/docs/videos/insert">videos.insert</a></code> method to

710

# upload new videos and the <code><a

711

# href="/youtube/v3/docs/videos/delete">videos.delete</a></code> method to

712

# delete previously uploaded videos.

713

"likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the

714

# <code> <a href="/youtube/v3/docs/playlistItems/insert">

715

# playlistItems.insert</a></code> and <code> <a

716

# href="/youtube/v3/docs/playlistItems/delete">playlistItems.delete</a></code>

717

# to add or remove items from that list.

718

},

719

},

720

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

721

# channel, etc.

722

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

723

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

724

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

725

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

726

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

727

},

Bu Sun Kim

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

[diff] [blame]

728

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

729

"topicDetails": { # Freebase topic information related to the channel. # The <code>topicDetails</code> object encapsulates information about

730

# <a href="http://www.freebase.com">Freebase</a> topics associated with the

731

# channel.

732

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

733

"A String",

Bu Sun Kim

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

[diff] [blame]

734

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

735

"topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve

736

# information about each topic using the <a

737

# href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>.

738

"A String",

739

],

Bu Sun Kim

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

[diff] [blame]

740

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

741

"snippet": { # Basic details about a channel, including title, description and thumbnails. # The <code>snippet</code> object contains basic details about the channel,

742

# such as its title, description, and thumbnail images.

Bu Sun Kim

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

[diff] [blame]

743

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

744

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

745

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in

746

# the map, the key is the name of the thumbnail image, and the value is an

747

# object that contains other information about the thumbnail.<br><br> When

748

# displaying thumbnails in your application, make sure that your code uses

749

# the image URLs exactly as they are returned in API responses. For example,

750

# your application should not use the <code>http</code> domain instead of the

751

# <code>https</code> domain in a URL returned in an API response.<br><br>

752

# Beginning in July 2018, channel thumbnail URLs will only be available in

753

# the <code>https</code> domain, which is how the URLs appear in API

754

# responses. After that time, you might see broken images in your application

755

# if it tries to load YouTube images from the <code>http</code> domain.

756

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

757

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

758

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

759

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

760

},

761

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

762

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

763

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

764

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

765

},

766

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

767

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

768

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

769

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

770

},

771

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

772

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

773

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

774

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

775

},

776

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

777

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

778

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

779

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

780

},

781

},

Bu Sun Kim

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

[diff] [blame]

782

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

783

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

784

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

785

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

786

"publishedAt": "A String", # The date and time that the channel was created. The value is specified in

787

# < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

788

# format.

Bu Sun Kim

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

[diff] [blame]

789

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

790

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

791

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

John Asmuth

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

[diff] [blame]

792

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

793

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

794

# status of the channel.

795

"isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+

796

# account. Otherwise, the user doesn't have a public YouTube identity.

Bu Sun Kim

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

[diff] [blame]

797

"madeForKids": True or False,

798

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

799

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

800

# https://support.google.com/youtube/answer/71673 for more information.

Bu Sun Kim

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

[diff] [blame]

801

"selfDeclaredMadeForKids": True or False,

802

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

803

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

804

"auditDetails": { # The <code>auditDetails</code> object encapsulates channel data that is # The <code>auditionDetails</code> object encapsulates channel data

805

# that is relevant for YouTube Partners during the audition process.

806

# relevant for YouTube Partners during the audit process.

807

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

808

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

809

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

Craig Citro

e633be1

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

[diff] [blame]

810

},

Bu Sun Kim