API De plateforme numérique - Rapport Key Value Analytics

Le rapport Key Value Analytics affiche les informations associées aux valeurs et clés de ciblage définies de votre réseau.

Les impressions avec ciblage clé/valeur serviront et seront signalées uniquement pour les impressions enregistrées par une balise de placement contenant le préfixe kw_ sur le nom de clé. Par exemple, une balise de placement contenant keyname=value1 ne sera pas servie et ne sera donc pas journalisée, tandis qu’une balise de placement contenant kw_keyname=value1 sera servie et journalisée. Cela s’applique aux GETappels d’annonces basés sur une chaîne de requête avec les types de balises suivants : /tt, /ttj/jpt/pt/fpt, /ptv, /ssptv, . /ssvmap/mtj/map/mob/prebid/amp/vmap

Toutes les impressions des cibles clés/valeurs ne seront pas incluses dans les rapports. Pour être incluses, les cibles doivent répondre aux critères suivants :

• La clé doit être prédéfinie. Pour plus d’informations, consultez la page Prédéfinissement des clés et des valeurs de ciblage dans l’interface utilisateur.
• La valeur doit être prédéfinie OU la valeur doit être ciblée par au moins un élément de ligne ou une campagne.
• La valeur n’est pas une plage numérique (supérieure ou inférieure à).
• La valeur n’inclut pas de caractère générique.

Période

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

• aujourd’hui
• yesterday
• last_24_hours
• last_48_hours
• last_7_days
• last_month
• month_to_date
• quarter_to_date

Dates se produisant il y a plus de 45 jours

Si vous créez un rapport Key Value Analytics avec le champ Plage défini sur Personnalisé (où la date de fin est supérieure à 45 jours à partir d’aujourd’hui), votre rapport (quelles que soient les métriques incluses) est ajouté à une file d’attente spéciale pour les rapports « gourmands en ressources ». Par conséquent, le rapport peut prendre plus de temps que d’habitude. En outre, ce rapport gourmand en ressources peut, en raison de la quantité de données demandées, échouer avant d’être terminé. Si votre rapport ne se termine pas, vous recevrez une notification. Si votre demande de rapport échoue, vous pouvez :

• Réexécutez le rapport ultérieurement.
• Utilisez un type de rapport autre que Key Value Analytics.
• Modifiez la façon dont vous structurez vos rapports (si possible) afin qu’ils n’incluent pas de dates supérieures à 45 jours.

Si vous demandez fréquemment des rapports Key Value Analytics qui incluent des dates de plus de 45 jours, vous devrez peut-être envisager d’exécuter ces rapports via l’API, de mettre en cache les données et d’utiliser des flux de création de rapports en bloc ou un flux de données au niveau du journal - Archive. Pour plus d’informations sur la façon de modifier vos rapports pour éviter ces problèmes, consultez la page Dimensions, Métriques, Filtrage et Regroupement dans l’interface utilisateur.

Période de conservation des données

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

Dimensions

Mesures

Exemples

Create la demande de rapport JSON

Le fichier JSON doit inclure le report_type de "key_value_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é (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 key_value_analytics

{"report":
    {
        "report_type":"key_value_analytics",
        "columns":[
            "hour",
            "seller_member_id",
            "key_name",
            "key_name_label",
            "key_value",
            "key_value_label",
            "imps",
            "clicks",
            "revenue",
            "ctr"
        ],
        "report_interval":"last_48_hours",
        "format":"csv"
    }
}

POST la demande adressée au service De rapports

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

$ curl -b cookies -X post -d @key_value_analytics "https://api.appnexus.com/report?advertiser_id=123"

{
   "response":{
      "status":"OK",
      "report_id":"09b6979a6a4c3805bdac8921378d3622"
   }
}

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=09b6979a6a4c3805bdac8921378d3622'

{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2016-12-11 19:15:48",
         "json_request": "{\"report\":{\"report_type\":\"key_value_analytics\",
             \"columns\":[\"hour\",\"seller_member_id\",
             \"key_name\",\"key_name_label\",\"key_value\",\"key_value_label\",
             \"imps\",\"clicks\",\"revenue\",\"ctr\"],
             \"report_interval\":\"last_48_hours\",\"format\":\"csv\",\"filters\":[{\"advertiser_id\":\"123\"}]}}",
             "url":"report-download?id=b97897a7864dd8f34e7457226c7af592"
      },
      "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 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 dans lequel vous souhaitez enregistrer, veillez à utiliser l’extension de fichier du format de fichier que vous avez spécifié dans votre fichier initial POST.

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