Partager via


API de plateforme numérique - Rapport d’attribution hors connexion

Le rapport Attribution hors connexion est utilisé pour analyser les performances de votre élément de ligne pour influencer les achats en magasin auprès de vos publics cibles. Le rapport Attribution hors connexion n’est accessible qu’aux clients dont l’attribution des ventes hors connexion est activée pour leurs éléments de ligne.

Pour obtenir des instructions sur la récupération d’un rapport, consultez Service de rapports ou l’exemple ci-dessous. Ce rapport nécessite la spécification de l’ID de l’annonceur dans le cadre de l’URL, par exemple :

 https://api.appnexus.com/report?advertiser_id=ADVERTISER_ID

Période

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

  • Personnalisé
  • last_7_available_days
  • last_14_available_days
  • last_30_available_days
  • last_365_days

Période de conservation des données

Ce rapport a une granularité de temps quotidienne et peut récupérer des données des 120 derniers 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.
  • Vous ne pouvez pas effectuer une sélection de fuseau horaire spécifique, car les données NCS utilisent le ou les fuseaux horaires à partir desquels les ventes ont lieu.

Dimensions

Column Type Filtre? Exemple Description
day date "2021-10-10" Jour où le NCS a généré le rapport. La date affichée pour cette dimension correspond à la date affichée pour .analysis_start_date
insertion_order_id string Oui "5533431" ID de l’ordre d’insertion.
insertion_order_name string Oui "My IO" Nom de l’ordre d’insertion.
line_item_id string Oui "14545960" ID de l’élément de ligne.
line_item_name string Oui "NCS Line Item" Nom de l’élément de ligne.
flight_id string "12396335" ID de la version d’évaluation.
flight.start_date date "2021-04-16 00:00:00 UTC" Date de début du vol.
flight.end_date date "2021-04-30 23:59:59 UTC" Date de fin du vol.
split_id string Oui "1234" ID d’un fractionnement.
split_name string Oui "my split" Nom d’un fractionnement.
analysis_end_date date "2021-10-10" Dernier jour de l’intervalle d’achat signalé pour chaque cohorte.
analysis_rejection_reason string "DMA minimum not met, Retailer minimum not met" Erreur qui identifie les exigences pour la mesure qui n’ont pas été remplies.
analysis_start_date date "2021-10-03" Premier jour de l’intervalle d’achat signalé pour chaque cohorte.
frequency_type chaîne "weekly" Fréquence de création de rapports sélectionnée pour cet élément de ligne ou fractionnement.
lookback_hours string "flight_lifetime" Fenêtre de recherche arrière sélectionnée pour cet élément de ligne ou fractionnement.
product_id string "10096" ID de sélection de produit utilisé pour décrire le ou les produits signalés.
product chaîne "BAKING SUPPLIES \| MARS INCORPORATED \| M&M MARS" Nom de sélection de produit utilisé pour décrire le ou les produits signalés.

Mesures

Column Type Description
imps int Nombre total d’impressions servies.
clicks int Nombre total de clics enregistrés.
booked_revenue int Revenus reçus de l’annonceur.
media_cost int Coût pour le membre achetant pour cet inventaire.
total_cost int Montant total des coûts accumulés au cours de la période indiquée. Cela inclut généralement deux types de coûts : les coûts budgétés (coût des médias, coût des données, frais de partenaire, frais de service, commissions) et les revenus des éditeurs si vous suivez les paiements des éditeurs sur la plateforme.
imps_viewed int Impressions considérées comme visibles selon la définition de l’Interactive Advertising Bureau (IAB) : Pendant au moins une seconde, 50 % des pixels d’un créateur (ou 30 % pour un créatif avec au moins 242 500 pixels) doivent être affichés sur un écran.
all_outlet_adjusted_number_of_trips int Nombre de déplacements au magasin par les ménages qui se sont passés aux dates de début et de fin de l’analyse. LE NCS contient uniquement des données pour certains magasins (points de vente) situés aux États-Unis. Il ajuste donc les métriques de ventes pour tenir compte des ventes qui se sont produites dans tous les points de vente aux États-Unis.
all_outlet_adjusted_penetration% int Pourcentage de pénétration du produit, de la catégorie ou de la marque pendant les dates de début et de fin de l’analyse. LE NCS contient uniquement des données pour certains magasins (points de vente) situés aux États-Unis. Il ajuste donc les métriques de ventes pour tenir compte des ventes qui se sont produites dans tous les points de vente aux États-Unis.

