API de plateforme numérique - Rapport d’utilisation du fournisseur

Ce rapport réseau fournit des détails sur votre utilisation des données ou de la plateforme alimentée par des fournisseurs tiers (par exemple, des fournisseurs de segments d’utilisateurs), les coûts de l’utilisation de ces données ou fonctionnalités, ainsi que les éléments/campagnes pour lesquels les coûts du fournisseur étaient applicables.

Période

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

aujourd’hui
yesterday
last_7_days
last_30_days
month_to_date
quarter_to_date
last_month
Vie

Le time_granularity des données est hourly. Pour obtenir des instructions sur la récupération d’un rapport, consultez le service de rapports ou les exemples ci-dessous.

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.

Période de conservation des données

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

Dimensions

Column	Type	Filtre?	Exemple	Description
`month`	date	oui	`"2010-02"`	Mois auquel la vente aux enchères associée à l’impression s’est produite.
`day`	date	oui	`"2010-02-01"`	Le jour où la vente aux enchères associée à l’impression s’est produite.
`hour`	date	oui	`"2010-02-01 05:00:00"`	Heure à laquelle la vente aux enchères associée à l’impression s’est produite.
`buyer_member_id`	int	oui	`643`	ID du membre qui a utilisé les données fournies par le fournisseur tiers (par exemple, les fournisseurs de segments d’utilisateurs).
`geo_country`	chaîne	Oui	`"US"`	Code du pays géographique associé à l’impression.
`geo_country_name`	string	Non	`"United States"`	Nom du pays géographique associé à l’impression.
`geo_country_code`	chaîne	Oui	`"CA"`	Chaîne à deux caractères indiquant le pays associé à l’impression.
`campaign_id`	int	oui	`31`	ID de la campagne associée à l’impression qui a utilisé le ciblage de données tierces.
`campaign_name`	string	Non	`"Prospect Campaign"`	Nom de la campagne associée à l’impression qui utilisait le ciblage de données tierces.
`campaign`	chaîne	Non	`"Prospect Campaign (31)"`	Nom et ID de la campagne associée à l’impression.
`campaign_group_type_id`	int	oui	`154`	ID du type de groupe de campagne qui a acheté cette impression. Utilisé dans les rapports fractionnés.
`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	Non	`"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`.
`split`	string	Non	`"Mobile Split A (342)"`	Nom et ID du fractionnement.
`line_item_name`	string	Non	`"Fall Apparel"`	Nom de l’élément de ligne associé à l’impression qui utilisait le ciblage de données tierces.
`targeted_segment_ids`	string	Non	`"935035, 935146"`	Liste d’ID séparés par des virgules pour chacun des segments utilisés lors du ciblage.
`advertiser_currency`	chaîne	Oui	`"USD"`	La devise préférée de l’annonceur. Cette préférence peut être définie à l’aide du service Annonceur.
`insertion_order_id`	int	oui	`1243`	ID de l’ordre d’insertion associé à l’impression qui utilisait le ciblage de données tierces.
`insertion_order_name`	chaîne	Non	`"IO001"`	Nom de l’ordre d’insertion associé à l’impression qui a utilisé le ciblage de données tierces.
`insertion_order_code`	chaîne	Non	`"IOABC-1243"`	Code défini par l’utilisateur associé à l’ordre d’insertion.
`insertion_order`	string	Non	`"IO001 (1243)"`	Nom et ID de l’ordre d’insertion associé à l’impression qui a utilisé le ciblage de données tierces.
`advertiser_id`	int	oui	`9843`	ID de l’annonceur associé à l’impression. Si la valeur est `0`, soit l’impression a été achetée par un acheteur externe, soit une valeur par défaut ou une valeur PSA a été affichée.
`advertiser_name`	string	Non	`"ADVUS"`	Nom de l’annonceur associé à l’impression.
`advertiser`	string	Non	`"ADVUS (9843)"`	Nom et ID de l’annonceur associé à l’impression.
`line_item_id`	int	oui	`9865`	ID de l’élément de ligne associé à l’impression qui utilisait le ciblage de données tierces.
`line_item_code`	string	Non	`"LI001"`	Code défini par l’utilisateur associé à l’élément de ligne.
`line_item`	string	Non	`"Fall Apparel (9865)"`	Nom et ID de l’élément de ligne associé à l’impression qui utilisait le ciblage de données tierces.
`vendor_id`	int	oui	`76`	ID du fournisseur tiers (par exemple, les fournisseurs de segments d’utilisateurs) dont l’utilisation et le coût des données sont indiqués dans ce rapport.
`vendor_name`	string	Non	`"AXM"`	Nom du fournisseur tiers.
`vendor`	chaîne	Non	`"AXM (76)"`	Nom et ID du fournisseur tiers.
`vendor_type`	string	Non	`"Segment Marketplace"`	Type du fournisseur en fonction des données tierces qu’il fournit. Les valeurs autorisées sont les suivantes : - `Segment Marketplace` - `Cross Device Graph` - `Measurement` - `Offline Attribution` - `Unknown Vendor Type`
`cost_type`	string	Non	`"Segment Data Costs"`	Type de coût lié à l’utilisation des données fournies par les fournisseurs tiers. Les valeurs autorisées sont les suivantes : - `Segment Data Costs` - `Feature Costs` - `Unknown Vendor Type`
`buying_currency`	chaîne	Oui	`"USD"`	Devise de transaction utilisée par l’acheteur pour acheter cette impression.
`cpm_usd`	Argent	oui	`7.8`	Coût par mille, ou mille (mille = mille en latin) exprimé en USD. Modèle de tarification dans lequel les annonceurs paient pour chaque 1000 impressions de leur publicité servie.

