API de plataforma digital: servicio Desasignar acceso al comprador

Artículo
05/18/2024

Este servicio de solo lectura permite a los compradores ver información sobre las ofertas negociadas que tienen con los vendedores de interfaz de usuario de Xandr y los asociados de suministro externos. Un acuerdo puede proporcionar a un comprador precios preferenciales, acceso a inventario exclusivo, competencia reducida en el inventario u otras oportunidades. Cada oferta es válida para un único comprador, pero tenga en cuenta que el inventario incluido en una oferta también puede estar abarcado por acuerdos con otros compradores.

Los compradores pueden usar el deal_targets campo del servicio de perfil para dirigirse a las ofertas. Los vendedores pueden usar el Servicio de oferta para configurar y administrar ofertas.

API de REST

Http (método)	Endpoint	Description
`GET`	`https://api.appnexus.com/deal-buyer-access`	Ver todas las ofertas que tiene con los vendedores
`GET`	`https://api.appnexus.com/deal-buyer-access?seller_member_id=SELLER_MEMBER_ID`	Ver todas las ofertas que tiene con un vendedor específico
`GET`	`https://api.appnexus.com/deal-buyer-access?id=DEAL_ID`	Visualización de una oferta específica
`GET`	`https://api.appnexus.com/deal-buyer-access?id=1,2,3`	Visualización de varias ofertas por identificador mediante una lista separada por comas
`GET`	`https://api.adnxs.com/deal-buyer-access?search="Deal_ID,DEAL_NAME,orCODE"`	Búsqueda de una oferta por nombre, identificador o código
`GET`	`https://api.appnexus.com/deal-buyer-access/meta`	Averigüe por qué campos puede filtrar y ordenar

Campos JSON

