Servicio broker
Importante
El servicio Broker se ha reemplazado por el servicio de cuota de asociados para los artículos de línea aumentadas (ALI).
El servicio Broker solo se puede usar con elementos de línea estándar o heredados. Las tarifas de broker no se aplican a los artículos de línea aumentadas.
Broker Service permite a los usuarios de elementos de línea estándar o heredados definir agentes. Los agentes recopilan tarifas de las redes al dar una impresión. Las tarifas reales se definen a través del servicio campaign, el servicio de artículos de línea o el servicio de pedido de inserción.
Precaución
Si se aplica una tarifa de agente a un pedido de inserción, la tarifa no se aplicará a los artículos de línea aumentadas asociados con el pedido de inserción. Solo se aplicará a los elementos de línea estándar del pedido de inserción.
API de REST
| Http (método) | Endpoint | Description |
|---|---|---|
| POST | https://api.appnexus.com/broker (JSON de add-broker) |
Agregue un agente. |
| PUT | https://api.appnexus.com/modify-broker?id=BROKER_ID (json modify-broker) |
Modificar un agente. |
| GET | https://api.appnexus.com/broker |
Ver todos los agentes. |
| GET | https://api.appnexus.com/broker?id=BROKER_ID |
Ver un agente específico. |
Campos JSON
| Parámetro | Tipo | Descripción |
|---|---|---|
broker_fees |
matriz de objetos | Matriz de cuotas de agente asociadas al agente. Consulte la sección Tasas de broker . Valor predeterminado: null |
id |
Entero | Identificador único de un agente. Valor predeterminado: Número incrementado automáticamente (es decir, 123) Obligatorio activado: PUT |
last_modified |
Timestamp | Solo lectura. Hora de la última modificación en este agente con el formato AAAA-MM-DD HH:MM:SS. |
member_id |
Entero | Número de identificación único del miembro del agente. Al crear un agente, se asigna el miembro del usuario. |
name |
string | Nombre único que se usa para describir un agente. Obligatorio activado: POST |
state |
string | Estado del agente. Valores posibles: active o inactive. Valor predeterminado: activo |
Tasas de agente aplicadas a otros objetos
Las tarifas del agente se crean a través del servicio Campaign, el servicio de artículos de línea o el servicio de pedido de inserción. Se pueden ver aquí, pero no se pueden crear ni editar a través de este servicio. Consulte la sección Cuotas de broker en cada uno de los servicios a los que se hace referencia anteriormente para obtener más información sobre cómo aplicar tarifas a los agentes.
Precaución
Si se aplica una tarifa de agente a un pedido de inserción, la tarifa no se aplicará a los artículos de línea aumentadas asociados con el pedido de inserción. Solo se aplicará a los elementos de línea estándar del pedido de inserción.
Cada objeto de la broker_fees matriz contiene los campos siguientes:
| Campo | Tipo | Descripción |
|---|---|---|
object_type |
string | Indica si esta cuota está asociada a una campaña o a un grupo de campañas. Valores posibles: campaign o campaign-group. Solo lectura. |
object_id |
Entero | Número de identificación único de la tarifa. Solo lectura. |
description |
string | Texto que proporciona información sobre la tarifa. Solo lectura. |
fee_type |
string | Valores posibles: commission o serving:- Comisión: se trata de tarifas de agente de artículos de línea o de pedido de inserción y se deducen de los ingresos reservados que el anunciante ha dado a la red. Comisión siempre está en la moneda de la orden de inserción, elemento de línea o campaña asociada. - Servicio: son tarifas de agente de campaña y se suman al costo de inventario que la red pagó al editor. Las tarifas por servicio están en dólares estadounidenses. Solo lectura. |
payment_type |
string | Tipo de pago: cpm o revshare. Solo lectura. |
value |
double | Valor de la tarifa. Solo lectura. |
Ejemplos
Adición de un agente
$ cat add-broker.json
{
"broker":
{
"name": "JMS3"
}
}
$ curl -b cookies -c cookies -X POST -d @add-broker.json 'https://api.appnexus.com/broker'
"response":{
"status":"OK",
"count":1,
"id":287,
"start_element":0,
"num_elements":100,
"broker":{
"id":287,
"name":"JMS3",
"state":"active",
"member_id":1066,
"last_modified":"2013-09-26 17:17:38",
"broker_fees":null
Modificación de un agente
$ cat modify-broker.json
{
"broker":
{
"state": "inactive"
}
}
$ curl -b cookies -c cookies -X PUT -d @modify-broker.json 'https://api.appnexus.com/broker?id=81'
"response":{
"status":"OK",
"count":1,
"id":"81",
"start_element":0,
"num_elements":100,
"broker":{
"id":81,
"name":"Test",
"state":"inactive",
"member_id":1066,
"last_modified":"2013-09-26 17:21:42",
"broker_fees":null
},
}
Ver todos los agentes
$ curl -b cookies -c cookies 'https://api.appnexus.com/broker'
{
"response":{
"status":"OK",
"count":6,
"start_element":0,
"num_elements":100,
"brokers":[
{
"id":81,
"name":"Test",
"state":"inactive",
"member_id":1066,
"last_modified":"2013-09-26 17:21:42",
"broker_fees":null
},
{
"id":145,
"name":"Test 2",
"state":"active",
"member_id":1066,
"last_modified":"2013-03-15 20:41:47",
"broker_fees":null
},
{
"id":152,
"name":"Test 3",
"state":"active",
"member_id":1066,
"last_modified":"2013-03-20 15:30:21",
"broker_fees":null
},
{
"id":217,
"name":"Third party",
"state":"active",
"member_id":1066,
"last_modified":"2013-05-21 03:58:36",
"broker_fees":null
},
{
"id":218,
"name":"Third party",
"state":"active",
"member_id":1066,
"last_modified":"2013-05-21 04:12:58",
"broker_fees":null
},
{
"id":287,
"name":"JMS3",
"state":"active",
"member_id":1066,
"last_modified":"2013-09-26 17:17:38",
"broker_fees":null
}
],
}
Visualización de un agente específico
$ curl -b cookies -c cookies 'https://api.appnexus.com/broker?id=81'
{
"response":{
"status":"OK",
"count":1,
"start_element":0, "num_elements":100,
"broker":{
"id":81,
"name":"Test",
"state":"inactive",
"member_id":1066,
"last_modified":"2013-09-26 17:21:42",
"broker_fees":null
},
}