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

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

[diff] [blame]

82

<p class="firstline">Retrieves a list of resources, possibly filtered.</p>

John Asmuth

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

[diff] [blame]

83

84

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

85

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

86

Bu Sun Kim

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

[diff] [blame]

87

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

88

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

John Asmuth

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

[diff] [blame]

89

<h3>Method Details</h3>

90

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

John Asmuth

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

[diff] [blame]

98

99

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

part: string, The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set *part=contentDetails*, the API response will also contain all of those nested properties. (required) (repeated)

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

101

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

102

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

103

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

104

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

105

hl: string, Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

106

onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

107

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.

108

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

109

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

110

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

Bu Sun Kim

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

[diff] [blame]

111

x__xgafv: string, V1 error format.

112

Allowed values

113

1 - v1 error format

114

2 - v2 error format

John Asmuth

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

[diff] [blame]

115

116

Returns:

117

An object of the form:

118

119

{

Bu Sun Kim

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

[diff] [blame]

120

"items": [

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

121

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

122

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

123

"hints": [ # Additional experimental branding properties.

124

{ # A pair Property / Value.

125

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

126

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

127

},

128

],

129

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

130

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

"localized": [

{

"value": "A String",

"language": "A String",

135

},

136

],

137

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

138

"value": "A String",

139

},

140

"default": "A String",

141

},

142

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

143

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

"localized": [

{

"value": "A String",

"language": "A String",

148

},

149

],

150

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

151

"value": "A String",

152

},

153

"default": "A String",

154

},

155

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

156

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

157

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

158

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

"localized": [

{

"value": "A String",

"language": "A String",

163

},

164

],

165

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

166

"value": "A String",

167

},

168

"default": "A String",

169

},

170

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

171

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

172

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

173

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

174

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

175

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

176

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

"localized": [

{

"value": "A String",

"language": "A String",

181

},

182

],

183

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

184

"value": "A String",

185

},

186

"default": "A String",

187

},

188

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

189

"watchIconImageUrl": "A String",

190

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

191

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

192

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

"localized": [

{

"value": "A String",

"language": "A String",

197

},

198

],

199

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

200

"value": "A String",

201

},

202

"default": "A String",

203

},

204

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

205

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

206

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

207

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

208

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

209

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

210

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

211

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

212

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

"A String",

226

],

227

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

228

"defaultLanguage": "A String",

229

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

230

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

231

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

232

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

233

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

234

"A String",

235

],

236

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

237

"A String",

238

],

239

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

240

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

241

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

242

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

243

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

244

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

245

},

246

],

Bu Sun Kim

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

[diff] [blame]

247

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

248

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

249

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

250

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

251

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

252

},

253

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

254

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

255

"timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 format.

256

},

257

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

258

"relatedPlaylists": {

259

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

260

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

261

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

262

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

263

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

264

},

265

},

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

},

274

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

275

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

276

"localizations": { # Localizations for different languages

277

"a_key": { # Channel localization setting

278

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

279

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

280

},

281

},

282

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

283

"longUploadsStatus": "A String", # The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.

284

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

285

"selfDeclaredMadeForKids": True or False,

286

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

287

"madeForKids": True or False,

288

},

289

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

290

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

291

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

292

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

293

},

294

"publishedAt": "A String", # The date and time that the channel was created. The value is specified in < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601 format.

295

"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. 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. 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. Thumbnail images might be empty for newly created channels and might take up to one day to populate.

296

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

297

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

298

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

299

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

300

},

301

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

302

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

303

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

304

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

305

},

306

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

307

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

308

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

309

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

310

},

311

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

312

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

313

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

314

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

315

},

316

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

317

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

318

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

319

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

320

},

321

},

322

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

323

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

324

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

325

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

326

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

327

},

John Asmuth

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

[diff] [blame]

328

},

John Asmuth

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

[diff] [blame]

329

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

330

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

331

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

332

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

333

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

334

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

335

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

336

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

337

},

338

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

339

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

340

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

341

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

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>

347

<pre>Retrieves the next page of results.

348

349

Args:

350

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

351

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

352

353

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

354

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

John Asmuth

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

[diff] [blame]

355

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]

360

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

361

<pre>Updates an existing resource.

John Asmuth

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

[diff] [blame]

362

363

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

364

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. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. (required) (repeated)

Dan O'Meara

dd49464

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

[diff] [blame]

365

body: object, The request body.

John Asmuth

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

[diff] [blame]

366

The object takes the form of:

367

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

368

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

369

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

370

"hints": [ # Additional experimental branding properties.

371

{ # A pair Property / Value.

372

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

373

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

374

},

375

],

