Yield Management Profile Service

Artículo
07/05/2024

El servicio de perfil de administración de rendimiento se usa para crear y actualizar perfiles de administración de rendimiento que definen niveles dinámicos de precios, sesgos de puja y niveles de subasta para un publicador.

Más concretamente, el perfil de administración de rendimiento es un conjunto de reglas con las siguientes propiedades y comportamientos:

El perfil tiene como destino:
- Inventario de algunos o todos
- Algunos/todos los compradores
El perfil especifica:
- 0 o más reglas básicas
- 0 o más reglas de sesgo
- 0 o más modificadores que se aplicarán a esos pisos y sesgos
- 0 o más niveles de subasta

API de REST

Http (método)	Endpoint	Description
`GET`	- https://api.appnexus.com/ym-profile?id=YMP_ID - https://api.appnexus.com/ym-profile?id=YMP_CODE	Ver un perfil específico.
`GET`	- https://api.appnexus.com/ym-profile?publisher_id=PUBLISHER_ID - https://api.appnexus.com/ym-profile?publisher_code=PUBLISHER_CODE	Ver todos los perfiles asociados a un publicador determinado.
`GET`	https://api.appnexus.com/ym-profile?id=1,2,3	Vea varios perfiles por identificador mediante una lista separada por comas.
`POST`	https://api.appnexus.com/ym-profile (JSON de perfil de ym)	Agregue un perfil. Nota: Después de agregar un perfil, puede usar el servicio publisher para asignar el perfil a un publicador determinado.
`PUT`	- https://api.appnexus.com/ym-profile?id=YMP_ID - https://api.appnexus.com/ym-profile?id=YMP_CODE (JSON de perfil de ym)	Modificar un perfil existente.
`DELETE`	https://api.appnexus.com/ym-profile?id=YMP_ID	Elimine un perfil existente.

Campos JSON

Campo	Tipo	Descripción
`id`	Entero	Identificador único de un perfil de administración de rendimiento. Predeterminado: Número incrementado automáticamente (es decir, 123). Obligatorio activado:`PUT`
`code`	string	Código personalizado opcional que se usa para hacer referencia a un perfil de administración de rendimiento. Predeterminado:`NULL`
`name`	string	Nombre que se usa para describir un perfil de administración de rendimiento. Predeterminado:`None` Obligatorio activado:`POST`
`description`	string	Descripción opcional del perfil de administración de rendimiento. Predeterminado:`NULL`
`base_ym_bias_id`	Entero	Identificador del sesgo de YM que se debe aplicar si no se debe usar ningún otro sesgo de YM. Normalmente, este sesgo de YM tiene una prioridad 1 (prioridad más baja) y ningún perfil. Predeterminado:`NULL`
`base_ym_floor_id`	Entero	Identificador del nivel de YM que se debe aplicar si no se debe usar ningún otro suelo de YM. Normalmente, esta planta de YM tiene una prioridad 1 (prioridad más baja) y ningún perfil. Predeterminado:`NULL`
`publisher_id`	Entero	Solo lectura. Identificador del publicador al que está asociado el perfil de administración de rendimiento. Use el servicio publisher para establecer la asociación entre el perfil de administración de rendimiento y el publicador.
`modifiers`	matriz	Modificadores aplicados al atributo técnico de la creatividad. Para obtener más información, vea Modificadores a continuación. Predeterminado:`NULL`
`biases`	matriz	Los sesgos aplicados a los objetos secundarios de la demanda: Grupos de compradores, Miembros compradores. Para obtener más información, consulte Sesgos a continuación. Predeterminado:`NULL`
`floors`	matriz	Precios mínimos aplicados en función del inventario y la segmentación de usuarios. Para obtener más información, consulte Pisos a continuación. Predeterminado:`NULL`
`last_modified`	Timestamp	Hora de la última modificación de este perfil de administración de rendimiento. Predeterminado:`N/A`

Modificadores

Campo	Tipo	Descripción
`technical_attributes`	matriz	Se trata de una matriz que especifica los atributos técnicos a los que se debe aplicar el modificador de administración de rendimiento. Predeterminado:`NULL` Obligatorio en:`POST` , `PUT`

Modificadores: atributos técnicos

Campo	Tipo	Descripción
`id`	Entero	Este es el identificador del atributo técnico (como se encuentra en el Servicio de atributos técnicos) para el que se debe aplicar el modificador. Predeterminado:`None` Obligatorio en:`POST` , `PUT`
`name`	name	Este es el nombre del atributo técnico. Predeterminado:`N/A`
`type`	enumeración (`'bias-pct'`, `'bias-cpm'`, `'floor-pct'`, `'floor-cpm'`)	Esto determina el valor que se va a usar para el modificador, representado como un porcentaje o un CPM plano, y a qué se debe aplicar el modificador: la puja o la planta. Predeterminado:`NULL` Obligatorio en:`POST` , `PUT`
`amount_pct`	double	Este es el porcentaje por el que debe modificarse la oferta o el piso. Si `bias_pct = 5`es , la oferta neta se incrementará un 5 %. Predeterminado:`0.00` Obligatorio En:`POST`, `PUT` (si `type` es `'bias-pct'` o `'floor-pct'`).
`amount_cpm`	double	Este es el aumento o disminución de CPM por el que debe modificarse la oferta o el piso. Predeterminado:`NULL` Obligatorio En:`POST`, `PUT` (si `type` es `'bias-cpm'` o `'floor-cpm'`).

