Partager via

API de plateforme numérique - Service d’accès de l’acheteur de package

Ce service en lecture seule permet aux acheteurs d’afficher des informations sur les packages des vendeurs. Un paquet est une transaction qu’un vendeur est prêt à offrir à n’importe quel acheteur. Les acheteurs parcourent les packages disponibles, puis utilisent le service Deal From Package pour générer eux-mêmes des transactions.

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/package-buyer-access Afficher tous les packages disponibles.
GET https://api.appnexus.com/package-buyer-access?member_id=SELLER_MEMBER_ID Afficher tous les packages proposés par un vendeur spécifique.
GET https://api.appnexus.com/package-buyer-access?id=PACKAGE_ID Afficher un package spécifique.
GET https://api.appnexus.com/package-buyer-access?id=1,2,3 Affichez plusieurs packages par ID à l’aide d’une liste séparée par des virgules.
GET https://api.appnexus.com/package-buyer-access?sizes=WIDTHxHEIGHT,WIDTHxHEIGHT Affichez tous les packages, y compris des tailles spécifiques.
GET https://api.appnexus.com/package-buyer-access?search=PACKAGE_ID or NAME Recherchez un package par nom ou ID.
GET https://api.appnexus.com/package/meta Découvrez les champs que vous pouvez filtrer et trier.

Champs JSON

Nom Type Description
id int ID du package.
name string Nom du package.
description string Description du package. Les vendeurs l’utilisent généralement pour fournir aux acheteurs un meilleur aperçu de la transaction.
active Valeur booléenne Si truela valeur est , le package est actif. Si falsela valeur est , vous ne pouvez pas générer de transactions à partir du package et toutes les transactions associées cesseront de servir.
default_ask_price double Prix demandé qui sera appliqué à toutes les transactions générées à partir du package. Lorsque vous générez une transaction, le service d’accès acheteur de transaction calcule automatiquement le suggested_min_bid_price en ajoutant les frais de service d’enchère spécifiés dans votre contrat Xandr à la valeur de ce champ. Pour plus d’informations sur , suggested_min_bid_priceconsultez le service d’accès acheteur de transaction.

Remarque : ce champ n’est pertinent que si default_use_deal_floor a la valeur true.
default_currency string Devise de prix ask qui sera appliquée à toutes les transactions générées à partir du package.
default_use_deal_floor Valeur booléenne Si truela valeur est , le default_ask_price sera appliqué aux transactions générées à partir du package.

Remarque : Lorsque default_use_deal_floor a la valeur , le prix demandé de la transaction remplace tous les autres étages que le vendeur peut avoir, c’est-à-dire truedans les placements ou les profils de gestion du rendement.
last_modified Timestamp Jour et heure de la dernière modification du package.
data_protected Valeur booléenne Pas encore pris en charge.
allow_creative_add_on_view Valeur booléenne Pas encore pris en charge.
allow_creative_add_on_click true Pas encore pris en charge.
visibility_profile_id int Pas encore pris en charge.
seller_rank int Classement du vendeur pour le package. Cela contrôle l’emplacement dans lequel le package apparaîtra dans la liste complète des packages du vendeur. Plage autorisée : 1 - 65355, où 1 est le classement le plus élevé.
size_preference chaîne Spécifie la façon dont ce package gère les tailles privées. Les tailles privées sont des tailles de placement que le vendeur peut autoriser à servir dans un package. Il existe deux options :
- standard: les tailles privées ne sont pas disponibles pour ce package.
- append: les tailles privées peuvent être utilisées en plus de la taille de placement spécifiée.
technical_attribute_restrict Valeur booléenne Spécifie si le package est limité uniquement aux attributs techniques répertoriés dans l’objet Attributs techniques .
- true: le package est limité uniquement aux attributs techniques répertoriés.
- false: d’autres attributs techniques sont également autorisés à servir.
seller objet Nom et ID du vendeur qui propose le package. Pour plus d’informations, consultez Vendeur ci-dessous.
default_deal_type objet Type de transaction qui sera appliqué à toutes les transactions générées à partir du package. Pour plus d’informations, consultez Type de transaction par défaut ci-dessous.
setting objet Type de contenu inclus dans le package. Pour plus d’informations, consultez Paramètre ci-dessous.
technical_attributes tableau d’objets Attributs techniques des éléments créatifs éligibles pour le package. Pour plus d’informations, consultez Attributs techniques ci-dessous.
sizes tableau d’objets Tailles créatives incluses dans le package. Pour plus d’informations, consultez Tailles ci-dessous.

Vendeur

L’objet seller contient les champs suivants.

Champ Type Description
id int ID de membre du vendeur.
name chaîne Nom du membre du vendeur.

Type de transaction par défaut

L’objet default_deal_type contient les champs suivants. Par défaut, tous les packages génèrent des transactions avec un type de contrat d’enchère ouvert.

Champ Type Description
id int ID représentant le type de transaction. Valeurs possibles : 1 (Enchère ouverte) ou 2 (Enchère privée). Pour plus d’informations sur les enchères ouvertes et privées, consultez le Service de transaction.
name string En lecture seule. Nom du type de transaction. Valeurs possibles : "Open Auction« ou "Private Auction".

Setting

Ces informations sont utilisées pour donner aux acheteurs une compréhension générale de l’inventaire inclus dans le package. L’objet setting contient les champs suivants.

Champ Type Description
has_inventory Boolean Si la valeur est true, le package inclut des cibles d’éditeur, de placement, de site ou de catégorie de contenu.
inventory_description string Si has_inventory a la valeur true, ce champ fournit une description de l’inventaire inclus dans le package.
has_segments Valeur booléenne Si la valeur est true, le package inclut des cibles de segment.
segments_description string Si has_segments a la valeur true, ce champ fournit une description des segments inclus dans le package.
has_sizes Valeur booléenne Si la valeur est true, le package inclut des cibles de taille. Pour connaître les tailles spécifiques incluses, consultez le tableau des tailles.