Campo	Tipo (longitud)	Description
`active`	booleano	Si `true`es , la oferta está activa. Tenga en cuenta que la oferta estará disponible para el comprador solo cuando este campo sea `true`, esté en el pasado (o `null`) y `end_date` esté en el futuro (o `nullstart_date` ).
`ask_price`	Entero	Precio asociado a la oferta. Esta es la cantidad mínima que el vendedor aceptará para este inventario.
`audit_status_option`	string	Especifica cómo controla la oferta las creatividades. - `none`: los creativos usan la configuración de calidad de anuncios existente. - `provisional`: las creatividades en `"pending"` estado de auditoría servirán. Una vez auditadas estas creatividades, se usa la configuración de calidad de anuncios existente. - `max_trust`: cualquier creativo puede servir para esta oferta. Las creatividades enumeradas específicamente en el objeto Creatives invalidarán esta configuración.
`brands`	matriz de objetos	Las marcas de creativos que son elegibles para la oferta. Para obtener más información, consulte Marcas a continuación.
`brand_restrict`	Booleano	Especifica si la oferta está restringida solo a las marcas enumeradas en el objeto Brands . - `true`: la oferta solo está restringida a las marcas enumeradas. - `false`: también se permite que otras marcas sirvan.
`buyer`	object	El miembro comprador que puede dirigirse a esta oferta. Para obtener más información, consulte Comprador a continuación.
`categories`	matriz de objetos	Categorías que describen las creatividades que son aptas para la oferta. Para obtener más información, vea Categorías a continuación.
`category_restrict`	Booleano	Especifica si la oferta está restringida solo a las categorías enumeradas en el objeto Categories . - `true`: la oferta solo está restringida a las categorías enumeradas. - `false`: también se permite que otras categorías sirvan.
`code`	string (100)	Código personalizado para la oferta. En el caso de las ofertas con asociados de suministro externos, esta suele ser la cadena que usará para identificar la oferta.
`creatives`	matriz de objetos	Una lista de creativos que están específicamente aprobados o prohibidos para la oferta. Esta lista invalida cualquier otra configuración de calidad de anuncio. Para obtener más detalles, consulte Creatives a continuación.
`currency`	enumeración	Moneda de `floor_price`. Para obtener una lista completa de las monedas disponibles, use el servicio de moneda de solo lectura.
`description`	string (65535)	Descripción de la oferta. Para las ofertas con asociados de suministro externos, la descripción puede proporcionar información adicional o detalles sobre la oferta.
`end_date`	Timestamp	El día y la hora en que la oferta deja de estar disponible para el comprador. Null corresponde a "indefinidamente".
`floor_price`	double	En desuso. Consulte el `ask_price` campo en su lugar. Valor mínimo de CPM que el comprador debe pujar para ser elegible para la oferta. Nota: Si `use_deal_floor` es `false`, `floor_price` será `0`. En este caso, tenga en cuenta que aunque `0` se muestra como el precio del piso, no se aplica ningún piso de oferta; si el vendedor tiene otros pisos (en colocaciones o perfiles de gestión de rendimiento), se aplicarán, o si el vendedor no tiene ningún otro piso, se aplicará la mecánica estándar de subastas de segundo precio.
`id`	Entero	El identificador de la transacción.
`languages`	matriz de objetos	Idioma asociado a las creatividades que son aptas para la oferta. Para obtener más información, consulte Idiomas a continuación.
`language_restrict`	Booleano	Especifica si la oferta está restringida solo a los idiomas enumerados en el objeto Languages . - `true`: la oferta solo está restringida a los idiomas enumerados. - `false`: también se permite que otros idiomas sirvan.
`last_modified`	Timestamp	Fecha y hora en que se modificó por última vez la oferta.
`name`	string (255)	Nombre de la oferta.
`payment_type`	string	Especifica el tipo de pago de la oferta: - `default`: esta oferta usa el tipo de pago predeterminado para el comprador de esta oferta. Incluye CPM y también puede incluir CPA, CPC o ambos. - `cpvm`: esta oferta usa el tipo de pago DE CPM visible. Solo las impresiones visibles dan como resultado el pago del comprador.
`seller`	object	El miembro vendedor que está ofreciendo el trato. Para obtener más información, consulte Vendedor a continuación.
`sizes`	matriz de objetos	Los tamaños de los creativos que son aptos para la oferta. Para obtener más información, vea Objetivos de tamaño a continuación. Nota: Si esta matriz no está presente en la respuesta, no hay requisitos de tamaño creativo para la oferta.
`size_preference`	string	Especifica cómo controla esta oferta los tamaños privados. Los tamaños privados son tamaños de ubicación que un vendedor puede permitir para servir para una oferta. Hay dos opciones: - `standard`: los tamaños privados no están disponibles para esta oferta. - `append`: se pueden usar tamaños privados además del tamaño de ubicación especificado.
`start_date`	Timestamp	El día y la hora en que la oferta comienza a estar disponible para el comprador. Null corresponde a "inmediatamente".
`suggested_min_bid_price`	Entero	Cantidad mínima que probablemente borrará el precio de la solicitud. Esta es la suma del cargo del `ask_price` servicio de subasta y especificado en su contrato de Xandr. En el caso de los contratos con proveedores externos, esta cantidad incluirá margen adicional para tener en cuenta las discrepancias. Pujar por ayuda `suggested_min_bid_price` a asegurarse de que es elegible para la oferta, pero no hay ninguna garantía de que su oferta ganará.
`technical_attributes`	matriz de objetos	Los atributos técnicos de los creativos que son aptos para la oferta. Para obtener más información, consulte Atributos técnicos a continuación.
`technical_attribute_restrict`	Booleano	Especifica si la oferta solo está restringida a los atributos técnicos enumerados en el objeto Technical Attributes . - `true`: la oferta solo está restringida a los atributos técnicos enumerados. - `false`: también se permite que otros atributos técnicos sirvan.
`type`	object	Tipo de oferta. Para los vendedores, una oferta puede ser una subasta abierta o una subasta privada. Para los asociados de suministro externos, una oferta también puede ser acceso de primera vista. Para obtener más información, vea Tipo a continuación.
`use_deal_floor`	Booleano	Si es true, se aplica para `floor_price` la oferta. Nota: Cuando `use_deal_floor` es `true`, el precio mínimo de la oferta invalida cualquier otro piso que el vendedor pueda tener, es decir, en colocaciones o perfiles de administración de rendimiento.

Vendedor

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

Comprador

Campo	Tipo	Description
`id`	Entero	Identificador de miembro del comprador.
`bidder_id`	Entero	Id. del pujador del miembro. Para los compradores de la interfaz de usuario de Xandr, siempre será 2.
`name`	string	Nombre del miembro del comprador.

Tipo

El Type objeto contiene los campos siguientes.

