完成本页面其余部分介绍的步骤,大约五分钟后,您将获得一个向 YouTube Data API 发出请求的简单 Node.js 命令行应用。
本指南中使用的示例代码会检索 Google Developers 的 YouTube 频道channel
资源,并输出该资源的一些基本信息。
前提条件
如需运行本快速入门,您需要:
- 已安装 Node.js。
- npm 软件包管理工具(附带 Node.js)。
- 访问互联网和网络浏览器。
- Google 帐号。
第 1 步:启用 YouTube Data API
-
您可以使用此向导在 Google Developers Console 中创建或选择项目,并自动启用 API。点击继续,然后点击转到凭据。
-
在创建凭据页面上,点击取消按钮。
-
在页面顶部,选择 OAuth 同意屏幕标签页。选择一个 Email address(电子邮件地址),输入产品名称(如果尚未设置),然后点击 Save(保存)按钮。
-
选择凭据标签页,点击创建凭据按钮,然后选择 OAuth 客户端 ID。
-
选择其他应用类型,输入名称“YouTube Data API 快速入门”,然后点击创建按钮。
-
点击 OK 关闭生成的对话框。
-
点击客户端 ID 右侧的
(下载 JSON)按钮。 -
将下载的文件移动到工作目录,并将其重命名为
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
首次运行示例时,系统会提示您授予访问权限:
在网络浏览器中浏览提供的网址。
如果您尚未登录 Google 帐号,系统会提示您登录。如果您登录了多个 Google 帐号,系统会要求您选择一个帐号用于授权。
- 点击接受按钮。
- 复制所提供的代码,将其粘贴到命令行提示符中,然后按 Enter 键。
备注
- 授权信息存储在文件系统中,因此后续执行将不会提示用户授权。
- 此示例中的授权流程专为命令行应用而设计。如需了解如何在使用 YouTube Data API 的 Web 应用中执行授权,请参阅为网络服务器应用使用 OAuth 2.0。
如需了解如何在其他环境中执行授权,请参阅该库的 README 文件的授权和身份验证部分。