Partager via


API de plateforme numérique - Rapport sur la vente de la facturation

Avertissement

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

Le rapport sur la facturation des ventes peut être utilisé pour afficher les données de facturation entre les éditeurs directs (vendues entre les annonceurs directs et d’autres acheteurs de plateforme).

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é

Conseil

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.

Période de conservation des données

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

Dimensions

Column Type Filtre? Exemple Description
hour Temps Non "2010-02-01 06:00:00" L’heure de l’impression.

Remarque : 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 pendant lequel 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.
publisher_id int Oui 321 ID interne de l’éditeur.
publisher_name string Non "Test" Nom d’affichage de l’éditeur.
publisher_code int Oui 123 ID externe de l’éditeur.
selling_currency string Oui Yes Devise de transaction utilisée par le vendeur pour vendre cette impression.
buying_currency string Oui "USD" Devise de transaction utilisée par l’acheteur pour acheter cette impression.
deal_id int Oui 123 ID interne de la transaction
imp_type_id int Oui 1 ID du type d’impression. Valeurs possibles (ID associés entre parenthèses) :
- « Vide » (1) : aucun créativité servi.
- « PSA » (2) : une annonce d’intérêt public a été faite parce qu’il n’y avait pas d’offres valides et qu’aucune création par défaut n’était disponible.
- « Erreur par défaut » (3) : création par défaut fournie en raison d’un problème de délai d’expiration.
- « Par défaut » (4) : valeur créative par défaut servie, car il n’y avait pas d’enchères valides.
- « Kept » (5) : la créativité de votre annonceur servie sur le site de votre éditeur.
- « Resold » (6) : l’impression de votre éditeur a été vendue à un acheteur tiers.
- « RTB » (7) : l’impression de votre éditeur a été vendue à un acheteur tiers.
- « Erreur PSA » (8) : une annonce de service public a été effectuée en raison d’un problème de délai d’expiration ou de l’absence d’un élément créatif par défaut.
- « Impression externe » (9) : impression d’un dispositif de suivi d’impression.
- « Clic externe » (10) : clic à partir d’un dispositif de suivi des clics.
selling_imp_type string Oui "Resold" 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.

Conseil : Les acheteurs peuvent faire correspondre le coût du média sur leur facture en filtrant les transactions « directes effacées ».
pricing_media_type_id int Non 0, 1 ID de la classification du type de média spécifique à la vidéo (pour la facturation uniquement). Si vous n’avez pas de tarification spécifique à la vidéo, ce champ n’est pas pertinent. Les valeurs possibles sont les suivantes : 0, 1, 2 et 3..
pricing_media_type_name string Non "Non Video" Nom de la classification du type de média spécifique à la vidéo (pour la facturation uniquement). Si vous n’avez pas de tarification spécifique à la vidéo, ce champ n’est pas pertinent. Les valeurs possibles sont les suivantes :
- "--"
- "Non-Video"
- "Video (Hosted)"
- "Video (Non-Hosted)"
deal_type string Oui "Open Auction" Type de transaction pour une transaction particulière. Les options de type de transaction sont les suivantes :
- Open Auction
- Private Auction -
Curated
- First Look
- Programmatic Guaranteed
auction_charges_available string Oui "Yes" Identifie les activités facturables dans lesquelles les déductions du vendeur peuvent être divulguées. Si la valeur est “yes”, la colonne Déductions SASC est remplie.
is_claims_activity string Oui "No" Identifie les activités facturables qui ne seront pas payées, car une revendication de trafic non valide a été traitée par rapport à celle-ci.
is_cross_seat_activity string Oui "No" Pertinent uniquement si vous avez plusieurs membres/sièges sur la plateforme Xandr. Dans ce cas, ce champ vous permet de savoir si l’activité était associée à des transactions entre les membres que vous gérez et donc de simplifier la réconciliation de leurs factures.
buyer_cleared int Oui 0 Que l’acheteur paie ou non le vendeur ou le curateur directement pour le coût des médias. Les valeurs acceptées sont les suivantes :
0: Xandr fait office de chambre d’échange, en collectant le coût des médias auprès de l’acheteur et en payant le vendeur.
1: Xandr n’efface pas l’argent ; l’acheteur paie directement le vendeur pour le coût des médias.
-1: valeur factice pour les activités non facturées.
curator_cleared int Oui 1 Indique si le vendeur reçoit ou non le chiffre d’affaires du revendeur de Xandr ou du curateur. Les valeurs acceptées sont les suivantes :
0: le vendeur reçoit le chiffre d’affaires du revendeur de Xandr.
1: le vendeur reçoit le chiffre d’affaires du revendeur de la part du curateur.
-1: valeur factice pour les activités non facturées.

