इस पेज पर आपको ऐसा ऐप्लिकेशन बनाने का तरीका बताया गया है जो किसी उपयोगकर्ता के YouTube वीडियो से जुड़े आंकड़े देखने के लिए, कई अलग-अलग एपीआई का इस्तेमाल करता है. ऐप्लिकेशन नीचे दिए गए टास्क करती है:
- यह उपयोगकर्ता के अपलोड किए गए मौजूदा वीडियो की सूची पाने के लिए, YouTube डेटा एपीआई का इस्तेमाल करता है. इसके बाद, वीडियो के शीर्षक की सूची दिखाता है.
- जब उपयोगकर्ता किसी खास वीडियो पर क्लिक करता है, तो ऐप्लिकेशन उस वीडियो के लिए Analytics डेटा पाने के लिए YouTube Analytics API को कॉल करता है.
- ऐप्लिकेशन, ऐनलिटिक्स डेटा को चार्ट में दिखाने के लिए, Google विज़ुअलाइज़ेशन एपीआई का इस्तेमाल करता है.
ऐप्लिकेशन बनाने की प्रक्रिया नीचे दी गई है. चरण 1 में, आप ऐप्लिकेशन की HTML और सीएसएस फ़ाइलें बनाते हैं. चरण 2 से 5, JavaScript के उन अलग-अलग हिस्सों के बारे में बताता है जिनका इस्तेमाल ऐप्लिकेशन करता है. पूरा सैंपल कोड भी दस्तावेज़ के आखिर में शामिल होता है.
- पहला चरण: अपना एचटीएमएल पेज और सीएसएस फ़ाइल बनाना
- दूसरा चरण: OAuth 2.0 की पुष्टि करना
- तीसरा चरण: जिस उपयोगकर्ता ने अभी लॉग इन किया हुआ है उसका डेटा वापस पाना
- चौथा चरण: वीडियो के लिए Analytics डेटा का अनुरोध करना
- पांचवां चरण: चार्ट में Analytics का डेटा दिखाना
ज़रूरी जानकारी: अपने ऐप्लिकेशन के लिए OAuth 2.0 क्लाइंट आईडी पाने के लिए, आपको Google के साथ अपना ऐप्लिकेशन रजिस्टर करना होगा.
पहला चरण: अपना एचटीएमएल पेज और सीएसएस फ़ाइल बनाना
इस चरण में, आप एक HTML पेज बनाएंगे, जो JavaScript लाइब्रेरी को लोड करता है और जिसे ऐप्लिकेशन इस्तेमाल करेगा. नीचे दिया गया HTML, पेज का कोड दिखाता है:
<!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 विज़ुअलाइज़ेशन एपीआई लोड करने के लिए एपीआई लोडर का इस्तेमाल करता है. इसका इस्तेमाल, फिर से हासिल किए गए Analytics डेटा को चार्ट करने में किया जाता है. - index.js लाइब्रेरी में, सैंपल ऐप्लिकेशन से जुड़े फ़ंक्शन होते हैं. इस ट्यूटोरियल में उन फ़ंक्शन को बनाने का तरीका बताया गया है.
- JavaScript के लिए Google API क्लाइंट लाइब्रेरी से, आपको 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 फ़ाइल बनाना शुरू करेंगे, जिसे आपका HTML पेज कॉल कर रहा है. इसे ध्यान में रखते हुए, अपने इंडेक्स में उसी डायरेक्ट्री में 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 डेटा एपीआई (v2.0) का इस्तेमाल करके, फ़िलहाल लॉग इन किए हुए उपयोगकर्ता के अपलोड किए गए वीडियो फ़ीड को वापस लाता है. वह फ़ीड, उपयोगकर्ता का YouTube चैनल आईडी तय करेगा, जिसकी ज़रूरत आपको YouTube Analytics एपीआई को कॉल करते समय पड़ेगी. इसके अलावा, सैंपल ऐप्लिकेशन उपयोगकर्ता के अपलोड किए गए वीडियो की सूची बनाता है, ताकि उपयोगकर्ता किसी वीडियो के लिए Analytics डेटा फिर से पा सके.
अपनी index.js फ़ाइल में नीचे दिए गए बदलाव करें:
-
एक ऐसा फ़ंक्शन जोड़ें जो YouTube Analytics और डेटा एपीआई के लिए, क्लाइंट इंटरफ़ेस को लोड करे. Google API 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पैरामीटर शामिल होता है. इससे यह पता चलता है कि अनुरोध, हाल ही में पुष्टि किए गए उपयोगकर्ता के चैनल की जानकारी के लिए है. Analytics Analytics कोchannelIdउस चैनल की पहचान करने के लिए भेजा जाएगा जिसके लिए आप 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 विज़ुअलाइज़ेशन एपीआई को भेजता है. इसके बाद, वह एपीआई जानकारी को चार्ट में दिखाता है.
-
Google विज़ुअलाइज़ेशन API लोड करें, जो आपके डेटा को एक चार्ट में दिखाएगा. चार्ट के विकल्पों के बारे में ज़्यादा जानकारी के लिए, विज़ुअलाइज़ेशन एपीआई का दस्तावेज़ देखें.
google.load('visualization', '1.0', {'packages': ['corechart']}); -
displayChartनाम का एक नया फ़ंक्शन तय करें. यह Google विज़ुअलाइज़ेशन एपीआई का इस्तेमाल करके, डाइनैमिक रूप से Analytics डेटा दिखाने वाला चार्ट जनरेट करता है.// 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();
}
})();