Skip to content

Latest commit

 

History

History
185 lines (153 loc) · 5.41 KB

APIv2-3_Reference.md

File metadata and controls

185 lines (153 loc) · 5.41 KB
Raw

#APIv2 to APIv3 Reference Notes

Notes to reference for the conversion for a better understanding on what has changed for myself and others.

Youtube-TV Elements Chart

Currently used elements in ytv.js and their new APIv3 counterparts.

User (channel) Playlists

playlists = res.feed.entry
res.feed.items

playlists[i]

Element Old Value New Value
title .title.$t .snippet.title
plid .yt$playlistId.$t .id
thumb .media$group.media$thumbnail[1].url .snippet.thumbnails.medium.url

User (channel) Info

user = userInfo.entry
userInfo.items[0]
Element Old Value New Value
title .title.$t .snippet.title
url .yt$username.$t .id
thumb .media$thumbnail.url .snippet.thumbnails.default.url
summary .summary.$t .snippet.description
subscribers .yt$statistics.subscriberCount .statistics.subscriberCount
views .yt$statistics.totalUploadViews .statistics.viewCount
NEW - -
uploads n/a .contentDetails.relatedPlaylists.uploads

To support newer accounts by using channel ID instead of user ID.
Old: url: local+'//youtube.com/user/'+userInfo.entry.yt$username.$t
New: url: 'https://youtube.com/channel/'+userInfo.id

NEW Playlist Videos

playlistVideos = n/a
res.feed.items

plistlistVideos[i]

Element Old Value New Value
slug n/a .contentDetails.videoId

Video Info

videos = data.feed.entry
data.feed.items

videos[i]

Element Old Value New Value
title .title.$t .snippet.title
*slug .media$group.yt$videoid.$t .id
link .link[0].href n/a *use slug
published .published.$t .snippet.publishedAt
rating .yt$rating n/a *see statistics
stats .yt$statistics .statistics
duration ( .media$group.yt$duration.seconds) .contentDetails.duration
thumb .media$group.media$thumbnail[1].url .snippet.thumbnails.medium.url
NEW - -
embed n/a .status.embeddable

Updated URLs

base

base = local+'//gdata.youtube.com/'
'https://www.googleapis.com/youtube/v3/'
  • https required for APIv3

userInfo

Before:  
utils.endpoints.base+'feeds/api/users/'+settings.user+'?v=2&alt=json';
After:  
utils.endpoints.base+'channels?'+settings.cid+'&key='+apiKey+'&part=snippet,contentDetails,statistics';

Required in Build

if (settings.channelId){
    settings.cid = 'id='+settings.channelId;
} else if(settings.user){
    settings.cid = 'forUsername='+settings.user;
}

userVids

Before:  
utils.endpoints.base+'feeds/api/users/'+settings.user+'/uploads/?v=2&alt=json&format=5&max-results=50';
After:  n/a pulled playlistId pulled from userInfo

Replaced with:

userUploads: function(userInfo){
    if (userInfo && userInfo.items){
        settings.playlist = userInfo.items[0].contentDetails.relatedPlaylists.uploads;
        utils.ajax.get( utils.endpoints.playlistVids(), prepare.compileVideos );
    }
}

userPlaylists

Before:  
utils.endpoints.base+'feeds/api/users/'+settings.user+'/playlists/?v=2&alt=json&format=5&max-results=50';
After:  
utils.endpoints.base+'playlists?channelId='+settings.channelId+'&key='+apiKey+'&maxResults=50&part=snippet';

playlistVids

Before:  
utils.endpoints.base+'feeds/api/playlists/'+(settings.playlist)+'?v=2&alt=json&format=5&max-results=50';
After:  
utils.endpoints.base+'playlistItems?playlistId='+settings.playlist+'&key='+apiKey+'&maxResults=50&part=contentDetails';

NEW playlistInfo

utils.endpoints.base+'playlists?id='+settings.playlist+'&key='+apiKey+'&maxResults=50&part=snippet';

selectedPlaylist: function(playlistInfo){
    if (playlistInfo && playlistInfo.items) {
        settings.currentPlaylist = playlistInfo.items[0].snippet.title;
        utils.ajax.get( utils.endpoints.playlistVids(), prepare.compileVideos );
    }
}

NEW videoInfo

utils.endpoints.base+'videos?id='+settings.videoString+'&key='+apiKey+'&maxResults=50&part=snippet,contentDetails,status,statistics';

compileVideos: function(res){
    if (res && res.items){
        var playlists = res.items,
        i;
        settings.videoString = '';
        for(i=0; i<playlists.length; i++){
            settings.videoString += playlists[i].contentDetails.videoId;
            if (i<playlists.length-1){ settings.videoString += ',';}
        }
        utils.ajax.get( utils.endpoints.videoInfo(), prepare.compileList );
    }
}

Parsing the new time format - Reference

function parseDuration(duration) {
    var matches = video.duration.match(/[0-9]+[HMS]/g);
    var h = 0, m = 0, s = 0, time = '';

    matches.forEach(function (part) {
        var unit = part.charAt(part.length-1);
        var amount = parseInt(part.slice(0,-1));

        switch (unit) {
            case 'H': h = (amount > 9 ? '' + amount : '0' + amount); break;
            case 'M': m = (amount > 9 ? '' + amount : '0' + amount); break;
            case 'S': s = (amount > 9 ? '' + amount : '0' + amount); break;
            default: // ??? profit
        }
    });
    if (h){ time += h+':';}
    if (m){ time += m+':';} else { time += '00:';}
    if (s){ time += s;} else { time += '00';}

    return time;
}