インサイトAPIの内訳

内訳を使用して、インサイトAPIの結果をさまざまなセットにグループ化できます。

インサイトAPIは、推定値の指標と開発中の指標のいずれかまたは両方を複数返すことができます。インサイトの内訳の値は、推定値です。詳しくは、インサイトAPIの推定指標と廃止された指標をご覧ください。

制限

利用不可のフィールド

内訳を指定する際に、以下のフィールドはリクエストできません

• app_store_clicks
• newsfeed_avg_position
• newsfeed_clicks
• relevance_score
• newsfeed_impressions

Meta外のアクション指標に関する制限

以下の内訳は、Meta外のアクション指標では利用できなくなります。

タイプ1

• region
• dma
• hourly_stats_aggregated_by_audience_time_zone
• hourly_stats_aggregated_by_advertiser_time_zone

タイプ2

• action_device
• action_destination
• action_target_id
• product_id
• action_carousel_card_id/action_carousel_card_name
• action_canvas_component_name

上記の内訳を含むクエリに関するルール:

• タイプ1 — サポートされていないオフサイト指標が含まれている場合(例: タイプ1の内訳のアクション指標)、インサイトAPIはその指標を返しません。
• タイプ2 — 引き続きAPIからオフサイトウェブ指標は返されますが、内訳の値は含められません。これらの内訳を指定してクエリを実行しても、モバイル指標は返されません。

注: 上記の内訳は、インプレッションやリンククリックなどのMetaでの指標では引き続きサポートされます。また、この変更は、2021年4月27日より前の履歴データには影響しません。履歴データの内訳は引き続き利用できます。

アクション指標

次のシナリオでは、指標は使用できません。

• 複数のアトリビューション設定で試行された集計が存在する場合
• 影響を受ける内訳が指定されてリクエストされた場合(この制限は、Meta外の指標とアクションタイプにのみ適用されます)。

注:action_attribution_windows=1d_click,7d_click,1d_view (デフォルトウィンドウを含まない)でクエリを実行すると、指標が使用可能になります。

一般的な内訳

次の内訳を使用できます。

注

• filteringフィールドを使用したapp_idとskan_conversion_idのフィルタリングは、現在サポートされていません。
• estimated_ad_recall_rate指標またはvideo_thruplay_watched_actions指標には、dmaの内訳を利用できません。
• dmaの内訳では、リーチなどのユニークな指標を計算するために、サンプリング手法を採用しています。比較的低い数値のDMA地域が多数あるケースでは、これらの地域がサンプルに反映されないか、2のべき乗まで切り上げられる可能性があります。より精度を上げるため、対応するインプレッションも同様にクエリすることをおすすめします。
• frequency_valueと併用できるのは、reachだけです。例えば、ユニークユーザーがある広告を見る頻度などを指定します。
• ダイナミッククリエイティブで使用されるアセットの広告アカウントレベルでは、設計上、image_asset内訳とvideo_asset内訳は使用できません。
• 広告アクションvideo_p25_watched_actions、video_p50_watched_actions、video_p75_watched_actions、video_p95_watched_actions、video_p100_watched_actionsは、region内訳をサポートしていません。
• ダイナミッククリエイティブアセットの内訳はどれも、一部の指標だけをサポートしています。

次の呼び出しを行うと、結果がageとgenderにグループ化されます。

curl -G \
  -d "breakdowns=age,gender" \
  -d "fields=impressions" \
  -d "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<AD_CAMPAIGN_ID>/insights"

1時間ごとの内訳

次の内訳を使用して、1時間ごとの統計を利用できるようになりました。

• hourly_stats_aggregated_by_advertiser_time_zone
• hourly_stats_aggregated_by_audience_time_zone

1時間ごとの内訳でリクエストできる内訳数の制限については、内訳の組み合わせをご覧ください。1時間ごとの内訳は、先頭にunique_*、reach、frequencyのいずれかが付加されたユニークなフィールドには対応していません。1時間ごとの内訳を使用すると、reachフィールドとfrequencyフィールドは0を返します。

curl -G \
-d "fields=impressions" \
-d "breakdowns=hourly_stats_aggregated_by_audience_time_zone" \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<AD_CAMPAIGN_ID>/insights"

アクションの内訳

actionsフィールドの結果をグループ化します。action_breakdownsには次の内訳を使用できます。

action_breakdownsフィールドに入る可能性がある内訳は、以下のとおりです。

• action_device
• conversion_destination
• matched_persona_id
• matched_persona_name
• signal_source_bucket
• standard_event_content_type
• action_canvas_component_name
• action_carousel_card_id
• action_carousel_card_name
• action_destination
• action_reaction
• action_target_id
• action_type
• action_video_sound
• action_video_type

action_breakdownsパラメーターを指定しない場合、action_breakdownsとしてaction_typeが暗黙で追加されます。

actionsの合計数

すべての値の合計カウント(sum)がグループ結果で返されます(actions)。

total_actions - 33
    page_engagement - 10
        post_engagement - 10
            link_click - 2
            comment - 3
            post_reaction - 3
            like - 2
    mobile_app_install - 12
    app_custom_event - 11
        app_custom_event.fb_mobile_activate_app - 6
        app_custom_event.other - 5

この例では、post_engagementは、link_click、comment、like、post_reactionの合計で、post_reactionは「いいね！」を含むすべてのリアクションの数です。total_actionsフィールドは、page_engagement、mobile_app_install、app_custom_eventなど、オブジェクトのトップレベルのアクションの合計を表します。

内訳の組み合わせ

保存容量の制限により、内訳には一部のパーミュテーションのみを使用できます。アスタリスク(*)の付いたパーミュテーションは、action_type、action_target_id、action_destination(action_target_idの名前)と組み合わせることができます。

制限

• 1時間ごとの統計内訳では、video_*フィールドはリクエストできません。
• 地域内訳では、video_avg_time_watched_actionsフィールドはリクエストできません。
• action_breakdownsパラメーターが指定されないときは、action_breakdownsとしてaction_typeが暗黙で追加されます。