Ruby 快速入门

完成本页其余部分中所述的步骤，大约五分钟后，您将拥有一个简单的 Ruby 命令行应用，该应用会向 YouTube Data API 发出请求。

本指南中使用的示例代码会检索 GoogleDevelopers YouTube 频道的 channel 资源，并输出该资源中的一些基本信息。

前提条件

如需运行此快速入门，您需要：

  • Ruby 2.0 或更高版本。
  • 能够访问互联网并拥有网络浏览器。
  • 一个 Google 账号。

第 1 步：启用 YouTube Data API

  1. 使用 此向导 在 Google Developers Console 中创建或选择一个项目，并 自动启用该 API。点击继续 ，然后 前往凭据 。

  2. 在创建凭据 页面上，点击 取消 按钮。

  3. 在页面顶部，选择 OAuth 权限请求页面 标签页。选择一个电子邮件地址 ，输入商品名称 （如果尚未 设置），然后点击保存 按钮。

  4. 选择凭据 标签页，点击创建凭据 按钮，然后选择 OAuth 客户端 ID。

  5. 选择应用类型其他，输入名称 "YouTube Data API Quickstart"，然后点击创建按钮。

  6. 点击确定 以关闭生成的对话框。

  7. 点击客户端 ID 右侧的 （下载 JSON）按钮。

  8. 将下载的文件移至您的工作目录，并将其重命名为 client_secret.json。

第 2 步：安装 Google 客户端库

运行以下命令以安装该库：

gem install google-api-client

如需了解其他 安装选项，请参阅该库的安装 页面。

第 3 步：设置示例

在工作目录中创建一个名为 quickstart.rb 的文件，然后复制以下代码：

# Sample Ruby code for user authorization

require 'rubygems'
gem 'google-api-client', '>0.7'
require 'google/apis'
require 'google/apis/youtube_v3'
require 'googleauth'
require 'googleauth/stores/file_token_store'

require 'fileutils'
require 'json'

# REPLACE WITH VALID REDIRECT_URI FOR YOUR CLIENT
REDIRECT_URI = 'http://localhost'
APPLICATION_NAME = 'YouTube Data API Ruby Tests'

# REPLACE WITH NAME/LOCATION OF YOUR client_secrets.json FILE
CLIENT_SECRETS_PATH = 'client_secret.json'

# REPLACE FINAL ARGUMENT WITH FILE WHERE CREDENTIALS WILL BE STORED
CREDENTIALS_PATH = File.join(Dir.home, '.credentials',
                             "youtube-quickstart-ruby-credentials.yaml")

# SCOPE FOR WHICH THIS SCRIPT REQUESTS AUTHORIZATION
SCOPE = Google::Apis::YoutubeV3::AUTH_YOUTUBE_READONLY

def authorize
  FileUtils.mkdir_p(File.dirname(CREDENTIALS_PATH))

  client_id = Google::Auth::ClientId.from_file(CLIENT_SECRETS_PATH)
  token_store = Google::Auth::Stores::FileTokenStore.new(file: CREDENTIALS_PATH)
  authorizer = Google::Auth::UserAuthorizer.new(
    client_id, SCOPE, token_store)
  user_id = 'default'
  credentials = authorizer.get_credentials(user_id)
  if credentials.nil?
    url = authorizer.get_authorization_url(base_url: REDIRECT_URI)
    puts "Open the following URL in the browser and enter the " +
         "resulting code after authorization"
    puts url
    code = gets
    credentials = authorizer.get_and_store_credentials_from_code(
      user_id: user_id, code: code, base_url: REDIRECT_URI)
  end
  credentials
end

# Initialize the API
service = Google::Apis::YoutubeV3::YouTubeService.new
service.client_options.application_name = APPLICATION_NAME
service.authorization = authorize

# Sample ruby code for channels.list

def channels_list_by_username(service, part, **params)
  response = service.list_channels(part, params).to_json
  item = JSON.parse(response).fetch("items")[0]

  puts ("This channel's ID is #{item.fetch("id")}. " +
        "Its title is '#{item.fetch("snippet").fetch("title")}', and it has " +
        "#{item.fetch("statistics").fetch("viewCount")} views.")
end

channels_list_by_username(service, 'snippet,contentDetails,statistics', for_username: 'GoogleDevelopers')

第 4 步：运行示例

使用以下命令运行示例：

ruby quickstart.rb

首次运行该示例时，系统会提示您授权访问：

  1. 该示例会尝试在默认浏览器中打开一个新窗口或标签页。 如果此操作失败，请从控制台中复制网址，然后在浏览器中手动打开该网址。

    如果您尚未登录 Google 账号，系统会提示您登录。如果您已登录多个 Google 账号，系统会要求您选择一个账号用于授权。

  2. 点击接受 按钮。

  3. 复制系统提供的代码，将其粘贴到命令行提示符中，然后按 Enter 键。该代码可能会显示在您获得授权后重定向到的页面的网址中：

    http://localhost/?code=4/nr_1TspmmQPFyifh7nz...OFo#

备注

  • 授权信息存储在文件系统中，因此后续执行不会提示授权。
  • 此示例中的授权流程是为命令行应用设计的。如需了解如何在 Web 应用中执行授权，请参阅 针对网络服务器应用使用 OAuth 2.0。

深入阅读