Remarque : La pénétration mesure la popularité de la marque ou de la catégorie. Il est calculé en divisant le nombre de personnes qui ont acheté une marque ou une catégorie spécifique de biens au moins une fois au cours d’une période donnée par la taille de la population totale du marché concerné.
all_outlet_adjusted_total_spend int Nombre de dollars dépensés par les ménages sur le produit, la catégorie ou la marque pendant les dates de début et de fin de l’analyse. LE NCS contient uniquement des données pour certains magasins (points de vente) situés aux États-Unis. Il ajuste donc les métriques de ventes pour tenir compte des ventes qui se sont produites dans tous les points de vente aux États-Unis.
video_completions int Pour une vidéo créative, nombre de fois où la création vidéo a été visionnée jusqu’à la fin.

Exemple

Create une demande de rapport au format JSON

Le fichier JSON doit inclure le report_type de "offline_attribution", ainsi que les colonnes (dimensions et métriques) et le 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 report-request.json

{
    "report": {
        "report_type": "offline_attribution",
        "format": "csv",
        "report_interval": "last_365_days",
        "columns": [
            "month",
            "member_id",
            "line_item_id",
            "split_id",
            "all_outlet_adjusted_total_spend",
            "imps",
            "analysis_rejection_reason"
        ],
        "orders": [
            "member_id",
            "line_item_id",
            "split_id"
        ],
        "filters": [{
            "line_item_id": [14545960, 14545978]
        }]
    }
}

POST la demande au service de création de rapports

Dans cet exemple, nous demandons l’exécution du rapport pour l’annonceur 660.

$ curl -b cookies -c cookies -X POST -d @offline_attribution 'https://api.appnexus.com/report?advertiser_id=660'

{
    "response":{
        "status":"OK",
        "report_id":"07af1282c9485adcef49c95fa5d7496b"
    }
}

Utiliser l’ID de rapport pour récupérer les données du rapport

La réponse standard inclut les données du rapport et une URL de téléchargement que vous pouvez utiliser pour enregistrer les données dans un fichier. Si vous souhaitez obtenir uniquement l’URL de téléchargement sans les données du rapport, transmettez "without_data" la chaîne de requête.

$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=07af1282c9485adcef49c95fa5d7496b'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2011-11-16 23:51:14",
            "cache_hit": false,
            "fact_cache_hit": false,
            "json_request": "{\"report\":{\"report_type\":\"offline_attribution\",\"format\":\"csv\",\"report_interval\":\"last_365_days\",\"columns\":[\"month\",\"member_id\",\"line_item_id\",\"split_id\",\"all_outlet_adjusted_total_spend\",\"imps\",\"analysis_rejection_reason\"],\"orders\":[{\"order_by\":\"member_id\",\"direction\":\"ASC\"},{\"order_by\":\"line_item_id\",\"direction\":\"ASC\"},{\"order_by\":\"split_id\",\"direction\":\"ASC\"}],\"filters\":[{\"line_item_id\":[14545960,14545978]},{\"member_id\":\"958\"}],\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1622678400,\"start_date\":1591142400,\"user_id\":\"46052\"}",
            "header_info": "Report type: offline_attributions\nReport ID: 5dd162b83a0417e13859e5e243844329\n",
            "data": "day,campaign,booked_revenue,imps,clicks,click_thru_pct,site_domain\u000d\u000a2011-11-12,ExampleCampaign - 1
             (123456),.000000,24,0,.000000000000000000%,aaaa.com\u000d\u000a2011-11-13,ExampleCampaign - 2 (789012),.000000,9,0,
             .000000000000000000%,bbbb.net\u000d\u000a2011-11-12,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,
             ccc.com\u000d\u000a2011-11-13,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,cccc.de\u000du000a
             2011-11-14,ExampleCampaign - 3 (345678),.000000,10,0,.000000000000000000%,dddd.com\u000d\u000a2011-11-13,
             ExampleCampaign - 4 (901234), 2.574900,22,3,13.636363636363636364%,aaaa.com\u000d\u000a2011-11-15,ExampleCampaign - 3
             (345678),8.583000,2431,10,.411353352529823118%,abab.com\
             ...
            "url": "report-download?id=495d03a7667bac467bb488043ae336e9"
        },
        "execution_status": "ready"
    }
}

Utiliser l’URL de téléchargement pour enregistrer les données du rapport dans un fichier

Vous utilisez le "url" champ dans la réponse pour enregistrer les données du rapport dans un fichier. Effectuez simplement un autre GET appel et identifiez l’emplacement et le fichier dans lesquels vous souhaitez enregistrer. Veillez à utiliser le fichier l’extension du "format" que vous avez spécifié dans votre demande initiale POST .

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=495d03a7667bac467bb488043ae336e9' > /tmp/site_domain.csv