Service Broker

Importante

Le service Broker a été remplacé par le service Des frais de partenaire pour les éléments de ligne augmentée (ALI).

Le service Broker ne peut être utilisé qu’avec des éléments de ligne standard ou hérités. Les frais de répartiteur ne s’appliquent pas aux articles de ligne augmentés.

Le service Broker permet aux utilisateurs d’éléments de ligne standard ou hérités de définir des répartiteurs. Les courtiers collectent les frais des réseaux lorsqu’ils servent une impression. Les frais réels sont définis par le biais du service campagne, du service d’article de ligne ou du service de commande d’insertion.

Attention

Si des frais de courtier sont appliqués à une commande d’insertion, les frais ne s’appliquent pas aux éléments de ligne augmentés associés à l’ordre d’insertion. Elle s’applique uniquement aux éléments de ligne standard de l’ordre d’insertion.

API REST

HTTP, méthode	Endpoint	Description
POST	`https://api.appnexus.com/broker` (add-broker JSON)	Ajoutez un répartiteur.
PUT	`https://api.appnexus.com/modify-broker?id=BROKER_ID` (modifier-broker JSON)	Modifier un répartiteur.
GET	`https://api.appnexus.com/broker`	Afficher tous les répartiteurs.
GET	`https://api.appnexus.com/broker?id=BROKER_ID`	Afficher un répartiteur spécifique.

Champs JSON

Paramètre	Type	Description
`broker_fees`	tableau d’objets	Tableau des frais de répartiteur associés au répartiteur. Reportez-vous à la section Frais de broker . Par défaut : `null`
`id`	int	Identificateur unique d’un répartiteur. Par défaut : Numéro incrémenté automatiquement (par exemple, 123) Obligatoire sur : `PUT`
`last_modified`	Timestamp	En lecture seule. Heure de la dernière modification de ce répartiteur au format AAAA-MM-JJ HH :MM :SS.
`member_id`	int	Numéro d’identification unique du membre du répartiteur. Lors de la création d’un répartiteur, le membre de l’utilisateur est affecté.
`name`	string	Nom unique utilisé pour décrire un répartiteur. Obligatoire sur : `POST`
`state`	string	État du répartiteur. Valeurs possibles : `active` ou `inactive`. Valeur par défaut : active

Frais de répartiteur appliqués à d’autres objets

Les frais de répartiteur sont créés par le biais du service Campagne, du service d’élément de ligne ou du service de commande d’insertion. Ils peuvent être consultés ici, mais ne peuvent pas être créés ou modifiés via ce service. Pour plus d’informations sur la façon d’appliquer des frais aux courtiers, reportez-vous à la section Frais de courtier dans chacun des services mentionnés ci-dessus.

Attention

Chaque objet du broker_fees tableau contient les champs suivants :

Champ	Type	Description
`object_type`	string	Indique si ces frais sont associés à une campagne ou à un groupe de campagnes. Valeurs possibles : `campaign` ou `campaign-group`. En lecture seule.
`object_id`	int	Numéro d’identification unique des frais. En lecture seule.
`description`	chaîne	Texte qui fournit des informations sur les frais. En lecture seule.
`fee_type`	string	Valeurs possibles : `commission` ou `serving`: - Commission - Il s’agit des frais de courtier d’articles de ligne ou d’insertion et qui sont déduits du chiffre d’affaires réservé donné de l’annonceur au réseau. La commission est toujours dans la devise de l’ordre d’insertion, de l’élément de ligne ou de la campagne associés. - Service - Il s’agit de frais de courtier de campagne et s’ajoutent au coût d’inventaire que le réseau a payé à l’éditeur. Les frais de service sont en dollars américains. En lecture seule.
`payment_type`	string	Type de paiement : `cpm` ou `revshare`. En lecture seule.
`value`	double	Valeur des frais. En lecture seule.

Exemples

Ajouter un répartiteur

$ cat add-broker.json

{
    "broker":
    {
    "name": "JMS3"
    }
}

$ curl -b cookies -c cookies -X POST -d @add-broker.json 'https://api.appnexus.com/broker'

    "response":{
        "status":"OK",
        "count":1,
        "id":287,
        "start_element":0,
        "num_elements":100,
        "broker":{
            "id":287,
            "name":"JMS3",
            "state":"active",
            "member_id":1066,
            "last_modified":"2013-09-26 17:17:38",
            "broker_fees":null

Modifier un répartiteur

$ cat modify-broker.json

{
    "broker":
    {
    "state": "inactive"
    }
}

$ curl -b cookies -c cookies -X PUT -d @modify-broker.json 'https://api.appnexus.com/broker?id=81'

    "response":{
        "status":"OK",
        "count":1,
        "id":"81",
        "start_element":0,
        "num_elements":100,
        "broker":{
            "id":81,
            "name":"Test",
            "state":"inactive",
            "member_id":1066,
            "last_modified":"2013-09-26 17:21:42",
            "broker_fees":null
        },
}

Afficher tous les répartiteurs

$ curl -b cookies -c cookies 'https://api.appnexus.com/broker'

{
    "response":{
        "status":"OK",
        "count":6,
        "start_element":0,
        "num_elements":100,
        "brokers":[
            {
                "id":81,
                "name":"Test",
                "state":"inactive",
                "member_id":1066,
                "last_modified":"2013-09-26 17:21:42",
                "broker_fees":null
            },
            {
                "id":145,
                "name":"Test 2",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-03-15 20:41:47",
                "broker_fees":null
            },
            {
                "id":152,
                "name":"Test 3",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-03-20 15:30:21",
                "broker_fees":null
            },
            {
                "id":217,
                "name":"Third party",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-05-21 03:58:36",
                "broker_fees":null
            },
            {
                "id":218,
                "name":"Third party",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-05-21 04:12:58",
                "broker_fees":null
            },
            {
                "id":287,
                "name":"JMS3",
                "state":"active",
                "member_id":1066,
                "last_modified":"2013-09-26 17:17:38",
                "broker_fees":null
            }
        ],
}

Afficher un répartiteur spécifique

$ curl -b cookies -c cookies 'https://api.appnexus.com/broker?id=81'

{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,        "num_elements":100,
        "broker":{
            "id":81,
            "name":"Test",
            "state":"inactive",
            "member_id":1066,
            "last_modified":"2013-09-26 17:21:42",
            "broker_fees":null
        },
}

Last updated on 2025-10-22

Partager via