Service profil de gestion des rendements

Le service profil de gestion du rendement est utilisé pour créer et mettre à jour des profils de gestion des rendements qui définissent des prix planchers dynamiques, des biais d’enchères et des niveaux d’enchères pour un éditeur.

Plus concrètement, le profil de gestion des rendements est un ensemble de règles avec les propriétés et comportements suivants :

Le profil cible :
- Tout/partie de l’inventaire
- Certains/tous les acheteurs
Le profil spécifie :
- 0 ou plus de règles de plancher
- 0 règles de biais ou plus
- 0 modificateurs ou plus qui s’appliqueront à ces planchers et biais
- 0 ou plus niveaux d’enchères

API REST

HTTP, méthode	Endpoint	Description
`GET`	- https://api.appnexus.com/ym-profile?id=YMP_ID - https://api.appnexus.com/ym-profile?id=YMP_CODE	Afficher un profil spécifique.
`GET`	- https://api.appnexus.com/ym-profile?publisher_id=PUBLISHER_ID - https://api.appnexus.com/ym-profile?publisher_code=PUBLISHER_CODE	Affichez tous les profils associés à un éditeur particulier.
`GET`	https://api.appnexus.com/ym-profile?id=1,2,3	Affichez plusieurs profils par ID à l’aide d’une liste séparée par des virgules.
`POST`	https://api.appnexus.com/ym-profile (ym-profile JSON)	Ajoutez un profil. Note: Après avoir ajouté un profil, vous pouvez utiliser le service serveur de publication pour attribuer le profil à un serveur de publication particulier.
`PUT`	- https://api.appnexus.com/ym-profile?id=YMP_ID - https://api.appnexus.com/ym-profile?id=YMP_CODE (ym profile JSON)	Modifier un profil existant.
`DELETE`	https://api.appnexus.com/ym-profile?id=YMP_ID	Supprimer un profil existant.

Champs JSON

Champ	Type	Description
`id`	int	Identificateur unique d’un profil de gestion des rendements. Par défaut: Nombre incrémenté automatiquement (c’est-à-dire 123). Obligatoire sur :`PUT`
`code`	string	Code personnalisé facultatif utilisé pour référencer un profil de gestion des rendements. Par défaut:`NULL`
`name`	string	Nom utilisé pour décrire un profil de gestion des rendements. Par défaut:`None` Obligatoire sur :`POST`
`description`	string	Description facultative du profil de gestion du rendement. Par défaut:`NULL`
`base_ym_bias_id`	int	ID du biais YM qui doit être appliqué si aucun autre biais YM ne doit être utilisé. En règle générale, ce biais YM a une priorité 1 (priorité la plus basse) et aucun profil. Par défaut:`NULL`
`base_ym_floor_id`	int	ID du plancher YM à appliquer si aucun autre étage YM ne doit être utilisé. En règle générale, ce plancher YM a une priorité 1 (priorité la plus basse) et aucun profil. Par défaut:`NULL`
`publisher_id`	int	En lecture seule. ID de l’éditeur auquel le profil de gestion des rendements est associé. Vous utilisez le service serveur de publication pour établir l’association entre le profil de gestion des rendements et l’éditeur.
`modifiers`	tableau	Modificateurs appliqués à l’attribut technique du créatif. Pour plus d’informations, consultez Modificateurs ci-dessous. Par défaut:`NULL`
`biases`	tableau	Les biais appliqués aux objets côté demande : Buyer Groupes, Buyer Members. Pour plus d’informations, consultez Biais ci-dessous. Par défaut:`NULL`
`floors`	tableau	Prix plancher appliqués en fonction de l’inventaire et du ciblage des utilisateurs. Pour plus d’informations, consultez Planchers ci-dessous. Par défaut:`NULL`
`last_modified`	Timestamp	Heure de la dernière modification de ce profil de gestion des rendements. Par défaut:`N/A`

Modificateurs

Champ	Type	Description
`technical_attributes`	tableau	Il s’agit d’un tableau spécifiant les attributs techniques auxquels le modificateur de gestion du rendement doit être appliqué. Par défaut:`NULL` Obligatoire sur :`POST`, `PUT`

Modificateurs - Attributs techniques

