DataSpiderからFacebookのグラフAPIを使って情報取得をしてみた

はじめに

こんにちは、すぎもんです今回はFacebookのグラフAPIを使ってみます。
Facebookアプリのアカウントや、投稿に対する操作をするためのAPIです。因みに、FacebookグラフAPIは、InstagramグラフAPIのベースとなっていますので、もしInstagram APIを使ってみたい方はFaceBook グラフAPIも併せてご確認ください。

Facebookとは

今や人々の生活の一部となっているSNS（ソーシャルネットワーキングサービス）。その中でもFacebookは、世界で最もユーザー数が多く、年齢別で利用率が異なるものの、日本国内では、30～60代の利用率が高いサービスです。基本的に実名で利用するという特徴を持っており、企業の公式アカウントも多く、販促やブランディングにも使われています。

今回やること

DataSpiderと連携して、Facebookの グラフAPI を使ってみます。

グラフAPIを使って「特定のオブジェクトのデータを取得」します。

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
■グラフAPIとは
Facebookの「ソーシャルグラフ」の読み取りと書き込みを行う手段。
HTTPベースのAPIで、投稿や写真アップロードなど、Facebookアプリに対するさまざまなタスクに利用できます。

■ソーシャルグラフとは
Facebookなどのソーシャルメディアの人間関係や、集積された情報を可視化させたもの。「ノード・エッジ・フィールド」の3つで構成されています。API利用の観点だと、それぞれで取得できる情報や操作できる内容が異なる、という理解で問題ないと思います。
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++

検証手順

＜Facebookの設定＞
　　　　①アカウントの作成
　　　　②アプリの作成
　　　　③接続情報の確認

＜DataSpiderの設定＞
　１．アクセストークンの取得をするスクリプトの作成
　　　　④プロジェクト/スクリプト/スクリプト変数の作成
　　　　⑤GET実行の設定
　２．Facebookの/meノードの情報を取得するスクリプトの作成
　　　　⑥プロジェクト/スクリプト/スクリプト変数の作成
　　　　⑦GET実行の設定

Facebookの設定

①アカウントの作成

まずは、ユーザーアカウントを発行し、開発者としての登録までを実施します。
詳細は割愛しますが、下記をご参考にしてください。
　　　　◆グラフAPI-スタートガイド
　　　　◆Facebook開発者としての登録について

②アプリの作成

開発者としての登録完了後に、下記の画面が表示されるので【アプリを作成】を押下。

アプリタイプは、「なし」を選択し、【次へ】を押下します。

アプリ名を入力し、【アプリを作成】を押下します。

赤枠のエラーは、アプリ名を「fb」で始める名前にして表示されたものです。エラーメッセージにある内容を参考に、エラーにならないアプリ名を設定しましょう。

アプリ作成後、パスワード入力のポップアップ表示が出るので、入力し【送信】を押下します。これで、アプリの作成は完了です。

画面上部に、作成したアプリ名とアプリIDが表示されます。

③接続情報の確認

アプリ作成が完了したので、DataSpiderから接続するために必要な情報を確認します。

開発者サイト（Meta for Developers）から「マイアプリ」で下記の画面を表示します。作成したアプリのアイコン部分を押下して、ダッシュボードを表示します。

左側のメニューバー「設定」-「ベーシック」で表示される「アプリID」と「app secret」は、DataSpiderの設定で使用するので控えておきましょう。

「app secret」は表示を押下して、パスワード入力すると表示されます。

左側のメニューバー「Facebookログイン」-「設定」から、Oauthの設定画面を表示します。「有効なOAuthリダイレクトURL」という項目に下記のリダイレクトURLを設定します。
・リダイレクトURL　：　
　　　　https://{DataSpiderServerのアドレス}:8443/dataspider/oauth_2_0

Facebookの設定は、これで完了です。

DataSpiderの設定

FacebookのグラフAPIを使うにはまず、アクセストークンの取得が必要です。
そのため、今回は下記2つのスクリプトを作成します。
　　　◇アクセストークンの取得
　　　◇Facebookの/meノードの情報を取得

Facebookのアクセストークンについて、記事最後にご参考を記載しています。
詳細については、下記をご参照ください。
　　　　◆アクセストークンについて
　　　　◆アクセストークンの取得について

④接続先の設定

まず始めに、FacebookのグラフAPIへの接続先を設定します。
DataSpider Studioの「コントロールパネル」-「グローバルリソースの設定」-「新しいグローバルリソースの作成」を押下します。

「認証」タブの「OAuth 2.0」を選択し、「次へ」を選択します。

