Partager via


Service Des frais de partenaire

Remarque

Les frais de partenaire sont une amélioration et un remplacement des frais de courtier pour les éléments de ligne augmentée (ALI) .

Si vous avez besoin de réserver une partie de votre budget pour les coûts tiers (coûts dus à des tiers autres que l’éditeur), vous pouvez définir ces informations avec le service Frais partenaires. Les frais peuvent être suivis sur une base de CPM, de partage des coûts ou de partage des revenus, et peuvent être appliqués à plusieurs annonceurs et articles de ligne, si vous le souhaitez. Un seul annonceur ou élément de ligne peut avoir plusieurs frais appliqués.

Les frais courants que vous devrez peut-être budgétrez sont les suivants :

  • Les frais de diffusion d’annonces publicitaires et les frais d’hébergement créatif, qui sont facturés pour la livraison des ressources créatives d’un article de ligne.
  • Frais de données qui ne sont pas effacés par Xandr dans le cadre de la Place de marché des données.
  • Frais de rapport post-enchère : par exemple, l’utilisation d’un pixel pour suivre l’endroit où les impressions sont servies, puis l’audit rétroactif du nombre de transactions qui ont enfreint les normes de sécurité de la marque.
  • Accords de partage de revenus avec d’autres partenaires techniques publicitaires.
  • Frais incrémentiels facturés par un intermédiaire à l’annonceur, comme des frais de service géré ou des frais de conseil.

API REST

HTTP, méthode Endpoint Description
GET https://api.appnexus.com/partner-fee?advertiser_id=ADVERTISER_ID Afficher tous les frais de partenaire pour un annonceur.
GET https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID Afficher les frais d’un partenaire spécifique.
POST https://api.appnexus.com/partner-fee Create de nouveaux frais de partenaire.
PUT https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID Modifier les frais d’un partenaire.
DELETE https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID Supprimer des frais de partenaire.

Remarque :
Vous pouvez uniquement supprimer des frais qui ne s’appliquent à aucun élément de ligne.

Champs JSON

Champ Type Description
advertisers Cartographie Les annonceurs auxquels ces frais sont éligibles. Ce champ doit être transmis en tant que tableau d’objet au format suivant :
[{'id':ADVERTISER_ID_1},{'id'}:ADVERTISER_ID_2}]
apply_to_deals bool Détermine si ces frais s’appliquent aux transactions.

Obligatoire sur : POST
Par défaut : true
apply_to_managed bool Détermine si ces frais s’appliquent à l’inventaire managé.

Obligatoire sur : POST
Par défaut : true
apply_to_rtb bool Détermine si ces frais s’appliquent à l’inventaire RTB.

Obligatoire sur : POST
Par défaut : true
available_for_all_advertisers bool Lorsque truela valeur est , ces frais peuvent être appliqués à tous les annonceurs pour ce membre. Cette option est disponible uniquement pour les utilisateurs disposant d’un accès de niveau membre.

Par défaut : false
description text Optional. Description fournie par l’utilisateur des frais.
currency char(3) Devise dans laquelle les frais sont calculés.
- Si partner_fee_payment_type_id est cpm, une valeur est requise.
- Si partner_fee_payment_type_id a la valeur revshare, ce champ doit être null.
Utilisez le service monétaire pour afficher la liste des devises disponibles.
id int Identificateur unique pour les frais.

Obligatoire sur : PUT et DELETE
Valeur par défaut : nombre généré automatiquement.
name varchar(255) Nom des frais.

Obligatoire sur : POST
partner_fee_payment_type_id int Détermine le type de paiement pour ces frais :
- "1" pour cpm. Si cpm est sélectionné, vous devez spécifier la devise avec devise.
- "2" pour le partage des revenus.