Champ	Type	Description
`id`	int	Il s’agit de l’ID de l’attribut technique (tel qu’il se trouve dans le service d’attributs techniques) pour lequel le modificateur doit être appliqué. Par défaut:`None` Obligatoire sur :`POST`, `PUT`
`name`	nom	Il s’agit du nom de l’attribut technique. Par défaut:`N/A`
`type`	enum (`'bias-pct'`, `'bias-cpm'`, `'floor-pct'`, `'floor-cpm'`)	Cela détermine la valeur à utiliser pour le modificateur, représentée sous la forme d’un pourcentage ou d’un CPM plat, et à quoi le modificateur doit être appliqué : l’enchère ou le plancher. Par défaut:`NULL` Obligatoire sur :`POST`, `PUT`
`amount_pct`	double	Il s’agit du pourcentage de la valeur par laquelle l’offre ou le plancher doit être modifié. Si `bias_pct = 5`la valeur est , l’offre nette sera augmentée de 5 %. Par défaut:`0.00` Obligatoire On :`POST`, `PUT` (si `type` est `'bias-pct'` ou `'floor-pct'`).
`amount_cpm`	double	Il s’agit de l’augmentation/diminution du CPM par laquelle l’enchère ou le plancher doit être modifié. Par défaut:`NULL` Obligatoire On :`POST`, `PUT` (si `type` est `'bias-cpm'` ou `'floor-cpm'`).

Préjugés

Champ	Type	Description
`id`	int	Identificateur unique d’un biais de gestion du rendement. Par défaut: Nombre incrémenté automatiquement (c’est-à-dire 123). Obligatoire sur :`PUT`
`code`	string	Code personnalisé facultatif utilisé pour référencer un biais de gestion des rendements. Par défaut:`NULL`
`name`	string	Nom utilisé pour décrire un biais de gestion du rendement. Par défaut:`None` Obligatoire sur :`POST`
`description`	string	Description facultative de l’utilisation du biais de gestion du rendement. Par défaut:`NULL`
`profile_id`	int	Une valeur facultative `profile_id` est utilisée pour déterminer quand appliquer un biais. Un profil est un ensemble générique de règles permettant de cibler l’inventaire, et certains biais peuvent s’appliquer uniquement à certaines tranches d’inventaire. Pour plus d’informations, consultez service de profil. Par défaut:`NULL`
`priority`	int	Le champ de priorité (facultatif) est utilisé pour créer une hiérarchie de la façon dont le biais doit être appliqué. La valeur peut être comprise entre l’emplacement `1`-`10` où la priorité `10` est traitée comme la valeur de priorité la plus élevée. Par défaut:`5`
`members`	tableau	Il s’agit d’un tableau spécifiant le ou les membres auquel le biais de gestion du rendement doit être appliqué. Par défaut:`NULL`
`buyer_groups`	tableau	Il s’agit d’un tableau spécifiant le ou les groupes d’acheteurs auquel le biais de gestion du rendement doit être appliqué. Par défaut:`NULL`

Biais - Membres acheteur

Champ	Type	Description
`id`	int	Il s’agit de l’ID du membre acheteur (tel que trouvé dans le service membre de la plateforme) pour lequel le biais doit être appliqué. Par défaut:`None` Obligatoire sur :`POST`, `PUT`
`name`	chaîne	Il s’agit du nom du membre acheteur. Par défaut:`N/A`
`type`	enum (`'percent'`,`'cpm'`)	Cela détermine la valeur à utiliser pour le biais, représentée sous la forme d’un pourcentage ou d’un CPM plat. Par défaut:`"percent"` Obligatoire sur :`POST`, `PUT`
`bias_pct`	double	Il s’agit du pourcentage par lequel le membre acheteur doit être ajusté. Si `bias_pct = 5`la valeur est , l’offre nette sera augmentée de 5 %. Par défaut:`0.00` Obligatoire On :`POST`, `PUT` (si `type` a la valeur `'percent'`).
`bias_cpm`	double	Il s’agit de l’augmentation/diminution du CPM par laquelle le membre acheteur doit être ajusté. Par défaut:`NULL` Obligatoire On :`POST`, `PUT` (si `type` a la valeur `'cpm'`).

Biais - Groupes d’acheteurs

