מדריך למתחילים ב-Node.js

עליכם לבצע את השלבים שמפורטים בהמשך הדף, ובתוך כחמש דקות תהיה לכם אפליקציית שורת פקודה פשוטה של Node.js ששולחת בקשות ל-YouTube Data API.

קוד הדוגמה שמוצג במדריך הזה מאחזר את המשאב channel של ערוץ YouTube של GoogleDevelopers ומדפיס מידע בסיסי מהמשאב הזה.

דרישות מוקדמות

כדי להריץ את המדריך למתחילים הזה, צריך:

  • Node.js מותקן.
  • הכלי לניהול חבילות npm (מגיע עם Node.js).
  • גישה לאינטרנט ודפדפן אינטרנט.
  • חשבון Google.

שלב 1: מפעילים את YouTube Data API

  1. אפשר להשתמש באשף הזה כדי ליצור או לבחור פרויקט ב-Google Developers Console ולהפעיל את ה-API באופן אוטומטי. לוחצים על Continue ואז על Go to credentials.

  2. בדף Create credentials, לוחצים על הלחצן Cancel.

  3. בחלק העליון של הדף, לוחצים על הכרטיסייה מסך הסכמה ל-OAuth. בוחרים כתובת אימייל, מזינים שם מוצר אם הוא עדיין לא מוגדר ולוחצים על הלחצן שמירה.

  4. בוחרים בכרטיסייה Credentials, לוחצים על הלחצן Create credentials ובוחרים באפשרות OAuth client ID.

  5. בוחרים את סוג האפליקציה אחר, מזינים את השם 'YouTube Data API Quickstart' ולוחצים על הלחצן Create.

  6. לוחצים על OK כדי לסגור את תיבת הדו-שיח שנפתחת.

  7. לוחצים על הלחצן (הורדת קובץ JSON) שמשמאל למזהה הלקוח.

  8. מעבירים את הקובץ שהורדתם לספריית העבודה ומשנים את השם שלו ל-client_secret.json.

שלב 2: התקנת ספריית הלקוח

מריצים את הפקודות הבאות כדי להתקין את הספריות באמצעות npm:

npm install googleapis --save
npm install google-auth-library --save

שלב 3: מגדירים את הדוגמית

יוצרים קובץ בשם quickstart.js בספריית העבודה ומעתיקים את הקוד הבא:

var fs = require('fs');
var readline = require('readline');
var {google} = require('googleapis');
var OAuth2 = google.auth.OAuth2;

// If modifying these scopes, delete your previously saved credentials
// at ~/.credentials/youtube-nodejs-quickstart.json
var SCOPES = ['https://www.googleapis.com/auth/youtube.readonly'];
var TOKEN_DIR = (process.env.HOME || process.env.HOMEPATH ||
    process.env.USERPROFILE) + '/.credentials/';
var TOKEN_PATH = TOKEN_DIR + 'youtube-nodejs-quickstart.json';

// Load client secrets from a local file.
fs.readFile('client_secret.json', function processClientSecrets(err, content) {
  if (err) {
    console.log('Error loading client secret file: ' + err);
    return;
  }
  // Authorize a client with the loaded credentials, then call the YouTube API.
  authorize(JSON.parse(content), getChannel);
});

/**
 * Create an OAuth2 client with the given credentials, and then execute the
 * given callback function.
 *
 * @param {Object} credentials The authorization client credentials.
 * @param {function} callback The callback to call with the authorized client.
 */
function authorize(credentials, callback) {
  var clientSecret = credentials.installed.client_secret;
  var clientId = credentials.installed.client_id;
  var redirectUrl = credentials.installed.redirect_uris[0];
  var oauth2Client = new OAuth2(clientId, clientSecret, redirectUrl);

  // Check if we have previously stored a token.
  fs.readFile(TOKEN_PATH, function(err, token) {
    if (err) {
      getNewToken(oauth2Client, callback);
    } else {
      oauth2Client.credentials = JSON.parse(token);
      callback(oauth2Client);
    }
  });
}

/**
 * Get and store new token after prompting for user authorization, and then
 * execute the given callback with the authorized OAuth2 client.
 *
 * @param {google.auth.OAuth2} oauth2Client The OAuth2 client to get token for.
 * @param {getEventsCallback} callback The callback to call with the authorized
 *     client.
 */
function getNewToken(oauth2Client, callback) {
  var authUrl = oauth2Client.generateAuthUrl({
    access_type: 'offline',
    scope: SCOPES
  });
  console.log('Authorize this app by visiting this url: ', authUrl);
  var rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout
  });
  rl.question('Enter the code from that page here: ', function(code) {
    rl.close();
    oauth2Client.getToken(code, function(err, token) {
      if (err) {
        console.log('Error while trying to retrieve access token', err);
        return;
      }
      oauth2Client.credentials = token;
      storeToken(token);
      callback(oauth2Client);
    });
  });
}

/**
 * Store token to disk be used in later program executions.
 *
 * @param {Object} token The token to store to disk.
 */
function storeToken(token) {
  try {
    fs.mkdirSync(TOKEN_DIR);
  } catch (err) {
    if (err.code != 'EEXIST') {
      throw err;
    }
  }
  fs.writeFile(TOKEN_PATH, JSON.stringify(token), (err) => {
    if (err) throw err;
    console.log('Token stored to ' + TOKEN_PATH);
  });
}

/**
 * Lists the names and IDs of up to 10 files.
 *
 * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
 */
function getChannel(auth) {
  var service = google.youtube('v3');
  service.channels.list({
    auth: auth,
    part: 'snippet,contentDetails,statistics',
    forUsername: 'GoogleDevelopers'
  }, function(err, response) {
    if (err) {
      console.log('The API returned an error: ' + err);
      return;
    }
    var channels = response.data.items;
    if (channels.length == 0) {
      console.log('No channel found.');
    } else {
      console.log('This channel\'s ID is %s. Its title is \'%s\', and ' +
                  'it has %s views.',
                  channels[0].id,
                  channels[0].snippet.title,
                  channels[0].statistics.viewCount);
    }
  });
}

שלב 4: מריצים את הדוגמה

מריצים את הדוגמה באמצעות הפקודה הבאה:

node quickstart.js

בפעם הראשונה שתפעילו את הדוגמה, תתבקשו לאשר את הגישה:

  1. עוברים אל כתובת ה-URL שצוינה בדפדפן האינטרנט.

    אם עדיין לא נכנסתם לחשבון Google, תתבקשו לעשות זאת. אם אתם מחוברים לכמה חשבונות Google, תתבקשו לבחור חשבון אחד לצורך ההרשאה.

  2. לוחצים על הלחצן אישור.
  3. מעתיקים את הקוד שקיבלתם, מדביקים אותו בהודעה בשורת הפקודה ומקישים על Enter.

הערות

  • פרטי ההרשאה מאוחסנים במערכת הקבצים, כך שבפעולות הבאות לא תופיע בקשה להרשאה.
  • תהליך ההרשאה בדוגמה הזו מיועד לאפליקציה של שורת הפקודה. במאמר שימוש ב-OAuth 2.0 לאפליקציות אינטרנט מוסבר איך לבצע הרשאה באפליקציית אינטרנט שמשתמשת ב-YouTube Data API.

    מידע נוסף על ביצוע הרשאה בהקשרים אחרים זמין בקטע Authorizing and Authenticating בקובץ README של הספרייה.

קריאה נוספת