Obligatoire sur : POST
partner_fee_basis_id int Détermine la base à partir de laquelle un pourcentage de frais est dérivé.
- "1" pour le coût multimédia net.
- "2" pour le coût média brut (coût multimédia, y compris BASC.
- "3" pour le coût multimédia net (coût multimédia sans BASC) + coûts des données.
- "4" pour le coût média brut (coût multimédia, y compris BASC) + coûts de données.
- "5" pour les recettes.
Les frais CPM ne peuvent être définis que sur "5" (chiffre d’affaires).

Obligatoire sur : POST
partner_fee_type_id int Définit le type de frais. Les valeurs prises en charge sont :
- "1" pour le service d’annonces
- "2" pour l’algorithme
- "3" pour les données
- "4" pour la création de rapports
- "5" pour le service
- "6" pour la technologie
- "7" pour la visibilité
- "8" pour les autres

Obligatoire sur : POST
partner_fee_vendor_id int ID du fournisseur qui facture les frais. Les valeurs prises en charge sont :
- "1" pour Adloox
- "2" pour ComScore
- "3" pour DoubleClick
- "4" pour DoubleVerify
- "5" pour Evidon
- "6" pour flashtalking
- "7" pour Ghostery
- "8" pour GroovinAds
- "9" for Integral Ad Science (IAS)
- "10" pour MOAT
- "11" pour neuvième décimale
- "12" pour Sizmek
- "13" pour TrustArc
- "14" pour le fournisseur personnalisé 1
- "15" pour le fournisseur personnalisé 2
- "16" pour le fournisseur personnalisé 3
- "17" pour le fournisseur personnalisé 4
- "18" pour le fournisseur personnalisé 5
Les fournisseurs personnalisés apparaissent sous les noms Fournisseur personnalisé 1, Fournisseur personnalisé 2, etc. dans les rapports. Nous vous recommandons d’inclure le nom du partenaire dans le champ nom des frais pour faciliter l’identification.

Obligatoire sur : POST
required bool Lorsque truela valeur est , ces frais seront exigés et appliqués à tous les nouveaux éléments de ligne pour les annonceurs éligibles. Il ne sera pas appliqué automatiquement rétroactivement aux éléments de ligne existants.

Remarque : Vous ne pouvez pas supprimer de frais d’un élément de ligne si required a la valeur true. Vous devez d’abord définir requiredfalse sur , puis supprimer les frais de l’élément de ligne.

Par défaut : false
value decimal(15,5) Frais facturés.
- Si le type de paiement est cpm, cette valeur se trouve dans le défini currency.
- Si le type de paiement est le partage des revenus, la valeur doit être une fraction entre 0 et 1. Par exemple, des frais de repartage de 10 % sont spécifiés par 0,1.

Obligatoire sur : POST

Exemples

Create des frais de partenaire

$ cat partner-fee.json

{
    "partner_fee": {
        "name" : "Test1",
        "apply_to_managed" : true,
        "apply_to_rtb" : true,
        "apply_to_deals" : true,
        "value" : .5,
        "partner_fee_vendor_id" : 3,
        "partner_fee_payment_type_id" : 2,
        "partner_fee_basis_id" : 2,
        "partner_fee_type_id" : 1,
        "required" : true,
        "advertisers" : [
            {
                "id" : 1
            }
        ]
    }
}

$curl -b cookie -X POST -d @partner-fee.json "https://api.appnexus.com/partner-fee"

{
    "response": {
        "status" : "OK",
        "id": 4401
    }
}

Afficher les détails des frais d’un partenaire

$ curl -b cookie "https://api.appnexus.com/partner-fee?id=4401"

{
    "response": {
        "status": "OK",
        "partner_fees": [
            {
                "name" : "Test1",
                "apply_to_managed" : true,
                "apply_to_rtb" : true,
                "apply_to_deals" : true,
                "currency" : null,
                "value" : .5,
                "partner_fee_vendor_id" : 3,
                "partner_fee_payment_type_id" : 2,
                "partner_fee_basis_id" : 2,
                "partner_fee_type_id" : 1,
                "required" : true,
                "advertisers" : [
                    {
                      "id" : 1
                    }
                ]
            }        
        ]
    }
}

Afficher les frais des partenaires de partage des revenus pour l’inventaire managé

$ curl -b cookie "https://api.appnexus.com/partner-fee?apply_to_managed=true&partner_fee_payment_type_id=2"

{
    "response": {
        "count": "2",
        "partner_fees": [
            {
                "id" : 4401,
                "name" : "Test1",
                "apply_to_managed" : true,
                "apply_to_rtb" : true,
                "apply_to_deals" : true,
                "value" : .1,
                "partner_fee_vendor_id" : 3,
                "partner_fee_payment_type_id" : 2,
                "partner_fee_basis_id" : 2,
                "partner_fee_type_id" : 1,
                "required" : true,
                "available_for_all_advertisers": true,
                "advertisers" : [
                ]
            },
            {
                "id" : 4402,
                "name" : "Test2",
                "apply_to_managed" : true,
                "apply_to_rtb" : false,
                "apply_to_deals" : false,
                "currency" : "null",
                "value" : .5,
                "partner_fee_vendor_id" : 14,
                "partner_fee_payment_type_id" : 2,
                "partner_fee_basis_id" : 2,
                "partner_fee_type_id" : 6,
                "required" : false,
                "available_for_all_advertiser" : true,
                "advertisers" : [
                ]
            } 
        ]
    }
}

Modifier le type de paiement des frais d’un partenaire

$ cat partner-fee.json

{
    "partner_fee": {
        "currency" : USD,
        "value" : 1.2,
        "partner_fee_payment_type_id" : 1,
        "partner_fee_basis_id": 5 
    }
}

$ curl -b cookie -X PUT -d @partner-fee.json "https://api.appnexus.com/partner-fee?id=4401"

{
    "response": {
        "status" : "OK",
        "id": 4401
    }
}

Appliquer des frais de partenaire à un élément de ligne

$ cat LI-update.json

{       
    "line-item": {
        "partner_fees": [
            {
                "id": 4401
            },
            { 
                "id": 4402
            }
        ]
    }
}

$ curl -b cookie -X PUT -d @LI-update.json "https://api.appnexus.com/line-item?id=2345432"

{
    "response": {
        "status" : "OK",
        "id": 2345432
    }
}

Supprimer des frais d’un élément de ligne

$ curl -b cookie -x GET "https://api.appnexus.com/line-item?id=1234"

 {
    "line-item": {
        ...,
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 2
            }, 
            {
                "id": 3
            }
        ],
        ...
    }
}


