Partager via


Service Yield Management Floor

Le service d’étage de gestion des rendements est utilisé pour créer et mettre à jour des étages au sein d’un profil de gestion des rendements existant.

Un plancher peut être considéré comme le prix minimum qu’un réseau ou un éditeur aimerait recevoir pour un créatif. Il y a cependant des subtilités.

Avertissement

Les paramètres d’étage remplacent les prix de réserve définis via le service de placement.

Exemple: Vous avez un sol souple, mais pas de plancher dur, et vous avez défini un prix de réserve au niveau placement . Toutefois, étant donné que vous utilisez des outils de gestion du rendement , votre paramètre de prix de réserve sera ignoré. Vous devez le placer ici par un plancher dur.

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/ym-floor?member_id=MEMBER_ID Afficher tous les étages associés à un membre donné.
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
Affichez tous les étages associés à un profil de gestion du rendement donné.
GET - https://api.appnexus.com/ym-floor?id=YM_FLOOR_ID
- https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE
Afficher un étage spécifique.
GET https://api.appnexus.com/ym-floor?id=1,2,3 Affichez plusieurs planchers de gestion du rendement par ID à l’aide d’une liste séparée par des virgules.
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)
Ajoutez un nouvel étage.
PUT - https://api.appnexus.com/ym-floor?member_id=MEMBER_ID
- https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE
(ym-floor JSON)
Modifier un plancher existant.
DELETE - https://api.appnexus.com/ym-floor?id=YM_FLOOR_ID
- https://api.appnexus.com/ym-floor?code=YM_FLOOR_CODE
Supprimer un étage existant.

Note: Vous ne pouvez pas supprimer un plancher utilisé comme plancher de base pour un ou plusieurs profils de gestion des rendements.

Champs JSON

Champ Type Description
member_id int Identificateur unique du membre auquel l’étage est associé.
Par défaut:NULL
Obligatoire On :PUT, dans la chaîne de requête.
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
name string Nom utilisé pour décrire un plancher de gestion du rendement.
Par défaut:None
Obligatoire sur :POST
code string Code personnalisé facultatif utilisé pour référencer un plancher de gestion des rendements.
Par défaut:NULL
description string Description facultative de la façon dont le plancher de gestion du rendement est utilisé.
Par défaut:NULL
hard_floor double Plancher CPM utilisé comme prix de réserve dure à appliquer.
Par défaut:None
Obligatoire sur :POST
soft_floor double Plancher CPM utilisé comme réserve souple, défini comme le prix le plus bas auquel la réduction de prix se produira. Cette valeur doit être supérieure ou égale au plancher dur si elle est définie. Cette valeur est ignorée si floor_optimization_enabled a la valeur true.
Par défaut:NULL
default_calculation_type enum Indique si le plancher doit être appliqué à l’offre gross ou net .
Valeurs possibles : gross ou net. Un default_calculation_type de net est un plancher appliqué au coût média payé à l’éditeur.
Par défaut:gross
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 1-10, où la priorité 10 est traitée comme la valeur de priorité la plus élevée.
Par défaut:5
ym_profile_id int ID du profil de gestion du rendement auquel le plancher de gestion du rendement est associé. Pour plus d’informations, consultez le service de profil de gestion du rendement.

Note: Cet ID ne peut pas être modifié une fois qu’il est défini.

