1. खास जानकारी
इस कोडलैब में, आपको यह जानकारी मिलेगी कि Google Slides को कस्टम प्रज़ेंटेशन टूल के तौर पर इस्तेमाल करके, सबसे सामान्य सॉफ़्टवेयर लाइसेंस का विश्लेषण कैसे किया जा सकता है. BigQuery API का इस्तेमाल करके, GitHub पर मौजूद सभी ओपन सोर्स कोड की क्वेरी की जाएगी. साथ ही, नतीजे दिखाने के लिए Google Slides API का इस्तेमाल करके, स्लाइड डेक बनाया जाएगा. सैंपल ऐप्लिकेशन को Node.js का इस्तेमाल करके बनाया गया है, लेकिन ये बुनियादी सिद्धांत किसी भी आर्किटेक्चर पर लागू होते हैं.
आपको क्या सीखने को मिलेगा
- Slides API का इस्तेमाल करके प्रज़ेंटेशन बनाना
- बड़े डेटासेट की अहम जानकारी पाने के लिए, BigQuery का इस्तेमाल करना
- Google Drive API का इस्तेमाल करके फ़ाइल कॉपी करना
आपको किन चीज़ों की ज़रूरत होगी
- Node.js इंस्टॉल होना चाहिए
- इंटरनेट और वेब ब्राउज़र का ऐक्सेस
- Google खाता
- Google Cloud Platform प्रोजेक्ट
2. सैंपल कोड पाना
आपके पास अपने कंप्यूटर पर सभी सैंपल कोड डाउनलोड करने का विकल्प है...
...या कमांड लाइन से GitHub रिपॉज़िटरी को क्लोन करें.
git clone https://github.com/googleworkspace/slides-api.git
अगर आपको किसी काम करने वाले वर्शन का रेफ़रंस चाहिए, तो रिपॉज़िटरी में प्रोसेस के हर चरण को दिखाने वाली डायरेक्ट्री का एक सेट होता है.
आपको start
डायरेक्ट्री में मौजूद कॉपी पर काम करना होगा. हालांकि, ज़रूरत पड़ने पर, अन्य कॉपी से फ़ाइलों को रेफ़र या कॉपी किया जा सकता है.
3. सैंपल ऐप्लिकेशन चलाना
सबसे पहले, Node स्क्रिप्ट को तैयार और चलाएं. डाउनलोड किए गए कोड की मदद से, Node.js ऐप्लिकेशन को इंस्टॉल और शुरू करने के लिए, यहां दिए गए निर्देशों का पालन करें:
- अपने कंप्यूटर पर कमांड-लाइन टर्मिनल खोलें और कोडलैब की
start
डायरेक्ट्री पर जाएं. - Node.js की डिपेंडेंसी इंस्टॉल करने के लिए, यह कमांड डालें.
npm install
- स्क्रिप्ट चलाने के लिए, यह कमांड डालें:
node .
- इस प्रोजेक्ट के लिए सिलसिलेवार निर्देशों वाला वेलकम मैसेज देखें.
-- Start generating slides. --
TODO: Get Client Secrets
TODO: Authorize
TODO: Get Data from BigQuery
TODO: Create Slides
TODO: Open Slides
-- Finished generating slides. --
आपको slides.js
, license.js
, और auth.js
में, 'क्या-क्या करना है' की हमारी सूची दिख सकती है. ध्यान दें कि हम ऐप्लिकेशन को पूरा करने के लिए ज़रूरी चरणों को चेन करने के लिए, JavaScript Promises का इस्तेमाल करते हैं. ऐसा इसलिए, क्योंकि हर चरण पिछले चरण के पूरा होने पर निर्भर करता है.
अगर आपको प्रॉमिस के बारे में नहीं पता है, तो चिंता न करें. हम आपको ज़रूरी सारा कोड देंगे. कम शब्दों में, प्रॉमिस की मदद से, एसिंक्रोनस प्रोसेसिंग को सिंक्रोनस तरीके से मैनेज किया जा सकता है.
4. क्लाइंट सीक्रेट पाना
Slides, BigQuery, और Drive के एपीआई इस्तेमाल करने के लिए, हम एक OAuth क्लाइंट और एक सेवा खाता बनाएंगे.
Google Developers Console सेट अप करना
- Google Developers Console में कोई प्रोजेक्ट बनाने या चुनने के लिए, इस विज़र्ड का इस्तेमाल करें. इससे एपीआई अपने-आप चालू हो जाएगा. जारी रखें पर क्लिक करें. इसके बाद, क्रेडेंशियल पर जाएं.
- अपने प्रोजेक्ट में क्रेडेंशियल जोड़ें पेज पर, रद्द करें बटन पर क्लिक करें.
- पेज पर सबसे ऊपर, OAuth सहमति वाली स्क्रीन टैब चुनें. कोई ईमेल पता चुनें, प्रॉडक्ट का नाम
Slides API Codelab
डालें, और सेव करें बटन पर क्लिक करें.
BigQuery, Drive, और Slides के एपीआई चालू करना
- डैशबोर्ड टैब चुनें. इसके बाद, एपीआई चालू करें बटन पर क्लिक करें और यहां दिए गए तीन एपीआई चालू करें:
- BigQuery API
- Google Drive API
- Google Slides API
OAuth क्लाइंट सीक्रेट डाउनलोड करना (Slides और Drive के लिए)
- क्रेडेंशियल टैब चुनें. इसके बाद, क्रेडेंशियल बनाएं बटन पर क्लिक करें और OAuth क्लाइंट आईडी चुनें.
- ऐप्लिकेशन का टाइप अन्य चुनें, नाम
Google Slides API Codelab
डालें, और बनाएं बटन पर क्लिक करें.इसके बाद दिखने वाले डायलॉग को बंद करने के लिए, ठीक है पर क्लिक करें. - क्लाइंट आईडी की दाईं ओर मौजूद, file_download (JSON डाउनलोड करें) बटन पर क्लिक करें.
- अपनी गोपनीय फ़ाइल का नाम बदलकर
client_secret.json
करें और उसे start/ और finish/, दोनों डायरेक्ट्री में कॉपी करें.
सेवा खाते का पासवर्ड डाउनलोड करना (BigQuery के लिए)
- क्रेडेंशियल टैब चुनें. इसके बाद, क्रेडेंशियल बनाएं बटन पर क्लिक करें और सेवा खाते की कुंजी चुनें.
- ड्रॉपडाउन में, नया सेवा खाता चुनें. अपनी सेवा के लिए
Slides API Codelab Service
नाम चुनें. इसके बाद, भूमिका पर क्लिक करें और BigQuery पर स्क्रोल करें. इसके बाद, BigQuery डेटा व्यूअर और BigQuery जॉब यूज़र, दोनों को चुनें. - कुंजी का टाइप के लिए, JSON चुनें.
- बनाएं पर क्लिक करें. कुंजी फ़ाइल आपके कंप्यूटर पर अपने-आप डाउनलोड हो जाएगी. दिखने वाले डायलॉग बॉक्स से बाहर निकलने के लिए, बंद करें पर क्लिक करें.
- अपनी गोपनीय फ़ाइल का नाम बदलकर
service_account_secret.json
करें और उसे start/ और finish/, दोनों डायरेक्ट्री में कॉपी करें.
क्लाइंट सीक्रेट पाना
start/auth.js
में, getClientSecrets
का तरीका भरें.
auth.js
const fs = require('fs');
/**
* Loads client secrets from a local file.
* @return {Promise} A promise to return the secrets.
*/
module.exports.getClientSecrets = () => {
return new Promise((resolve, reject) => {
fs.readFile('client_secret.json', (err, content) => {
if (err) return reject('Error loading client secret file: ' + err);
console.log('loaded secrets...');
resolve(JSON.parse(content));
});
});
}
हमने क्लाइंट सीक्रेट लोड कर लिए हैं. क्रेडेंशियल, अगले प्रॉमिस को पास कर दिए जाएंगे. node .
की मदद से प्रोजेक्ट चलाकर, पक्का करें कि उसमें कोई गड़बड़ी न हो.
5. OAuth2 क्लाइंट बनाना
स्लाइड बनाने के लिए, अपनी auth.js फ़ाइल में यह कोड जोड़कर, Google API में पुष्टि करने की सुविधा जोड़ें. पुष्टि करने के लिए, आपके Google खाते का ऐक्सेस मांगा जाएगा. इससे, Google Drive में फ़ाइलों को पढ़ने और उनमें बदलाव करने, Google Slides में प्रज़ेंटेशन बनाने, और Google BigQuery से सिर्फ़ पढ़ने की सुविधा वाली क्वेरी चलाने में मदद मिलेगी. (ध्यान दें: हमने getClientSecrets
में कोई बदलाव नहीं किया है)
auth.js
const fs = require('fs');
const readline = require('readline');
const openurl = require('openurl');
const googleAuth = require('google-auth-library');
const TOKEN_DIR = (process.env.HOME || process.env.HOMEPATH ||
process.env.USERPROFILE) + '/.credentials/';
const TOKEN_PATH = TOKEN_DIR + 'slides.googleapis.com-nodejs-quickstart.json';
// If modifying these scopes, delete your previously saved credentials
// at ~/.credentials/slides.googleapis.com-nodejs-quickstart.json
const SCOPES = [
'https://www.googleapis.com/auth/presentations', // needed to create slides
'https://www.googleapis.com/auth/drive', // read and write files
'https://www.googleapis.com/auth/bigquery.readonly' // needed for bigquery
];
/**
* Loads client secrets from a local file.
* @return {Promise} A promise to return the secrets.
*/
module.exports.getClientSecrets = () => {
return new Promise((resolve, reject) => {
fs.readFile('client_secret.json', (err, content) => {
if (err) return reject('Error loading client secret file: ' + err);
console.log('loaded secrets...');
resolve(JSON.parse(content));
});
});
}
/**
* Create an OAuth2 client promise with the given credentials.
* @param {Object} credentials The authorization client credentials.
* @param {function} callback The callback for the authorized client.
* @return {Promise} A promise to return the OAuth client.
*/
module.exports.authorize = (credentials) => {
return new Promise((resolve, reject) => {
console.log('authorizing...');
const clientSecret = credentials.installed.client_secret;
const clientId = credentials.installed.client_id;
const redirectUrl = credentials.installed.redirect_uris[0];
const auth = new googleAuth();
const oauth2Client = new auth.OAuth2(clientId, clientSecret, redirectUrl);
// Check if we have previously stored a token.
fs.readFile(TOKEN_PATH, (err, token) => {
if (err) {
getNewToken(oauth2Client).then(() => {
resolve(oauth2Client);
});
} else {
oauth2Client.credentials = JSON.parse(token);
resolve(oauth2Client);
}
});
});
}
/**
* Get and store new token after prompting for user authorization, and then
* fulfills the promise. Modifies the `oauth2Client` object.
* @param {google.auth.OAuth2} oauth2Client The OAuth2 client to get token for.
* @return {Promise} A promise to modify the oauth2Client credentials.
*/
function getNewToken(oauth2Client) {
console.log('getting new auth token...');
openurl.open(oauth2Client.generateAuthUrl({
access_type: 'offline',
scope: SCOPES
}));
console.log(''); // \n
return new Promise((resolve, reject) => {
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout
});
rl.question('Enter the code from that page here: ', (code) => {
rl.close();
oauth2Client.getToken(code, (err, token) => {
if (err) return reject(err);
oauth2Client.credentials = token;
let storeTokenErr = storeToken(token);
if (storeTokenErr) return reject(storeTokenErr);
resolve();
});
});
});
}
/**
* Store token to disk be used in later program executions.
* @param {Object} token The token to store to disk.
* @return {Error?} Returns an error or undefined if there is no error.
*/
function storeToken(token) {
try {
fs.mkdirSync(TOKEN_DIR);
fs.writeFileSync(TOKEN_PATH, JSON.stringify(token));
} catch (err) {
if (err.code != 'EEXIST') return err;
}
console.log('Token stored to ' + TOKEN_PATH);
}
6. BigQuery सेटअप करना
BigQuery को एक्सप्लोर करना (ज़रूरी नहीं)
BigQuery की मदद से, हम कुछ ही सेकंड में बड़े डेटासेट पर क्वेरी कर सकते हैं. प्रोग्राम के हिसाब से क्वेरी करने से पहले, वेब इंटरफ़ेस का इस्तेमाल करें. अगर आपने पहले कभी BigQuery सेट अप नहीं किया है, तो शुरुआती निर्देशों वाले इस लेख में दिया गया तरीका अपनाएं.
BigQuery में उपलब्ध GitHub डेटा को ब्राउज़ करने और अपनी क्वेरी चलाने के लिए, Cloud Console खोलें. GitHub पर सबसे लोकप्रिय सॉफ़्टवेयर लाइसेंस ढूंढने के लिए, यह क्वेरी लिखें और चालू करें बटन दबाएं.
bigquery.sql
WITH AllLicenses AS (
SELECT * FROM `bigquery-public-data.github_repos.licenses`
)
SELECT
license,
COUNT(*) AS count,
ROUND((COUNT(*) / (SELECT COUNT(*) FROM AllLicenses)) * 100, 2) AS percent
FROM `bigquery-public-data.github_repos.licenses`
GROUP BY license
ORDER BY count DESC
LIMIT 10
हमने GitHub पर मौजूद लाखों सार्वजनिक रिपॉज़िटरी का विश्लेषण किया है. इससे हमें सबसे लोकप्रिय लाइसेंस के बारे में पता चला है. कूल! अब एक ही क्वेरी को प्रोग्राम के हिसाब से चलाने का सेटअप करते हैं.
BigQuery सेट अप करना
फ़ाइल license.js
में मौजूद कोड बदलें. bigquery.query
फ़ंक्शन, promise दिखाएगा.
license**.js**
const google = require('googleapis');
const read = require('read-file');
const BigQuery = require('@google-cloud/bigquery');
const bigquery = BigQuery({
credentials: require('./service_account_secret.json')
});
// See codelab for other queries.
const query = `
WITH AllLicenses AS (
SELECT * FROM \`bigquery-public-data.github_repos.licenses\`
)
SELECT
license,
COUNT(*) AS count,
ROUND((COUNT(*) / (SELECT COUNT(*) FROM AllLicenses)) * 100, 2) AS percent
FROM \`bigquery-public-data.github_repos.licenses\`
GROUP BY license
ORDER BY count DESC
LIMIT 10
`;
/**
* Get the license data from BigQuery and our license data.
* @return {Promise} A promise to return an object of licenses keyed by name.
*/
module.exports.getLicenseData = (auth) => {
console.log('querying BigQuery...');
return bigquery.query({
query,
useLegacySql: false,
useQueryCache: true,
}).then(bqData => Promise.all(bqData[0].map(getLicenseText)))
.then(licenseData => new Promise((resolve, reject) => {
resolve([auth, licenseData]);
}))
.catch((err) => console.error('BigQuery error:', err));
}
/**
* Gets a promise to get the license text about a license
* @param {object} licenseDatum An object with the license's
* `license`, `count`, and `percent`
* @return {Promise} A promise to return license data with license text.
*/
function getLicenseText(licenseDatum) {
const licenseName = licenseDatum.license;
return new Promise((resolve, reject) => {
read(`licenses/${licenseName}.txt`, 'utf8', (err, buffer) => {
if (err) return reject(err);
resolve({
licenseName,
count: licenseDatum.count,
percent: licenseDatum.percent,
license: buffer.substring(0, 1200) // first 1200 characters
});
});
});
}
हमारे ऑब्जेक्ट के स्ट्रक्चर को समझने और कोड को काम करते हुए देखने के लिए, हमारे Promise के कॉलबैक में मौजूद कुछ डेटा को console.log
करें.
7. स्लाइड बनाएं
अब सबसे मज़ेदार हिस्सा! आइए, Slides API के create
और batchUpdate
तरीकों को कॉल करके स्लाइड बनाते हैं. हमारी फ़ाइल को इनसे बदला जाना चाहिए:
slides.js
const google = require('googleapis');
const slides = google.slides('v1');
const drive = google.drive('v3');
const openurl = require('openurl');
const commaNumber = require('comma-number');
const SLIDE_TITLE_TEXT = 'Open Source Licenses Analysis';
/**
* Get a single slide json request
* @param {object} licenseData data about the license
* @param {object} index the slide index
* @return {object} The json for the Slides API
* @example licenseData: {
* "licenseName": "mit",
* "percent": "12.5",
* "count": "1667029"
* license:"<body>"
* }
* @example index: 3
*/
function createSlideJSON(licenseData, index) {
// Then update the slides.
const ID_TITLE_SLIDE = 'id_title_slide';
const ID_TITLE_SLIDE_TITLE = 'id_title_slide_title';
const ID_TITLE_SLIDE_BODY = 'id_title_slide_body';
return [{
// Creates a "TITLE_AND_BODY" slide with objectId references
createSlide: {
objectId: `${ID_TITLE_SLIDE}_${index}`,
slideLayoutReference: {
predefinedLayout: 'TITLE_AND_BODY'
},
placeholderIdMappings: [{
layoutPlaceholder: {
type: 'TITLE'
},
objectId: `${ID_TITLE_SLIDE_TITLE}_${index}`
}, {
layoutPlaceholder: {
type: 'BODY'
},
objectId: `${ID_TITLE_SLIDE_BODY}_${index}`
}]
}
}, {
// Inserts the license name, percent, and count in the title
insertText: {
objectId: `${ID_TITLE_SLIDE_TITLE}_${index}`,
text: `#${index + 1} ${licenseData.licenseName} — ~${licenseData.percent}% (${commaNumber(licenseData.count)} repos)`
}
}, {
// Inserts the license in the text body paragraph
insertText: {
objectId: `${ID_TITLE_SLIDE_BODY}_${index}`,
text: licenseData.license
}
}, {
// Formats the slide paragraph's font
updateParagraphStyle: {
objectId: `${ID_TITLE_SLIDE_BODY}_${index}`,
fields: '*',
style: {
lineSpacing: 10,
spaceAbove: {magnitude: 0, unit: 'PT'},
spaceBelow: {magnitude: 0, unit: 'PT'},
}
}
}, {
// Formats the slide text style
updateTextStyle: {
objectId: `${ID_TITLE_SLIDE_BODY}_${index}`,
style: {
bold: true,
italic: true,
fontSize: {
magnitude: 10,
unit: 'PT'
}
},
fields: '*',
}
}];
}
/**
* Creates slides for our presentation.
* @param {authAndGHData} An array with our Auth object and the GitHub data.
* @return {Promise} A promise to return a new presentation.
* @see https://developers.google.com/apis-explorer/#p/slides/v1/
*/
module.exports.createSlides = (authAndGHData) => new Promise((resolve, reject) => {
console.log('creating slides...');
const [auth, ghData] = authAndGHData;
// First copy the template slide from drive.
drive.files.copy({
auth: auth,
fileId: '1toV2zL0PrXJOfFJU-NYDKbPx9W0C4I-I8iT85TS0fik',
fields: 'id,name,webViewLink',
resource: {
name: SLIDE_TITLE_TEXT
}
}, (err, presentation) => {
if (err) return reject(err);
const allSlides = ghData.map((data, index) => createSlideJSON(data, index));
slideRequests = [].concat.apply([], allSlides); // flatten the slide requests
slideRequests.push({
replaceAllText: {
replaceText: SLIDE_TITLE_TEXT,
containsText: { text: '{{TITLE}}' }
}
})
// Execute the requests
slides.presentations.batchUpdate({
auth: auth,
presentationId: presentation.id,
resource: {
requests: slideRequests
}
}, (err, res) => {
if (err) {
reject(err);
} else {
resolve(presentation);
}
});
});
});
8. Slides खोलें
आखिर में, ब्राउज़र में प्रज़ेंटेशन खोलें. slides.js
में, नीचे दिया गया तरीका अपडेट करें.
slides.js
/**
* Opens a presentation in a browser.
* @param {String} presentation The presentation object.
*/
module.exports.openSlidesInBrowser = (presentation) => {
console.log('Presentation URL:', presentation.webViewLink);
openurl.open(presentation.webViewLink);
}
फ़ाइनल नतीजा देखने के लिए, अपने प्रोजेक्ट को एक बार फिर से चलाएं.
9. बधाई हो!
BigQuery का इस्तेमाल करके, विश्लेषण किए गए डेटा से Google Slides जनरेट हो गए हैं. आपकी स्क्रिप्ट, Google Slides API और BigQuery का इस्तेमाल करके एक प्रज़ेंटेशन बनाती है. इससे, सबसे ज़्यादा इस्तेमाल किए जाने वाले सॉफ़्टवेयर लाइसेंस का विश्लेषण किया जा सकता है.
सुधार की संभावनाएं
यहां कुछ और आइडिया दिए गए हैं, जिनसे इंटिग्रेशन को ज़्यादा आकर्षक बनाया जा सकता है:
- हर स्लाइड में इमेज जोड़ना
- Gmail API का इस्तेमाल करके, ईमेल से स्लाइड शेयर करना
- कमांड लाइन आर्ग्युमेंट के तौर पर टेंप्लेट स्लाइड को पसंद के मुताबिक बनाना
ज़्यादा जानें
- Google Slides API के डेवलपर दस्तावेज़ पढ़ें.
- google-slides-api टैग के तहत, Stack Overflow पर सवाल पोस्ट करें और जवाब पाएं.