इस पेज पर, आपको एक ऐसा ऐप्लिकेशन बनाने का तरीका बताया गया है जो उपयोगकर्ता के YouTube वीडियो देखने के आंकड़ों को चार्ट में दिखाने के लिए, कई अलग-अलग एपीआई का इस्तेमाल करता है. ऐप्लिकेशन ये काम करता है:
- यह YouTube Data API का इस्तेमाल करके, पुष्टि किए गए उपयोगकर्ता के अपलोड किए गए वीडियो की सूची हासिल करता है. इसके बाद, वीडियो के टाइटल की सूची दिखाता है.
- जब कोई उपयोगकर्ता किसी वीडियो पर क्लिक करता है, तो ऐप्लिकेशन उस वीडियो का आंकड़े वाला डेटा पाने के लिए, YouTube Analytics API को कॉल करता है.
- ऐप्लिकेशन, आंकड़ों के डेटा को चार्ट में दिखाने के लिए, Google Visualization API का इस्तेमाल करता है.
यहां ऐप्लिकेशन बनाने की प्रोसेस के बारे में बताया गया है. पहले चरण में, ऐप्लिकेशन की एचटीएमएल और सीएसएस फ़ाइलें बनाई जाती हैं. दूसरे से लेकर पांचवें चरण में, JavaScript के उन अलग-अलग हिस्सों के बारे में बताया गया है जिनका इस्तेमाल ऐप्लिकेशन करता है. दस्तावेज़ के आखिर में पूरा सैंपल कोड भी शामिल किया गया है.
- पहला चरण: अपना एचटीएमएल पेज और सीएसएस फ़ाइल बनाना
- दूसरा चरण: OAuth 2.0 से पुष्टि करने की सुविधा चालू करना
- तीसरा चरण: फ़िलहाल लॉग इन किए हुए उपयोगकर्ता का डेटा वापस पाना
- चौथा चरण: किसी वीडियो के लिए Analytics डेटा का अनुरोध करना
- पांचवां चरण: चार्ट में Analytics का डेटा दिखाना
अहम जानकारी: अपने ऐप्लिकेशन के लिए OAuth 2.0 क्लाइंट आईडी पाने के लिए, आपको अपने ऐप्लिकेशन को Google के साथ रजिस्टर करना होगा.
पहला चरण: अपना एचटीएमएल पेज और सीएसएस फ़ाइल बनाना
इस चरण में, आपको एक एचटीएमएल पेज बनाना होगा. यह पेज, उन JavaScript लाइब्रेरी को लोड करेगा जिनका इस्तेमाल ऐप्लिकेशन करेगा. यहां दिया गया एचटीएमएल, पेज का कोड दिखाता है:
<!doctype html>
<html>
<head>
<title>Google I/O YouTube Codelab</title>
<link type="text/css" rel="stylesheet" href="index.css">
<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script type="text/javascript" src="//www.google.com/jsapi"></script>
<script type="text/javascript" src="index.js"></script>
<script type="text/javascript" src="https://apis.google.com/js/client.js?onload=onJSClientLoad"></script>
</head>
<body>
<div id="login-container" class="pre-auth">This application requires access to your YouTube account.
Please <a href="#" id="login-link">authorize</a> to continue.
</div>
<div class="post-auth">
<div id="message"></div>
<div id="chart"></div>
<div>Choose a Video:</div>
<ul id="video-list"></ul>
</div>
</body>
</html>
सैंपल पेज के <head> टैग में दिखाए गए अनुसार, ऐप्लिकेशन इन लाइब्रेरी का इस्तेमाल करता है:
- jQuery, एचटीएमएल दस्तावेज़ को ट्रैवर्स करने, इवेंट को हैंडल करने, ऐनिमेशन देने, और Ajax इंटरैक्शन को आसान बनाने के लिए सहायक तरीके उपलब्ध कराता है.
- Google API लोडर (
www.google.com/jsapi) की मदद से, एक या उससे ज़्यादा Google API आसानी से इंपोर्ट किए जा सकते हैं. यह सैंपल ऐप्लिकेशन, Google Visualization API को लोड करने के लिए API लोडर का इस्तेमाल करता है. इसका इस्तेमाल, Analytics से मिले डेटा को चार्ट में दिखाने के लिए किया जाता है. - index.js लाइब्रेरी में, सैंपल ऐप्लिकेशन के लिए खास फ़ंक्शन होते हैं. इस ट्यूटोरियल में, फ़ंक्शन बनाने का तरीका बताया गया है.
- JavaScript के लिए Google APIs क्लाइंट लाइब्रेरी की मदद से, OAuth 2.0 की पुष्टि करने और YouTube Analytics API को कॉल करने की सुविधा मिलती है.
सैंपल ऐप्लिकेशन में index.css फ़ाइल भी शामिल होती है. यहां एक सैंपल सीएसएस फ़ाइल दी गई है. इसे एचटीएमएल पेज की डायरेक्ट्री में सेव किया जा सकता है:
body {
font-family: Helvetica, sans-serif;
}
.pre-auth {
display: none;
}
.post-auth {
display: none;
}
#chart {
width: 500px;
height: 300px;
margin-bottom: 1em;
}
#video-list {
padding-left: 1em;
list-style-type: none;
}
#video-list > li {
cursor: pointer;
}
#video-list > li:hover {
color: blue;
}
दूसरा चरण: OAuth 2.0 ऑथेंटिकेशन की सुविधा चालू करना
इस चरण में, आपको index.js फ़ाइल बनानी होगी. इसे आपके एचटीएमएल पेज से कॉल किया जा रहा है. इस बात को ध्यान में रखते हुए, अपने एचटीएमएल पेज की डायरेक्ट्री में index.js नाम की फ़ाइल बनाएं और उस फ़ाइल में यह कोड डालें. YOUR_CLIENT_ID स्ट्रिंग को अपने रजिस्टर किए गए ऐप्लिकेशन के क्लाइंट आईडी से बदलें.
(function() {
// Retrieve your client ID from the Google API Console at
// https://console.cloud.google.com/.
var OAUTH2_CLIENT_ID = 'YOUR_CLIENT_ID';
var OAUTH2_SCOPES = [
'https://www.googleapis.com/auth/yt-analytics.readonly',
'https://www.googleapis.com/auth/youtube.readonly'
];
// Upon loading, the Google APIs JS client automatically invokes this callback.
// See https://developers.google.com/api-client-library/javascript/features/authentication
window.onJSClientLoad = function() {
gapi.auth.init(function() {
window.setTimeout(checkAuth, 1);
});
};
// Attempt the immediate OAuth 2.0 client flow as soon as the page loads.
// If the currently logged-in Google Account has previously authorized
// the client specified as the OAUTH2_CLIENT_ID, then the authorization
// succeeds with no user intervention. Otherwise, it fails and the
// user interface that prompts for authorization needs to display.
function checkAuth() {
gapi.auth.authorize({
client_id: OAUTH2_CLIENT_ID,
scope: OAUTH2_SCOPES,
immediate: true
}, handleAuthResult);
}
// Handle the result of a gapi.auth.authorize() call.
function handleAuthResult(authResult) {
if (authResult) {
// Authorization was successful. Hide authorization prompts and show
// content that should be visible after authorization succeeds.
$('.pre-auth').hide();
$('.post-auth').show();
loadAPIClientInterfaces();
} else {
// Authorization was unsuccessful. Show content related to prompting for
// authorization and hide content that should be visible if authorization
// succeeds.
$('.post-auth').hide();
$('.pre-auth').show();
// Make the #login-link clickable. Attempt a non-immediate OAuth 2.0
// client flow. The current function is called when that flow completes.
$('#login-link').click(function() {
gapi.auth.authorize({
client_id: OAUTH2_CLIENT_ID,
scope: OAUTH2_SCOPES,
immediate: false
}, handleAuthResult);
});
}
}
// This helper method displays a message on the page.
function displayMessage(message) {
$('#message').text(message).show();
}
// This helper method hides a previously displayed message on the page.
function hideMessage() {
$('#message').hide();
}
/* In later steps, add additional functions above this line. */
})();
तीसरा चरण: फ़िलहाल लॉग इन किए हुए उपयोगकर्ता का डेटा वापस पाना
इस चरण में, आपको अपनी index.js फ़ाइल में एक फ़ंक्शन जोड़ना होगा. यह फ़ंक्शन, YouTube Data API (v2.0) का इस्तेमाल करके, फ़िलहाल लॉग इन किए हुए उपयोगकर्ता के अपलोड किए गए वीडियो फ़ीड को वापस लाएगा. उस फ़ीड में, उपयोगकर्ता का YouTube चैनल आईडी दिखेगा. YouTube Analytics API को कॉल करते समय, आपको इसकी ज़रूरत होगी. इसके अलावा, सैंपल ऐप्लिकेशन में उपयोगकर्ता के अपलोड किए गए वीडियो की सूची दिखेगी, ताकि उपयोगकर्ता किसी भी वीडियो का Analytics डेटा ऐक्सेस कर सके.
अपनी index.js फ़ाइल में ये बदलाव करें:
-
ऐसा फ़ंक्शन जोड़ें जो YouTube Analytics और Data API के लिए क्लाइंट इंटरफ़ेस लोड करता हो. Google APIs JavaScript क्लाइंट का इस्तेमाल करने के लिए, यह ज़रूरी है.
दोनों एपीआई क्लाइंट इंटरफ़ेस लोड होने के बाद, फ़ंक्शन
getUserChannelफ़ंक्शन को कॉल करता है.// Load the client interfaces for the YouTube Analytics and Data APIs, which // are required to use the Google APIs JS client. More info is available at // https://developers.google.com/api-client-library/javascript/dev/dev_jscript#loading-the-client-library-and-the-api function loadAPIClientInterfaces() { gapi.client.load('youtube', 'v3', function() { gapi.client.load('youtubeAnalytics', 'v1', function() { // After both client interfaces load, use the Data API to request // information about the authenticated user's channel. getUserChannel(); }); }); } -
channelIdवैरिएबल के साथ-साथgetUserChannelफ़ंक्शन जोड़ें. यह फ़ंक्शन, YouTube Data API (v3) को कॉल करता है और इसमेंmineपैरामीटर शामिल होता है. इससे पता चलता है कि अनुरोध, पुष्टि किए गए मौजूदा उपयोगकर्ता के चैनल की जानकारी के लिए है.channelIdको Analytics API को भेजा जाएगा, ताकि उस चैनल की पहचान की जा सके जिसके लिए Analytics का डेटा वापस पाया जा रहा है.// Keep track of the currently authenticated user's YouTube channel ID. var channelId; // Call the Data API to retrieve information about the currently // authenticated user's YouTube channel. function getUserChannel() { // Also see: https://developers.google.com/youtube/v3/docs/channels/list var request = gapi.client.youtube.channels.list({ // Setting the "mine" request parameter's value to "true" indicates that // you want to retrieve the currently authenticated user's channel. mine: true, part: 'id,contentDetails' }); request.execute(function(response) { if ('error' in response) { displayMessage(response.error.message); } else { // We need the channel's channel ID to make calls to the Analytics API. // The channel ID value has the form "UCdLFeWKpkLhkguiMZUp8lWA". channelId = response.items[0].id; // Retrieve the playlist ID that uniquely identifies the playlist of // videos uploaded to the authenticated user's channel. This value has // the form "UUdLFeWKpkLhkguiMZUp8lWA". var uploadsListId = response.items[0].contentDetails.relatedPlaylists.uploads; // Use the playlist ID to retrieve the list of uploaded videos. getPlaylistItems(uploadsListId); } }); } -
getPlaylistItemsफ़ंक्शन जोड़ें, जो किसी प्लेलिस्ट में मौजूद आइटम को वापस लाता है. इस मामले में, प्लेलिस्ट में उपयोगकर्ता के चैनल पर अपलोड किए गए वीडियो की सूची होती है. (ध्यान दें कि नीचे दिया गया सैंपल फ़ंक्शन, उस फ़ीड में सिर्फ़ पहले 50 आइटम को फ़ेच करता है. ज़्यादा आइटम फ़ेच करने के लिए, आपको पेजेशन लागू करना होगा.)प्लेलिस्ट आइटम की सूची वापस पाने के बाद, फ़ंक्शन
getVideoMetadata()फ़ंक्शन को कॉल करता है. इसके बाद, यह फ़ंक्शन सूची में मौजूद हर वीडियो का मेटाडेटा हासिल करता है और हर वीडियो को उस सूची में जोड़ देता है जो उपयोगकर्ता को दिखती है.// Call the Data API to retrieve the items in a particular playlist. In this // example, we are retrieving a playlist of the currently authenticated user's // uploaded videos. By default, the list returns the most recent videos first. function getPlaylistItems(listId) { // See https://developers.google.com/youtube/v3/docs/playlistitems/list var request = gapi.client.youtube.playlistItems.list({ playlistId: listId, part: 'snippet' }); request.execute(function(response) { if ('error' in response) { displayMessage(response.error.message); } else { if ('items' in response) { // The jQuery.map() function iterates through all of the items in // the response and creates a new array that only contains the // specific property we're looking for: videoId. var videoIds = $.map(response.items, function(item) { return item.snippet.resourceId.videoId; }); // Now that we know the IDs of all the videos in the uploads list, // we can retrieve information about each video. getVideoMetadata(videoIds); } else { displayMessage('There are no videos in your channel.'); } } }); } // Given an array of video IDs, this function obtains metadata about each // video and then uses that metadata to display a list of videos. function getVideoMetadata(videoIds) { // https://developers.google.com/youtube/v3/docs/videos/list var request = gapi.client.youtube.videos.list({ // The 'id' property's value is a comma-separated string of video IDs. id: videoIds.join(','), part: 'id,snippet,statistics' }); request.execute(function(response) { if ('error' in response) { displayMessage(response.error.message); } else { // Get the jQuery wrapper for the #video-list element before starting // the loop. var videoList = $('#video-list'); $.each(response.items, function() { // Exclude videos that do not have any views, since those videos // will not have any interesting viewcount Analytics data. if (this.statistics.viewCount == 0) { return; } var title = this.snippet.title; var videoId = this.id; // Create a new <li> element that contains an <a> element. // Set the <a> element's text content to the video's title, and // add a click handler that will display Analytics data when invoked. var liElement = $('<li>'); var aElement = $('<a>'); // Setting the href value to '#' ensures that the browser renders the // <a> element as a clickable link. aElement.attr('href', '#'); aElement.text(title); aElement.click(function() { displayVideoAnalytics(videoId); }); // Call the jQuery.append() method to add the new <a> element to // the <li> element, and the <li> element to the parent // list, which is identified by the 'videoList' variable. liElement.append(aElement); videoList.append(liElement); }); if (videoList.children().length == 0) { // Display a message if the channel does not have any viewed videos. displayMessage('Your channel does not have any videos that have been viewed.'); } } }); }
चौथा चरण: किसी वीडियो के लिए Analytics डेटा का अनुरोध करना
इस चरण में, आपको सैंपल ऐप्लिकेशन में बदलाव करना होगा, ताकि किसी वीडियो के टाइटल पर क्लिक करने पर, ऐप्लिकेशन उस वीडियो का Analytics डेटा पाने के लिए, YouTube Analytics API को कॉल कर सके. ऐसा करने के लिए, सैंपल ऐप्लिकेशन में ये बदलाव करें:
-
ऐसा वैरिएबल जोड़ें जो वापस लाए गए Analytics रिपोर्ट डेटा के लिए, तारीख की डिफ़ॉल्ट सीमा तय करता हो.
var ONE_MONTH_IN_MILLISECONDS = 1000 * 60 * 60 * 24 * 30;
-
ऐसा कोड जोड़ें जो तारीख वाले ऑब्जेक्ट के लिए
YYYY-MM-DDस्ट्रिंग बनाता हो और तारीखों में दिन और महीने की संख्या को दो अंकों तक पैड करता हो:// This boilerplate code takes a Date object and returns a YYYY-MM-DD string. function formatDateString(date) { var yyyy = date.getFullYear().toString(); var mm = padToTwoCharacters(date.getMonth() + 1); var dd = padToTwoCharacters(date.getDate()); return yyyy + '-' + mm + '-' + dd; } // If number is a single digit, prepend a '0'. Otherwise, return the number // as a string. function padToTwoCharacters(number) { if (number < 10) { return '0' + number; } else { return number.toString(); } } -
displayVideoAnalyticsफ़ंक्शन तय करें. यह फ़ंक्शन, किसी वीडियो के लिए YouTube Analytics का डेटा वापस लाता है. यह फ़ंक्शन तब लागू होगा, जब उपयोगकर्ता सूची में मौजूद किसी वीडियो पर क्लिक करेगा.getVideoMetadataफ़ंक्शन, वीडियो की सूची को प्रिंट करता है. इसे तीसरे चरण में तय किया गया था. यह क्लिक इवेंट हैंडलर तय करता है.// This function requests YouTube Analytics data for a video and displays // the results in a chart. function displayVideoAnalytics(videoId) { if (channelId) { // To use a different date range, modify the ONE_MONTH_IN_MILLISECONDS // variable to a different millisecond delta as desired. var today = new Date(); var lastMonth = new Date(today.getTime() - ONE_MONTH_IN_MILLISECONDS); var request = gapi.client.youtubeAnalytics.reports.query({ // The start-date and end-date parameters must be YYYY-MM-DD strings. 'start-date': formatDateString(lastMonth), 'end-date': formatDateString(today), // At this time, you need to explicitly specify channel==channelId. // See https://developers.google.com/youtube/analytics/v1/#ids ids: 'channel==' + channelId, dimensions: 'day', sort: 'day', // See https://developers.google.com/youtube/analytics/v1/available_reports // for details about the different filters and metrics you can request // if the "dimensions" parameter value is "day". metrics: 'views', filters: 'video==' + videoId }); request.execute(function(response) { // This function is called regardless of whether the request succeeds. // The response contains YouTube Analytics data or an error message. if ('error' in response) { displayMessage(response.error.message); } else { displayChart(videoId, response); } }); } else { // The currently authenticated user's channel ID is not available. displayMessage('The YouTube channel ID for the current user is not available.'); } }metrics,dimensions, औरfiltersपैरामीटर के लिए, मान्य वैल्यू के कॉम्बिनेशन और वापस पाया जा सकने वाले डेटा के बारे में ज़्यादा जानने के लिए, एपीआई दस्तावेज़ का उपलब्ध रिपोर्ट पेज देखें.
पांचवां चरण: Analytics का डेटा चार्ट में दिखाना
इस चरण में, आपको displayChart फ़ंक्शन जोड़ना होगा. यह फ़ंक्शन, YouTube Analytics का डेटा Google Visualization API को भेजता है. इसके बाद, वह एपीआई जानकारी को चार्ट में दिखाता है.
-
Google Visualization API लोड करें. इससे आपका डेटा चार्ट में दिखेगा. चार्ट बनाने के विकल्पों के बारे में ज़्यादा जानने के लिए, Visualization API का दस्तावेज़ देखें.
google.load('visualization', '1.0', {'packages': ['corechart']}); -
displayChartनाम का एक नया फ़ंक्शन तय करें. यह फ़ंक्शन, Analytics का डेटा दिखाने वाला चार्ट डाइनैमिक तौर पर जनरेट करने के लिए, Google Visualization API का इस्तेमाल करता है.// Call the Google Chart Tools API to generate a chart of Analytics data. function displayChart(videoId, response) { if ('rows' in response) { hideMessage(); // The columnHeaders property contains an array of objects representing // each column's title -- e.g.: [{name:"day"},{name:"views"}] // We need these column titles as a simple array, so we call jQuery.map() // to get each element's "name" property and create a new array that only // contains those values. var columns = $.map(response.columnHeaders, function(item) { return item.name; }); // The google.visualization.arrayToDataTable() function wants an array // of arrays. The first element is an array of column titles, calculated // above as "columns". The remaining elements are arrays that each // represent a row of data. Fortunately, response.rows is already in // this format, so it can just be concatenated. // See https://developers.google.com/chart/interactive/docs/datatables_dataviews#arraytodatatable var chartDataArray = [columns].concat(response.rows); var chartDataTable = google.visualization.arrayToDataTable(chartDataArray); var chart = new google.visualization.LineChart(document.getElementById('chart')); chart.draw(chartDataTable, { // Additional options can be set if desired as described at: // https://developers.google.com/chart/interactive/docs/reference#visdraw title: 'Views per Day of Video ' + videoId }); } else { displayMessage('No data available for video ' + videoId); } }
पूरी index.js फ़ाइल देखना
नीचे दी गई index.js फ़ाइल में, ऊपर बताए गए सभी बदलाव शामिल हैं. फिर से याद रखें कि आपको YOUR_CLIENT_ID स्ट्रिंग को अपने रजिस्टर किए गए ऐप्लिकेशन के क्लाइंट आईडी से बदलना होगा.
(function() {
// Retrieve your client ID from the Google API Console at
// https://console.cloud.google.com/.
var OAUTH2_CLIENT_ID = 'YOUR_CLIENT_ID';
var OAUTH2_SCOPES = [
'https://www.googleapis.com/auth/yt-analytics.readonly',
'https://www.googleapis.com/auth/youtube.readonly'
];
var ONE_MONTH_IN_MILLISECONDS = 1000 * 60 * 60 * 24 * 30;
// Keep track of the currently authenticated user's YouTube channel ID.
var channelId;
// For information about the Google Chart Tools API, see:
// https://developers.google.com/chart/interactive/docs/quick_start
google.load('visualization', '1.0', {'packages': ['corechart']});
// Upon loading, the Google APIs JS client automatically invokes this callback.
// See https://developers.google.com/api-client-library/javascript/features/authentication
window.onJSClientLoad = function() {
gapi.auth.init(function() {
window.setTimeout(checkAuth, 1);
});
};
// Attempt the immediate OAuth 2.0 client flow as soon as the page loads.
// If the currently logged-in Google Account has previously authorized
// the client specified as the OAUTH2_CLIENT_ID, then the authorization
// succeeds with no user intervention. Otherwise, it fails and the
// user interface that prompts for authorization needs to display.
function checkAuth() {
gapi.auth.authorize({
client_id: OAUTH2_CLIENT_ID,
scope: OAUTH2_SCOPES,
immediate: true
}, handleAuthResult);
}
// Handle the result of a gapi.auth.authorize() call.
function handleAuthResult(authResult) {
if (authResult) {
// Authorization was successful. Hide authorization prompts and show
// content that should be visible after authorization succeeds.
$('.pre-auth').hide();
$('.post-auth').show();
loadAPIClientInterfaces();
} else {
// Authorization was unsuccessful. Show content related to prompting for
// authorization and hide content that should be visible if authorization
// succeeds.
$('.post-auth').hide();
$('.pre-auth').show();
// Make the #login-link clickable. Attempt a non-immediate OAuth 2.0
// client flow. The current function is called when that flow completes.
$('#login-link').click(function() {
gapi.auth.authorize({
client_id: OAUTH2_CLIENT_ID,
scope: OAUTH2_SCOPES,
immediate: false
}, handleAuthResult);
});
}
}
// Load the client interfaces for the YouTube Analytics and Data APIs, which
// are required to use the Google APIs JS client. More info is available at
// https://developers.google.com/api-client-library/javascript/dev/dev_jscript#loading-the-client-library-and-the-api
function loadAPIClientInterfaces() {
gapi.client.load('youtube', 'v3', function() {
gapi.client.load('youtubeAnalytics', 'v1', function() {
// After both client interfaces load, use the Data API to request
// information about the authenticated user's channel.
getUserChannel();
});
});
}
// Call the Data API to retrieve information about the currently
// authenticated user's YouTube channel.
function getUserChannel() {
// Also see: https://developers.google.com/youtube/v3/docs/channels/list
var request = gapi.client.youtube.channels.list({
// Setting the "mine" request parameter's value to "true" indicates that
// you want to retrieve the currently authenticated user's channel.
mine: true,
part: 'id,contentDetails'
});
request.execute(function(response) {
if ('error' in response) {
displayMessage(response.error.message);
} else {
// We need the channel's channel ID to make calls to the Analytics API.
// The channel ID value has the form "UCdLFeWKpkLhkguiMZUp8lWA".
channelId = response.items[0].id;
// Retrieve the playlist ID that uniquely identifies the playlist of
// videos uploaded to the authenticated user's channel. This value has
// the form "UUdLFeWKpkLhkguiMZUp8lWA".
var uploadsListId = response.items[0].contentDetails.relatedPlaylists.uploads;
// Use the playlist ID to retrieve the list of uploaded videos.
getPlaylistItems(uploadsListId);
}
});
}
// Call the Data API to retrieve the items in a particular playlist. In this
// example, we are retrieving a playlist of the currently authenticated user's
// uploaded videos. By default, the list returns the most recent videos first.
function getPlaylistItems(listId) {
// See https://developers.google.com/youtube/v3/docs/playlistitems/list
var request = gapi.client.youtube.playlistItems.list({
playlistId: listId,
part: 'snippet'
});
request.execute(function(response) {
if ('error' in response) {
displayMessage(response.error.message);
} else {
if ('items' in response) {
// The jQuery.map() function iterates through all of the items in
// the response and creates a new array that only contains the
// specific property we're looking for: videoId.
var videoIds = $.map(response.items, function(item) {
return item.snippet.resourceId.videoId;
});
// Now that we know the IDs of all the videos in the uploads list,
// we can retrieve information about each video.
getVideoMetadata(videoIds);
} else {
displayMessage('There are no videos in your channel.');
}
}
});
}
// Given an array of video IDs, this function obtains metadata about each
// video and then uses that metadata to display a list of videos.
function getVideoMetadata(videoIds) {
// https://developers.google.com/youtube/v3/docs/videos/list
var request = gapi.client.youtube.videos.list({
// The 'id' property's value is a comma-separated string of video IDs.
id: videoIds.join(','),
part: 'id,snippet,statistics'
});
request.execute(function(response) {
if ('error' in response) {
displayMessage(response.error.message);
} else {
// Get the jQuery wrapper for the #video-list element before starting
// the loop.
var videoList = $('#video-list');
$.each(response.items, function() {
// Exclude videos that do not have any views, since those videos
// will not have any interesting viewcount Analytics data.
if (this.statistics.viewCount == 0) {
return;
}
var title = this.snippet.title;
var videoId = this.id;
// Create a new <li> element that contains an <a> element.
// Set the <a> element's text content to the video's title, and
// add a click handler that will display Analytics data when invoked.
var liElement = $('<li>');
var aElement = $('<a>');
// Setting the href value to '#' ensures that the browser renders the
// <a> element as a clickable link.
aElement.attr('href', '#');
aElement.text(title);
aElement.click(function() {
displayVideoAnalytics(videoId);
});
// Call the jQuery.append() method to add the new <a> element to
// the <li> element, and the <li> element to the parent
// list, which is identified by the 'videoList' variable.
liElement.append(aElement);
videoList.append(liElement);
});
if (videoList.children().length == 0) {
// Display a message if the channel does not have any viewed videos.
displayMessage('Your channel does not have any videos that have been viewed.');
}
}
});
}
// This function requests YouTube Analytics data for a video and displays
// the results in a chart.
function displayVideoAnalytics(videoId) {
if (channelId) {
// To use a different date range, modify the ONE_MONTH_IN_MILLISECONDS
// variable to a different millisecond delta as desired.
var today = new Date();
var lastMonth = new Date(today.getTime() - ONE_MONTH_IN_MILLISECONDS);
var request = gapi.client.youtubeAnalytics.reports.query({
// The start-date and end-date parameters must be YYYY-MM-DD strings.
'start-date': formatDateString(lastMonth),
'end-date': formatDateString(today),
// At this time, you need to explicitly specify channel==channelId.
// See https://developers.google.com/youtube/analytics/v1/#ids
ids: 'channel==' + channelId,
dimensions: 'day',
sort: 'day',
// See https://developers.google.com/youtube/analytics/v1/available_reports
// for details about the different filters and metrics you can request
// if the "dimensions" parameter value is "day".
metrics: 'views',
filters: 'video==' + videoId
});
request.execute(function(response) {
// This function is called regardless of whether the request succeeds.
// The response contains YouTube Analytics data or an error message.
if ('error' in response) {
displayMessage(response.error.message);
} else {
displayChart(videoId, response);
}
});
} else {
// The currently authenticated user's channel ID is not available.
displayMessage('The YouTube channel ID for the current user is not available.');
}
}
// This boilerplate code takes a Date object and returns a YYYY-MM-DD string.
function formatDateString(date) {
var yyyy = date.getFullYear().toString();
var mm = padToTwoCharacters(date.getMonth() + 1);
var dd = padToTwoCharacters(date.getDate());
return yyyy + '-' + mm + '-' + dd;
}
// If number is a single digit, prepend a '0'. Otherwise, return the number
// as a string.
function padToTwoCharacters(number) {
if (number < 10) {
return '0' + number;
} else {
return number.toString();
}
}
// Call the Google Chart Tools API to generate a chart of Analytics data.
function displayChart(videoId, response) {
if ('rows' in response) {
hideMessage();
// The columnHeaders property contains an array of objects representing
// each column's title -- e.g.: [{name:"day"},{name:"views"}]
// We need these column titles as a simple array, so we call jQuery.map()
// to get each element's "name" property and create a new array that only
// contains those values.
var columns = $.map(response.columnHeaders, function(item) {
return item.name;
});
// The google.visualization.arrayToDataTable() function wants an array
// of arrays. The first element is an array of column titles, calculated
// above as "columns". The remaining elements are arrays that each
// represent a row of data. Fortunately, response.rows is already in
// this format, so it can just be concatenated.
// See https://developers.google.com/chart/interactive/docs/datatables_dataviews#arraytodatatable
var chartDataArray = [columns].concat(response.rows);
var chartDataTable = google.visualization.arrayToDataTable(chartDataArray);
var chart = new google.visualization.LineChart(document.getElementById('chart'));
chart.draw(chartDataTable, {
// Additional options can be set if desired as described at:
// https://developers.google.com/chart/interactive/docs/reference#visdraw
title: 'Views per Day of Video ' + videoId
});
} else {
displayMessage('No data available for video ' + videoId);
}
}
// This helper method displays a message on the page.
function displayMessage(message) {
$('#message').text(message).show();
}
// This helper method hides a previously displayed message on the page.
function hideMessage() {
$('#message').hide();
}
})();