API de plateforme numérique - Publisher Analytics

Le rapport Publisher Analytics peut être utilisé pour afficher les données de revenus et de bénéfices sur les sites et les placements d’un éditeur spécifique. Ce rapport est disponible pour les utilisateurs du réseau et de l’éditeur.

Pour obtenir des instructions sur la récupération d’un rapport, consultez le service de rapports ou les exemples ci-dessous. Ce rapport nécessite qu’un ID d’éditeur soit spécifié dans le cadre de l’URL comme suit :

https://api.appnexus.com/report?publisher_id=PUBLISHER_ID

Période

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

current_hour
last_hour
aujourd’hui
yesterday
last_48_hours
last_7_days
last_30_days
month_to_date
month_to_yesterday
quarter_to_date
last_month
Vie

Période de conservation des données

La plupart des données de ce rapport sont conservées de manière permanente (exceptions indiquées ci-dessous). Après:

100 jours, vous ne pouvez plus générer de rapports sur les données horaires. Toutefois, des intervalles quotidiens, mensuels et cumulés sont toujours disponibles.
14 mois, vous n’êtes plus en mesure de rendre compte des individus :
- Créatifs
- Placements
- Marques

Dans certains cas, les rapports d’analyse peuvent afficher une remise qui ne correspond pas à la durée de vie quickStats d’un annonceur ou d’un éditeur donné. Cela est dû à la façon dont les données de rapports Analytics datant de plus de 100 jours et 14 mois sont agrégées. Les données des rapports de facturation sont conservées indéfiniment sous forme non agrégée.

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
`hour`	Temps	Non	`"2010-02-01 06:00:00"`	L’heure de la vente aux enchères. Note: Pour les impressions antérieures à 100 jours, le jour est retourné plutôt que l’heure.
`day`	Temps	Non	`"2010-02-01"`	Le jour de la vente aux enchères.
`month`	Temps	Non	`"2010-02"`	Le mois de la vente aux enchères.
`publisher_id`	int	oui	`923`	ID de l’éditeur.
`publisher_code`	string	Non	`"My Publisher Code"`	Code personnalisé pour l’éditeur.
`publisher_currency`	string	Non	`"USD"`	Devise de l’éditeur.
`pub_rule_id`	int	oui	`736`	ID de la règle d’éditeur.
`pub_rule_name`	chaîne	Non	`"My Publisher Rule"`	Nom de la règle d’éditeur.
`pub_rule`	chaîne	Non	`"My Publisher Rule (736)"`	Déconseillé (à compter du 17 octobre 2016).
`pub_rule_code`	chaîne	Non	`"My Publisher Rule Code"`
`seller_member_id`	int	oui	`456`	ID du membre vendeur.
`geo_country`	chaîne	Oui	`"US"`	Code du pays géographique.
`geo_country_name`	chaîne	Non	`"United States"`	Nom du pays géographique.
`size`	chaîne	Oui	`"728x90"`	Taille du placement/créatif servi.
`placement_id`	int	oui	`546`	ID du placement. Note: Pour les impressions antérieures à 100 jours, les placements sont agrégés en une ligne avec `-1` comme `placement_id`.
`placement_name`	chaîne	Non	`"300x250 Business"`	Nom du placement. Notez que, pour les impressions antérieures à 100 jours, les placements sont agrégés en une ligne avec « Toutes les données de placement antérieures à 100 jours » comme placement_name.
`placement`	chaîne	Non	`"Photos 728x90 (567)"`	Déconseillé (à compter du 17 octobre 2016).
`placement_code`	string	Non	`"Photos Code"`
`deal_id`	int	Oui	`2345`	ID de la transaction. Pour plus d’informations sur les transactions que vous avez négociées avec les acheteurs, consultez Deal Service.
`deal_name`	string	Non	`"Private deal for buyer 1085 with floor of $2.50"`	Nom de la transaction.
`deal`	string	Non	`"Private deal for buyer 1085 with floor of $2.50 (45)"`	Déconseillé (à compter du 17 octobre 2016).
`deal_code`	string	Non	`"Custom code"`	Code personnalisé pour la transaction.
`brand_id`	int	oui	`3`	ID de la marque associée à un créatif servi dans l’inventaire de l’éditeur. Pour `imp_type_id = 6`, aucune information n’est disponible dans le `brand_id` champ de ce rapport. Consultez plutôt le rapport d’évaluation de la marque de l’éditeur .
`brand_name`	string	Non	`"Ace Hardware"`	Nom de la marque associée à un créatif servi dans l’inventaire de l’éditeur. Pour `imp_type_id = 6`, aucune information n’est disponible dans le `brand_name` champ de ce rapport. Consultez plutôt le rapport d’évaluation de la marque de l’éditeur .
`brand`	chaîne	Non	`"Ace Hardware (3)"`	Déconseillé (à compter du 17 octobre 2016).
`supply_type`	string	Non		Type d’inventaire. Valeurs possibles : - `"web"` - `"mobile_web"` - `"mobile_app"`
`imp_type_id`	int	oui	`1`	ID du type d’impression. Valeurs possibles (types associés entre parenthèses) : - `1` (« Vide ») : aucun créativité servi. - `2` (« PSA ») : Une annonce d’intérêt public a été rendue publique parce qu’il n’y avait pas d’offre valide et qu’aucune création par défaut n’était disponible. - `3` (« Erreur par défaut ») : création par défaut fournie en raison d’un problème de délai d’expiration. - `4` (« Valeur par défaut ») : valeur créative par défaut fournie, car il n’y avait pas d’enchères valides. - `5` (« Conservé ») : la créativité de votre annonceur servie sur le site de votre éditeur. - `6` (« Revendu ») : 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` (« Erreur PSA ») : une annonce de service public a été effectuée en raison d’un problème de délai d’expiration ou d’une absence de création par défaut. - `9` (« Impression externe ») : impression provenant d’un dispositif de suivi d’impression.
`imp_type`	nom	oui	`"Kept"`	Type d’impressions. Pour connaître les valeurs possibles, consultez `imp_type_id`.
`media_type`	chaîne	Non	`"Banner"`, `"Pop"`, `"Interstitial"`, `"Video"`, `"Text"`, `"Expandable"`, `"Skin"`	Style d’affichage général d’un créatif servi dans l’inventaire de l’éditeur. Vous pouvez utiliser le service de type de média pour afficher la liste complète des types de médias.
`adjustment_id`	int	oui	`22`	ID d’un ajustement que vous avez défini à l’aide du service d’ajustement. Les réseaux utilisent des ajustements pour afficher leur chiffre d’affaires réel dans les rapports Xandr.
`site_id`	int	oui	`555`	ID du site. Pour plus d’informations, consultez service de site.
`site_name`	chaîne	Oui	`"My Site"`	Nom du site. Pour plus d’informations, consultez service de site.
`site`	chaîne	Oui	`"My Site (555)"`	Déconseillé (à compter du 17 octobre 2016).
`venue`	chaîne	Oui	`"Venue 55"`	Le mot Lieu suivi de l’ID du lieu associé à l’inventaire.
`mediatype_id`	int	oui	`444`	ID du type de média associé au créatif qui a été servi. Pour plus d’informations, consultez Media Type Service.

Mesures

Column	Type	Exemple	Formule	Description
`imps_total`	int	`234223`	Lutins	Nombre total d’impressions (y compris les valeurs par défaut).
`imps_requests`	int	`234300`	imps_requests	Nombre total d’appels publicitaires (demandes d’impression). Avertissement: Cette métrique est généralement inexacte pour l’inventaire vidéo en raison de retards occasionnels dans la réception des événements vidéo, ce qui peut entraîner des totaux de demandes gonflés en fonction de l’hypothèse que la vidéo a expiré. Pour une meilleure métrique de demande vidéo, vous devez utiliser les demandes d’annonces dans le rapport réseau de remplissage et de remise du vendeur ou le rapport Analyse vidéo réseau.
`imps_sold`	int	`234123`	imps_sold	Nombre total d’impressions vendues aux annonceurs directs et en temps réel.
`imps_default`	int	`100`	imps_default	Nombre total d’impressions non vendues (création par défaut servie).
`imps_blank`	int	`12`	imps_blank	Nombre d’impressions qui ont été servies avec un vide.
`imps_psa`	int	`10`	imps_psa	Nombre d’impressions qui ont été servies avec un APS.
`imps_default_error`	int	`3`	imps_default_error	Nombre d’impressions par défaut en raison d’une erreur de délai d’expiration.
`imps_default_bidder`	int	`5`	imps_default_bidder	Nombre d’impressions par défaut, car il n’y avait pas d’enchères valides.
`imps_kept`	int	`405`	imps_kept	Nombre d’impressions achetées par votre annonceur auprès de votre éditeur.
`imps_resold`	int	`506`	imps_resold	Nombre d’impressions que votre éditeur a vendues à un tiers.
`imps_rtb`	int	`94`	imps_rtb	Nombre d’impressions que votre annonceur a achetées auprès d’un tiers.
`imps_filled`	int	`4900`	imps_filled	Nombre d’impressions vides, PSA, par défaut, conservées, revendues et externes.
`external_impression`	int	`0`	external_impression	Nombre d’impressions externes.
`external_click`	int	`0`	external_click	Nombre de clics externes.
`clicks`	int	`545`	Clics	Nombre total de clics sur toutes les impressions.
`post_view_convs_pixel`	int	`23`		Publier les conversions d’affichage pour le pixel. Pour plus d’informations sur la façon dont nous imptribuons les conversions post-affichage (et d’autres), consultez Attribution de conversion (Microsoft Monetize) ou Attribution de conversion (Microsoft Invest).
`post_clicks_convs_pixel`	int	`15`		Publier les conversions de clic pour le pixel. Pour plus d’informations sur la façon dont nous imptribuons les conversions post-affichage (et d’autres), consultez Attribution de conversion (Microsoft Monetize) ou Attribution de conversion (Microsoft Invest).
`publisher_revenue`	Argent	`400.05`	publisher_revenue	Le revenu versé à l’éditeur (basé sur revshare ou CPM).
`publisher_revenue_pub_curr`	Argent	`400.05`	publisher_revenue_pub_curr	Revenu versé à l’éditeur (basé sur revshare ou CPM), dans la devise de l’éditeur.
`publisher_filled_revenue`	Argent	`350.02`	publisher_filled_revenue	Revenus versés à l’éditeur (basé sur revshare ou CPM) pour les impressions remplies.
`publisher_filled_revenue_publisher_curr`	Argent	`350.02`	publisher_filled_revenue	Le revenu versé à l’éditeur (basé sur revshare ou CPM) pour les impressions remplies, dans la devise de l’éditeur.
`publisher_default_revenue`	Argent	`350.02`	publisher_default_revenue	Chiffre d’affaires versé à l’éditeur (basé sur revshare ou CPM) pour les impressions par défaut.
`publisher_default_revenue_publisher_curr`	Argent	`350.02`	publisher_default_revenue	Chiffre d’affaires versé à l’éditeur (basé sur revshare ou CPM) pour les impressions par défaut, dans la devise de l’éditeur.
`total_convs`	int	`205`	total_convs	Nombre total de conversions d’affichage de publication et de clic de publication.
`ctr`	double	`0.002327`	clicks / imps	Taux de clics vers les impressions.
`click_thru_pct`	double	`1.12359550561797`	(clics / imps) * 100	Taux de clics vers les impressions sous forme de pourcentage.
`convs_rate`	double	`0.000856`	total_convs / imps	Taux de conversions en impressions.
`convs_per_mm`	double	`221.877080097625`	(total_convs / imps) x 1 000 000	Nombre de conversions par million d’impressions.
`publisher_rpm`	Argent	`1.71`	(publisher_revenue / imps) x 1000	Chiffre d’affaires de l’éditeur pour 1 000 impressions.
`publisher_rpm_pub_curr`	Argent	`1.71`	(publisher_revenue / imps) x 1000	Chiffre d’affaires de l’éditeur par 1 000 impressions, dans la devise de l’éditeur.
`publisher_filled_rpm`	Argent		(publisher_revenue / imps_filled) x 1000	Le chiffre d’affaires de l’éditeur par 1 000 impressions remplies.
`publisher_filled_rpm_publisher_currency`	Argent		(publisher_revenue / imps_filled) x 1000	Chiffre d’affaires de l’éditeur pour 1 000 impressions remplies, dans la devise de l’éditeur.
`publisher_default_rpm`	Argent	`1.71`	(publisher_revenue / imps_default) x 1000	Chiffre d’affaires de l’éditeur pour 1 000 impressions par défaut.
`publisher_default_rpm_publisher_curr`	Argent	`1.71`	(publisher_revenue / imps_default) x 1000	Chiffre d’affaires de l’éditeur par 1 000 impressions par défaut, dans la devise de l’éditeur.
`imps_viewed`	int	`30,450`	imps_viewed	Nombre d’impressions mesurées qui étaient visibles, selon la définition de l’affichage IAB, qui indique qu’une impression est visible si 50 % des pixels sont affichés pendant 1 seconde consécutive.
`view_measured_imps`	int	`10,120`	view_measured_imps	Nombre total d’impressions qui ont été mesurées pour la visibilité.
`view_rate`	double	`58%`	view_rate	Pourcentage d’impressions visibles par rapport au nombre total d’impressions mesurées pour la visibilité. (Imps consultés / Afficher les imposs mesurés)
`view_measurement_rate`	double	`45%`	view_measurement_rate	Pourcentage d’impressions mesurées pour la visibilité sur le nombre total d’impressions. (Afficher imps/imps mesurés)
`video_skips`	int	`10`		Nombre total de fois où un utilisateur a ignoré la vidéo. Utilisez cette métrique pour créer des rapports lors de l’achat d’un inventaire non modifiable.
`video_starts`	int	`11`		Nombre total de fois où le premier segment de la création vidéo a été téléchargé et démarré.
`video_25_pcts`	int	`10`		Nombre total de fois où les créations vidéo ont terminé 25 % de la durée totale.
`video_50_pcts`	int	`10`		Nombre total de fois où les créations vidéo se sont terminées 50 % de la durée totale.
`video_75_pcts`	int	`10`		Nombre total de fois où les créations vidéo se sont terminées 75 % de la durée totale.
`video_completions`	int	`12`		Nombre total de fois où les créations vidéo ont été lues pendant toute la durée.
`video_served`	int	`10`		Nombre total de réponses vidéo envoyées au lecteur. Une réponse publicitaire se produit lorsque le document VAST (XML) est servi en réponse à une demande. Une réponse publicitaire n’indique pas nécessairement une impression réussie. Pour une impression, la première image de la vidéo doit être servie.
`video_errors`	int	`2`		Nombre total de fois qu’une erreur vidéo s’est produite.
`revenue_per_video_complete`	Argent	`25.76`		Chiffre d’affaires par saisie semi-automatique de la vidéo.
`cost_per_video_complete`	Argent	`22.76`		Coût par saisie semi-automatique de la vidéo.
`video_completion_rate`	double	`1.12359550561797%`	(saisies vidéo/impressions totales) x 100	Rapport entre les saisies semi-vidéo et les impressions, exprimé sous forme de pourcentage.
`video_start_rate`	double	`1.12359550561797%`		Pourcentage de fois où le premier segment de la création vidéo a été téléchargé et démarré.
`video_skip_rate`	double	`1.12359550561797%`		Pourcentage de fois où l’utilisateur a choisi d’ignorer la vidéo.

Compartiments d’âge

ID de compartiment	Nom du compartiment
`0`	`"unknown"`
`1`	`"13-17"`
`2`	`"18-24"`
`3`	`"25-34"`
`4`	`"35-44"`
`5`	`"45-54"`
`6`	`"'55-64"`
`7`	`"65+"`

Exemples

Étape 1 : Préparer votre demande de rapport

$ cat the-file.json

{
    "report": {
        "format": "csv",
        "report_interval": "yesterday",
        "columns": [
            "publisher_id",
            "imp_type",
            "geo_country",
            "placement_id",
            "imps_total",
            "imps_kept",
            "imps_resold",
            "publisher_filled_revenue",
            "total_convs"
        ],
        "report_type": "publisher_analytics"
    }
}

Étape 2 : `POST` demande JSON au service de rapport

$ curl -b cookies -c cookies -X POST -d @the-file.json 'https://api.appnexus.com/report?publisher_id=5555'

{
    "response": {
        "status": "OK",
        "report_id": "f589854c1697da8ff9ead66825c9bc04"
    }
}

Étape 3 : Vérifier la status de votre demande

$ curl -b cookies 'https://api.appnexus.com/report?id=f589854c1697da8ff9ead66825c9bc04'

{
    "response": {
        "status": "OK",
        "report": {
            "name": "",
            "created_on": "2013-10-30 21:15:36",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": "",
            "header_info": "",
            "row_count": "",
            "report_size": "",
            "internal_info": "",
            "user_id": "2027",
            "entity_id": "0",
            "started_on": "1970-01-01 00:00:01",
            "finished_on": "1970-01-01 00:00:01",
            "query_time": ""
        },
        "execution_status": "pending"
    }
}

Étape 4 : Télécharger vos données

curl -b cookies 'https://api.appnexus.com/report-download?id=f589854c1697da8ff9ead66825c9bc04' > /tmp/publisher_analytics.csv