API de plateforme numérique - Rapport d’engagement de l’acheteur

2025-04-01

Le rapport d’engagement de l’acheteur vous donne un aperçu de la durée visible de vos créations vidéo et d’affichage.

Pour obtenir des instructions sur la récupération d’un rapport, consultez Service de rapports ou l’exemple ci-dessous.

Période

Le report_interval champ dans la requête JSON peut être défini sur l’une des valeurs suivantes :

Personnalisé
yesterday
last_7_days
last_14_days
month_to_yesterday
last_30_days

Période de conservation des données

Les données de ce rapport ont une granularité de temps quotidienne et sont conservées pendant cinq semaines. Ce rapport affiche également les données sous le fuseau horaire UTC/GMT.

Remarque

Pour exécuter un rapport pour une période personnalisée, définissez les start_date champs et end_date dans votre demande de rapport. Pour plus d’informations sur ces champs, consultez Service de rapports.

Dimensions

Column	Type	Filtre?	Exemple	Description
`advertiser_id`	int	Oui	`3`	L’ID de l’annonceur dont la création a été servie
`advertiser_name`	string	Non	`"Advertiser"`	Nom de l’annonceur dont la création a été servie
`buyer_member_id`	int	Oui	`210`	ID de membre de l’acheteur
`campaign_id`	int	Oui	`728`	ID de la campagne (ne s’applique pas à tous les annonceurs)
`campaign_name`	string	Non	`"Test"`	Nom du créateur (ne s’applique pas à tous les annonceurs)
`creative_id`	int	Oui	554	ID du créatif qui a servi. - Pour les impressions de plus de 14 mois, les éléments créatifs sont regroupés en une seule ligne avec 0 comme ID créatif. Remarque : pour les suivis de clic ou d’impression externes, `creative_id` sera `"External Clicks"` ou `"External Imps"`.
`creative_name`	string	Non	`"Q1 2010 728x90"`	Nom du créatif qui a servi - Pour les impressions datant de plus de 14 mois, les éléments créatifs sont regroupés en une ligne avec « Toutes les données créatives antérieures à 14 mois » comme nom créatif. Remarque : pour les suivis de clic ou d’impression externes, `creative_name` sera `"External Clicks"` ou `"External Imps"`.
`day`	date	Oui	`"2012-08-23"`	Le jour où l’impression s’est produite
`deal_id`	int	Oui	`2345`	ID de la transaction à laquelle l’impression servie est associée. - Pour plus d’informations sur les transactions que vous avez négociées avec les vendeurs, consultez Deal Buyer Access Service.
`deal_name`	string	Non	`"Private deal for buyer 1085 with floor of $2.50"`	Nom de la transaction à laquelle l’impression servie est associée
`device_type`	string	Oui	`"Mobile Phones"`	Type d’appareil où l’impression s’est produite : - `Desktops & Laptops` - `Tablets` - `Mobile Phones` - `TV` - `Game Consoles` - `Set Top Box` - `Media Players` - `Other Devices`
`domain`	string	Non	`"bestsiteever.com (1536)"`	URL et ID du domaine sur lequel l’impression s’est produite
`domain_id`	int	Non	`1536`	ID du domaine sur lequel l’impression s’est produite
`domain_name`	string	Non	`"bestsiteever.com"`	URL du domaine sur lequel l’impression s’est produite
`imp_type`	string	Oui	`"External Impression"`	Type d’impression qui a servi. Pour connaître les valeurs possibles, consultez `imp_type_id`.
`imp_type_id`	int	Oui	`3`	ID du type d’impression servi (types associés entre parenthèses) : - `1 ("Blank")`: Aucune créativité servie - `2 ("PSA")`: Une annonce de service public a été effectuée parce qu’il n’y avait pas d’enchères valides et qu’aucune création par défaut n’était disponible - `3 ("Default Error")`: une créativité par défaut servie en raison d’un problème de délai d’expiration - `4 ("Default")`: création par défaut servie car il n’y avait pas d’enchères valides - `5 ("Kept")`: la créativité de votre annonceur servie sur le site de votre éditeur - `6 ("Resold")`: l’impression de votre éditeur a été vendue à un acheteur tiers - `7 ("RTB")`: la créativité de votre annonceur servie sur l’inventaire tiers - `8 ("PSA Error")`: une annonce de service public a été effectuée en raison d’un problème de délai d’expiration ou d’un manque de créativité par défaut - `9 ("External Impression")`: une impression provenant d’un suivi d’impression - `10 ("External Click")`: un clic à partir d’un dispositif de suivi des clics - `11 ("Insertion")`: votre créativité a servi sur l’inventaire tiers, où il persiste entre les chargements de pages et les sessions. Ce type d’impression est actuellement réservé aux créateurs Facebook flux d’actualités.
`insertion_order_id`	int	Non	`648359`	ID de l’ordre d’insertion
`insertion_order_name`	string	Non	`"InsertionOrderABC"`	Nom de l’ordre d’insertion
`line_item_id`	int	Oui	`947764`	ID de l’élément de ligne qui a servi l’impression
`line_item_name`	string	Non	`"LineItemDEF"`	Nom de l’élément de ligne qui a servi à l’impression
`media_type`	string	Non	`"Banner"`	Le style d’affichage général du créatif qui a servi : - `Banner` - `Interstitial` - `Video` - `Text` - `Expandable` - `Skin` - `Facebook`
`mediatype_id`	int	Oui	`2`	ID du type de média qui a servi
`placement_id`	int	Oui	`546`	ID du placement où le créatif a été servi
`placement_name`	string	Non	`"300x250 Business"`	Nom du placement dans lequel le créatif a été servi
`publisher_id`	int	Oui	`374967`	ID de l’éditeur propriétaire de l’inventaire
`publisher_name`	string	Non	`"Publisher XYZ"`	Nom de l’éditeur propriétaire de l’inventaire
`seller_member_id`	int	Oui	`765`	ID de membre du vendeur qui a vendu l’impression
`seller_member_name`	string	Non	`"AdMeld"`	Nom du vendeur qui a vendu l’impression.
`size`	string	Oui	`"728x90"`	La taille du créatif qui a été servi
`split_id`	int	Oui	`342`	ID du fractionnement qui a acheté les impressions dans ce jeu de données. Les fractionnements s’appliquent uniquement aux éléments de ligne augmentée. Pour tous les rapports qui contiennent des campagnes, le (s’il `split_id` est inclus) est `null` .
`split_name`	string	Non	`"Mobile Split A"`	Nom du fractionnement qui a acheté les impressions dans ce jeu de données. Les fractionnements s’appliquent uniquement aux éléments de ligne augmentée. Pour tous les rapports qui contiennent des campagnes, le (s’il `split_name` est inclus) est `null` .
`supply_type`	string	Oui	`"mobile_web"`	Type d’approvisionnement (inventaire) sur lequel l’impression s’est produite : - `Web` - `Mobile Web` - `Mobile App`

