本記事では、FacebookのAPIを利用されている方の役に立つ…かもしれない、APIと管理画面の項目照合表を作りました。
【注意点！】 調査は人力で行っており、正確な答え合わせはFacebook社にしかできないため、参考程度にご覧ください。
※本記事の内容は2019年5月現在の情報です。最新の設定方法や画面と異なる場合があります。
Facebook の API について
Facebookが公開しているAPIにはグラフAPIやページAPIといったものがあり、その種類はさまざまです。コンテンツ投稿などのFacebookへのデータ送信、いいね！数の確認などのデータ取得と、APIによってできることは異なります。
弊社では、管理画面にログインしなくてもFacebook広告の配信結果を取得できるシステムで「インサイトAPI」を利用しています。この「インサイトAPI」は「マーケティングAPI」というAPIの一部に分類されています。こういったAPI群の大元になるのが「グラフAPI」で、FacebookのAPIはすべてグラフAPIの拡張版なのです。
参考： グラフAPI
（ややこしくて困りますが）さまざまなことができるのでわくわくしますよね！
インサイトAPIでできること
この API では Facebook 広告アカウントが管理しているキャンペーンの情報や広告配信結果、それらに関連する情報を取得できます。
Facebook 広告運用の経験がある方ならおわかりかと思いますが、広告マネージャーの画面で指標や各数値を確認したり、ダウンロードしてきたりするのは結構手間がかかります。APIがあればこういったものをブラウザを使わず取得できるのです。うまく使えば時短になりますし、システムに組み込んで高度な分析にも活用可能です。
クリック数やコストの値は、インサイトAPIの「フィールド」に格納されます。しかしAPIは便利な半面なかなかの曲者で、管理画面で見えているとおりの名前ではデータをくれません。
そこで今回のような照合表を作ってみました。
FacebookインサイトAPI：フィールドの照合表
本記事の内容は2019/05/20時点での下記ページを参考にしています。
インサイト：パラメーターとフィールド
繰り返しますが、人力の調査のもと作成したものになり、Facebook側の仕様変更で内容が変わる可能性がありますので、最新情報は公式ドキュメントをご覧ください！
※管理画面上で見つからないものは「？」としています。
※型情報 s: string, ns: numeric string, AAS: AdsActionStats, AgRS: AdgroupRelevanceScore
| 管理画面名称 | フィールド名 | 型 | 備考 |
|---|---|---|---|
| ？（広告アカウントで使用されている通貨） | account_currency | s | |
| アカウントID | account_id | ns | |
| アカウント名 | account_name | s | |
| ？ | action_values | list（AAS） | |
| ？ | actions | list（AAS） | |
| 広告ID | ad_id | ns | |
| 広告の名前 | ad_name | s | |
| 広告セットID | adset_id | ns | |
| 広告セット名 | adset_name | s | |
| ？ | app_store_clicks | ns | |
| 購入タイプ | buying_type | s | |
| キャンペーンID | campaign_id | ns | |
| キャンペーン名 | campaign_name | s | |
| インスタントエクスペリエンスの閲覧率 | canvas_avg_view_percent | ns | |
| インスタントエクスペリエンスの閲覧時間 | canvas_avg_view_time | ns | |
| クリック（すべて） | clicks | ns | |
| 動画10秒再生の単価 | cost_per_10_sec_video_view | list（AAS） | |
| ？ | cost_per_action_type | list（AAS） | |
| 推定広告想起リフトの単価（人） | cost_per_estimated_ad_recallers | ns | 開発中の指標 |
| CPC（リンククリックの単価） | cost_per_inline_link_click | ns | |
| ？ | cost_per_inline_post_engagement | ns | |
| アウトバウンドクリックの単価 | cost_per_outbound_click | list（AAS） | |
| ThruPlayの単価 | cost_per_thruplay | list（AAS） | 開発中の指標 |
| ？ | cost_per_unique_action_type | list（AAS） | |
| ユニーククリック単価（すべて） | cost_per_unique_click | ns | |
| リンククリックの単価（ユニーク） | cost_per_unique_inline_link_click | ns | |
| ユニークアウトバウンドクリックの単価 | cost_per_unique_outbound_click | list（AAS） | |
| CPC（すべて） | cpc | ns | |
| CPM（インプレッション単価） | cpm | ns | |
| リーチ1,000人あたりの単価 | cpp | ns | |
| CTR（すべて） | ctr | ns | |
| レポート開始日 | date_start | s | |
| レポート終了日 | date_stop | s | |
| ？ | deeplink_clicks | ns | |
| ？ | estimated_ad_recall_rate | ns | |
| ？ | estimated_ad_recallers | ns | 開発中の指標 |
| フリークエンシー | frequency | ns | |
| インプレッション | impressions | ns | |
| CTR（リンククリックスルー率） | inline_link_click_ctr | ns | |
| リンクのクリック | inline_link_clicks | ns | |
| 投稿のエンゲージメント | inline_post_engagement | ns | |
| モバイルアプリでの購入ROAS（広告費用対効果） | mobile_app_purchase_roas | list（AAS） | 廃止予定 |
| ？ | newsfeed_avg_position | ns | |
| ？ | newsfeed_clicks | ns | |
| ？ | newsfeed_impressions | ns | |
| 広告の目的 | objective | s | |
| アウトバウンドクリック | outbound_clicks | list（AAS） | |
| アウトバウンドCTR（クリック率） | outbound_clicks_ctr | list（AAS） | |
| 購入ROAS（広告費用対効果） | purchase_roas | list（AAS） | |
| リーチ | reach | ns | |
| 関連度スコア | relevance_score | AgRS | 廃止予定 |
| ？ | social_spend | ns | |
| 消化金額 | spend | ns | |
| ？ | unique_actions | list（AAS） | |
| ユニーククリック（すべて） | unique_clicks | ns | |
| ユニークCTR（すべて） | unique_ctr | ns | |
| ？ | unique_impressions | ns | |
| ユニークCTR（リンククリックスルー率） | unique_inline_link_click_ctr | ns | |
| リンククリック（ユニーク） | unique_inline_link_clicks | ns | |
| ユニークCTR（リンククリックスルー率） | unique_link_clicks_ctr | ns | |
| ユニークアウトバウンドクリック | unique_outbound_clicks | list（AAS） | |
| ユニークアウトバウンドCTR（クリック率） | unique_outbound_clicks_ctr | list（AAS） | |
| 動画の10秒再生数 | video_10_sec_watched_actions | list（AAS） | |
| ？ | video_30_sec_watched_actions | list（AAS） | |
| ？ | video_avg_percent_watched_actions | list（AAS） | |
| 動画の平均再生時間 | video_avg_time_watched_actions | list（AAS） | |
| ？ | video_complete_watched_actions | list（AAS） | |
| 動画の100％再生数 | video_p100_watched_actions | list（AAS） | |
| 動画の95％再生数 | video_p95_watched_actions | list（AAS） | |
| 動画の75％再生数 | video_p75_watched_actions | list（AAS） | |
| 動画の50％再生数 | video_p50_watched_actions | list（AAS） | |
| 動画の25％再生数 | video_p25_watched_actions | list（AAS） | |
| 動画再生数 | video_play_actions | list（AAS） | 開発中の指標 |
| ？ | video_play_curve_actions | list（AAS） | |
| ThruPlay | video_thruplay_watched_actions | list（AAS） | |
| ？ | website_clicks | ns | |
| ？ | website_ctr | list（AAS） | |
| ？ | website_purchase_roas | list（AAS） |
実際にはフィールドとさまざまなもの（データの対象範囲など）を組み合わせたうえでFacebookにデータを要求する必要があるのですが、まずはどの指標のことを指しているのか把握するとAPIの理解がしやすいかもしれません。
APIで広告データを自動取得するシステム「HARBEST」
今回紹介したAPIを利用して、弊社ではマーケティングデータETLツール「HARBEST（ハーベスト）」を開発しています。
HARBESTはFacebookだけでなくさまざまなプラットフォームからデータを自動取得し、Amazon S3などに出力することができます！
広告やSNSの分析においては、まず分析のためのデータを手元に集める作業が必要ですが、想像以上にコストがかかってしまいお悩みの方も多いのではないでしょうか。そういったデータ収集コストの削減にHARBESTがお役に立てると思います！
まだ正式提供前となっていますが、この度公式サイトをオープンしました。ご興味のある方はぜひご覧になってください。お問合せもお待ちしております！