グラフAPIエクスプローラガイド

一般的な用途

• アクセストークンの即時生成
• クエリに使用するコードサンプルの取得
• サポートリクエストに含めるデバッグ情報の生成
• 本番アプリの設定(アクセス許可、機能、ユースケースの設定など)を使用したAPIクエリのテスト
• テストユーザーやテストデータのアクセス許可と機能を使用した、テストアプリや開発アプリによるAPIクエリのテスト

要件

• Facebook開発者アカウント
• あなたが役割(管理者、開発者、テスター)を持っているアプリ

構成要素

アクセストークン

アクセストークンを取得すると、それがツールの右上に表示されます。このトークンが、グラフAPIクエリに含められます。このトークンをコピーして、アプリでコードをテストするために使用することができます。

情報アイコンをクリックして、現在のトークンに関する情報を表示できます。この情報には、関連付けられたアプリ、アプリを使用しているユーザー(あなた)から付与されたアクセス許可が含まれます。

トークンの期限が切れた場合やアクセス許可を新規追加した場合に、新しいアクセストークンを生成することができます。

Metaアプリ

右上にある[Metaアプリ]ドロップダウンメニューには、あなたが管理者役割、開発者役割、またはテスター役割を保持しているすべてのアプリが表示されます。このドロップダウンを使用して、テストするアプリ設定を選択します。

ユーザーまたはページ

[ユーザーまたはページ]ドロップダウンメニューを使用すれば、アプリ、ユーザー、および現在選択されているアプリのページアクセストークンを取得して交換することができます。このメニューを使用して、アプリをユーザーノードからアンインストールすることもできます。そうすると、現在のアクセストークンが破棄されます。

アクセス許可

ユーザーアクセストークンをリクエストすると、デフォルトではpublic_profileのアクセス許可のみが与えられます。[アクセス許可]ドロップダウンメニューで、ユーザーデータアクセス許可(emailやuser_photosなど)、イベント/グループ/ページアクセス許可(manage_pagesやads_managementなど)、その他のアクセス許可(instagram_basicやpublish_videoなど)を選択できます。これにより、現在のアプリユーザー(あなた)は、アプリ固有のアクセス許可を付与することができます。アプリが実際に必要としているアクセス許可だけを付与してください。

開発中のアプリには、任意のアクセス許可を与えることができます。クエリはそのアクセス許可に応じて、アプリに対して役割を持っている人が所有するデータを取得します。ただし、本番稼働のアプリの場合は、アプリレビュープロセスで承認されていないアクセス許可をアプリに付与すると、クエリを送信するたびに失敗します。

クエリ文字列フィールド

ツールに最初に入力すると、デフォルトのクエリが表示されます。クエリの編集は、新しいクエリを入力するか、クエリの実行後にフィールドビューアーでフィールドを探して選択することによってできます。また、ドロップダウンメニューを使用して、演算方式を切り替えたり、グラフAPIの別のバージョンをターゲットに設定したりすることもできます。

クエリフィールドの端にあるスターアイコンをクリックすると、お気に入りとして保存されます。お気に入りのクエリを表示するには、本アイコンをクリックします。

ノードフィールドビューアー

ノードに対してGETクエリを送信すると、ウィンドウの左側にあるフィールドビューアーに、ノードの名前とグラフAPIから返されたフィールドが表示されます。クエリを変更するには、新しいフィールドを探して選択し、プラスアイコンをクリックして、使用可能なフィールドから選択するか、不要なフィールドを選択解除します。これらのアクションにより、クエリ文字列フィールド内のクエリが動的にアップデートされます。

応答ウィンドウ

クエリ文字列の下にある応答は、前回送信したクエリから返された結果を示します。

コードを取得

クエリが完成したら、応答の下の中央下部にある[コードを取得]ボタンをクリックして、そのクエリをベースにしたサンプルコードを生成します。通常、サンプルコードをコピーして直接コードベースに貼り付けることはできませんが、開始点として使用するには便利です。

デバッグ情報のコピー

クエリが失敗を繰り返し、その理由が特定できず、開発者サポートに問い合わせることにした場合は、中央下部にあるこのボタンをクリックしてクエリと応答の詳細をクリップボードにコピーします。この情報をサポートリクエストと一緒に送信することで、Metaでの原因の究明に役立ちます。

セッションの保存

アクセストークンが削除されたクエリの状態を保存するには、中央下部にある[セッションの保存]ボタンをクリックします。開発者サポートに問い合わせることにした場合は、このセッションへのリンクを含めてください。

サンプルクエリ

グラフAPIエクスプローラを初めて起動したときに表示されるデフォルトクエリを実行してみてください。まだ実行していない場合は、新しいウィンドウでグラフAPIエクスプローラを開いて、[アプリ]ドロップダウンメニューからテストするアプリを選択し、ユーザーアクセストークンを取得します。

次のように、デフォルトクエリがクエリ文字列フィールドに表示されます。

GET https://developers.facebook.com/v21.0/me?fields=id,name

デフォルトクエリは、/meノード上のidフィールドとnameフィールドをリクエストします。このノードは、トークンによって識別される/Userノードまたは/Pageノードのいずれかにマップされる特別なノードです。この場合は、ユーザーアクセストークンを使用しているため、ユーザーノードにマップします。

idフィールドとnameフィールドは公開されているため、ユーザーがアプリにdefaultまたはpublic_profileのアクセス許可を付与していれば、返すことができます。これらのアクセス許可は、すべてのアプリに対して事前に承認されているため(アクセストークンフィールドで情報アイコンをクリックすると確認できます)、クエリを実行するために新たなアクセス許可をアプリに付与する必要はありません。[アクセストークンを取得]をクリックして、公開されているユーザー情報へのアクセス許可をアプリに付与することを確認してください。

クエリを送信します。応答ウィンドウにapp-scoped user IDと名前が表示されるはずです。