Partager via


API de plateforme numérique - Rapport d’achat de facturation

Avertissement

Ce rapport ne doit être utilisé que pour les données postérieures au 30 septembre 2015.

Le rapport de facturation d’achat peut être utilisé pour afficher les données de facturation sur les impressions des annonceurs directs (achetées sur les éditeurs directs et l’inventaire en temps réel).

Pour obtenir des instructions sur la récupération d’un rapport, consultez Service de rapports.

Période

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

  • last_hour
  • aujourd’hui
  • yesterday
  • last_48_hours
  • last_7_days
  • last_30_days
  • month_to_date
  • quarter_to_date
  • last_month
  • Vie
  • Personnalisé

Période de conservation des données

La période de conservation des données pour ce rapport est de 1 095 jours.

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 l’impression.

Note: Pour les impressions antérieures à 100 jours, les données horaires sont agrégées en une ligne avec « AAAA-MM-JJ 00 :00 :00 » comme heure ( « AAAA-MM-JJ » est le jour UTC au cours duquel l’activité s’est produite). Cela donnera l’impression que toute l’activité s’est produite à minuit. Toutes les données quotidiennes antérieures à 100 jours sont retournées dans le fuseau horaire UTC.
day Temps Non "2010-02-01" Le jour de l’impression.
month Temps Non "2010-02" Mois de l’impression.
buyer_member_id int Oui 123 ID interne du membre acheteur.
buyer_member_name string Non "My Network" Nom d’affichage du membre acheteur.
seller_member_id int Oui 456 ID interne du membre vendeur.
seller_member_name string Non "That Seller" Nom d’affichage du membre vendeur.
advertiser_id int Oui 789 ID interne de l’annonceur.
advertiser_name string Non "Verizon" Nom d’affichage de l’annonceur.
advertiser_code string Non "Advertiser Code" Code externe associé à un annonceur.
insertion_order_id int Oui 451 ID interne de l’ordre d’insertion.
insertion_order_name string Non "Q1-2014" Nom d’affichage de l’ordre d’insertion.
insertion_order_code string Non "Insertion Order Code" Code externe associé à un ordre d’insertion.
line_item_id int Oui 932 ID interne de l’élément de ligne.
line_item_name string Non "$3 CPM Verizon Remarketing" Nom d’affichage de l’élément de ligne.
line_item_code string Non "Line Item Code" Code externe associé à un élément de ligne.
campaign_id int Oui 728 ID interne de la campagne.
campaign_name string Non "Test" Nom d’affichage de la campagne.
campaign_code string Non "Campaign Code" Code externe associé à une campagne.
publisher_id int Oui 321 ID interne de l’éditeur.
publisher_name string Non "Test" Nom d’affichage de l’éditeur.
deal_id int Oui 123 ID interne de la transaction.
deal_name string Non "Deal A" Nom complet de la transaction.
buying_currency string Oui "USD" Devise de transaction utilisée par l’acheteur pour acheter cette impression.
selling_currency string Oui "EUR" Devise de transaction utilisée par le vendeur pour vendre cette impression.
imp_type_id int Oui 1 ID du type d’impression. Valeurs possibles (types associés entre parenthèses) :
- 1 ("Blank"): Aucune créativité n’est 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"): création par défaut servie en raison d’un problème de délai d’expiration.
- 4 ("Default"): création par défaut, 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éation par défaut.
- 9 ("External Impression"): impression provenant d’un dispositif de suivi d’impression.
- 10 ("External Click"): un clic à partir d’un dispositif de suivi des clics.
imp_type string Oui "Blank" Type d’impression. Pour connaître les valeurs possibles, consultez imp_type_id.
cleared_direct int Oui 0, 1 Que l’acheteur paie ou non directement le vendeur pour le coût des médias. Si 0la valeur est , Xandr perçoit le coût des médias auprès de l’acheteur et paie le vendeur. Si 1la valeur est , l’acheteur paie directement le vendeur pour le coût des médias.

Pointe: Les acheteurs peuvent faire correspondre le coût du média sur leur facture en filtrant les transactions « directes effacées ».
marketplace_clearing_event string Oui "Views - Standard Display" Nom de l’événement d’enchère sous-jacent qui a été traité (par exemple, impression, impression visible, vidéo terminée). Pour plus d’informations, consultez Résultats garantis et normes de visibilité prises en charge dans la documentation de l’interface utilisateur.
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 chaîne Oui "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.

Mesures