Champ	Type	Description
`id`	int	Il s’agit de l’ID du groupe d’acheteurs pour lequel le biais doit être appliqué. Par défaut: Aucun Obligatoire sur :`POST`, `PUT`
`name`	string	Il s’agit du nom du groupe d’acheteurs. Par défaut:`N/A`
`type`	enum (`'percent'`,`'cpm'`)	Cela détermine la valeur à utiliser pour le biais, représentée sous la forme d’un pourcentage ou d’un CPM plat. Par défaut:`"percent"` Obligatoire sur :`POST`, `PUT`
`bias_pct`	double	Il s’agit du pourcentage par lequel le membre acheteur doit être ajusté. Si `bias_pct = 5`la valeur est , l’offre nette sera augmentée de 5 %. Par défaut:`0.00` Obligatoire On :`POST`, `PUT` (si `type` a la valeur `'percent'`).
`bias_cpm`	double	Il s’agit de l’augmentation/diminution du CPM par laquelle le membre acheteur doit être ajusté. Par défaut:`NULL` Obligatoire On :`POST`, `PUT` (si `type` a la valeur `'cpm'`).

Étages

Champ	Type	Description
`id`	int	Identificateur unique d’un plancher de gestion du rendement. Par défaut: Nombre incrémenté automatiquement (c’est-à-dire 123). Obligatoire sur :`PUT`
`code`	chaîne	Code personnalisé facultatif utilisé pour référencer un plancher de gestion des rendements. Par défaut:`NULL`
`name`	string	Nom utilisé pour décrire un plancher de gestion des rendements. Par défaut:`None` Obligatoire sur :`POST`
`description`	string	Description facultative de la façon dont le plancher de gestion du rendement est utilisé. Par défaut:`NULL`
`profile_id`	int	Une valeur facultative `profile_id` est utilisée pour déterminer quand appliquer un plancher. Un profil est un ensemble générique de règles pour cibler l’inventaire, et certains étages peuvent s’appliquer uniquement à certaines tranches d’inventaire. Pour plus d’informations, consultez service de profil. Par défaut:`NULL`
`priority`	int	Le champ de priorité (facultatif) est utilisé pour créer une hiérarchie de la façon dont le plancher doit être appliqué. La valeur peut être comprise entre l’emplacement `1`-`10` où la priorité `10` est traitée comme la valeur de priorité la plus élevée. Par défaut:`5`
`hard_floor`	double	Ce plancher cpm est utilisé comme prix de réserve dure à appliquer. Par défaut:`None` Obligatoire sur :`POST`
`soft_floor`	double	Ce plancher cpm est utilisé comme la réserve souple, définie comme le prix le plus bas auquel la réduction de prix se produira - Ceci doit être >= le plancher dur si défini. Par défaut:`NULL`
`members`	tableau	Il s’agit d’un tableau spécifiant le ou les membres auquel le plancher de gestion du rendement doit être appliqué. Par défaut:`NULL`
`brands`	tableau	Il s’agit d’un tableau spécifiant la ou les marques à laquelle le plancher de gestion du rendement doit être appliqué. Par défaut:`NULL`
`categories`	tableau	Il s’agit d’un tableau spécifiant la ou les catégories à laquelle le plancher de gestion du rendement doit être appliqué. Par défaut:`NULL`
`default_calculation_type`	enum (`'gross'`,`'net'`)	Cela permet de déterminer si le plancher doit être appliqué à l’offre brute ou nette. Par défaut:`gross`
`apply_floor_to_direct`	int	Cela permet de déterminer si l’étage doit être appliqué uniquement aux membres spécifiés ou en plus de la demande gérée. Par défaut:`1`

Floor - Membres

Champ	Type	Description
`id`	int	Il s’agit de l’ID du membre acheteur (tel que trouvé dans le service membre de la plateforme) pour lequel l’étage doit être appliqué. Obligatoire sur :`POST`, `PUT`
`name`	tableau	Il s’agit du nom du membre acheteur.

Floor - Marques

Champ	Type	Description
`id`	int	Il s’agit de l’ID de la marque du créateur (tel que trouvé dans le service de marque) pour lequel le plancher doit être appliqué. Obligatoire sur :`POST`, `PUT`
`name`	tableau	Il s’agit du nom de la marque.

Floor - Catégories

Champ	Type	Description
`id`	int	Il s’agit de l’ID de la catégorie du créatif (tel que trouvé dans le service de catégorie) pour laquelle le plancher doit être appliqué. Obligatoire sur :`POST`, `PUT`
`name`	tableau	Il s’agit du nom de la catégorie.

Exemple

Afficher un profil de gestion des rendements spécifique

$ 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
            }
        ]
    }
}

Last updated on 2025-04-01

Partager via