Partager via


API de plateforme numérique - Rapport de disponibilité de l’inventaire

Les rapports de disponibilité d’inventaire fournissent des informations sur les types d’inventaire disponibles sur la plateforme. Ces rapports sont disponibles uniquement sur demande ; utilisez le portail de support. En raison de la structure de nos bases de données de disponibilité d’impression, les dimensions de création de rapports sont limitées à celles décrites ci-dessous. Notez également :

  • Nos bases de données contiennent 30 jours de données historiques de disponibilité d’inventaire. Les rapports sont donc limités à cette période.
  • Des restrictions de création de rapports supplémentaires peuvent s’appliquer aux impressions mobiles. Pour plus d’informations, contactez votre représentant Xandr.

Période

Vous pouvez exécuter ce rapport pour une période personnalisée, définir 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

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

Dimensions

Column Type Filtre? Exemple Description
day date Oui "2023-04-18" Le jour de l’impression.
month date Oui "2023-04" Mois de l’impression.
seller_member_id int Oui 9876 ID interne du membre vendeur.
seller_member_name string Non "CNN" Nom d’affichage du membre vendeur.
size string Oui "120"x"600" La taille standard d’un créatif. Pour en savoir plus sur les tailles, consultez standard_sizes retourné à partir du service membre.
geo_country string Oui "US" Code du pays géographique associé à l’impression.
imp_type_id int Oui 5 ID du type d’impression. Valeurs possibles (types associés entre parenthèses) :
- 1 (« Vide ») : aucun créativité servi.
- 2 (« PSA ») : Une annonce d’intérêt public a été rendue publique parce qu’il n’y avait pas d’offre valide et qu’aucune création par défaut n’était disponible.
- 3 (« Erreur par défaut ») : création par défaut fournie en raison d’un problème de délai d’expiration.
- 4 (« Valeur par défaut ») : valeur créative par défaut fournie, car il n’y avait pas d’enchères valides.
- 5 (« Conservé ») : la créativité de votre annonceur servie sur le site de votre éditeur.
- 6 (« Revendu ») : l’impression de votre éditeur a été vendue à un acheteur tiers.
- 7 (« RTB ») : la créativité de votre annonceur servie sur l’inventaire tiers.
- 8 (« Erreur PSA ») : une annonce de service public a été effectuée en raison d’un problème de délai d’expiration ou d’une absence de création par défaut.
- 9 (« Impression externe ») : impression provenant d’un dispositif de suivi d’impression.
- 10 (« Clic externe ») : clic à partir d’un dispositif de suivi des clics.
media_type_id int Oui 5 ID associé à un certain type de média. Par exemple, vidéo. Pour plus d’informations, consultez Media Type Service.
audit_type_id int Oui 2 Code entier pour la priorité de l’audit. Valeurs autorisées :
- 1:Standard
- 2:Priorité
browser_id int Oui 3 ID associé à un certain navigateur. Par exemple, Microsoft Edge. Pour plus d’informations, consultez Service de navigateur.
mobile_application string Non "Angry Birds (com.rovio.angrybirds)" Nom de l’application mobile suivi de l’ID au format Xandr.
language_id int Oui 1 ID associé à un certain navigateur. Par exemple, l'anglais. Pour plus d’informations, consultez Service de langage.
operating_system_family_id int Oui 5 ID associé à une certaine famille de systèmes d’exploitation. Par exemple, Microsoft Windows. Pour plus d’informations, consultez Service famille de systèmes d’exploitation.
datacenter_id int Oui 001 ID du centre de données utilisé pour acheminer la demande vers des partenaires de demande.
seller_join_date int Oui 20220901 Date à laquelle un membre vendeur a été ajouté. S’il est inférieur à un an, la date exacte s’affiche ; si vous avez plus d’un an, la date de jointure s’affiche sous la forme +1 an.
mobile_application_id string Oui "343200656" (iOS) ou "com.rovio.angrybirds" (Android) Un ID de App Store Apple, un nom de package Google Play ou un ID d’application Windows pouvant être ciblé.
device_type 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)

Mesures

Column Type Exemple Formule Description
imps int 1000 Lutins Nombre d’impressions disponibles.

Exemples

Create la demande de rapport au format JSON

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

{
    "report": {
        "columns": [
            "day",
            "seller_member_name",
            "audit_type",
            "size",
            "device_type",
            "operating_system_family",
            "geo_country",
            "imps"
        ],
        "format": "csv",
        "report_interval": "today",
        "report_type": "platform_inventory_avail"
    }
}

POST la demande adressée au service De rapports

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

{
   "response":{
      "status":"OK",
      "report_id":"6b177543a9411ffa67b09bdf5e76cac1"
   }
}

GETle rapport status à partir du service De rapports

$ curl -b cookies 'https://api.appnexus.com/report?id=6b177543a9411ffa67b09bdf5e76cac1'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2020-08-25 13:03:37",
         "json_request":"{\"report\":{\"report_type\":\"platform_inventory_avail\",\"columns\":[\"day\",\"seller_member_name\",\"audit_type\",\"imps\",\"size\",\"device_type\,\"operating_system_family\,\"geo_country\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"device_type\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
         "url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
      },
      "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=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/platform_inventory_avail.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.