Campo	Tipo (longitud)	Description
`id`	Entero	Identificador que representa el tipo de transacción. Posibles valores: `1` = Abrir subasta En , `"Open Auction"`los compradores que se dirigen a las ofertas y los compradores que se dirigen al inventario a través de otros medios compiten por la impresión. Si un comprador que se dirige a un acuerdo envía la oferta más alta y la oferta borra el piso del contrato, ese comprador gana la subasta, pagando la segunda oferta más alta o el precio del piso de oferta, lo que sea más alto. Si uno de los compradores sin acuerdo envía la oferta más alta, ese comprador gana la subasta, pagando la segunda oferta más alta o ECP, lo que sea más alto. `2` = Subasta privada En , `"Private Auction"`los compradores que se dirigen a las ofertas privadas compiten primero por la impresión. A continuación, si ninguno de los compradores de la oferta gana, la subasta se abre a los compradores que se dirigen al inventario a través de otros medios. Si un comprador que se dirige a un acuerdo envía una oferta más alta que el piso de la oferta y mayor que cualquier otra oferta de subasta privada, ese comprador gana la subasta, pagando la segunda oferta más alta de la subasta privada o el precio del piso de oferta, lo que sea más alto. Si no hay ofertas de subasta privada que borren sus pisos, gana la puja más alta de la subasta abierta, pagando la segunda puja más alta de la subasta abierta o ECP, lo que sea más alto. `3` = Primer aspecto Las ofertas consideradas `"First Look"` solo las ofrecen los socios de suministro externos y tienen una lógica de subasta muy variada, dependiendo tanto del socio de suministro como del vendedor. Debe ponerse en contacto con el asociado de suministro para obtener más información sobre cómo funciona la oferta. Xandr como plataforma de compra no puede garantizar que las ofertas de primer aspecto realmente le dan la primera vista de una impresión.
`name`	string (255)	Nombre del tipo de transacción. Posibles valores: - `"Open Auction"` - `"Private Auction"` - `"First Look"`.

Marcas

Cada brands objeto contiene los campos siguientes:

Campo	Tipo	Description
`id`	Entero	El identificador de la marca que es elegible para la oferta. Puede usar brand service para recuperar identificadores de marca.
`name`	string	Nombre de la marca que es apta para la oferta.
`override`	Booleano	Si se establece en `true`, una marca puede servir para una oferta incluso si el perfil de calidad del anuncio lo hubiera bloqueado.

Campo	Tipo	Description
`id`	Entero	Identificador de las categorías que son aptas para la oferta. Puede usar el servicio category para recuperar identificadores de categoría.
`name`	string	Nombre de la categoría que es apta para la oferta.
`override`	Booleano	Si se establece en `true`, una categoría puede servir para una oferta incluso si el perfil de calidad del anuncio lo hubiera bloqueado.

Idiomas

Cada languages objeto contiene los campos siguientes:

Campo	Tipo	Description
`id`	Entero	Identificador del idioma que es apto para la oferta. Puede usar language service para recuperar identificadores de idioma.
`name`	string	Nombre del idioma que es apto para la oferta.
`override`	Booleano	Si se establece en `true`, un idioma puede servir para una oferta incluso si el perfil de calidad del anuncio lo hubiera bloqueado.

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 la oferta. 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 la oferta.
`override`	Booleano	Si se establece en `true`, un atributo técnico puede servir para una oferta incluso si el perfil de calidad del anuncio lo hubiera bloqueado.

Creativos

La creatives matriz está limitada a 100 creatividades. Cada creatives objeto contiene los campos siguientes:

Campo	Tipo	Description
`id`	Entero	El identificador del creativo que se aprueba o prohíbe para la oferta. Puede usar Creative Service para recuperar identificadores creativos.
`status`	string	Especifica cómo se controlará esta creatividad para esta oferta. - `approved`: esta creatividad siempre puede servir en esta oferta, independientemente de cualquier otra configuración o invalidación de calidad de anuncios. - `banned`: esta creatividad nunca puede servir en esta oferta, independientemente de cualquier otra configuración o invalidación de calidad de anuncios.

Tamaños

Cada objeto de la size_targets matriz contiene los campos siguientes.

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

Ejemplos