Mesures

Column	Type	Exemple	Formule	Description
`average_viewable_duration`	Secondes	`132297`	Durée d’affichage moyenne = Durée totale visible / Imps visibles	Nombre moyen de secondes pendant lesquelles le créatif était en vue selon les critères de visibilité IAB
`clicks`	int	`132297`	S/O	Nombre total de clics de votre élément de ligne
`ctr`	double	`0.00067472306143`	S/O	Taux de clics : ratio de clics par rapport aux impressions, exprimé sous forme de pourcentage
`imps`	int	`11080000`	S/O	Nombre total d’impressions de votre élément de ligne
`total_viewable_duration`	Secondes	`152.4298`	S/O	Nombre total de secondes pendant lesquelles le créatif était en vue selon les critères de visibilité IAB
`video_completion_rate`	double	`0.0084979838709677`	Taux de saisie semi-automatique de la vidéo = Saisie semi-automatique / Impressions totales	Le rapport entre les saisies vidéo et le nombre total d’impressions, exprimé sous forme de pourcentage
`video_completions`	int	`10`	S/O	Nombre total de vidéos créatives lues pendant toute leur durée
`view_measurable_imps`	int	`11080000`	S/O	Nombre total d’impressions mesurées pour la visibilité
`view_measurable_rate`	double	`0.00067472306143`	Taux de mesure de la visibilité = Afficher les imps mesurables / imps	Pourcentage d’impressions mesurées pour la visibilité sur le nombre total d’impressions
`view_rate`	double	`0.00067472306143`	Taux de visibilité = Imps consultés / Afficher des impos mesurables	Pourcentage d’impressions visibles par rapport au nombre total d’impressions mesurées pour la visibilité
`viewable_completion_rate`	double	`0.0084979838709677`	Taux d’achèvement visible = Impressions vidéo visibles et terminées / Impressions vidéo mesurables	Le rapport entre les saisies vidéo en mode affichage et le nombre total d’impressions, exprimé sous forme de pourcentage
`viewdef_view_rate`	double	`0.00067472306143`	S/O	Pourcentage d’impressions qui étaient visibles, selon la configuration de définition personnalisée au niveau du membre, sur le nombre total d’impressions mesurées pour la visibilité
`viewdef_viewed_imps`	int	`5.678014273984716`	S/O	Nombre d’impressions mesurées qui étaient visibles, en fonction de la configuration de définition personnalisée au niveau du membre (pour plus d’informations, contactez votre représentant de compte Xandr)
`viewed_imps`	int	`51.47677411571988`	S/O	Nombre total d’impressions jugées visibles selon la définition de l’Interactive Advertising Bureau (IAB) : Pendant au moins une seconde, 50 % des pixels d’un créateur (ou 30 % pour un créatif avec au moins 242 500 pixels) doivent être visibles par une visionneuse sur son écran.