それぞれ下記の通りに設定します。
　・接続名　　　　　　　　　：　facebook Oauth 2.0認証設定
　・クライアントID　　　　　：　XXX（※FacebookアプリのアプリID）
　・クライアントシークレット：　XXX（※Facebookアプリのapp secret）
　・リダイレクトURI（※Facebookアプリに設定したリダイレクトURI）
　　：　https://{DataSpiderServerのアドレス}:8443/dataspider/oauth_2_0
　・認可エンドポイント　　
　　：　https://www.facebook.com/v15.0/dialog/oauth
　・トークンエンドポイント
　　：　https://graph.facebook.com/v15.0/oauth/access_token
　・スコープ　　　　　　　：　public_profile

今回は、認可コードを使うフローなので、認可コードとトークンエンドポイントの両方が必要です。Meta for Developers（Facebookアプリの開発者向けドキュメント）より、下記の通り設定します。

■認可エンドポイント
　：　https://www.facebook.com/(*version)/dialog/oauth
■トークンエンドポイント
　：　https://graph.facebook.com/(*version)/oauth/access_token

スコープは、Meta for Developers（アクセス許可のリファレンス）より、プロフィール読み取りをする public_profileを設定します。

◇アクセストークンの取得をするスクリプトの作成

⑤プロジェクト/スクリプト/スクリプト変数の作成

まず始めに、プロジェクトとスクリプトを任意の名前で作成します。
また、処理内で使用するスクリプト変数を下記の通り作成します。

名前	初期値	変数型
client_id	※FacebookアプリのアプリID	文字列型
client_secret	※Facebookアプリのapp secret	文字列型
認可コード	※未設定	文字列型

スクリプト変数「認可コード」に後で取得するアクセストークンを設定します。

⑥GET実行の設定

デザイナ画面右側のツールパレットの[ネットワーク]＞[REST]＞[GET実行]アイコンを、デザイナ中央部分にドラッグ＆ドロップして設定画面を開きます。

まず、接続先の入力欄の右端▶を押下し「追加」をします。下記の通り設定します。
　　・名前　：　REST接続設定 facebook
　　・URL 　：　https://graph.facebook.com/v15.0

「接続テスト」を押下してDataSpiderとの接続確認をして完了です。

必須設定タブは下記の通り設定します。
　　・名前　　：　アクセストークン取得
　　・接続先　：　REST接続設定 facebook
　　・パス　　：　/oauth/access_token
＜クエリパラメータ＞

名前	値
client_id	スクリプト変数「client_id」
client_secret	スクリプト変数「client_secret」
redirect_uri	※FacebookアプリのOAuth設定で指定したリダイレクトURI※
code	スクリプト変数「認可コード」

スクリプト変数の記載方法は、${スクリプト変数名}と記載します。
入力項目欄の右端▶からも変数を選択ができます。

必須設定タブの設定は以上です。

次に、レスポンス設定タブは下記の通り設定します。
　　・データ出力先　：　ファイル
　　・ファイルパス　：　/data/facebook/access_token_response.json

「完了」を押下して、GET実行処理の設定は以上です。アクセストークン取得のスクリプト作成は完了です。

◇Facebookの/meノードの情報を取得するスクリプトの作成

⑦プロジェクト/スクリプト/スクリプト変数の作成

まず始めに、プロジェクトとスクリプトを任意の名前で作成します。また、処理内で使用するスクリプト変数を下記の通り作成します。全て初期値は未設定で作成します。

名前	初期値	変数型
access_token	※未設定※	文字列型
id	※未設定※	文字列型
name	※未設定※	文字列型

⑧GET実行の設定

デザイナ画面右側のツールパレット[ネットワーク]＞[REST]>[GET実行]アイコンを、デザイナ中央部分にドラッグ＆ドロップして設定画面を開きます。

下記の通り設定します。
　　・名前　　：　API実行
　　・接続先　：　REST接続設定 facebook
　　・パス　　：　/me
＜クエリパラメータ＞
　　・名前　　：　access_token
　　・値　　　：　${access_token}

続いて、レスポンス設定タブです。
　　・データ出力先　　：　データ
　　・データ形式　　　：　JSON

青字リンクのJSONファイルを指定して出力スキーマを設定を押下して、JSONファイルによるスキーマ設定をします。ここでは準備したファイルを設定することができます。DataSpiderServerの/data配下のフォルダに、準備したファイルを格納して指定しましょう。

指定するJSONファイルは、各Web APIのサイトページに記載された例をコピーして作成したり、Curlコマンド等でファイルを作成してDataSpiderで読み込みます。

最後に、"API実行"で取得したデータのマッピング設定をします。

デザイナ画面右側のツールパレットメニューから、[変換]＞[基本]＞[マッピング]アイコンを、「GET実行」アイコンの右側にドラッグ＆ドロップします。
「フローの作成」では、「プロセスフローとデータフローを引く」を選択してください。

マッピングアイコンをダブルクリックして、下記の通りマッピングします。

