Partager via

API de rapport de facturation du soumissionnaire

Les acheteurs peuvent collecter des informations de transaction à l’aide du rapport de facturation du soumissionnaire pour facturer leurs annonceurs.

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 :

  • current_hour
  • last_hour
  • last_48_hours
  • today
  • yesterday
  • last_7_days
  • month_to_date
  • quarter_to_date
  • last_month
  • lifetime
  • month_to_yesterday
  • custom

Dimensions

Column Type Groupe? Filtre? Exemple Description
hour Temps Oui Oui "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 Oui Oui "2010-02-01" Le jour de l’impression.
month Temps Oui Oui "2010-02" Mois de l’impression.
buyer_member_id int Oui Oui 123 ID interne du membre acheteur.
buyer_member_name string Non Non "My Buyer" Nom d’affichage du membre acheteur.
seller_member_id int Oui Oui 456 ID interne du membre vendeur.
seller_member_name string Non Non "That Seller" Nom d’affichage du membre vendeur.
publisher_id int Oui Oui 321 ID interne de l’éditeur.
geo_country string Oui Oui "US" Code du pays géographique.
geo_country_name string Non Non "United States" Nom du pays géographique.
deal_id int Oui Oui 123 ID interne de la transaction.
deal_name string Non Non "Deal A" Nom complet de la transaction.
direct_cleared int Oui 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 ».
buying_currency string Oui Oui "USD" Devise de transaction utilisée par l’acheteur pour acheter cette impression.
selling_currency string Oui Oui "EUR" Devise de transaction utilisée par le vendeur pour vendre cette impression.
imp_type_id int Oui Oui 7 ID du type d’impression. Valeurs possibles (types associés entre parenthèses) :
- 7 (« RTB ») : la créativité de vos acheteurs servie sur l’inventaire tiers.
- 9 (« Impression externe ») : une impression provenant d’un dispositif de suivi d’impression.
- 10 (« Clic externe ») : un clic à partir d’un dispositif de suivi des clics.
buyer_seat_code string Oui Non "1234" ID de siège acheteur personnalisé (soumis par DSP) qui a été utilisé pour enchérir sur l’impression.
buyer_seat_name string Oui Non "test seat" Nom d’affichage du code du siège acheteur.

Mesures

Column Type Exemple Formule Description
imps int 100 imps_delivered Nombre total d’impressions correctement traitées.
imps_direct_cleared int 100 imps_direct_cleared Nombre total d’impressions où Xandr ne collecte PAS le coût média de l’acheteur ou paye le paiement vendeur pour les transactions entre cette paire acheteur-vendeur.
imps_appnexus_cleared int 100 imps_appnexus_cleared Nombre total d’impressions où Xandr collecte le coût des médias de l’acheteur et paie les paiements des vendeurs pour les transactions entre cette paire acheteur-vendeur.
buyer_media_cost Argent 123.45 buyer_media_cost Coût total de l’inventaire acheté.
buyer_media_cost_direct_cleared Argent 123.45 buyer_media_cost sur imps_direct_cleared Les dépenses de l’acheteur pour les impressions où le paiement du vendeur est effectué directement entre cette paire acheteur-vendeur, et non par le biais de Xandr.
buyer_media_cost_direct_cleared_buying_currency Argent 123.45 buyer_media_cost_direct_cleared_buying_currency Les dépenses de l’acheteur pour les impressions où le paiement du vendeur est effectué directement entre cette paire acheteur-vendeur, et non via Xandr, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
buyer_media_cost_appnexus_cleared Argent 123.45 buyer_media_cost sur imps_appnexus_cleared Les dépenses de l’acheteur pour les impressions où Xandr paie le paiement du vendeur.
buyer_media_cost_direct_cleared_buying_currency Argent 123.45 buyer_media_cost_direct_cleared_buying_currency Les dépenses de l’acheteur pour les impressions où Xandr paie le paiement du vendeur, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
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.
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 Les frais facturés sur les impressions achetées rtb spécifiées dans le contrat du membre acheteur. Par exemple, avec des frais de 10 %, si l’acheteur dépense 1 000 $ en inventaire, Xandr lui facture des frais de 100 $. Ils recevront une facture de 1 000 $ de frais de média et de 100 $ pour les frais de service de vente aux enchères de l’acheteur (BASC) pour un total de 1 100 $.

Deux types sont à distinguer :
- Pour les lignes qui sont direct_cleared, vos frais directs en clair sont enregistrés dans ce champ.
- Si vos frais de service de vente aux enchères (BASC) sont définis comme des frais plutôt qu’une déduction, une valeur sera également enregistrée ici. Vous pouvez différencier en regroupant par la dimension direct_cleared lorsque vous extrayez le rapport.
auction_service_fees_buying_currency Argent 123.45 auction_service_fees_buying_currency Les frais facturés sur les impressions achetées rtb spécifiées dans le contrat du membre acheteur, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
auction_service_deduction Argent 123.45 auction_service_deduction La déduction sur les impressions achetées RTB spécifiées dans le contrat du membre acheteur. Par exemple, avec une déduction de 10 %, s’il budgete 1 000 $ pour sa campagne, Xandr en prend 100 $, ce qui laisse à l’acheteur 900 $ qui est utilisé pour acheter l’inventaire auprès du vendeur. Creative Auction Service Change (CASC) sera également représenté ici. Pour l’exemple ci-dessus, l’acheteur recevra une facture de 1 000 $ de frais multimédias, qui comprend la déduction des frais Xandr.

Avertissement: Ce champ correspond auction_service_fees si votre contrat a un taux de frais de service de vente aux enchères (BASC) supérieur à 0 %.
auction_service_deduction_buying_currency Argent 123.45 auction_service_deduction_buying_currency La déduction sur les impressions achetées rtb spécifiées dans le contrat du membre acheteur, dans la devise de transaction utilisée par l’acheteur pour acheter l’impression.
buyer_ecpm Argent 123.45 buyer_media_cost / imps_delivered * 1000 Coût de l’acheteur par impression, exprimé en eCPM.
buyer_ecpm_buying_currency Argent 123.45 buyer_ecpm, exprimée dans la devise de l’acheteur Coût de l’acheteur par impression dans la devise sélectionnée. Pour obtenir la liste des devises prises en charge, consultez Devises prises en charge.

Exemples

Create la demande de rapport au format JSON

Le fichier JSON doit inclure le report_typebidder_pricing_report, ainsi que le columns (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_request.json
{
    "report": {
        "format": "csv",
        "report_interval": "last_48_hours",
        "columns": [
            "seller_member_name",
            "buyer_member_name",
            "imps"
        ],
        "report_type": "bidder_pricing_report"
    }
}

POST la demande au service de création de rapports

$ curl -b cookies -c cookies -X POST -d @bidder_pricing_report_request.json 'https://api.adnxs.com/report'
{
 "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.adnxs.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\",\"report_type\":\"bidder_pricing_report\"}}",
     "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": "{...}",
     "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.adnxs.com/report-download?id=39c4855a07e92433947886b5aabd267d' > bidder_pricing_report.csv
  • Last updated on