Attributs techniques

Chaque technical_attribute objet contient les champs suivants :

Champ Type Description
id int ID de l’attribut technique éligible pour le package. Vous pouvez utiliser le service d’attributs techniques pour récupérer les ID d’attribut technique.
name string Nom de l’attribut technique éligible pour le package.
override Valeur booléenne S’il trueest défini sur , un attribut technique peut servir pour un package même si le profil de qualité d’annonce l’aurait bloqué.

Tailles

Chaque objet du sizes tableau contient les champs suivants.

Champ Type Description
width string Largeur du créatif.
height chaîne La hauteur du créatif.

Exemples

Afficher tous les packages disponibles

$ curl -b cookies -c cookies "https://api.appnexus.com/package-buyer-access"
{
  "response": {
    "status": "OK",
    "count": 102,
    "packages": [
      {
        "id": 1,
        "name": "Test Pkg",
        "description": "this is a test package",
        "active": true,
        "default_ask_price": 2.5,
        "default_currency": "USD",
        "default_use_deal_floor": true,
        "last_modified": "2014-05-30 15:02:33",
        "seller_rank": 100,
        "seller": {
          "id": 5581,
          "name": "Test University"
        },
        "default_deal_type": {
          "id": 1,
          "name": "Open Auction"
        },
        "setting": {
          "has_inventory": true,
          "inventory_description: "Description of inventory.",
          "has_segments": true,
          "segment_description": "Description of segments.",
          "has_sizes": false
        },
        "technical_attributes":null,
        "sizes": null
      },
      {
        "id": 2,
        "name": "High Performance & Viewability!",
        "description": "This is an artisanal, hand-picked collection of extremely high performing placements that are visible at least 90% of the time. Viewability audit performed daily by our proprietary View-O-Matic technology and verified by a trusted 3rd party.",
        "active": true,
        "default_ask_price": 8.8,
        "default_currency": "USD",
        "default_use_deal_floor": true,
        "last_modified": "2014-06-26 22:12:31",
        "seller_rank": 100,
        "seller": {
          "id": 55570,
          "name": "Seller ABC"
        },
        "default_deal_type": {
          "id": 1,
          "name": "Open Auction"
        },
        "setting": {
          "has_inventory": true,
          "inventory_description: "Description of inventory.",
          "has_segments": true,
          "segment_description": "Description of segments.",
          "has_sizes": true
        },
        "sizes": [
          {
            "width": "120",
            "height": "600"
          },
          {
            "width": "160",
            "height": "600"
          },
          {
            "width": "300",
            "height": "250"
          },
          {
            "width": "468",
            "height": "60"
          },
          {
            "width": "480",
            "height": "80"
          },
          {
            "width": "640",
            "height": "360"
          }
        ]
      },
      ...
    ]
  }
}

Afficher tous les packages proposés par un vendeur spécifique

$ curl -b cookies -c cookies "https://sand.api.appnexus.com/package-buyer-access?member_id=55586"
{
  "response": {
    "status": "OK",
    "count": 2,
    "packages": [
      {
        "id": 108,
        "name": null,
        "description": null,
        "active": true,
        "default_ask_price": 1,
        "default_currency": "USD",
        "default_use_deal_floor": true,
        "last_modified": "2014-07-16 20:49:30",
        "seller_rank": 100,
        "seller": {
          "id": 55586,
          "name": "Tyroo Media Pvt. Ltd."
        },
        "default_deal_type": {
          "id": 1,
          "name": "Open Auction"
        },
        "setting": {
          "has_inventory": true,
          "inventory_description: "Description of inventory.",
          "has_segments": true,
          "segment_description": "Description of segments.",
          "has_sizes": false
        },
        "technical_attributes": null,
        "sizes": null
      }
    ],
    {
        "id": 5,
        "name": "Package of inventory with data",
        "description": "This package includes inventory X and data X.",
        "active": false,
        "default_ask_price": 11.26,
        "default_currency": "USD",
        "default_use_deal_floor": true,
        "last_modified": "2014-06-06 18:10:47",
        "seller_rank": 100,
        "seller": {
          "id": 55586,
          "name": "Tyroo Media Pvt. Ltd."
        },
        "default_deal_type": {
          "id": 1,
          "name": "Open Auction"
        },
        "setting": {
          "has_inventory": true,
          "inventory_description: "Description of inventory.",
          "has_segments": true,
          "segment_description": "Description of segments.",
          "has_sizes": true
        },
        "sizes": [
          {
            "width": "160",
            "height": "600"
          },
          {
            "width": "300",
            "height": "50"
          }
        ]
      },
  }
}

Afficher un package spécifique

$ curl -b cookies -c cookies "https://api.appnexus.com/package?id=109"
{
  "response": {
    "status": "OK",
    "count": 1,
    "package": {
      "id": 109,
      "name": "Updated Package 1",
      "description": null,
      "active": true,
      "default_ask_price": 1,
      "default_currency": "USD",
      "default_use_deal_floor": true,
      "last_modified": "2014-07-21 17:14:16",
      "seller_rank": 100,
      "seller": {
        "id": 5558,
        "name": "TMP Ltd."
      },
      "default_deal_type": {
        "id": 1,
        "name": "Open Auction"
      },
      "setting": {
          "has_inventory": true,
          "inventory_description: "Description of inventory.",
          "has_segments": true,
          "segment_description": "Description of segments.",
          "has_sizes": false
      },
      "technical_attributes": null,
      "sizes": null     
    }
  }
}
  • Last updated on