376

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

377

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

"localized": [

{

"value": "A String",

"language": "A String",

382

},

383

],

384

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

385

"value": "A String",

386

},

387

"default": "A String",

388

},

389

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

390

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

"localized": [

{

"value": "A String",

"language": "A String",

395

},

396

],

397

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

398

"value": "A String",

399

},

400

"default": "A String",

401

},

402

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

403

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

404

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

405

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

"localized": [

{

"value": "A String",

"language": "A String",

410

},

411

],

412

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

413

"value": "A String",

414

},

415

"default": "A String",

416

},

417

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

418

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

419

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

420

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

421

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

422

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

423

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

"localized": [

{

"value": "A String",

"language": "A String",

428

},

429

],

430

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

431

"value": "A String",

432

},

433

"default": "A String",

434

},

435

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

436

"watchIconImageUrl": "A String",

437

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

438

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

439

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

"localized": [

{

"value": "A String",

"language": "A String",

444

},

445

],

446

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

447

"value": "A String",

448

},

449

"default": "A String",

450

},

451

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

452

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

453

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

454

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

455

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

456

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

457

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

458

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

459

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

"A String",

473

],

474

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

475

"defaultLanguage": "A String",

476

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

477

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

478

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

479

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

480

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

481

"A String",

482

],

483

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

484

"A String",

485

],

486

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

487

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

488

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

489

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

490

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

491

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

492

},

493

],

Bu Sun Kim

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

[diff] [blame]

494

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

495

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

496

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

497

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

498

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

499

},

500

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

501

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

502

"timeLinked": "A String", # The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 format.

503

},

504

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

505

"relatedPlaylists": {

506

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

507

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

508

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

509

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

510

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

511

},

512

},

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

},

521

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

522

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

523

"localizations": { # Localizations for different languages

524

"a_key": { # Channel localization setting

525

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

526

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

527

},

528

},

529

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

530

"longUploadsStatus": "A String", # The long uploads status of this channel. See https://support.google.com/youtube/answer/71673 for more information.

531

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

532

"selfDeclaredMadeForKids": True or False,

533

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

534

"madeForKids": True or False,

535

},

536

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

537

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

538

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

539

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

540

},

541

"publishedAt": "A String", # The date and time that the channel was created. The value is specified in < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601 format.

542

"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. 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. 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. Thumbnail images might be empty for newly created channels and might take up to one day to populate.

543

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

544

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

545

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

546

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

547

},

548

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

549

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

550

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

551

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

552

},

553

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

554

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

555

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

556

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

557

},

558

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

559

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

560

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

561

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

562

},

563

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

564

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

565

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

566

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

567

},

568

},

569

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

570

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

571

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

572

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

573

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

574

},

Bu Sun Kim

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

[diff] [blame]

575

}

576

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

577

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.

Bu Sun Kim

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

[diff] [blame]

578

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

585

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

586

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

587

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

588

"hints": [ # Additional experimental branding properties.

589

{ # A pair Property / Value.

590

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

591

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

592

},

593

],

594

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

595

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

"localized": [

{

"value": "A String",

"language": "A String",

600

},

601

],

602

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

603

"value": "A String",

604

},

605

"default": "A String",

606

},

607

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

608

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

"localized": [

{

"value": "A String",

"language": "A String",

613

},

614

],

615

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

616

"value": "A String",

617

},

618

"default": "A String",

619

},

620

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

621

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

622

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

623

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

"localized": [

{

"value": "A String",

"language": "A String",

628

},

629

],

630

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

631

"value": "A String",

632

},

633

"default": "A String",

634

},

635

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

636

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

637

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

638

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

639

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

640

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

641

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

"localized": [

{

"value": "A String",

"language": "A String",

646

},

647

],

648

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

649

"value": "A String",

650

},

651

"default": "A String",

652

},

653

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

654

"watchIconImageUrl": "A String",

655

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

656

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

657

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

"localized": [

{

"value": "A String",

"language": "A String",

662

},

663

],

664

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

665

"value": "A String",

666

},

667

"default": "A String",

668

},

669

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

670

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

671

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

672

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

673

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

674

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

675

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

676

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

677

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

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

687

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

688

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

689

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

690

"A String",

691

],

692

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

693

"defaultLanguage": "A String",

694

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

695

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

696

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

697

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

698

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

699

"A String",

700

],

701

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

702

"A String",

703

],

704

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

705

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

706

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

707

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

708

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

709

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

710

},

711

],

Bu Sun Kim

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

[diff] [blame]

712

},

Yoshi Automation Bot