Column Type Exemple Formule Description
imps int 123456 Lutins Nombre total d’impressions.
clicks int 123456 Clics Nombre total de clics sur toutes les impressions.
convs int 123456 total_convs Nombre total de conversions pour toutes les impressions.
booked_revenue Argent 123.45 booked_revenue Chiffre d’affaires du réseau réservé par le biais d’annonceurs directs.
booked_revenue_dollars_buying_currency Argent 123.45 booked_revenue_dollars_buying_currency Chiffre d’affaires du réseau réservé par le biais d’annonceurs directs, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
buyer_media_cost Argent 123.45 buyer_media_cost Coût total de l’inventaire acheté.
buyer_media_cost_buying_currency Argent 123.45 buyer_media_cost_buying_currency Coût total de l’inventaire acheté, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
auction_service_deduction Argent 123.45 auction_service_deduction Le total des déductions facturées pour les impressions achetées auprès de tiers.
Ces déductions sont incluses dans le coût média de l’acheteur et déduites lors du calcul du paiement du vendeur. Pour plus d’informations, consultez Mécanismes des frais du service d’enchères de l’acheteur.
auction_service_deduction_buying_currency Argent 123.45 auction_service_deduction_buying_currency Le total des déductions facturées pour les impressions achetées à des tiers, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
Ces déductions sont incluses dans le coût média de l’acheteur et déduites lors du calcul du paiement du vendeur. Pour plus d’informations, consultez Mécanismes des frais du service d’enchères de l’acheteur.
net_media_cost Argent 123.45 net_media_cost Montant total à payer pour les achats de médias, moins la déduction pour le service d’enchères.
net_media_cost_buying_currency Argent 123.45 net_media_cost_buying_currency Montant total à payer pour les achats de médias, moins la déduction pour le service d’enchères, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
creative_overage_fees Argent 123.45 creative_overage_fees Total des frais facturés pour les créations hébergées qui dépassent la limite de taille de création.
creative_overage_fees_buying_currency Argent 123.45 creative_overage_fees_buying_currency Total des frais facturés pour les créations hébergées qui dépassent la limite de taille créative, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
auction_service_fees Argent 123.45 auction_service_fees Total des frais facturés pour les impressions achetées auprès de tiers.
Ces frais sont facturés en plus du coût média de l’acheteur. Pour plus d’informations, consultez Mécanismes des frais du service d’enchères de l’acheteur.
auction_service_fees_buying_currency Argent 123.45 auction_service_fees_buying_currency Total des frais facturés pour les impressions achetées auprès de tiers, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
Ces frais sont facturés en plus du coût média de l’acheteur. Pour plus d’informations, consultez Mécanismes des frais du service d’enchères de l’acheteur.
marketplace_clearing_event_units int 23 marketplace_clearing_event_units Nombre total d’événements achetés (pour l’événement d’effacement associé). Lors de l’achat d’un événement d’effacement autre que l’impression (par exemple, des impressions visibles), le nombre d’événements facturés est inférieur au nombre d’impressions. Pour plus d’informations, consultez Résultats garantis dans la documentation de l’interface utilisateur.
exchange_cost Argent 4.32 exchange_cost Montant retiré de l’échange à donner au vendeur. Si vous n’utilisez pas d’élément de ligne avec un modèle de paiement des résultats garantis, la valeur de cette métrique est égale au coût multimédia net.
ecpm_conversion_deduction Argent 3.2 ecpm_conversion_deduction Montant que Xandr retire d’une offre/paiement de résultats garantis pour couvrir les services de conversion eCPM et de prédiction des résultats post-enchère. Si vous n’utilisez pas d’élément de ligne avec un modèle de paiement des résultats garantis, la valeur de ce champ est égale 0à .
Pour plus d’informations sur la façon dont ces frais sont calculés, consultez Présentation des taux de conversion des paiements.
go_market_making_fee Argent 0.48 go_market_making_fee Frais basés sur les pourcentages que Xandr prend sur une offre ou un paiement de résultats garantis pour couvrir le risque encouru lors de la fourniture de résultats garantis. La valeur de ce champ est égale 0 en cas d’utilisation d’un élément de ligne de résultats garantis. Si vous n’utilisez pas d’élément de ligne avec un modèle de paiement des résultats garantis, la valeur de ce champ est égale 0à .
L’objectif de ces frais est de 10 %, mais le pourcentage réel utilisé varie en fonction de la précision de prédiction en constante évolution :
Go Market Making Fee Percentage = Pourcentage fixe (10 %) ± variabilité de prédiction (pourcentage positif ou négatif qui change en fonction de la précision de la prédiction de décalage)

Pour plus d’informations sur la façon dont ces frais sont calculés, consultez Présentation des taux de conversion des paiements.

Exemples

Create la demande de rapport au format JSON

