インスタント記事のインサイト指標
このオブジェクトは、単一のインスタント記事について、そのインスタント記事の正規URLに基づいて、インサイト指標のセットを表します。記事レベルの指標のほか、記事中の個々のメディアアセットの指標もクエリできます。
インスタント記事の詳細については、インスタント記事開発者のドキュメントをご覧ください。
記事インサイト
記事レベルのインサイトをクエリするために使用するエンドポイントは、クエリする記事と検索する指標の正規URLによって定義されます。すべての利用可能な指標を以下にリストします。
GET /v21.0/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url} HTTP/1.1
Host: graph.facebook.com/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->get(
'/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}',
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result *//* make the API call */
FB.api(
"/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];権限
パラメーター
| 名前 | 説明 | 型 | 必須 |
|---|---|---|---|
| インスタント記事の正規URL。 |
|
|
| リクエストする指標。 | 次の利用可能な指標をご覧ください |
|
| 指標の集計期間。 |
|
|
| 考慮する期間の下限。デフォルト値: |
|
|
| 考慮する期間の上限。デフォルト値: |
|
|
| 指標が発生したプラットフォーム(iOSまたはAndroid)別の個々の結果。指定しない場合は、結果には両方のプラットフォームが含まれます。 |
|
|
フィールド
このエッジから読み取ると、JSON形式の結果が返されます。
{
"data": []
}data
InsightsQueryResultオブジェクトのリスト。返される各オブジェクトに次のフィールドが追加されます。
| 名前 | 説明 | 型 |
|---|---|---|
time | 期間の開始時間、または通算期間の終了時間。 | datetime |
value | 指標の期間中での、カウント、平均、割合(パーセント)。 | numeric |
breakdowns | 値が属するバケット( all_view_durations指標が使用されているか breakdown(platform)パラメーターが明示的に指定されている場合)。 | map<string, string> |
利用できる指標
さまざまな指標に利用可能な集計期間を次に示します。指標はiOSとAndroidデバイスの両方から収集されます。
| 名前 | 説明 | 期間の値 |
|---|---|---|
| 閲覧数 |
|
| 閲覧期間、内訳付き |
|
| 平均閲覧期間 |
|
| スクロールの深さの内訳 |
|
| スクロールの深さの平均 |
|
例
過去7日間の記事閲覧数(日単位)
いずれか1つのインスタント記事の過去7日間の閲覧数(日単位)の内訳をクエリするには、次のGETリクエストを発行します。
GET /v21.0/?fields=instant_article{insights.metric(all_views).period(day).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.comこのリクエストには、次のような応答が返されます。
{
"instant_article": {
"insights": {
"data": [
{
"time": "2015-10-28T08:00:00+0000",
"value": "3"
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "3"
},
{
"time": "2015-10-30T08:00:00+0000",
"value": "3"
},
{
"time": "2015-10-31T08:00:00+0000",
"value": "3"
},
{
"time": "2015-11-01T08:00:00+0000",
"value": "2"
},
{
"time": "2015-11-02T08:00:00+0000",
"value": "6"
},
{
"time": "2015-11-03T08:00:00+0000",
"value": "4"
}
]
},
"id": "<article-id>"
},
"id": "http://www.example.com/my-test-page.com"
}過去7日間の記事閲覧数(日単位)、プラットフォームの内訳付き
特定のインスタント記事の過去7日間の閲覧数(日単位)の内訳を、さらにその記事が閲覧されたプラットフォームごとに分類するには、次のGETリクエストを発行します。
GET /v21.0/?fields=instant_article{insights.metric(all_views).breakdown(platform).period(day).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.comこのリクエストには、次のような応答が返されます。
{
"instant_article": {
"insights": {
"data": [
{
"time": "2015-10-28T08:00:00+0000",
"value": "1",
"breakdowns": {
"platform": "ANDROID"
}
},
{
"time": "2015-10-28T08:00:00+0000",
"value": "2",
"breakdowns": {
"platform": "IOS"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"platform": "ANDROID"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "2",
"breakdowns": {
"platform": "IOS"
}
},
{
"time": "2015-10-30T08:00:00+0000",
"value": "1",
"breakdowns": {
"platform": "ANDROID"
}
},
{
"time": "2015-10-30T08:00:00+0000",
"value": "2",
"breakdowns": {
"platform": "IOS"
}
}
]
},
"id": "<article-id>"
},
"id": "http://www.example.com/my-test-page.com"
}過去7日間の記事閲覧数(週単位)
特定のインスタント記事の過去7日間のバケットにまとめられた閲覧期間(週単位)の内訳をクエリするには、次のGETリクエストを発行します。
GET /v21.0/?fields=instant_article{insights.metric(all_view_durations).period(week).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.comこのリクエストには、次のような応答が返されます。この応答で返されるデータは、次のようにバケットにまとめられています。
{
"instant_article": {
"insights": {
"data": [
{
"time": "2015-10-29T08:00:00+0000",
"value": "8",
"breakdowns": {
"bucket": "15"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "2",
"breakdowns": {
"bucket": "225"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "2",
"breakdowns": {
"bucket": "90"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "360"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "240"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "165"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "120"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "75"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "60"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "45"
}
},
{
"time": "2015-10-29T08:00:00+0000",
"value": "1",
"breakdowns": {
"bucket": "30"
}
}
]
},
"id": "<article-id>"
},
"id": "http://www.example.com/my-test-page.com"
}