Exemple

Create la demande de rapport au format JSON

Le fichier JSON doit inclure le report_type"engagement_report_for_buyers", ainsi que les colonnes (dimensions et métriques) et report_interval que vous souhaitez récupérer. Vous pouvez également filtrer des dimensions spécifiques, définir la granularité (année, mois, jour) et spécifier le format dans lequel les données doivent être retournées (csv, excel ou html). Pour obtenir une explication complète des champs qui peuvent être inclus dans le fichier JSON, consultez Service de rapports.

$ cat engagement_report_for_buyers
  {
    "report":
    {
        "report_type":"engagement_report_for_buyers",
        "columns":[
            "line_item_id",
            "line_item_name",
            "creative_name",
            "viewable_completion_rate",
            "average_viewable_duration",
            "ctr",
            "clicks",
            "imps"
        ],
        "report_interval":"last_7_days",
        "format":"csv"
    }
}

`POST` la demande au service de création de rapports

$ curl -b cookies -c cookies -X POST -d @engagement_report_for_buyers 'https://api.appnexus.com/report'
{
   "response":{
      "status":"OK",
      "report_id":"097f59fc3ab7d02c5d60db42081d9b69"
   }
}

`GET`le rapport status à partir du service de rapports

Effectuez un GET appel avec l’ID de rapport pour récupérer les status du rapport. Continuez à effectuer cet GET appel jusqu’à ce que soit execution_status"ready". Utilisez ensuite le service de téléchargement de rapports pour enregistrer les données du rapport dans un fichier, comme décrit à l’étape suivante.

$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=097f59fc3ab7d02c5d60db42081d9b69'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2021-05-25 19:19:53",
         "json_request":"{\"report\":{\"report_type\":\"engagement_report_for_buyerss\",\"columns\":[\"line_item_id\",
            \"line_item_name\",\"creative_name\",\"viewable_completion_rate\",\"average_viewable_duration\",\"ctr\",\"clicks\",\"imps\"],
            \"report_interval\":\"last_7_days\"}}",
         "url": "report-download?id=b97897a7864dd8f34e7457226c7af592"
      },
      "execution_status":"ready"
   }
}

`GET` les données de rapport du service de téléchargement de rapports

Pour télécharger les données du rapport dans un fichier, effectuez un autre GET appel avec l’ID de rapport, mais cette fois au service de téléchargement de rapports . Vous trouverez le service et l’ID de rapport dans le url champ de la réponse précédente GET . Lorsque vous identifiez le fichier dans lequel vous souhaitez enregistrer, veillez à utiliser l’extension de fichier du "format" que vous avez spécifié dans votre initial POST.

Remarque

Si une erreur se produit pendant le téléchargement, l’en-tête de réponse inclut un code d’erreur HTTP et un message. Utilisez -i ou -v dans votre appel pour exposer l’en-tête de réponse.

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/engagement_report_for_buyers.csv

Partager via