JSONファイルで定義した「name」と「id」を、スクリプト変数として定義した「name」と「id」に線をつなぎましょう。

スクリプトのテスト実行

完成スクリプトです。今回は下記２つのスクリプトを作成しました。

①アクセストークンの取得をするスクリプト

②Facebookの/meノードの情報を取得をするスクリプト

実行順序の注意。必要情報を取得しながら、下記の通り実行します。
　　①認可コードの取得（グローバルリソースを利用）
　　②アクセストークンの取得（スクリプトの実行）
　　③APIの実行（スクリプトの実行）

+++++++++++++++以下、テスト実行です++++++++++++++++++++++++++

テスト実行①認可コードの取得（グローバルリソースの利用）

DataSpider Studioの[コントロールパネル]＞[グローバルリソースの設定]を選択し、冒頭で作成したグローバルリソース（接続先）の設定を開きます。

上記キャプチャ右下にある青字リンク「トークンを発行する」を押下します。

認可コードの設定が表示されますので、青字リンク「認可コード取得…」を押下しましょう。

下記の通り「認可コード」が表示されるので、値をコピーして控えておいてください。

テスト実行②アクセストークンの取得（スクリプトの実行）

「アクセストークンの取得」をするスクリプトを開きます。
スクリプト変数「認可コード」の「初期値」に取得した「認可コード」を設定します。

（該当記事部分の一部抜粋）
・・・処理内で使用するスクリプト変数を下記の通り作成します。

認可コードの設定が完了したら、保存をして、スクリプトのテスト実行します。

DataSpiderのエクスプローラ「data/facebook」を開き、「access_token_response.json」があるかを確認します。

指定したファイルの中身が、下記のようになっていれば成功です。
（※見やすいよう「,」を「,改行」で置換）

「"access_token:"」の後の「”」で括られた文字列がアクセストークンです。コピーして控えておきましょう。

認可コードの有効期限は短いので、認可コードがブラウザに表示されてから、アクセストークンの取得スクリプトを実行するまでの操作は素早く実施しましょう。

認可コードを設定するスクリプトと、スクリプト変数は開いておくといいですね。

テスト実行③APIの実行

本題です。Facebookの/meノードの情報を取得する（API実行の）スクリプトを実行します。
スクリプト変数「access_token」に取得したアクセストークンを設定します。
スクリプトを保存してテスト実行しましょう。

実行ログを確認してみましょう。（ログレベル：INFO）

実行ログ内に「id」と「name」が出力されていたら成功です。

■結果確認について
レスポンスで得られるJSONファイルの出力結果は、「name」のマルチバイト文字がUnicodeエスケープシーケンスに変換された状態のままで確認しづらいので、変数格納して実行ログにて確認しました。

+++++++++++++++ここまでが、テスト実行です++++++++++++++++++++++++++

（ご参考）Facebook 開発者サイトから実行結果の確認について

Facebookの開発者サイトにログインし、グラフAPIエクスプローラーから、APIの確認ができます。その結果と、スクリプト実行の結果を照合してみてもOKです。

スタートガイドにある「最初のリクエスト」の「ステップ1～3」の内、ステップ2の「アクセストークン作成」の操作をスクリプト実行で取得したアクセストークンを設定する手順に置き換えます。

（ご参考）アクセストークンの取得について

OAuth2.0による認可コードを使ったフローでアクセストークンを取得した場合、有効期限は60日間です。有効期間内であれば、「認可コード」と「アクセストークン」の再取得不要です。スコープを変更したい場合や、取得後60日間を経過した場合は、再取得しましょう。

尚、アクセストークンは、「アクセストークンデバッカー」というFacebookの開発者サイト内の機能を使うと状態の確認ができます。

右上の「APIバージョン」を、利用しているバージョンに合わせ、発行したアクセストークンを貼り付けます。「デバック」を押下すると、下記のように、有効期限などの「アクセストークン情報」が表示されます。

表示された一覧の中の対象項目にマウスオーバーすると、下記のように、具体的な日時が分かりやすく表示されます。

最後に

いかがでしたでしょうか。今回はDataSpiderからFacebookのGraph APIを使ってみました。
API操作自体は、情報取得という基本的な操作でしたが、アクセストークン取得を含めたスクリプト作成の方法や、テスト実行の方法などを、ご確認いただけたかと思います。

また今回は、テスト実行時の確認方法として、DataSpiderの「実行ログ」を使ってみました。WebAPIでのレスポンスはJSON形式なことが多いものの、そのままでは解読が難しい場合もあります。読みづらいJSON形式のファイルを操作するのではなく、検証用に必要値を実行ログに出力するスクリプトを作成し、継続的な活用を見越して汎用化するのも良いですね。

ここまで読んでいただきありがとうございました。それでは、また！