Mesures

Column	Type	Filtre	Exemple	Formule	Description
`imps`	int	oui	`34534`	Lutins	Nombre total d’impressions qui ont utilisé des données tierces pour diffuser la publicité.
`third_party_costs`	Argent	oui	`5.20`	third_party_costs	Valeur monétaire totale des coûts des segments de données, des coûts des fonctionnalités ou autres.
`sales_tax`	Argent	Non	`.43`	sales_tax	Montant de la taxe de vente perçue en USD. Ce champ est rempli uniquement lorsque l’adresse de facturation de l’acheteur se trouve dans l’un des états américains suivants : NY, TX ou NJ. Xandr est tenu (par le régulateur de l’État local approprié) de percevoir cette taxe.
`vendor_costs`	Argent	Non	`5.00`	vendor_costs	Coûts totaux, y compris, mais sans s’y limiter, les coûts des données de segment et les coûts des fonctionnalités. Coûts des fonctionnalités : Coûts induits lors de l’utilisation d’une fonctionnalité de plateforme telle que Nielsen Digital Ad Ratings (DAR), Nielsen Catalina Solutions (NCS) et Cross Device. Coûts des données de segment : Tous les coûts liés à l’utilisation de segments dans la Place de marché de données. Applicable lorsque des segments spécifiques sont appliqués à des éléments de ligne et que la tarification associée est affichée dans la plateforme.
`vendor_costs_buying_currency`	Argent	Non	`1.50`	vendor_costs_buying_currency	Coûts du fournisseur exprimés dans la devise de transaction utilisée par l’acheteur.

Exemples

Create demande de rapport au format JSON

Le fichier JSON doit inclure le report_type de "buyer_vendor_usage_analytics", 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é (month, day, hour) 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_vendor_usage_analytics  
{
    "report": {
        "report_type": "buyer_vendor_usage_analytics",
        "format": "csv",
        "report_interval": "last_7_days",
        "columns": [
            "imps",
            "line_item_id",
            "vendor_costs",
            "sales_tax",
            "vendor_type",
            "vendor"
        ],
        "orders": [
            "line_item_id",
            "vendor_costs",
            "vendor_type"
        ]
    }
}

`POST` la demande adressée au service De rapports

POST demande JSON pour récupérer un ID de rapport.

