Servicio de lista de ofertas

Un acuerdo es un contrato entre un comprador y un vendedor que proporciona acceso especial al inventario o a los datos. Las ofertas se usan principalmente para acceder al inventario premium preferido o al inventario negociado. Una lista de ofertas es un grupo de identificadores de ofertas clasificados bajo un encabezado para dirigirse a los elementos de línea. Las listas de ofertas permiten a los especialistas de inventario conservar el inventario de ofertas para los operadores, así como optimizar los flujos de trabajo de los operadores, como dirigirse al mismo conjunto de ofertas entre artículos de línea. Si cambian los requisitos de agrupación de ofertas, solo los cambios necesarios en la lista de ofertas actualizarán automáticamente todos los artículos de línea en consecuencia.

Deal List API facilita la búsqueda, adición, modificación y captura de listas de ofertas específicas o diferentes. Permite crear, anexar y reemplazar una lista de ofertas por identificadores de transacción separados por comas.

Nota:

Todos los parámetros de consulta del servicio Lista de ofertas admiten una lista de valores separados por comas. Por ejemplo, para eliminar un conjunto de listas de ofertas, se puede pasar una lista separada por comas de identificadores como parámetros de consulta.

API de REST

Http (método)	Endpoint	Description
POST	https://api.appnexus.com/deal-list (JSON de lista de ofertas)	Agregue una nueva lista de ofertas.
PUT	https://api.appnexus.com/deal-list (JSON de lista de ofertas)	Modificar una lista de ofertas.
DELETE	https://api.appnexus.com/deal-list?id=DEAL_LIST_ID	Eliminar una lista de ofertas.
DELETE	https://api.appnexus.com/deal-list?id=DEAL_LIST_ID1,DEAL_LIST_ID2,DEAL_LIST_ID3	Eliminar listas de ofertas diferentes.
GET	https://api.appnexus.com/deal-list	Ver todas las listas de ofertas y ofertas que contienen.
GET	https://api.appnexus.com/deal-list?name=DEAL_LIST_NAME	Ver una lista de ofertas por nombre y ofertas que contiene.
GET	https://api.appnexus.com/deal-list?id=DEAL_LIST_ID	Ver una lista de ofertas específica y las ofertas que contiene.
GET	https://api.appnexus.com/deal-list?advertiser_id=ADVERTISER_ID	Ver una lista de ofertas por identificador de anunciante y ofertas que contiene.
GET	https://api.appnexus.com/deal-list?deal_id=DEAL_ID	Ver todas las listas de ofertas que contienen una oferta.
GET	https://api.appnexus.com/deal-list?search=SEARCH_TERM Nota: SEARCH_TERM puede ser DEAL_ID o DEAL_LIST_NAME contener ciertos caracteres.	Busque una lista de ofertas por identificador o nombre como término de búsqueda.
GET	https://api.appnexus.com/deal-list?search=SEARCH_TERM&advertiser_id=ADVERTISER_ID Nota: SEARCH_TERM puede ser DEAL_ID o DEAL_LIST_NAME contener ciertos caracteres.	Busque una lista de ofertas por identificador o nombre como término de búsqueda y sea accesible para un anunciante determinado.
GET	https://api.appnexus.com/deal-list?line_item_id=LINE_ITEM_ID	Ver todas las listas de ofertas destinadas a un elemento de línea.

Campos JSON

Campo	Tipo	Description
id	Entero	Identificador de una lista de ofertas. Obligatorio en: PUT, en la carga de JSON.
name	string	Nombre de la lista de ofertas. Obligatorio en: POST, en la carga de JSON.
deals	matriz de objetos	Las ofertas que se incluirán en la lista de ofertas. Aquí se incluyen los identificadores de las ofertas. Consulte Ejemplo para este campo. Obligatorio en:POST , PUT
advertisers	matriz de objetos	Los anunciantes para los que está pensada la lista de ofertas. Aquí se incluyen los identificadores de anunciante. Consulte Ejemplo para este campo. Nota: En POST las llamadas, si el advertisers campo se establece en una matriz vacía o se establece sin ningún valor, se establece de forma predeterminada en todos los anunciantes a los que el usuario tiene acceso. En otras palabras, si el usuario tiene acceso a todos los anunciantes de un miembro, este campo se establece de forma predeterminada en una matriz vacía porque no hay ninguna restricción específica del anunciante presente. De forma similar en PUT las llamadas, si los anunciantes están establecidos en matrices vacías, el valor predeterminado es para todos los anunciantes a los que el usuario tiene acceso (no establecer un valor de campo en PUT las llamadas no tiene ningún efecto).
last_modified	Timestamp	Hora de la última modificación realizada en la lista de ofertas. Solo lectura.
created_on	Timestamp	Hora de creación de la lista de ofertas.
line_items	matriz de objetos	Los elementos de línea que tienen como destino la lista de ofertas (elementos de línea que tienen un perfil asociado a ellos y ese perfil está destinado a la lista de ofertas). Consulte Ejemplo para este campo. Solo lectura.

Ejemplo del deals campo

"deals":[
{"id":1},
{"id":2},
{"id":3}
],

Ejemplo del advertisers campo

"advertisers":[
{"id":1},
{"id":2},
{"id":3}
],

Ejemplo del line_items campo

"line_items":[
{"id":1,
"name":"LINE_ITEM1",
"code":null
},
{
"id":2,
"name":"LINE_ITEM2",
"code":null
}
],

Ejemplos

Create una lista de ofertas

En este ejemplo, creamos una nueva lista de ofertas.

$ cat deal-list-create
 
{ 
   "deal-list":[ 
      { 
         "name":"My first deal list",
         "description": null,
         "advertisers":[
            {"id": 1},
            {"id": 2},
            {"id": 3}
         ]
      },
      { 
         "deals":[ 
            {"id": 1},
            {"id": 2},
            {"id": 3}
         ],
         "name":"Another one"
      }
   ]
}
 
$ curl -b cookies -X POST -d @deal-list-create 'https://api.appnexus.com/deal-list'
 
{
    "response": {
        "status": "OK",
        "deal-list": {
           "id": 3901,
           "name": "My first deal list"
           ....
         }
    }
}

Actualización de una lista de ofertas

En este ejemplo, actualizamos una lista de ofertas.

$ cat deal-list-update
 
{ 
   "deal-list": { 
       "deals": [{"id": 1}],
       "name":"My modified first deal list",
       "id":3901
   }
}
 
$ curl -b cookies -X PUT -d @deal-list-update 'https://api.appnexus.com/deal-list'
 
{
    "response": {
        "status": "OK",
        "inventory-list": {
           "id": 3901,
           "name": "XYZ Allowlist"
           "description": "Updated Description",
           ....
         }
    }
}

Eliminar una lista de ofertas

En este ejemplo, eliminamos una lista de ofertas existente.

$ curl -b cookies -c cookies -X DELETE https://api.appnexus.com/deal-list?id=3901
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null
    }
    }

Temas relacionados

• Servicio de perfil
• Splits Service