Compartir a través de

API de plataforma digital: servicio de acceso de comprador de paquetes

  • Artículo

Este servicio de solo lectura permite a los compradores ver información sobre los paquetes de los vendedores. Un paquete es una oferta que un vendedor está preparado para ofrecer a cualquier comprador. Los compradores exploran los paquetes disponibles y luego usan el servicio Deal From Package para generar ofertas por sí mismos.

API de REST

Http (método) Endpoint Description
GET https://api.appnexus.com/package-buyer-access Ver todos los paquetes disponibles.
GET https://api.appnexus.com/package-buyer-access?member_id=SELLER_MEMBER_ID Ver todos los paquetes ofrecidos por un vendedor específico.
GET https://api.appnexus.com/package-buyer-access?id=PACKAGE_ID Ver un paquete específico.
GET https://api.appnexus.com/package-buyer-access?id=1,2,3 Vea varios paquetes por identificador mediante una lista separada por comas.
GET https://api.appnexus.com/package-buyer-access?sizes=WIDTHxHEIGHT,WIDTHxHEIGHT Vea todos los paquetes, incluidos los tamaños específicos.
GET https://api.appnexus.com/package-buyer-access?search=PACKAGE_ID or NAME Busque un paquete por nombre o identificador.
GET https://api.appnexus.com/package/meta Averigüe por qué campos puede filtrar y ordenar.

Campos JSON

Nombre Tipo Description
id Entero Identificador del paquete.
name string Nombre del paquete.
description string Descripción del paquete. Por lo general, los vendedores usan esto para proporcionar a los compradores una mayor información sobre la oferta.
active Booleano Si truees , el paquete está activo. Si falsees , no puede generar ofertas a partir del paquete y todas las ofertas asociadas dejarán de servir.
default_ask_price double Precio de solicitud que se aplicará a todas las ofertas generadas a partir del paquete. Al generar una oferta, el Servicio de acceso al comprador de la oferta calculará automáticamente al suggested_min_bid_price agregar el cargo por servicio de subasta especificado en el contrato Xandr al valor de este campo. Para obtener más información sobre suggested_min_bid_price, consulte el servicio deal buyer access.

Nota: Este campo solo es relevante si default_use_deal_floor es true.
default_currency string La moneda del precio ask que se aplicará a todas las ofertas generadas a partir del paquete.
default_use_deal_floor Booleano Si truees , default_ask_price se aplicará a las ofertas generadas a partir del paquete.

Nota: Cuando default_use_deal_floor es true, el precio de solicitud de la oferta invalida cualquier otro piso que el vendedor pueda tener, es decir, en colocaciones o perfiles de administración de rendimiento.
last_modified Timestamp Día y hora en que se modificó por última vez el paquete.
data_protected Booleano Todavía no se admite.
allow_creative_add_on_view Booleano Todavía no se admite.
allow_creative_add_on_click true Todavía no se admite.
visibility_profile_id Entero Todavía no se admite.
seller_rank Entero Clasificación del vendedor para el paquete. Esto controla dónde aparecerá el paquete en la lista completa de paquetes del vendedor. Intervalo permitido: 1 - 65355, donde 1 es la clasificación más alta.
size_preference string Especifica cómo controla este paquete los tamaños privados. Los tamaños privados son tamaños de ubicación que el vendedor puede permitir para servir en un paquete. Hay dos opciones:
- standard: los tamaños privados no están disponibles para este paquete.
- append: se pueden usar tamaños privados además del tamaño de ubicación especificado.
technical_attribute_restrict Booleano Especifica si el paquete solo está restringido a los atributos técnicos enumerados en el objeto Technical Attributes .
- true: el paquete solo está restringido a los atributos técnicos enumerados.
- false: también se permite que otros atributos técnicos sirvan.
seller object El nombre y el identificador del vendedor que ofrece el paquete. Para obtener más información, consulte Vendedor a continuación.
default_deal_type object Tipo de oferta que se aplicará a todas las ofertas generadas a partir del paquete. Para obtener más información, vea Tipo de oferta predeterminado a continuación.
setting object Tipo de contenido incluido en el paquete. Para obtener más información, consulte Configuración a continuación.
technical_attributes matriz de objetos Atributos técnicos de las creatividades que son aptas para el paquete. Para obtener más información, consulte Atributos técnicos a continuación.
sizes matriz de objetos Los tamaños creativos incluidos en el paquete. Para obtener más información, vea Tamaños a continuación.

Vendedor

El seller objeto contiene los campos siguientes.

Campo Tipo Description
id Entero Id. de miembro del vendedor.
name string Nombre del miembro del vendedor.

Tipo de oferta predeterminado

El default_deal_type objeto contiene los campos siguientes. De forma predeterminada, todos los paquetes generarán ofertas con un tipo de oferta de subasta abierta.

Campo Tipo Description
id Entero Identificador que representa el tipo de transacción. Valores posibles: 1 (Subasta abierta) o 2 (Subasta privada). Para obtener más información sobre las subastas abiertas y privadas, consulte el servicio Deal.
name string Solo lectura. Nombre del tipo de transacción. Valores posibles: "Open Auction" o "Private Auction".

Configuración

Esta información se usa para proporcionar a los compradores una comprensión general del inventario incluido en el paquete. El setting objeto contiene los campos siguientes.

Campo Tipo Descripción
has_inventory Booleano Si truees , el paquete incluye destinos de categoría de publicador, ubicación, sitio o contenido.
inventory_description string Si has_inventory se establece en true, este campo proporciona una descripción del inventario incluido en el paquete.
has_segments Booleano Si truees , el paquete incluye destinos de segmento.
segments_description string Si has_segments se establece en true, este campo proporciona una descripción de los segmentos incluidos en el paquete.
has_sizes Booleano Si truees , el paquete incluye destinos de tamaño. Para conocer los tamaños específicos incluidos, consulte la matriz de tamaños.

Atributos técnicos

Cada technical_attribute objeto contiene los campos siguientes:

Campo Tipo Description
id Entero Identificador del atributo técnico que es apto para el paquete. Puede usar el Servicio de atributos técnicos para recuperar identificadores de atributo técnico.
name string Nombre del atributo técnico que es apto para el paquete.
override Booleano Si se establece en true, un atributo técnico puede servir para un paquete incluso si el perfil de calidad del anuncio lo hubiera bloqueado.

Tamaños

Cada objeto de la sizes matriz contiene los campos siguientes.

Campo Tipo Descripción
width string Ancho de la creatividad.
height string El alto de la creatividad.

Ejemplos

Ver todos los paquetes 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"
          }
        ]
      },
      ...
    ]
  }
}

Ver todos los paquetes ofrecidos por un vendedor específico

$ 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"
          }
        ]
      },
  }
}

Visualización de un paquete específico

$ 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     
    }
  }
}