Le fichier JSON doit inclure le report_type"buyer_invoice_report", 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é (year, month, day) et spécifier le format dans lequel les données doivent être retournées (csv, excelou html). Pour obtenir une explication complète des champs qui peuvent être inclus dans le fichier JSON, consultez service de rapports.

$ cat buyer_invoice_report.json

{
    "report": {
        "format": "csv",
        "report_interval": "last_48_hours",
        "columns": [
            "seller_member_name",
            "buyer_member_name",
            "imps",
            "clicks",
            "convs"
        ],
        "report_type": "buyer_invoice_report"
    }
}

POST la demande adressée au service reporting spécifiant un ID de membre en remplaçant INSERT_DESIRED_MEMBER_ID

$ curl -b cookies -c cookies -X POST -d @buyer_invoice_report.json 'https://api.appnexus.com/report?member_id=INSERT_DESIRED_MEMBER_ID'

{
 "response": {
   "status": "OK",
   "report_id": "39c4855a07e92433947886b5aabd267d", <=== COPY THIS report_id as you will need it to check the status of your report and to download your report
   "existing": false,
   "dbg_info": {
     ...
     }
   }
}

GETle 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=39c4855a07e92433947886b5aabd267d'

{
 "response": {
   "status": "OK",
   "report": {
     "name": null,
     "created_on": "2015-11-17 21:27:21",
     "cache_hit": false,
     "fact_cache_hit": false,
     "fact_cache_error": null,
     "json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"last_48_hours\",\"columns\":[\"seller_member_name\",\"buyer_member_name\",\"imps\",\"clicks\",\"convs\"],\"report_type\":\"buyer_invoice_report\",\"filters\":[{\"buyer_member_id\":\"668\"},{\"is_delivered\":{\"value\":[\"1\"],\"operator\":\"=\"}},{\"is_valid_buyer\":{\"value\":[\"1\"],\"operator\":\"=\"}},{\"is_valid_buying_imp_type\":{\"value\":[\"1\"],\"operator\":\"=\"}}]}}",
     "header_info": "Report ID:,39c4855a07e92433947886b5aabd267d\r\nRun at:,2015-11-17 21:27:21\r\nStart date:,2015-11-15 21:00:00\r\nEnd date:,2015-11-17 20:00:00\r\nTimezone:,\r\nUser:,Huanqing Liu (171989)\r\n",
     "row_count": "309",
     "report_size": "15583",
     "internal_info": "{\"report_id\":\"39c4855a07e92433947886b5aabd267d\",\"expected_query_cost\":\"1\",\"processor\":\"20.bm-report-processor.prod.nym2\",\"last_processor_run_on\":\"20.bm-report-processor.prod.nym2\",\"cache_miss\":1,\"query\":\" SELECT seller_member_id AS alias_1,CASE WHEN transaction_type = 1 THEN 'Blank' WHEN transaction_type = 3 THEN 'Default Error' WHEN transaction_type = 4 THEN 'Default' WHEN transaction_type = 2 THEN 'PSA' WHEN transaction_type = 8 THEN 'PSA Error' WHEN transaction_type IN (5,6,7,9,10,11) THEN CAST(BUYER_MEMBER_ID AS VARCHAR(7)) ELSE 'Unknown' END AS alias_2,SUM(IMPS) AS alias_3,SUM(CLICKS) AS alias_4,sum(convs) AS alias_5  FROM agg_combined_billing fact  WHERE 1=1  AND ymdh >= '2015-11-15 21:00:00' AND ymdh < '2015-11-17 20:00:00' AND buyer_member_id IN ('668') AND is_delivered IN ('1') AND CASE WHEN has_dw_buy=1 OR is_dw_buyer=0 THEN 1 ELSE 0 END IN ('1') AND CASE WHEN transaction_type in (7, 9, 10, 11) THEN 1 ELSE 0 END IN ('1')  GROUP BY alias_1, alias_2 LIMIT 1000000001\\n-- [member_id] \\n-- [report_id] 39c4855a07e92433947886b5aabd267d\"}",
     "user_id": "171989",
     "entity_id": "0",
     "started_on": "2015-11-17 21:27:22",
     "finished_on": "2015-11-17 21:27:24",
     "query_time": "0",
     "url": "report-download?id=39c4855a07e92433947886b5aabd267d"
   },
   "execution_status": "ready",
   "_was_this_status_cached_": 0,
   "dbg_info": {
     ...
     }
   }
}

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=39c4855a07e92433947886b5aabd267d' > buyer_invoice_report.csv

Remarque

Il existe une limite de 100 000 lignes par rapport lorsque vous les téléchargez en tant que fichier XLSX et Excel.