Par défaut:NULL
Obligatoire sur :POST
floor_application_target enum Type d’enchères auxquelles le prix plancher est appliqué.
Valeurs possibles :
- external_only: le prix plancher est appliqué uniquement aux enchères externes (le membre acheteur et le membre vendeur sont différents). Utilisez cette option si vous préférez fournir une impression d’apprentissage managé disponible plutôt qu’une valeur par défaut, même si cela signifie dépasser le pourcentage maximal de volume quotidien pour learn (max_learn_pct champ dans Publisher Service).
- external_non_preferred: le prix plancher est appliqué aux enchères externes (le membre achetant et le membre vendeur sont différents) ou lorsque l’impression est une impression d’apprentissage managé disponible qui dépasse le pourcentage maximal de volume quotidien pour learn. Utilisez cette option si vous préférez servir une valeur par défaut plutôt qu’une impression d’apprentissage managé disponible qui dépasserait le pourcentage maximal de volume quotidien pour learn.
- all: le prix plancher est appliqué à toutes les enchères à l’exception des impressions d’apprentissage managées dans le pourcentage maximal du volume quotidien pour learn.
Par défaut:all
apply_floor_to_direct Valeur booléenne Supprimé. Utilisez floor_application_target à la place.
allow_tag_reserve_override Valeur booléenne Si la valeur est true, autorisez un prix de réserve envoyé via la chaîne de requête de balise d’annonce pour remplacer le plancher dur existant. Le plancher ne sera remplacé que si le prix de réserve fourni par étiquette est supérieur au prix plancher.
Par défaut:false
floor_optimization_enabled Valeur booléenne Si truela valeur est , les planchers souples sont ignorés et les planchers pour monter et descendre en fonction des conditions du marché, mais ne laissez jamais la quantité passer sous le plancher dur.
Par défaut:false
members tableau Membres auxquels le plancher de gestion du rendement doit être appliqué. Si la valeur est définie sur NULL, l’étage s’applique à tous les membres. Pour plus d’informations, consultez Membres ci-dessous.
Par défaut:NULL
brands tableau Marques auxquelles le plancher de gestion du rendement doit être appliqué. Pour plus d’informations, consultez Marques ci-dessous.
Par défaut:NULL
categories tableau Marques ou catégories créatives auxquelles ce plancher de gestion du rendement doit être appliqué. Pour plus d’informations, consultez Catégories ci-dessous.
Par défaut:NULL
allowed_media_types tableau Types de supports auxquels ce plancher de gestion des rendements doit être appliqué. Pour plus d’informations, consultez Types de médias ci-dessous.
Par défaut:NULL
allowed_media_subtypes tableau Sous-types de média auxquels ce plancher de gestion du rendement doit être appliqué. Pour plus d’informations, consultez Sous-types de média ci-dessous.
Par défaut:NULL

Members

Champ Type Description
id int ID du membre acheteur (tel qu’il se trouve dans le service membre de la plateforme) pour lequel l’étage doit être appliqué.
Obligatoire sur :POST/PUT
name string Nom du membre acheteur. Ce champ est en lecture seule.

Marques

Champ Type Description
id int ID de la marque du créatif (tel que trouvé dans le service de marque) pour lequel le plancher doit être appliqué.
Obligatoire sur :POST/PUT
name string Nom de la marque. Ce champ est en lecture seule.

Catégories

Champ Type Description
id int ID de la marque ou de la catégorie créative (comme décrit dans le service catégorie) à laquelle cet étage doit être appliqué.
Obligatoire sur :POST/PUT
name string Nom de la marque ou de la catégorie créative. Ce champ est en lecture seule.

Types de médias

Champ Type Description
id int ID du type de média (comme décrit dans le service de type de média) auquel cet étage doit être appliqué.
Obligatoire sur :POST/PUT
name string Nom du type de média. Ce champ est en lecture seule.

Sous-types de média

Champ Type Description
id int ID du sous-type de média (comme décrit dans le service de sous-type multimédia) auquel cet étage doit être appliqué.
Obligatoire sur :POST/PUT
name chaîne Nom du sous-type de média. Ce champ est en lecture seule.

Exemples

Afficher un étage spécifique

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

Afficher tous les étages associés à un profil de gestion des rendements

Notez que les étages suivants ciblent par facultatif {{profile_id}} plutôt que par le biais du {{members}} tableau. Pour plus d’informations, consultez champs JSON ci-dessus.

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