$ cat LI-update.json

{
    "line-item": {
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 3
            } 
        ]
    }
}

$ curl -b cookie -X PUT "https://api.appnexus.com/line-item?id=1234"

{
    "line-item": {
        ...,
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 3
            }
        ],
        ...
    }
}

$ curl -b cookie -x GET "https://api.appnexus.com/line-item?id=1234"

 {
    "line-item": {
        ...,
        "partner_fees": [
            {
                "id": 1
            }, 
            {
                "id": 3
            }
        ],
        ...
    }
}

Remarque

Vous ne pouvez pas supprimer de frais d’un élément de ligne si required a la valeur true. Vous devez d’abord définir requiredfalse sur , puis supprimer les frais de l’élément de ligne.

Supprimer les frais d’un annonceur

$ curl -b cookie -x GET "https://api.appnexus.com/advertiser?id=5678"

 {
    "advertiser": {
        ...,
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 2
            }, 
            {
                "id": 3
            }
        ],
        ...
    }
}



$ cat partner-fee-update.json

{
    "partner-fee": {
        "advertisers": [
            {
                "id": 5677
            },
            {
                "id": 5679
            }
        ]
    }
}

$ curl -b cookie -X PUT -d @partner-fee-update.json "https://api.appnexus.com/partner-fee?id=1"

{
    "response": {
        "status" : "OK",
        "id": 1
    }
}

Vous ne pouvez pas supprimer des frais d’un annonceur si les frais sont actuellement appliqués à l’un des articles de ligne de cet annonceur. Vous devez d’abord supprimer les frais des articles de ligne, puis supprimer les frais de l’annonceur.