Ver todas las ofertas que tiene con los vendedores

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access'
{ 
    "response": {
        "status": "OK",
        "count": 6,
        "start_element": 0,
        "num_elements": 100,
        "deals": [
            {
                "id": 62,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of 2.5",
                "description": null,
                "active": false,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:59",
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 20:15:38",
                "seller": {
                    "id": 100004,
                    "name": "Seller 123"
                },
                "buyer": {
                    "id": 100005,
                    "bidder_id": 2,
                    "name": "Buyer 123"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                                                "name": "Example Brand"
                    },
                                "ask_price": 2.75,
                                "suggested_min_bid_price": 3,
                "sizes": [
                    {
                        "width": "300",
                        "height": "250"
                    }
                ]
            },
            {
                "id": 63,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of $2.50",
                "description": null,
                "active": false,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:59",
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 20:39:57",
                "seller": {
                    "id": 100006,
                    "name": "Seller 456"
                },
                "buyer": {
                    "id": 100007,
                    "bidder_id": 2,
                    "name": "Buyer 456"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                                                "name": "Example Brand"
                    }
                ]
            },
            ...
        ]
    }
}

Ver todas las ofertas que tiene con un vendedor específico

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access?seller_member_id=100006'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "deals": [
            {
                "id": 63,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of $2.50",
                "description": null,
                "active": false,
                "start_date": "2013-12-01 00:00:00",
                "end_date": "2013-12-31 23:59:59",
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2013-12-04 20:39:57",
                "seller": {
                    "id": 100006,
                    "name": "Seller 456"
                },
                "buyer": {
                    "id": 100007,
                    "bidder_id": 2,
                    "name": "Buyer 456"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                                                "name": "Example Brand"
                    }
                ],
                                "ask_price": 2.75,
                                "suggested_min_bid_price": 3,
                "sizes": [
                    {
                        "width": "300",
                        "height": "250"
                    }
                ]  
            }
        ]
    }
}

Visualización de una oferta específica

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access?id=63'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "deal": 
        "deals": {
            "id": 63,
            "code": null,
            "name": "Private deal for buyer 1085 with floor of $2.50",
            "description": null,
            "active": false,
            "start_date": "2013-12-01 00:00:00",
            "end_date": "2013-12-31 23:59:59",
            "floor_price": 2.5,
            "currency": "USD",
            "use_deal_floor": true,
            "last_modified": "2013-12-04 20:39:57",
            "seller": {
                "id": 100006,
                "name": "Seller 456"
            },
            "buyer": {
                "id": 100007,
                "bidder_id": 2,
                "name": "Buyer 456"
            },
            "type": {
                "id": 2,
                "name": "Private Auction"
            },
            "brands": [
                {
                    "id": 1,
                                        "name": "Example Brand"
                }
            ],
                        "ask_price": 2.75,
                        "suggested_min_bid_price": 3,
            "sizes": [
                {
                    "width": "300",
                    "height": "250"
                }
            ]
        }
    }
}

Ver todas las ofertas que no han expirado

En este ejemplo, suponiendo que hoy es el 4 de diciembre de 2018, queremos encontrar todas las ofertas que no hayan expirado. Para ello, se pasa el min_end_date=2018-12-04 filtro en la cadena de consulta. Tenga en cuenta, sin embargo, que no se mostrará ninguna fecha de finalización en la respuesta.

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-access?min_end_date=2018-12-04'
{
    "response": {
        "status": "OK",
        "count": 4,
        "start_element": 0,
        "num_elements": 100,
        "deals": [
            {
                "id": 60,
                "code": null,
                "name": null,
                "description": null,
                "active": true,
                "start_date": "2018-12-01 00:00:00",
                "end_date": "2018-12-31 23:59:00",
                "floor_price": 3.2,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2018-12-04 18:47:39",
                "seller": {
                    "id": 100006,
                    "name": "Seller 456"
                },
                "buyer": {
                    "id": 100007,
                    "bidder_id": 2,
                    "name": "Buyer 456"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": null,
                                "ask_price": 3.5,
                                "suggested_min_bid_price": 3.75,
            },
            {
                "id": 62,
                "code": null,
                "name": "Private deal for buyer 1085 with floor of 2.5",
                "description": null,
                "active": false,
                "seller_member_id": 1066,
                "start_date": "2018-12-01 00:00:00",
                "end_date": "2018-12-31 23:59:59",
                "profile_id": null,
                "floor_price": 2.5,
                "currency": "USD",
                "use_deal_floor": true,
                "last_modified": "2018-12-04 20:15:38",
                "seller": {
                    "id": 100006,
                    "name": "Seller 456"
                },
                "buyer": {
                    "id": 100007,
                    "bidder_id": 2,
                    "name": "Buyer 456"
                },
                "type": {
                    "id": 2,
                    "name": "Private Auction"
                },
                "brands": [
                    {
                        "id": 1,
                                                "name": "Example Brand"
                    }
                ]
            },
            ...
        ]
    }
}

Compartir a través de