$ curl -b cookies -c cookies -X post -d @buyer_vendor_usage_analytics "https://api.appnexus.com/report"
{
    "response": {
        "report_id": "d89151942729f768dcac4586288ff7eb",
        "status": "OK",
        "dbg_info": {
            "user::read_limit": 100,
            "user::write_limit": 60,
            "read_limit": 100,
            "write_limit": 60,
            "user::read_limit_seconds": 60,
            "user::write_limit_seconds": 60,
            "read_limit_seconds": 60,
            "write_limit_seconds": 60,
            "instance": "50.bm-report-processor.prod.nym2",
            "version": "1.73.238",
            "time": 712.83793449402,
            "start_microtime": 1686106227,
            "warnings": [],
            "api_cache_hit": "0",
            "output_term": null,
            "edge_forwarded_dbg_info": {
                "user::read_limit": 100,
                "user::write_limit": 60,
                "read_limit": 100,
                "write_limit": 60,
                "user::read_limit_seconds": 60,
                "user::write_limit_seconds": 60,
                "read_limit_seconds": 60,
                "write_limit_seconds": 60,
                "instance": "37.report-processor.prod.nym2",
                "version": "1.73.238",
                "time": 708.98699760437,
                "start_microtime": 1686106227,
                "warnings": [],
                "api_cache_hit": "0",
                "output_term": "report_id"
            },
            "edge_forwarded": true,
            "edge_forwarded_by": "50.bm-report-processor.prod.nym2",
            "edge_forwarded_to": "http://report-processor-edge.adnxs.net/report"
        }
    }
}

`GET`le 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_statusready. 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=d89151942729f768dcac4586288ff7eb'
{
    "response": {
        "status": "OK",
        "report": {
            "id": "d89151942729f768dcac4586288ff7eb",
            "name": "",
            "created_on": "2023-06-07 02:50:27",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": "",
            "json_request": "{\"report\":{\"report_type\":\"buyer_vendor_usage_analytics\",\"format\":\"csv\",\"report_interval\":\"last_7_days\",\"columns\":[\"imps\",\"line_item_id\",\"vendor_costs\",\"sales_tax\",\"vendor_type\",\"vendor\"],\"orders\":[{\"order_by\":\"line_item_id\",\"direction\":\"ASC\"},{\"order_by\":\"vendor_costs\",\"direction\":\"ASC\"},{\"order_by\":\"vendor_type\",\"direction\":\"ASC\"}],\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"buyer_member_id\":\"958\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1686096000,\"start_date\":1685491200,\"user_id\":\"4814\"}",
            "header_info": "Report type: buyer_vendor_usage_analyticss\nReport ID: d89151942729f768dcac4586288ff7eb\nRun at: 2023-06-07 04:08:58 UTC\nRequested Start date: 2023-05-31 00:00:00 UTC\nRequested End date: 2023-06-07 00:00:00 UTC\nTimezone: UTC\n",
            "user_id": "4814",
            "member_id": "958",
            "bidder_id": "2",
            "entity_id": "958",
            "row_count": 0,
            "report_size": 61,
            "url": "report-download?id=d89151942729f768dcac4586288ff7eb"
        },
        "execution_status": "ready",
        "_was_this_status_cached_": 0,
        "dbg_info": {
            "user::read_limit": 100,
            "user::write_limit": 60,
            "read_limit": 100,
            "write_limit": 60,
            "user::read_limit_seconds": 60,
            "user::write_limit_seconds": 60,
            "read_limit_seconds": 60,
            "write_limit_seconds": 60,
            "instance": "50.bm-report-processor.prod.nym2",
            "version": "1.73.238",
            "time": 454.48088645935,
            "start_microtime": 1686110938,
            "warnings": [],
            "api_cache_hit": "0",
            "output_term": null,
            "edge_forwarded_dbg_info": {
                "user::read_limit": 100,
                "user::write_limit": 60,
                "read_limit": 100,
                "write_limit": 60,
                "user::read_limit_seconds": 60,
                "user::write_limit_seconds": 60,
                "read_limit_seconds": 60,
                "write_limit_seconds": 60,
                "instance": "37.report-processor.prod.nym2",
                "version": "1.73.238",
                "time": 448.82392883301,
                "start_microtime": 1686110938,
                "warnings": [],
                "api_cache_hit": "0",
                "output_term": "report"
            },
            "edge_forwarded": true,
            "edge_forwarded_by": "50.bm-report-processor.prod.nym2",
            "edge_forwarded_to": "http://report-processor-edge.adnxs.net/report"
        }
    }
}

`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 l’ID de service et de rapport dans le url champ de la réponse à votre appel précédent GET . Lorsque vous identifiez le fichier que vous souhaitez enregistrer, veillez à utiliser l’extension du fichier "format" que vous avez spécifié dans votre appel initial POST , par exemple CSV.

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

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.

Remarque

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

Last updated on 2025-04-01

Partager via