Servicio de piso de administración de rendimiento

El servicio Yield Management Floor se utiliza para crear y actualizar pisos dentro de un perfil de Yield Management existente.

Un piso puede considerarse como el precio mínimo que una cadena o editor le gustaría recibir por una creatividad. Sin embargo, hay sutilezas.

Advertencia

La configuración del piso reemplaza cualquier precio de reserva establecido a través del Servicio de colocación.

Ejemplo: Tiene una configuración de piso blando, pero no piso duro, y ha establecido un precio de reserva en el nivel de colocación . Sin embargo, dado que está utilizando herramientas de gestión de rendimiento , se ignorará su configuración de precio de reserva. Debe colocarlo aquí a través de un piso duro.

API de REST

Método HTTP Endpoint Description
GET https://api.appnexus.com/ym-floor?member_id=MEMBER_ID Ver todos los pisos asociados con un miembro determinado.
GET - https://api.appnexus.com/ym-floor?ym_profile_id=YM_PROFILE_ID
- https://api.appnexus.com/ym-floor?ym_profile_code=YM_PROFILE_CODE
Ver todos los pisos asociados con un perfil de gestión del rendimiento determinado.
GET - https://api.appnexus.com/ym-floor?id=YM_FLOOR_ID
- https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE
Ver un piso específico.
GET https://api.appnexus.com/ym-floor?id=1,2,3 Vea varios pisos de gestión de rendimiento por ID utilizando una lista separada por comas.
POST - https://api.appnexus.com/ym-floor?ym_profile_id=YM_PROFILE_ID
- https://api.appnexus.com/ym-floor?ym_profile_code=YM_PROFILE_CODE
(ym-floor JSON)
Agregar un nuevo piso.
PUT - https://api.appnexus.com/ym-floor?member_id=MEMBER_ID
- https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE
(ym-floor JSON)
Modificar un piso existente.
DELETE - https://api.appnexus.com/ym-floor?id=YM_FLOOR_ID
- https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE
Eliminar un piso existente.

Nota: No se puede eliminar un suelo que se utiliza como suelo base para uno o más perfiles de Yield Management.

Campos JSON

Campo Tipo Descripción
member_id Entero El identificador único del miembro con el que está asociado el piso.
Valor predeterminado:NULL
Requerido el:PUT, en la cadena de consulta.
id Entero El identificador único de un piso de gestión del rendimiento.
Valor predeterminado: Número incrementado automáticamente (es decir, 123).
Requerido en:PUT
name string El nombre utilizado para describir un piso de gestión del rendimiento.
Valor predeterminado:None
Requerido en:POST
code string El código personalizado opcional que se usa para hacer referencia a un piso de gestión de rendimiento.
Valor predeterminado:NULL
description string La descripción opcional de cómo se usa el piso de gestión de rendimiento.
Valor predeterminado:NULL
hard_floor double El suelo del CPM utilizado como precio de reserva duro que se aplicará.
Valor predeterminado:None
Requerido en:POST
soft_floor double El suelo del CPM utilizado como reserva blanda, definido como el precio más bajo al que se producirá la reducción del precio. Debe ser mayor o igual que el piso duro si está configurado.
Valor predeterminado:NULL
default_calculation_type enumeración Si el piso debe aplicarse al gross or net bid.
Valores posibles: gross o net. A default_calculation_type de net es un piso aplicado al costo de los medios pagado al editor.
Valor predeterminado:gross
profile_id Entero Se utiliza un opcional profile_id para determinar cuándo aplicar un piso. Un perfil es un conjunto genérico de reglas para el inventario de destino, y ciertos pisos solo pueden aplicarse a ciertos sectores del inventario. Para obtener más información, consulte el Servicio de perfiles.
Valor predeterminado:NULL
priority Entero El campo de prioridad (opcional) se utiliza para crear una jerarquía de cómo se debe aplicar el suelo. El valor puede estar entre 1-10, donde la prioridad 10 se trata como el valor de prioridad más alto.
Valor predeterminado:5
ym_profile_id Entero Identificador del perfil de gestión del rendimiento al que está asociado el piso de gestión del rendimiento. Para obtener más información, consulte el Servicio de perfiles de administración de rendimiento.

Nota: Este identificador no se puede cambiar una vez configurado.

Valor predeterminado:NULL
Requerido en:POST
floor_application_target enumeración El tipo de ofertas a las que se aplica el precio mínimo.
Posibles valores:
- external_only: el precio mínimo se aplica solo a las ofertas externas (el miembro comprador y el miembro vendedor son diferentes). Utilice esta opción si prefiere servir una impresión de Learn administrado disponible que servir un valor predeterminado, incluso si esto significa superar el % máximo del volumen diario para Learn (max_learn_pct campo en Publisher Service).
- external_non_preferred: el precio mínimo se aplica a ofertas externas (el miembro comprador y el miembro vendedor son diferentes) o cuando la impresión es una impresión de aprendizaje administrada disponible que supera el % máximo del volumen diario de aprendizaje. Use esta opción si prefiere servir un valor predeterminado que servir una impresión de aprendizaje administrado disponible que superaría el % máximo del volumen diario de aprendizaje.
- all: el precio mínimo se aplica a todas las pujas excepto las impresiones de Aprendizaje administrado dentro del % máximo del volumen diario de Aprendizaje.
Valor predeterminado:all
apply_floor_to_direct Booleano Eliminado. Úselo floor_application_target en su lugar.
allow_tag_reserve_override Booleano Si true, permite que un precio de reserva enviado a través de la cadena de consulta de la etiqueta de anuncio invalide el suelo duro existente. El piso solo se anulará si el precio de reserva proporcionado por la etiqueta es mayor que el precio mínimo.
Valor predeterminado:false
floor_optimization_enabled Booleano En desuso
members matriz Los miembros a los que se debe aplicar el piso de gestión del rendimiento. Si se deja establecido en NULL, el piso se aplicará a todos los miembros. Para obtener más detalles, consulte Miembros a continuación.
Valor predeterminado:NULL
brands matriz Las marcas a las que se debe aplicar el piso de gestión del rendimiento. Para obtener más información, consulte Marcas a continuación.
Valor predeterminado:NULL
categories matriz Las marcas o categorías creativas a las que se debe aplicar este piso de gestión del rendimiento. Para obtener más información, consulte las categorías siguientes.
Valor predeterminado:NULL
allowed_media_types matriz Los tipos de medios a los que se debe aplicar este piso de gestión del rendimiento. Para obtener más información, consulte Tipos de medios a continuación.
Valor predeterminado:NULL
allowed_media_subtypes matriz Los subtipos de medios a los que se debe aplicar este piso de gestión del rendimiento. Para obtener más información, consulte Subtipos de medios a continuación.
Valor predeterminado:NULL

