Partager via


API De plateforme numérique - Rapport sur les performances des segments de conservateur

Remarque

Ce rapport est disponible uniquement pour les conservateurs.

Le rapport sur les performances des segments de curateur fournit aux conservateurs des informations sur la façon dont leurs segments ciblés contribuent à la performance globale de leurs transactions organisées. Le rapport fournit des données sur tous les segments ciblés (inclut et exclut) qui ont contribué aux impressions traitées. Pour les conservateurs, cela inclut toutes les activités de transactions organisées.

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 :

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

Période de conservation des données

Les données de ce rapport sont conservées pendant 429 jours.

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
bidder_id int Oui 456 ID du soumissionnaire qui a acheté sur la transaction
bidder_name string Non "That Bidder" Nom du soumissionnaire qui a acheté sur la transaction
buyer_member_id int Oui 789 ID de membre de l’acheteur qui a acheté sur la transaction
buyer_member_name string Non "That Buyer" Nom du membre de l’acheteur qui a acheté sur la transaction
curated_deal_id int Oui 123 ID de transaction organisé
cureated_deal_name string Non "My Deal Name" Nom de la transaction organisée
curated_line_item_id int Oui 123 ID d’élément de ligne de l’objet membre conservateur qui possède l’élément de ligne de transaction associé à la transaction organisée
curated_line_item_name string Non "My Curated LI" Nom de l’élément de ligne de l’objet membre conservateur qui possède l’élément de ligne de transaction associé à la transaction organisée
curator_member_id int Oui 123 ID de membre du compte conservateur
curator_member_name string Non "My Account" Nom du membre du compte de curateur
day date Oui "2020-02-01" Le jour de la vente aux enchères
device_type string Oui "desktops & laptops" Type d’appareil sur lequel l’impression a été servie. Les valeurs possibles sont les suivantes :
- "desktops & laptops"
- "tablets"
- "mobile phones"
- "tv"
- "game consoles"
- "set top box"
- "media players"
- "other devices"
device_type_id int Oui 1 ID de type d’appareil sur lequel l’impression a été servie. Les valeurs possibles sont les suivantes :
0 (autres appareils)
1 (ordinateurs de bureau & ordinateurs portables)
2 (téléphones mobiles)
3 (tablettes)
4 (tv)
5 (consoles de jeu)
6 (lecteurs multimédias)
7 (set top box)
device_type_name string Oui "desktops & laptops" Nom du type d’appareil sur lequel l’impression a été servie. Les valeurs possibles sont les suivantes :
- "desktops & laptops"
- "tablets"
- "mobile phones"
- "tv"
- "game consoles"
- "set top box"
- "media players"
- "other devices"
geo_country_code string Oui "US" Code de pays dans lequel l’impression a eu lieu. Pour les demandes d’impression pour lesquelles Xandr n’a reçu aucune indication que l’annonce a été rendue (c.-à-d. qu’elle n’a pas été traitée), aucune information sur le pays n’est fournie.
geo_country_name string Non "United States" Nom du pays dans lequel l’impression a eu lieu. Pour les demandes d’impression pour lesquelles Xandr n’a reçu aucune indication que l’annonce a été rendue (c.-à-d. qu’elle n’a pas été traitée), aucune information sur le pays n’est fournie.
hour date Oui "2020-02-01 06:00:00" L’heure de la vente aux enchères

Remarque : Pour les impressions antérieures à 100 jours, le jour est retourné plutôt que l’heure.
media_type string Non "banner" Type de média associé au créatif qui a servi sur cette impression. Les valeurs possibles sont les suivantes :
- "banner"
- "pop"
- "interstitial"
- "video"
- "text"
- "expandable"
- "skin"
- "facebook"
- "image and text"
- "high impact"
- "native"
- "audio"
- "Unknown"
media_type_id int Oui 1 ID de type de média associé au créatif qui a servi sur cette impression. Les valeurs possibles sont les suivantes :
1 (bannière)
2 (pop)
3 (interstitiel)
4 (vidéo)
5 (texte)
6 (extensible)
8 (skin)
9 (facebook)
10 (image et texte)
11 (impact élevé)
12 (natif)
13 (audio)
media_type_name string Non "banner" Nom du type de média associé au créatif qui a servi sur cette impression. Les valeurs possibles sont les suivantes :
- "banner"
- "pop"
- "interstitial"
- "video"
- "text"
- "expandable"
- "skin"
- "facebook"
- "image and text"
- "high impact"
- "native"
- "audio"
- "Unknown"
month date Oui "2020-02" Le mois de la vente aux enchères
segment_id int Oui 123456 ID d’un segment qui ciblait l’impression.

