Soumissionnaires - Service de rapports

Le service de rapports propose des données de création de rapports qui intéressent les acheteurs et les vendeurs. Il est utilisé pour répondre à des questions telles que :

• Combien d’argent a été dépensé ?
• Combien d’impressions ont été vues ?
• Combien d’impressions ont été vendues ?
• Combien de revenus a-t-on gagné ?

Il s’agit d’un service en lecture seule . Bien que vous mettez POST en place une demande de rapport au format JSON, cela ne modifie pas les données du cache Imp Bus. Vous devez être authentifié en tant que type d’utilisateur "bidder" pour exécuter des rapports. Chaque type de rapport fournit ses propres métriques, filtrage et options de regroupement.

Types de rapports

Les principaux types de rapports sont les suivants :

• Rapport de l’acheteur de la plateforme du soumissionnaire
• Rapport vendeur de plateforme
• API de rapport de facturation du soumissionnaire
• Rapport de facturation de la plateforme vendeur
• Rapport d’audits créatifs terminé
• API De rapport d’erreur d’enchère du soumissionnaire

API REST pour l’affichage des métadonnées

Il existe deux couches de données dans le service de rapports : les métadonnées et les données réelles. Les métadonnées sont une liste de paramètres de création de rapports disponibles.

Pour exécuter un rapport personnalisé, vous aurez besoin d’une requête au format JSON. Vous pouvez demander des données par filtre, groupe ou colonne. Un filtre filtre filtre les résultats. Une requête ayant un filtre tel que day, filtre en fonction des données agrégées. Vous pouvez également effectuer une recherche par paramètres individuels, tels que imps_sold.

report?meta=report_type

GET https://api.adnxs.com/report?meta=platform_buyer

Les métadonnées sont au format suivant :

{"column":"day","type":"time"}
{"column":"month","type":"time"}
{"column":"geo_country","type":"string"}

Exemple de métadonnées

$ curl "https://api.adnxs.com/report/meta/platform_buyer"
  "response": {
    "status": "OK",
 "meta": {
      "columns": [
        {
          "column": "month",
          "type": "time"
        },
        {
          "column": "day",
          "type": "date"
        },
        {
          "column": "hour",
          "type": "date"
        },
      ...
      ],
      "filters": [
        {
          "column": "hour",
          "type": "date"
        },
        {
          "column": "day",
          "type": "date"
        },
        {
          "column": "year",
          "type": "date"
        },
        ...
      ],
      "havings": [
        {
          "column": "clicks"
        },
        {
          "column": "buyer_spend"
        },
        {
          "column": "imps_bought"
        },
        {
          "column": "buyer_ecpm"
        },
        {
          "column": "click_rate_sold"
        }
      ],
      "time_intervals": [
        "current_hour",
        "last_hour",
        "last_48_hours",
        "today",
        "yesterday",
        "last_7_days",
        "month_to_date",
        "quarter_to_date",
        "last_month",
        "lifetime",
        "mtd"
      ]
    }
}

API REST pour la récupération de données

Champs JSON

Comment récupérer un rapport

• Étape 1. Create une demande de rapport au format JSON
• Étape 2. POST la requête au service de rapports
• Étape 3. GET the report status from the Report Service
• Étape 4. OBTENIR les données du rapport à partir du service de téléchargement de rapports

Étape 1. Create une demande de rapport au format JSON

Le fichier JSON doit inclure le spécifique report_type que vous souhaitez exécuter, ainsi que les columns (dimensions et métriques) et report_interval ("today", , "yesterday""month_to_date", etc.) que vous souhaitez récupérer. Vous pouvez également inclure pour les filters dimensions et définir la granularité (année, mois, jour) et spécifier le format dans lequel les données doivent être retournées. Les format options sont les suivantes :

• "csv" - Fichier séparé par des virgules
• "xls" - Fichier Excel M.S. séparé par des tabulations
• "xlsx" - Format Excel M.S. natif

"filters": [{"bid_type": ["learn","optimized"]}, {"geo_country":"US"}]

"filters": [{"bid_type":"learn"}, {"bid_type":"optimized"}, {"geo_country":"US"}]

Pour plus d’informations sur les champs qui peuvent être inclus dans la demande, consultez Champs JSON ci-dessus. Pour obtenir la liste complète des dimensions et métriques disponibles, consultez la documentation relative au type de rapport spécifique que vous souhaitez exécuter, ou extrayez les métadonnées de ce rapport, comme décrit dans API REST pour l’affichage des métadonnées.

$ cat report_request
{
    "report": {
        "report_type": "platform_buyer",
        "report_interval": "last_48_hours",
        "columns": ["day","imps_bought"],
        "filters": [{"geo_country":"US"}],
        "orders": [{"order_by":"day", "direction":"ASC"}],
        "format": "csv"
    }
}

Étape 2. POST la demande au service de rapport

Vous POST la demande JSON et récupérez un ID de rapport.

$ curl -b cookies -c cookies -X POST -d @report_request 'https://api.adnxs.com/report?member_id=255'
{
    "response": {
        "status": "OK",
        "report_id": "ca9955709eade9a0e89f5cda5345c12r",
        "dbg_info": {
            ...
        }
    }
}

Étape 3. 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 appel jusqu’à ce que soit "execution_status""ready". Utilisez ensuite le report-download service pour enregistrer les données de création de rapports dans un fichier. (Ceci est décrit à l’étape suivante.)

$ curl -b cookies -c cookies 'https://api.adnxs.com/report/ca9955709eade9a0e89f5cda5345c12r'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2012-03-13 18:15:48",
            "cache_hit": false,
            "fact_cache_hit": false,
            "json_request": "{\"report\":{\"report_type\":\"network_analytics\",\"report_interval\":
                \"last_48_hours\",\"columns\":[\"day\",\"imps\",\"clicks\"],\"filters\":[{\"geo_country\":
                \"US\"},{\"entity_member_id\":\"514\"},{\"entity_member_id\":null}],\"orders\":
                [{\"order_by\":\"day\",\"direction\":\"ASC\"},{\"order_by\":\"imps\",\"direction\":
                \"DESC\"}]}}",
            "header_info": "Report type:,network_analytics\r\n,\r\nRun at:,2012-03-13 18:15:48\r\nStart date:,
                \r\nEnd date:,\r\nTimezone:,\r\nUser:,John Smith (9385)\r\n",
            "report_size": "10",
            "row_count": "35",
            "url": "report-download?id=ca9955709eade9a0e89f5cda5345c12r"
        },
        "execution_status": "ready",
        "dbg_info": {
            ...
        }
    }
}

Étape 4. 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 report-download service. Vous trouverez le service et l’ID de rapport dans le champ URL 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.

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=<download_id>

Vous pouvez ensuite ouvrir le fichier.

Planifier des rapports périodiques

Vous pouvez automatiser le processus de création de rapports en créant des versions enregistrées des rapports qui vous intéressent et en demandant à notre système de vous envoyer les données par e-mail à des intervalles spécifiés. Pour plus d’informations sur la configuration de ces rapports automatisés, consultez Le service de rapports enregistrés.

Voir aussi

• Service de rapports enregistré
• Rapport d’audits créatifs terminé
• Rapport de l’acheteur de la plateforme du soumissionnaire
• API de rapport de facturation du soumissionnaire
• Rapport vendeur de plateforme
• Rapport de facturation de la plateforme vendeur
• API De rapport d’erreur d’enchère du soumissionnaire
• Rapports de disponibilité d’inventaire
• Fuseaux horaires de création de rapports