Sesgos

Campo	Tipo	Descripción
`id`	Entero	Identificador único de un sesgo de administración de rendimiento. Predeterminado: Número incrementado automáticamente (es decir, 123). Obligatorio activado:`PUT`
`code`	string	Código personalizado opcional que se usa para hacer referencia a un sesgo de administración de rendimiento. Predeterminado:`NULL`
`name`	string	Nombre que se usa para describir un sesgo de administración del rendimiento. Predeterminado:`None` Obligatorio activado:`POST`
`description`	string	Descripción opcional de cómo se usa el sesgo de administración del rendimiento. Predeterminado:`NULL`
`profile_id`	Entero	Se usa un opcional `profile_id` para determinar cuándo aplicar un sesgo. Un perfil es un conjunto genérico de reglas para el inventario de destino y ciertos sesgos solo se pueden aplicar a determinados segmentos del inventario. Para obtener más información, consulte El servicio de perfiles. Predeterminado:`NULL`
`priority`	Entero	El campo de prioridad (opcional) se usa para crear una jerarquía de cómo se debe aplicar el sesgo. El valor puede estar entre `1`-`10` donde la prioridad `10` se trata como el valor de prioridad más alto. Predeterminado:`5`
`members`	matriz	Se trata de una matriz que especifica los miembros a los que se debe aplicar el sesgo de administración de rendimiento. Predeterminado:`NULL`
`buyer_groups`	matriz	Se trata de una matriz que especifica los grupos de compradores a los que se debe aplicar el sesgo de administración del rendimiento. Predeterminado:`NULL`

Sesgos: miembros del comprador

Campo	Tipo	Descripción
`id`	Entero	Este es el identificador del miembro comprador (tal como se encuentra en el servicio de miembro de la plataforma) para el que se debe aplicar el sesgo. Predeterminado:`None` Obligatorio en:`POST` , `PUT`
`name`	string	Este es el nombre del miembro comprador. Predeterminado:`N/A`
`type`	enumeración (`'percent'`,`'cpm'`)	Esto determina qué valor se va a usar para el sesgo, representado como un porcentaje o un CPM plano. Predeterminado:`"percent"` Obligatorio en:`POST` , `PUT`
`bias_pct`	double	Este es el porcentaje por el que debe ajustarse el miembro comprador. Si `bias_pct = 5`es , la oferta neta se incrementará un 5 %. Predeterminado:`0.00` Obligatorio En:`POST`, `PUT` (si `type` es `'percent'`).
`bias_cpm`	double	Este es el aumento o disminución de CPM por el que debe ajustarse el miembro comprador. Predeterminado:`NULL` Obligatorio En:`POST`, `PUT` (si `type` es `'cpm'`).

Sesgos: grupos de compradores

Campo	Tipo	Descripción
`id`	Entero	Este es el identificador del grupo de compradores para el que se debe aplicar el sesgo. Predeterminado: Ninguno Obligatorio en:`POST` , `PUT`
`name`	string	Este es el nombre del grupo de compradores. Predeterminado:`N/A`
`type`	enumeración (`'percent'`,`'cpm'`)	Esto determina qué valor se va a usar para el sesgo, representado como un porcentaje o un CPM plano. Predeterminado:`"percent"` Obligatorio en:`POST` , `PUT`
`bias_pct`	double	Este es el porcentaje por el que debe ajustarse el miembro comprador. Si `bias_pct = 5`es , la oferta neta se incrementará un 5 %. Predeterminado:`0.00` Obligatorio En:`POST`, `PUT` (si `type` es `'percent'`).
`bias_cpm`	double	Este es el aumento o disminución de CPM por el que debe ajustarse el miembro comprador. Predeterminado:`NULL` Obligatorio En:`POST`, `PUT` (si `type` es `'cpm'`).

Pisos

