Servicio de nivel de subasta de administración de rendimiento
El servicio yield management auction tier le permite modificar la mecánica de subasta estándar de modo que ciertas pujas se consideren ante otras, siempre que esas pujas estén asociadas a determinados miembros y cumplan determinados requisitos de precios. También puede usar este servicio para excluir a determinados miembros de la consideración por completo.
Nota:
Los niveles de subasta deben estar asociados a un perfil de administración de rendimiento existente.
API de REST
Http (método) | Endpoint | Description |
---|---|---|
POST |
https://api.appnexus.com/ym-auction-tier (JSON de nivel de subasta) |
Agregue un nivel de subasta. |
PUT |
https://api.appnexus.com/ym-auction-tier?id=AUCTION_TIER_ID (JSON de nivel de subasta) |
Modificar un nivel de subasta. |
GET |
https://api.appnexus.com/ym-auction-tier | Vea todos los niveles de subasta. |
GET |
https://api.appnexus.com/ym-auction-tier?id=AUCTION_TIER_ID | Ver un nivel de subasta específico. |
GET |
https://api.appnexus.com/ym-auction-tier?id=1,2,3 | Vea varios niveles de subasta por identificador mediante una lista separada por comas. |
DELETE |
https://api.appnexus.com/ym-auction-tier?id=AUCTION_TIER_ID | Elimine un nivel de subasta. |
Campos JSON
Campo | Tipo | Descripción |
---|---|---|
id |
Entero | Identificador único de este nivel de subasta. Valor predeterminado: número generado automáticamente. Obligatorio On: PUT , en la cadena de consulta. |
name |
string | Nombre de este nivel. Obligatorio activado: POST |
code |
string | Código personalizado opcional que puede usar para asignar entre el identificador de este objeto en el sistema y en el nuestro. Predeterminado: null |
description |
string | Una descripción opcional. |
profile_id |
Entero | Se usa un opcional profile_id para determinar cuándo aplicar un nivel. Un perfil es un conjunto genérico de reglas para el inventario de destino y determinados niveles solo se pueden aplicar a determinados segmentos del inventario. Para obtener más información, consulte El servicio de perfiles.Predeterminado: null |
priority |
Entero | Clasificará cada nivel de subasta de 1 a 10 en prioridad ascendente. Las personas con prioridades más altas se comprueban primero para buscar una coincidencia. Si dos niveles coinciden con la puja en cuestión y sus prioridades son iguales, el ganador se elige de forma aleatoria.Predeterminado: 5 |
ym_profile_id |
Entero | Un nivel de subasta está asociado a un perfil de administración de rendimiento. Este es el identificador de ese perfil. Obligatorio activado: POST |
min_price |
decimal | Precio mínimo que deben pujar los miembros de la buyer_members matriz para su inclusión en este nivel. Esto puede ser null si se establece en member_action "exclude" .Nota: Si un comprador ha cumplido el valor de se comprueba después de min_price que se haya eliminado la cuota de uso compartido de ingresos de AppNexus; es decir, min_price se comprueba su oferta neta. Por ejemplo, si ha establecido en min_price $2.00 y el comprador puja $2.00 , su oferta neta puede reducirse a $1.70 . Esto significaría que no califican para el nivel. La solución es que los compradores tomen en cuenta su acuerdo de distribución de ingresos con AppNexus al enviar ofertas para su inclusión en los niveles.Predeterminado: null |
member_action |
enumeración | Esta configuración determina qué acción se va a realizar en la buyer_members matriz. Los valores permitidos son "include" y "exclude" .Predeterminado: exclude |
member_id |
Entero | Este es el identificador de miembro. |
buyer_members |
matriz de objetos | Esta matriz incluye los compradores a los que se dirige para su inclusión o exclusión en este nivel de subasta. Para obtener más información, consulte la matriz de miembros del comprador a continuación. Predeterminado: null |
Matriz de miembros del comprador
Campo | Tipo | Descripción |
---|---|---|
id |
Entero | El identificador del miembro al que va a dirigirse para su inclusión o exclusión. |
name |
string | Nombre del miembro al que va a dirigirse para su inclusión o exclusión. |
Ejemplos
Visualización de todos los niveles de subasta
$ curl -b cookies -c cookies 'https://api.appnexus.com/ym-auction-tier'
{
"response": {
"status": "OK",
"count": 328,
"start_element": null,
"num_elements": null,
"ym-auction-tiers": [
{
"id": 1,
"name": "Buyer 1 Tier",
"code": null,
"description": null,
"profile_id": null,
"priority": 10,
"ym_profile_id": 2785,
"min_price": "3.000000",
"member_action": "include",
"member_id": 752,
"buyer_members": [
{
"id": 1094,
"name": "Buyer 1"
}
]
},
{
"id": 2,
"name": "Buyer 2 Tier",
"code": null,
"description": null,
"profile_id": null,
"priority": 10,
"ym_profile_id": 2785,
"min_price": "4.000000",
"member_action": "include",
"member_id": 752,
"buyer_members": [
{
"id": 232,
"name": "Buyer 2"
}
]
},
{
"id": 3,
"name": "Buyer 3 Tier",
"code": null,
"description": null,
"profile_id": null,
"priority": 10,
"ym_profile_id": 2785,
"min_price": "2.500000",
"member_action": "include",
"member_id": 752,
"buyer_members": [
{
"id": 903,
"name": "Buyer 3"
}
]
},
...
]
}
}
Agregar un nivel de subasta: excluir un miembro
Debemos incluir nuestro {{member_id}}
nivel y el con el {{ym_profile_id}}
que queremos asociar este nivel.
$ cat add-tier.json
{
"ym-auction-tier": {
"member_id": 67890,
"ym_profile_id": 271828,
"description": "Bidder 9 from Outer Space has advanced alien bidding technology. They must be stopped!",
"name": "Exclude Bidder 9 from Outer Space",
"member_action": "exclude",
"priority": 10,
"min_price": null,
"buyer_members": [
{
"id": 12345,
"name": "Bidder 9 from Outer Space"
}
]
}
}
$ curl -b cookies -X POST -d @update.json "https://api.appnexus.com/ym-auction-tier"
{
"response": {
"id": 1105,
"ym-auction-tier": {
"profile_id": null,
"code": null,
"id": 5813,
"description": "Bidder 9 from Outer Space has advanced alien bidding technology. They must be stopped!",
"name": "Exclude Bidder 9 from Outer Space",
"member_id": 67890,
"member_action": "exclude",
"priority": 10,
"buyer_members": [{"id":12345,"name":"Bidder 9 from Outer Space"}],
"ym_profile_id": 271828,
"min_price": null
},
"status": "OK",
"start_element": null,
"count": 1,
"num_elements": null
}
}
Agregar un nivel de subasta: incluir un miembro
Tenga en cuenta que este miembro debe cumplir un nivel extremadamente alto {{min_price}}
para que se aplique este nivel. Dado que no hemos especificado , {{priority}}
el valor predeterminado es 5
.
$ cat add-tier.json
{
"ym-auction-tier": {
"ym_profile_id": 456,
"name": "A High Bar for Member 12 to clear",
"member_id":123,
"member_action": "include",
"min_price": "314159.00",
"buyer_members": [
{
"id": 12,
"name": "Member 12"
}
]
}
}
$ curl -b cookies -X POST -d @add-tier.json "https://api.appnexus.com/ym-auction-tier"
{
"response": {
"id": 1110,
"ym-auction-tier": {
"profile_id": null,
"code": null,
"id": 1110,
"description": null,
"name": "A high bar for Member 12 to clear",
"member_id": 123,
"member_action": "include",
"priority": 5,
"buyer_members": [
{
"id": 12,
"name": "Member 12"
}
],
"ym_profile_id": 456,
"min_price": "314159.000000"
},
"status": "OK",
"start_element": null,
"count": 1,
"num_elements": null
}
}
Actualización de un nivel de subasta
Hemos modificado nuestro acuerdo financiero con el Miembro 19 y nos gustaría que pujasen un mínimo de 1,25 USD para permanecer en su actual nivel de subasta.
$ cat update.json
{
"ym-auction-tier": {
"id": 001,
"member_id": 19,
"min_price": "1.25"
}
}
$ curl -b cookies -X PUT -d @update.json "https://api.appnexus.com/ym-auction-tier?id=001"
{
"response": {
"id": 001,
"ym-auction-tier": {
"profile_id": null,
"code": null,
"id": 001,
"description": null,
"name": "Member 19's Tier",
"member_id": 19,
"member_action": "include",
"priority": 7,
"buyer_members": [
{
"id": 19,
"name": "Member 19"
}
],
"ym_profile_id": 002,
"min_price": "1.25"
},
"status": "OK",
"start_element": null,
"count": 1,
"num_elements": null
}
}
Eliminación de un nivel de subasta
$ curl -b cookies -X DELETE "https://api.appnexus.com/ym-auction-tier?id=003"
{
"response": {
"status": "OK"
}
}