Ruby クイックスタート

このページの残りの部分で説明する手順を完了すると、約 5 分で YouTube Data API にリクエストを行う簡単な Ruby コマンドライン アプリケーションを使用できます。

このガイドで使用するサンプルコードでは、GoogleDevelopers の YouTube チャンネルの channel リソースを取得し、そのリソースから基本情報を出力します。

Prerequisites

このクイックスタートを実行するには、以下が必要です。

  • Ruby 2.0 以上。
  • インターネットとウェブブラウザへのアクセス。
  • Google アカウント。

ステップ 1: YouTube Data API を有効にする

  1. このウィザードを使用して、Google Developers Console でプロジェクトを作成または選択すると、API が自動的に有効になります。[続行]、[認証情報に移動] の順にクリックします。

  2. [認証情報を作成] ページで、[キャンセル] ボタンをクリックします。

  3. ページ上部の [OAuth 同意画面] タブを選択します。[メールアドレス] を選択し、まだ設定していない場合はプロダクト名を入力して、[保存] ボタンをクリックします。

  4. [認証情報] タブを選択し、[認証情報を作成] ボタンをクリックして、[OAuth クライアント ID] を選択します。

  5. アプリケーションの種類として [その他] を選択し、「YouTube Data API クイックスタート」という名前を入力して、[作成] ボタンをクリックします。

  6. [OK] をクリックして、表示されたダイアログを閉じます。

  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')
quickstart.rb

ステップ 4: サンプルを実行する

次のコマンドを使用してサンプルを実行します。

ruby quickstart.rb

サンプルを初めて実行すると、アクセスを承認するように求められます。

  1. サンプルでは、デフォルトのブラウザで新しいウィンドウまたはタブが開かれます。このコマンドが失敗した場合は、コンソールから URL をコピーし、ブラウザで手動で開きます。

    まだ Google アカウントにログインしていない場合は、ログインするように求められます。複数の Google アカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択するよう求められます。

  2. [同意する] ボタンをクリックします。

  3. 指定されたコードをコピーして、コマンドライン プロンプトに貼り付け、Enter キーを押します。コードは、認可後にリダイレクトされるページの URL に表示される場合があります。

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

備考

  • 認可情報はファイル システムに保存されるため、後続の実行で承認を求められません。
  • この例の承認フローは、コマンドライン アプリケーション向けに設計されています。ウェブ アプリケーションで認可を行う方法については、ウェブサーバー アプリケーションに OAuth 2.0 を使用するをご覧ください。

参考資料