Mesures

Column Type Exemple Formule Description
seller_billable_imps int 123456 Lutins Nombre total d’impressions facturables.
imps_filtered int 2365 imps_filtered Nombre total d’impressions qui ont été filtrées par l’évaluation de la qualité des stocks de Xandr (par exemple, les impressions d’un acheteur bloqué).
clicks int Clics Nombre total de clics sur toutes les impressions.
convs int 123456 total_convs Nombre total de conversions pour toutes les impressions.
reseller_revenue Argent 123.45 seller_revenue Chiffre d’affaires généré par les ventes aux acheteurs externes (RTB), en USD.
reseller_revenue_selling_currency Argent 123.45 reseller_revenue_selling_currency Chiffre d’affaires généré par les ventes à des acheteurs externes (RTB), dans la devise de transaction utilisée par le vendeur pour vendre l’impression.
seller_media_cost Argent 123.45 seller_media_cost Montant dû à l’éditeur, en USD.
seller_media_cost_selling_currency Argent 123.45 seller_media_cost_selling_currency Montant dû à l’éditeur, dans la devise de transaction utilisée par le vendeur pour vendre l’impression.
gross_seller_revenue Argent 123.45 gross_seller_revenue Chiffre d’affaires des vendeurs avant déductions SASC.
SASC_deduction Argent 122 SASC_deduction Seller Auction Service Frais, également appelé Seller Revenue Share dans certains contrats, SASC est la charge pour la vente d’inventaire à des acheteurs tiers. Il est indiqué sous la forme d’un pourcentage du coût média de l’acheteur, et déduit avant le calcul du chiffre d’affaires vendeur. Déduit de l’offre au moment de la vente aux enchères.
SASC_fees Argent 111 SASC_fees Facturé en tant que modèle de coût plus où les frais ne sont pas déduits de la soumission et sont facturés au client.
bad_debt_fees Argent 124 bad_debt_fees Un montant convenu que nous facturons pour garantir le paiement au vendeur indépendamment du fait que nous sommes payés ou non par l’acheteur. Facturé en tant que modèle de coût plus où les frais ne sont pas déduits de la soumission et sont facturés au client.
bad_debt_deductions Argent 155 bad_debt_deductions Un montant convenu que nous facturons pour garantir le paiement au vendeur indépendamment du fait que nous sommes payés ou non par l’acheteur. Déduit de l’offre au moment de la vente aux enchères.

Exemple

Create une demande de rapport au format JSON

Le fichier JSON doit inclure le report_type de "seller_pricing_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, excel, ou html). Pour obtenir une explication complète des champs qui peuvent être inclus dans le fichier JSON, consultez service de rapports.

$ cat seller_pricing_report.json

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

POST la demande au service de création de rapports spécifiant un ID de membre en remplaçant INSERT_DESIRED_MEMBER_ID

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

{
  "response": {
    "status": "OK",
    "report_id": "9282cde2a86670d9861b77b8fc0954ad", <=== COPY THIS report_id as you will need it to check the status of your report and to download your report
    "existing": false,
    "cached": true
    }
  }
}

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=9282cde2a86670d9861b77b8fc0954ad'

{
  "response": {
    "status": "OK",
    "report": {
      "name": null,
      "created_on": "2015-11-17 22:15:52",
      "cache_hit": true,
      "fact_cache_hit": true,
      "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\":\"seller_pricing_report\",\"filters\":[{\"seller_member_id\":\"2414\"},{\"is_delivered\":{\"value\":[\"1\"],\"operator\":\"=\"}},{\"is_valid_seller\":{\"value\":[\"1\"],\"operator\":\"=\"}}]}}",
      "header_info": "Report ID:,6adf8e4e075f93f7dfba164fe8cddab3\r\nRun at:,2015-11-17 22:15:30\r\nStart date:,2015-11-15 22:00:00\r\nEnd date:,2015-11-17 20:00:00\r\nTimezone:,\r\nUser:,Huanqing Liu (171989)\r\n",
      "row_count": "0",
      "report_size": "56",
      "internal_info": "{\"report_id\":\"9282cde2a86670d9861b77b8fc0954ad\",\"cache_hit_using\":\"6adf8e4e075f93f7dfba164fe8cddab3\",\"cache_cause\":1,\"controller_cache_hit\":true}",
      "user_id": "171989",
      "entity_id": "0",
      "started_on": "1970-01-01 00:00:01",
      "finished_on": "2015-11-17 22:15:52",
      "query_time": null,
      "url": "report-download?id=9282cde2a86670d9861b77b8fc0954ad"
    },
    "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.

Conseil

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=9282cde2a86670d9861b77b8fc0954ad' > seller_pricing_report.csv