Répartitions de l’API Insights

Vous pouvez regrouper les résultats de l’API Insights dans différents ensembles à l’aide des répartitions.

L’API Insights peut renvoyer plusieurs indicateurs dits estimés, en développement, ou les deux. Les valeurs des répartitions d’insights sont estimées. Pour en savoir plus, consultez la page API Insights, indicateurs estimés et abandonnés.

Limites

Champs indisponibles

Vous ne pouvez pas demander les champs suivants lorsque vous spécifiez une répartition :

• app_store_clicks
• newsfeed_avg_position
• newsfeed_clicks
• relevance_score
• newsfeed_impressions

Restrictions pour les indicateurs d’action hors Meta

Les répartitions suivantes ne seront plus disponibles pour les indicateurs d’action hors Meta.

Type 1

• region
• dma
• hourly_stats_aggregated_by_audience_time_zone
• hourly_stats_aggregated_by_advertiser_time_zone

Type 2

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

Règles relatives aux requêtes contenant les répartitions ci-dessus :

• Type 1 : l’API Insights ne renverra pas les indicateurs hors site non pris en charge (par exemple, un indicateur d’action avec des répartitions de type 1).
• Type 2 : l’API continuera de renvoyer les indicateurs Web hors site, mais ils ne contiendront pas la valeur de la répartition. Les indicateurs mobiles ne seront plus renvoyés s’ils sont demandés avec ces répartitions.

Remarque : les répartitions indiquées ci-dessus seront toujours prises en charge pour les indicateurs sur Meta comme les impressions, les clics sur un lien, etc. De même, ces changements n’ont pas d’incidence sur les données d’historique antérieures au 27 avril 2021. Les répartitions pour les données d’historique seront toujours disponibles.

Indicateurs d’action

Les indicateurs ne seront pas disponibles dans les scénarios suivants :

• Tentative d’agrégation portant sur plusieurs paramètres d’attribution
• Lorsqu’ils sont demandés avec les répartitions concernées (cette restriction s’applique uniquement aux types hors Meta et action).

Remarque : les indicateurs seront disponibles si la requête est effectuée avec action_attribution_windows=1d_click,7d_click,1d_view (n’incluant pas la fenêtre par défaut).

Répartitions génériques

Les répartitions suivantes sont disponibles.

Notes

• Le filtrage par app_id et skan_conversion_id à l’aide du champ filtering n’est pas pris en charge pour le moment.
• La répartition par dma n’est pas disponible pour l’indicateur estimated_ad_recall_rate ou pour l’indicateur video_thruplay_watched_actions.
• La répartition par dma utilise une méthodologie d’échantillonnage pour calculer des indicateurs uniques tels que la couverture. Quand il existe un grand nombre de régions DMA avec des volumes relativement faibles, celles-ci peuvent ne pas être représentées dans l’échantillon ou être arrondies à une puissance de 2. C’est pourquoi, il est préférable d’envoyer également une requête pour les impressions correspondantes, pour plus de précision.
• frequency_value est uniquement utilisé avec reach. Pour indiquer à quelle fréquence un utilisateur ou une utilisatrice unique a vu une publicité, par exemple.
• Par défaut, les répartitions image_asset et video_asset ne sont pas disponibles au niveau du compte publicitaire pour les ressources utilisées dans un contenu publicitaire dynamique.
• Les actions publicitaires video_p25_watched_actions, video_p50_watched_actions, video_p75_watched_actions, video_p95_watched_actions et video_p100_watched_actions ne prennent pas en charge la répartition region.
• Toutes les répartitions d’éléments de contenu publicitaire dynamique prennent en charge seulement un ensemble limité d’indicateurs :

L’appel suivant regroupe les résultats par age et 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"

Répartitions par heure

Les statistiques par heure sont désormais disponibles et comprennent les répartitions suivantes :

• hourly_stats_aggregated_by_advertiser_time_zone
• hourly_stats_aggregated_by_audience_time_zone

Consultez la section Combiner des répartitions pour en savoir plus sur les limites concernant le nombre de répartitions que vous pouvez demander dans le cadre de la répartition par heure. Les répartitions par heure ne prennent pas en charge les champs uniques, à savoir tous les champs précédés de unique_*, reach ou frequency. Les champs reach et frequency renvoient zéro dès que les répartitions par heure sont utilisées.

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"

Répartition par action

Regroupez les résultats dans le champ actions. Vous pouvez utiliser les répartitions suivantes pour action_breakdowns :

Il s’agit des répartitions possibles qui peuvent être fournies dans le champ 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

Si le paramètre action_breakdowns n’est pas spécifié, action_type est ajouté implicitement comme action_breakdowns.

Nombre total d’actions

Nombre total (somme) de toutes les valeurs renvoyées dans les résultats du groupe (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

Dans cet exemple, post_engagement est la somme de link_click, comment, like et post_reaction, où post_reaction correspond au nombre total de réactions, y compris de mentions J’aime. Le champ total_actions représente la somme d’actions prioritaires pour un objet, telles que page_engagement, mobile_app_install et app_custom_event.

Combiner des répartitions

En raison de contraintes de stockage, seules certaines permutations de répartitions sont disponibles. Les permutations signalées par un astérisque (*) peuvent être associées à action_type, action_target_id et action_destination, qui correspond au nom de action_target_id.

Limites

• Les champs video_* ne peuvent pas être demandés avec les répartitions de statistiques par heure.
• Le champ video_avg_time_watched_actions ne peut pas être demandé avec la répartition par région.
• action_type est ajouté implicitement comme action_breakdowns lorsque le paramètre action_breakdowns n’est pas spécifié.