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

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

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

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

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

  • 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" ולוחצים על יצירה.

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

  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);
    }
  });
}

nodejs-quickstart.js

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

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

node quickstart.js

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

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

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

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

הערות

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

    למידע על אופן ביצוע ההרשאה בהקשרים אחרים, קראו את הקטע הרשאה ואימות ב-README של הספרייה.

קריאה נוספת