Campo	Tipo	Descripción
`id`	Entero	Identificador único de una planta de administración de rendimiento. Predeterminado: Número incrementado automáticamente (es decir, 123). Obligatorio activado:`PUT`
`code`	string	Código personalizado opcional que se usa para hacer referencia a una planta de administración de rendimiento. Predeterminado:`NULL`
`name`	string	Nombre que se usa para describir una planta de administración de rendimiento. Predeterminado:`None` Obligatorio activado:`POST`
`description`	string	Descripción opcional de cómo se usa la planta de administración de rendimiento. Predeterminado:`NULL`
`profile_id`	Entero	Se usa un opcional `profile_id` para determinar cuándo se debe aplicar un suelo. Un perfil es un conjunto genérico de reglas para el inventario de destino y determinados pisos solo se pueden aplicar a determinados segmentos del inventario. Para obtener más información, consulte El servicio de perfiles. Predeterminado:`NULL`
`priority`	Entero	El campo de prioridad (opcional) se usa 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. Predeterminado:`5`
`hard_floor`	double	Esta planta cpm se utiliza como el precio de reserva dura que se va a aplicar. Predeterminado:`None` Obligatorio activado:`POST`
`soft_floor`	double	Este piso cpm se utiliza como reserva temporal, definida como el precio más bajo en el que se producirá la reducción del precio - Esto debe ser >= el piso duro si se establece. Predeterminado:`NULL`
`members`	matriz	Se trata de una matriz que especifica los miembros a los que se debe aplicar la planta de administración de rendimiento. Predeterminado:`NULL`
`brands`	matriz	Se trata de una matriz que especifica las marcas a las que se debe aplicar la planta de administración del rendimiento. Predeterminado:`NULL`
`categories`	matriz	Se trata de una matriz que especifica las categorías a las que se debe aplicar la planta de administración de rendimiento. Predeterminado:`NULL`
`default_calculation_type`	enumeración (`'gross'`,`'net'`)	Esto se usa para determinar si el piso debe aplicarse a la oferta bruta o neta. Predeterminado:`gross`
`apply_floor_to_direct`	Entero	Esto se usa para determinar si la planta se debe aplicar solo a miembros especificados o además de a la demanda administrada. Predeterminado:`1`

Pisos: miembros

Campo	Tipo	Descripción
`id`	Entero	Este es el identificador del miembro comprador (tal como se encuentra en el Servicio de miembros de la plataforma) para el que se debe aplicar el piso. Obligatorio en:`POST` , `PUT`
`name`	matriz	Este es el nombre del miembro comprador.

Pisos : marcas

Campo	Tipo	Descripción
`id`	Entero	Este es el identificador de la marca de la creatividad (como se encuentra en el Servicio de marca) para la que se debe aplicar el piso. Obligatorio en:`POST` , `PUT`
`name`	matriz	Este es el nombre de la marca.

Planta: categorías

Campo	Tipo	Descripción
`id`	Entero	Este es el identificador de la categoría de la creatividad de la creatividad (tal como se encuentra en el Servicio de categorías) para la que se debe aplicar la planta. Obligatorio en:`POST` , `PUT`
`name`	matriz	Este es el nombre de la categoría.

Ejemplo

Visualización de un perfil de administración de rendimiento específico

$ curl -b cookies -c cookies  "https://api.appnexus.com/ym-profile?id=8"
{
    "ym-profile": {
        "id": 1234,
        "member_id": 3,
        "active": true,
        "name": "Publisher X YMP",
        "description": "This profile will be used for publisher X.",
        "base_ym_bias_id": 125,
        "base_ym_floor_id": 1574,
        "last_modified": "2010-10-02 12:00:00",
        "modifiers": {
            "technical_attributes": [
                {
                    "id": 2,
                    "type": "bias-cpm",
                    "amount_pct": 0,
                    "amount_cpm": -1,
                    "name": "Flash"
                },
                {
                    "id": 3,
                    "type": "bias-pct",
                    "amount_pct": 10,
                    "amount_cpm": null,
                    "name": "Text"
                }
            ]
        },
        "biases": [
            {
                "id": 124,
                "name": "YMP Canada Bias",
                "description": "This rule will used to set the bias for a set of demand attributes across Canadian inventory.",
                "profile_id": 1241,
                "priority": 10,
                "members": [
                    {
                        "id": 100,
                        "name": "eBay",
                        "type": "percent",
                        "bias_pct": "9"
                    },
                    {
                        "id": 256,
                        "name": "MiG",
                        "type": "cpm",
                        "bias_cpm": -0.25
                    }
                ],
                "buyer_groups": [
                    {
                        "id": 120,
                        "name": "Third Party Ad Networks",
                        "type": "percent",
                        "bias_pct": -5
                    },
                    {
                        "id": 153,
                        "name": "Value Ad Networks",
                        "type": "cpm",
                        "bias_cpm": 0.50
                    }
                ]
            },
            {
                "id": 125,
                "name": "Base YMP Bias",
                "description": "",
                "profile_id": null,
                "priority": 1,
                "members": null,
                "buyer_groups": null
            }
        ],
        "floors": [
            {
                "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,
                "profile_id": 1542,
                "priority": 6,
                "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"
                    }
                ]
            },
            {
                "id": 1574,
                "name": "Base YM Floor",
                "description": "",
                "hard_floor": 1.00,
                "soft_floor": 1.50,
                "default_calculation_type": "gross",
                "apply_floor_to_direct": true,
                "profile_id": null,
                "priority": 1,
                "members": null,
                "brands": null,
                "categories": null
            }
        ]
    }
}

Compartir a través de