Remarque : les conservateurs qui exécutent ce rapport voient uniquement les segments qu’ils attribuent à leurs objets d’élément de ligne de transaction. Par exemple, un curateur qui extrait ce rapport ne verra pas les segments liés à une transaction de vendeur tiers qu’il achète.
segment_name string Non "That Segment" Nom d’un segment qui ciblait l’impression.

Remarque : les conservateurs qui exécutent ce rapport voient uniquement les segments qu’ils attribuent à leurs objets d’élément de ligne de transaction. Par exemple, un curateur qui extrait ce rapport ne verra pas les segments liés à une transaction de vendeur tiers qu’il achète.
segment_owner_id int Oui 789 ID de membre du propriétaire du segment qui possède le ou les segments ciblés
segment_owner_name string Non "That Segment Owner" Nom du membre du propriétaire du segment qui possède le ou les segments ciblés
seller_member_id int Oui 4567 ID de membre du vendeur où la transaction organisée a été effectuée
seller_member_name string Non "That Seller" Nom du membre du vendeur où la transaction organisée a été effectuée
supply_strategy string Oui "Deals" Fait la distinction entre les différents canaux d’approvisionnement utilisés pour sourcer des impressions pour le curateur.

Remarque : Seuls "Open Exchange" et "Deals" sont actuellement pertinents pour le curateur.
supply_type_id int Oui 0 ID du type de fourniture de l’annonce qui a été rendue. Les valeurs possibles sont les suivantes :
0 (web)
1 (mobile_web)
2 (mobile_app)
supply_type_name string Oui "web" Nom du type de fourniture de l’annonce qui a été rendue. Les valeurs possibles sont les suivantes :
- "web"
- "mobile_web"
- "mobile_app"
targeting_type string Oui "Inclusion" Indique si le segment a contribué au ciblage de l’élément de ligne en étant inclus ou exclu. Les valeurs possibles sont les suivantes :
- "Inclusion"
- "Exclusion"

Mesures

Column Type Exemple Description
targeted_curator_media_cost Argent 31.513709 Montant des dépenses (effectuées par le biais d’impressions ciblées par le segment) qu’un curateur a envoyé aux vendeurs d’échange nets des frais de curateur et des marges, le cas échéant
targeted_curator_media_cost_ecpm Argent 1.6654 Montant des dépenses (effectuées par le biais d’impressions ciblées par le segment, exprimées sous la forme d’un eCPM basé sur les impressions traitées) qu’un curateur a envoyé aux vendeurs d’échange nets des frais de curateur et des marges, le cas échéant
targeted_curator_revenue Argent 48.4185 Montant des dépenses (effectuées par le biais d’impressions ciblées par le segment) qu’un acheteur a envoyé au curateur net des frais d’acheteur, le cas échéant
targeted_curator_revenue_ecpm Argent 2.5588 Montant des dépenses (effectuées par le biais d’impressions ciblées par le segment, exprimées sous la forme d’un eCPM basé sur des impressions ciblées) d’un acheteur envoyé au curateur net des frais d’achat, le cas échéant
targeted_impressions int 18922 Nombre d’impressions traitées ciblées par le segment
targeted_view_measured_impressions int 17867 Nombre d’impressions traitées que Xandr a mesurées sur la visibilité sur le segment ciblé
targeted_viewable_impressions int 14135 Nombre d’impressions consultées ciblées par le segment

Exemple

Create une demande de rapport au format JSON

Le fichier JSON doit inclure le report_type de "curator_segment_performance", 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 curator_segment_performance

{
    "report": {
        "report_type": "curator_segment_performance",
        "columns": [
            "curated_deal_id",
            "cureated_deal_name",
            "segment_id",
            "segment_name",
            "targeting_type",
            "targeted_impressions",
            "targeted_curator_revenue"
        ],
        "report_interval": "today",
        "format": "csv"
    }
}

POST la demande au service de création de rapports

$ curl -b cookies -X POST -d @curator_segment_performance 'https://api.appnexus.com/report'

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

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 'https://api.appnexus.com/report?id=a2c95fcff2d8759e69cec123364f9b32'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2020-09-04 12:46:08",
            "json_request": "{\"report\":{\"report_type\":\"curator_segment_performance\",\"columns\":[\"curated_deal_id\",\"cureated_deal_name\",\"segment_id\",\"segment_name\",\"targeting_type\",\"targeted_impressions\",\"targeted_curator_revenue\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"curator_member_id\":\"12025\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1599264000,\"start_date\":1599177600,\"user_id\":\"123456\"}",
            "url": "report-download?id=a2c95fcff2d8759e69cec123364f9b32"
        },
        "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 'https://api.appnexus.com/report-download?id=a2c95fcff2d8759e69cec123364f9b32' > /tmp/curator_segment_performance.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.