2023-01-14 06:01:24 -05:00
|
|
|
# Object types used across the API
|
|
|
|
|
|
|
|
|
|
|
|
### ImageObject
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
{
|
|
|
|
"url": String,
|
|
|
|
"width": Number, // Integer
|
|
|
|
"height": Number // Integer
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### ThumbnailObject
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
{
|
|
|
|
"quality": String,
|
|
|
|
"url": String,
|
|
|
|
"width": Number, // Integer
|
|
|
|
"height": Number // Integer
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### VideoObject
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
{
|
|
|
|
"type": "video", // Constant
|
|
|
|
|
|
|
|
"title": String,
|
|
|
|
"videoId": String,
|
|
|
|
|
|
|
|
"author": String,
|
|
|
|
"authorId": String,
|
|
|
|
"authorUrl": String,
|
2023-02-10 17:49:20 -05:00
|
|
|
"authorVerified": Boolean,
|
2023-01-14 06:01:24 -05:00
|
|
|
|
|
|
|
"videoThumbnails": [
|
|
|
|
// One or more ThumbnailObject
|
|
|
|
],
|
|
|
|
|
|
|
|
"description": String,
|
|
|
|
"descriptionHtml": String,
|
|
|
|
|
|
|
|
"viewCount": Number, // Integer
|
2023-05-21 15:56:46 -04:00
|
|
|
"viewCountText": String,
|
2023-01-14 06:01:24 -05:00
|
|
|
"lengthSeconds": Number, // Integer
|
|
|
|
|
|
|
|
"published": Number, // Unix timestamp
|
|
|
|
"publishedText": String,
|
|
|
|
|
|
|
|
// Only available on premiered videos
|
|
|
|
"premiereTimestamp": Number, // Unix timestamp
|
|
|
|
|
|
|
|
"liveNow": Boolean,
|
|
|
|
"premium": Boolean,
|
|
|
|
"isUpcoming": Boolean
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### ChannelObject
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
{
|
|
|
|
"type": "channel", // Constant
|
|
|
|
|
|
|
|
"author": String,
|
|
|
|
"authorId": String,
|
|
|
|
"authorUrl": String,
|
|
|
|
"authorVerified": Boolean,
|
|
|
|
"authorThumbnails": [
|
|
|
|
// One or more ThumbnailObject
|
|
|
|
],
|
|
|
|
|
|
|
|
"autoGenerated": Boolean,
|
|
|
|
"subCount": Number, // Integer
|
|
|
|
"videoCount": Number, // Integer
|
|
|
|
|
|
|
|
"description": String,
|
|
|
|
"descriptionHtml": String,
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
|
2023-05-21 15:56:46 -04:00
|
|
|
### PlaylistObject
|
2023-01-14 06:01:24 -05:00
|
|
|
|
|
|
|
```javascript
|
|
|
|
{
|
|
|
|
"type": "playlist", // Constant
|
|
|
|
|
|
|
|
"title": String,
|
|
|
|
"playlistId": String,
|
|
|
|
"playlistThumbnail": String,
|
|
|
|
|
|
|
|
"author": String,
|
|
|
|
"authorId": String,
|
|
|
|
"authorUrl": String,
|
|
|
|
"authorVerified": Boolean,
|
|
|
|
|
|
|
|
"videoCount": Number, // Integer
|
|
|
|
"videos": [
|
|
|
|
{
|
|
|
|
"title": String,
|
|
|
|
"videoId": String,
|
|
|
|
"lengthSeconds": Number, // Integer
|
|
|
|
"videoThumbnails": [
|
|
|
|
// One or more ThumbnailObject
|
|
|
|
]
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|