Members

Campo Tipo Descripción
id Entero La identificación del miembro comprador (como se encuentra en el Servicio para miembros de la plataforma) para el cual se debe aplicar el piso.
Requerido en:POST/PUT
name string El nombre del miembro comprador. Este campo es de solo lectura.

Marcas

Campo Tipo Descripción
id Entero El identificador de la marca del creativo (tal como se encuentra en el Servicio de marca) para el que se debe aplicar el suelo.
Requerido en:POST/PUT
name string El nombre de la marca. Este campo es de solo lectura.

Categories

Campo Tipo Descripción
id Entero El identificador de la marca o categoría creativa (como se describe en la categoría Servicio) a la que se debe aplicar este piso.
Requerido en:POST/PUT
name string Nombre de la marca o categoría creativa. Este campo es de solo lectura.

Tipos de medios

Campo Tipo Descripción
id Entero El identificador del tipo de medio (como se describe en el servicio de tipo de medio) al que se debe aplicar este suelo.
Requerido en:POST/PUT
name string Nombre del tipo de medio. Este campo es de solo lectura.

Subtipos de multimedia

Campo Tipo Descripción
id Entero El identificador del subtipo de medio (como se describe en el servicio de subtipo de medios) al que se debe aplicar este suelo.
Requerido en:POST/PUT
name string Nombre del subtipo de medio. Este campo es de solo lectura.

Ejemplos

Ver un piso específico

$ curl -b cookies -c cookies  "https://api.appnexus.com/ym-floor?id=1234"
{
    "ym-floor": {
        "member_id": 3,
        "id": 1234,
        "name": "Germany Floor",
        "description": "This rule will used to set the floor for a set of demand attributes across Germany inventory.",
        "hard_floor": 1.20,
        "soft_floor": null,
        "default_calculation_type": "gross",
        "apply_floor_to_direct": true,
        "floor_application_target": "all",
        "profile_id": 1542,
        "priority": 6,
        "ym_profile_id": 1234,
        "members": [{
            "id": 100,
            "name": "eBay"
        }, {
            "id": 256,
            "name": "MiG"
        }],
        "brands": [{
            "id": 102,
            "name": "Netflix"
        }, {
            "id": 256,
            "name": "Blockbuster"
        }],
        "categories": [{
            "id": 2,
            "name": "Apparel"
        }, {
            "id": 8,
            "name": "Dating"
        }],
        "allowed_media_types": [{
            "id": 1,
            "name": "Banner"
        }, {
            "id": 4,
            "name": "Video"
        }],
        "allowed_media_subtypes": [{
            "id": 1,
            "name": "Standard Banner"
        }, {
            "id": 8,
            "name": "30-second VAST"
        }]
    }
}

Ver todos los pisos asociados con un perfil de gestión del rendimiento

Observe que los siguientes pisos se segmentan de forma opcional {{profile_id}} en lugar de a través de la {{members}} matriz. Para obtener más información, consulte los campos JSON anteriores.

$ curl -b cookies "https://api.appnexus.com/ym-floor?ym_profile_id=9999"
{
    "response": {
        "start_element": null,
        "count": 2,
        "ym-floors": [{
            "priority": 5,
            "last_modified": "2011-11-03 23:04:24",
            "soft_floor": 0.23999999999999999,
            "member_id": 123,
            "name": "Placement 60 + Size 300x250 Floor",
            "floor_application_target": "all",
            "default_calculation_type": "gross",
            "brands": null,
            "ym_profile_id": 9999,
            "code": "Tattooed Bikers Galore",
            "hard_floor": 0,
            "id": 555,
            "description": null,
            "profile_id": 23,
            "members": null,
            "categories": null,
            "allowed_media_types": null,
            "allowed_media_subtypes": null
        }, {
            "priority": 5,
            "last_modified": "2011-11-04 01:18:35",
            "soft_floor": 0.050000000000000003,
            "member_id": 1,
            "name": "Placement+Size 728x90 Floor",
            "floor_application_target": "all",
            "default_calculation_type": "gross",
            "brands": null,
            "ym_profile_id": 9999,
            "code": "Tattooed Bikers Knit and Sew",
            "hard_floor": 0,
            "id": 4,
            "description": null,
            "profile_id": 9,
            "members": null,
            "categories": null,
            "allowed_media_types": null,
            "allowed_media_subtypes": null
        }],
        "status": "OK",
        "num_elements": null
    }
}