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

グラフAPIエクスプローラは、管理者、開発者、およびテスターの役割を持つアプリに対して、グラフAPIクエリを作成して実行し、その応答を表示することができるツールです。

一般的な用途

  • 承認済みのログイン許可機能、Facebookログインなどの追加された製品に対する設定など、ライブアプリ設定に関するAPIクエリのテスト。
  • テストユーザーとテストデータについて、任意のログイン許可機能を使用して開発モードのアプリの設定を問い合わせるAPIクエリのテスト。
  • アクセストークンの即時生成。
  • 実行したクエリのサンプルコードの取得。
  • サポートリクエストに含めるデバッグ情報の生成。

コンポーネント

[アプリ]ドロップダウン

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

[アクセストークン]ドロップダウン

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

[アクセス許可]ドロップダウンによる追加

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

アプリが開発モードになっている場合は、アプリに任意のアクセス許可を付与することができ、クエリはそれらに準拠します。ただし、アプリがライブの場合は、アプリレビュープロセスで承認されていないアクセス許可をアプリに付与すると、送信するたびにクエリが失敗する可能性があります。

[アクセストークン]フィールド

アクセストークンを取得すると、このフィールドに表示されます。これは、グラフAPIクエリに含まれることになるトークンです。

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

[クエリ文字列]フィールド

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

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

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

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

応答ウィンドウ

最後に送信したクエリに対する応答がこのウィンドウに表示されます。

[コードを取得]

クエリが完成したら、[コードを取得]ボタンをクリックして、クエリに基づくサンプルコードを生成します。通常、サンプルコードをコピーして直接コードベースに貼り付けることはできませんが、このサンプルコードを基に開発を開始できます。

[デバッグ情報のコピー]

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

[セッションの保存]

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

ツール(ベータ版)

グラフAPIエクスプローラには、クエリに関する問題を特定し、関連するドキュメントを検索するための2つのツールがあります。Object Visibility Debuggerは、グラフAPIオブジェクトのクエリ要件を判定するのに役立ちます。また、APIドキュメンテーションリゾルバーでは、APIリクエストに関するドキュメントを検索できます。これらを使用するには、左上隅にあるツールアイコンをクリックして、ドロップダウンメニューからツールを選択します。

Object Visibility Debugger(ベータ版)

ユーザーやページの投稿、またはページ動画に対するクエリでエラーが発生した場合、またはオブジェクトに対するクエリの要件を確認したい場合には、[ツール]ドロップダウンメニューから[Object Visibility Debugger]を選択します。アクセストークンと、クエリを実行するオブジェクトのIDを入力します。

ツールには、アクセストークンが満たしている要件と、オブジェクトのクエリを成功させるために追加する必要がある要件が表示されます。

APIドキュメンテーションリゾルバー(ベータ版)

APIに関するドキュメントを検索するには、[ツール]ドロップダウンメニューから[APIドキュメンテーションリゾルバー]を選択します。クエリ文字列(例:{user-id}/feed、ここで、{user-id}はユーザーオブジェクトのID)と、アクセストークンを入力し、[解決]ボタンをクリックします。

そのAPIで使用できるGET、POST、DELETEの各メソッドに関するAPIドキュメントへのリンクが返されます。

サンプルクエリ

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

デフォルトのクエリがクエリ文字列フィールドに表示されるはずです。

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

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

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

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