Service de contrat de membre

Remarque

Ce service est actuellement disponible pour un ensemble limité de clients et d’employés Microsoft uniquement.

Il existe deux types de termes tarifaires indiqués par le pricing_version champ .

"2007.09.01": il s’agit des termes tarifaires « hérités ».
"2013.01.02": il s’agit des conditions tarifaires les plus récentes. La plupart des contrats clients négociés après 2013 utiliseront ces nouvelles conditions tarifaires. Le résultat des nouvelles conditions tarifaires est que les clients paient des frais d’achat pour l’inventaire des partenaires et de la plateforme, et que les clients paient un partage de réaide vendeur différent pour les acheteurs sur la plateforme Xandr que pour les acheteurs soumissionnaires.

Remarque

Ce service est disponible uniquement pour les utilisateurs administrateurs Xandr dont le is_sales_ops champ est défini sur true. Notez que le is_sales_ops champ peut être défini sur true uniquement via une mise à jour directe de la base de données. Les raisons valables pour définir votre is_sales_ops champ en production sont les suivantes :

Vous êtes membre de l’équipe Sales Ops et il vous incombe de créer et de mettre à jour des contrats.
Vous êtes ingénieur, chef de produit ou ingénieur test qui a besoin d’un accès pour créer ou mettre à jour des contrats pour votre travail.
Tu veux voir Katharine, Jennifer Yang et Alison pleurer. (Oui, vraiment.)
Si vous êtes dans Services et que vous devez créer ou mettre à jour des contrats dans sand, vous devez demander une écriture de base de données directe pour votre utilisateur sand, mais comprenez que vous n’aurez pas les mêmes fonctionnalités en production.

Avertissement

Lors d’un PUT appel, si vous incluez uniquement des contrats spécifiques, les contrats non inclus sont supprimés. Par conséquent, il est préférable d’inclure tous les contrats sur PUT.

Remarque

Mise à jour et suppression de contrats

L’opération de vente peut uniquement mettre à jour les champs suivants pour les contrats en cours : notes et end_date. Pour les contrats passés, elle peut uniquement mettre à jour le notes. Pour les contrats futurs, elle peut mettre à jour tous les champs.
Notez que si vous clonez un contrat dont pricing_type la valeur est "2007.09.01", mettez à "2013.01.02"jour pricing_type vers , puis mettez-le à jour une fois de plus vers "2007.09.01", toutes les valeurs minimales sont définies sur zéro.
L’opération sales ne peut supprimer que les contrats qui sont à l’avenir.

API REST

Méthodes HTTP	Points de terminaison	Descriptions
`GET`	`https://api.appnexus.com/member-contract?member_id=MEMBER_ID`	Afficher tous les contrats d’un membre spécifique
`GET`	`https://api.appnexus.com/member-contract` (contrat JSON)	Afficher un contrat spécifique
`POST`	`https://api.appnexus.com/member-contract` (contrat JSON)	Ajouter un nouveau contrat
`PUT`	`https://api.appnexus.com/member-contract?id=CONTRACT_ID` (contrat JSON)	Modifier un contrat
`DELETE`	`https://api.appnexus.com/member-contract?id=CONTRACT_ID`	Supprimer un contrat
`GET`	`https://api.appnexus.com/member-contract/meta`	Découvrez les champs que vous pouvez filtrer et trier par

Champs JSON

Il existe une intersection importante entre les ensembles de champs obligatoires selon que le pricing_version est "2007.09.01" (marqué ci-dessous comme OLD) ou (marqué ci-dessous comme NEW) ; "2013.01.02" seuls les champs qui diffèrent entre les versions tarifaires sont marqués comme tels dans la colonne Ancien ou Nouveau ? .

Champ	Type	Description
`id`	int	ID du contrat. Requird On : `PUT`/`DELETE`, dans la chaîne de requête.
`member_id`	int	ID du membre auquel le contrat s’applique.
`last_activity`	Timestamp	Date de la dernière modification de ce contrat « object ».
`start_date`	DateHeure	Date et heure de début des termes du contrat. Les nouveaux contrats doivent commencer à l’avenir, et généralement le premier jour d’un mois. Requird On : `POST`
`end_date`	DateHeure	Date et heure de fin des termes du contrat. Cela devrait toujours arriver à la fin d’un mois. Requird On : `POST`
`auction_revshare`	float	Ce champ n’est pas utilisé.
`auction_minimum_cpm`	float	Ce champ n’est pas utilisé. Auparavant, il s’agissait du montant minimal que l’acheteur accepte de payer pour les frais de service aux enchères, la déduction pour le service de vente aux enchères ou les frais directs en clair. Ancien ou nouveau : `OLD`
`ad_serving_cpm`	float	Frais de diffusion de publicités gérées facturés sur les impressions conservées (à inclure : conservé, par défaut, PSA). Il ne s’agit pas d’un vendeur de frais de service publicitaire CPM, qui n’est pas encore implémenté dans le système.
`auditing_fee_per_creative`	float	Frais d’audit par création.
`creative_size_minimum_bytes`	int	Taille au-dessus de laquelle un créatif est considéré comme surdimensionné. Le membre reçoit des frais de dépassement de créativité (en fonction de la valeur en `creative_size_fee_per_gb`) pour servir une création surdimensionnée.
`creative_size_fee_per_gb`	float	Frais facturés par gigaoctet pour un créatif qui dépasse le `creative_size_minimum_bytes`.
`monthly_minimum_spend`	float	Ce champ est mal étiqueté. Frais mensuels minimum que le membre s’engage à payer par mois. Ancien ou nouveau : `OLD`
`clearing_revshare`	float	La redevance forfaitaire prélevée sur les revenus de compensation par Xandr. Les membres peuvent choisir d’être facturés sous forme de pourcentage à la place (voir `clearing_revshare_pct` ci-dessous).
`auction_revshare_pct`	float	Pourcentage facturé aux vendeurs lorsqu’ils vendent leur inventaire à d’autres membres. Avertissement : ce champ correspond au nouveau `auction_revshare_platform_pct` champ et est utilisé par le pipeline de données pour les calculs impliquant les revenus de l’ACP/DUC. VEUILLEZ NE PAS SUPPRIMER CE CHAMP, SAUF SI VOUS SAVEZ CE QUE VOUS FAITES. Ancien ou nouveau : `OLD` Par défaut : `"0.00"`
`clearing_revshare_pct`	float	Pourcentage de déduction de compensation. Cette valeur est facturée lorsque le membre achète auprès d’un vendeur externe ou partenaire.
`auction_maximum_cpm`	float	Montant maximal que l’acheteur accepte de payer par impression. Pour cette raison, la somme des frais de service d’enchères et des déductions du client peut ne pas être égale au coût total des médias multiplié par leur repartage de la vente aux enchères à la fin du mois.
`apply_min_cpm_to_clearing`	valeur booléenne	Ce champ n’est pas utilisé. Par défaut : `False`
`auction_revshare_type`	enum	Type de part des recettes de vente aux enchères de l’acheteur. Valeurs autorisées : - `"deduction"`: l’acheteur est facturé une déduction pour le service de vente aux enchères. - `"fee"`: l’acheteur est facturé des frais de service aux enchères. Avertissement : ce champ correspond au nouveau `auction_revshare_platform_inv_type` champ et est utilisé par le pipeline de données pour les calculs impliquant les revenus de l’ACP/DUC. VEUILLEZ NE PAS SUPPRIMER CE CHAMP, SAUF SI VOUS SAVEZ CE QUE VOUS FAITES. Par défaut : - `"fee"` Ancien ou nouveau : `OLD`
`pricing_version`	enum	Version tarifaire associée à ce contrat. Avec les conditions tarifaires de 2013, les clients paient des frais côté achat pour l’inventaire des partenaires et de la plateforme, et les clients paient une repartage vendeur différente pour les acheteurs de la plateforme Xandr que pour les acheteurs soumissionnaires. Notez également qu’il est acceptable d’utiliser les conditions tarifaires de 2007 si cela est dicté par le contrat. Valeurs autorisées : - `"2007.09.01"` - `"2013.01.02"` Obligatoire sur : `POST`
`seller_type`	enum	Type de vendeur. Valeurs autorisées : - `"platform"`: Le membre dispose d’un contrat signé qui permet à Xandr de bénéficier d’une déduction du vendeur sur les impressions revendues. - `"partner"`: Le membre n’a pas de contrat signé permettant à Xandr de prendre une déduction vendeur sur les impressions revendues, de sorte que les membres acheteurs se voient facturer des frais de service aux enchères/déduction à la place. Par défaut : `"platform"` Obligatoire sur : `POST`
`note`	string	Remarque facultative.
`data_siphon_fee`	int	Frais mensuels pour la réception de flux de données au niveau du journal Xandr.
`mapuid_fee`	float	Frais mensuels liés à l’utilisation du service de mappage d’ID utilisateur Xandr. Par défaut : `"0.00"`
`monthly_minimum_imps`	int	Nombre minimal d’impressions que le membre s’engage à effectuer par mois.
`waive_ad_serving_fees`	valeur booléenne	Ce champ n’est pas utilisé. Ancien ou nouveau : `OLD`
`adx_auction_service_fee_pct`	float	Ce champ n’est pas utilisé. Auparavant, il s’agissait des frais de service d’enchères facturés lorsque les clients acheteurs achetaient des stocks auprès de Google Ad Manager. Google Ad Manager est un cas spécial, car ils sont un membre Xandr (avec un `bidder_id` de `2`) mais les clients acheteurs paient Google Ad Manager directement et ne paient pas Xandr pour le coût multimédia.
`direct_clear_fee_pct`	float	Pourcentage de frais clairs directs. Cela est utilisé pour l’activité où le membre efface le coût du média directement avec le vendeur.
`contract_type`	enum	Ce champ n’est plus utilisé. Dans le passé, il était utilisé par l’équipe financière pour la création de rapports sur les revenus. Les valeurs autorisées étaient les suivantes : - `"NIB"`: cet acronyme fait référence à une ancienne offre de produit appelée « Réseau dans une boîte ». - `"XIB"`: cet acronyme fait référence à une ancienne offre de produit appelée « Exchange in a box ». - `"RTBX"`: cet acronyme fait référence à une ancienne offre de produit appelée « RTB Exchange ». - `"MSFT"`: contrat Microsoft. - `"External"`: ... - `"Partner"`: ...
`creative_audit_fee`	float	Ce champ n’est pas utilisé. Utilisez `auditing_fee_per_creative` à la place. Auparavant, il représentait le total des frais d’audit créatif.
`creative_priority_fee_1`	float	Ce champ n’est pas utilisé. Il s’agit d’un espace réservé pour le développement futur.
`creative_priority_fee_2`	float	Frais d’audit prioritaires par création.
`imptracker_cpm`	float	Les frais facturés pour l’enregistrement des impressions tierces.
`clicktracker_cpc`	float	Les frais facturés pour l’enregistrement des clics tiers.
`auto_renewal_term`	int	Période de renouvellement automatique pour le membre, si une telle durée existe dans le contrat signé. Actuellement, il ne s’agit que d’un espace réservé pour le terme ; aucune logique de facturation n’est associée à ce champ.
`seller_serving_cpm`	float	Les frais basés sur CPM facturés pour chaque impression revendue. Actuellement, il ne s’agit que d’un espace réservé pour les frais ; aucune logique de facturation n’est associée à ce champ.
`monthly_spend_based_minimum`	float	Minimum mensuel basé sur les dépenses totales de l’acheteur (c’est-à-dire le coût des médias) achetés au cours d’un mois donné. Actuellement, il ne s’agit que d’un espace réservé ; aucune logique de facturation n’est associée à ce champ. Nouveau ou Ancien : `OLD`
`seller_revshare_pct`	float	Pourcentage de déduction du vendeur. Cette valeur est facturée lorsque le membre vend une impression à un autre membre.
`seller_revshare_minimum`	valeur booléenne	Le minimum de partage de réversion du vendeur est calculé en prenant le plus grand de (imps vu * demande d’enchère du vendeur cpm) ou (vendeur revshare). Par défaut : `false` Nouveau ou Ancien : `OLD`
`secure_whitelabel_pixel_fee`	float	Frais mensuels liés à l’utilisation du service Secure White Label Pixel. Actuellement, il ne s’agit que d’un espace réservé pour les frais ; aucune logique de facturation n’est associée à ce champ.
`monthly_minimum_requests`	int	Nombre minimal de demandes par mois en fonction du nombre total d’impressions enregistrées par Xandr. Actuellement, il ne s’agit que d’un espace réservé pour le minimum ; aucune logique de facturation n’est associée à ce champ. Nouveau ou Ancien : `OLD`
`managed_hosted_video_cpm`	float	Il s’agit d’un espace réservé pour le développement futur.
`cross_net_hosted_video_cpm`	float	Il s’agit d’un espace réservé pour le développement futur.
`seller_auction_request_cpm`	float	Montant qu’un vendeur doit payer chaque fois qu’il nous envoie une demande d’offre. Ce montant est facturé même s’il n’y a pas d’offre gagnante, ou d’enchères du tout.
`status`	enum	En lecture seule. Valeurs autorisées : - `"in_progress"`: le contrat est actuellement en vigueur. - `"in_past"`: le contrat est terminé. - `"in_future"`: le contrat est défini pour commencer à l’avenir. Par défaut : `"in_future"`
`member_name`	string	Le nom du membre.
`member_is_billable`	valeur booléenne	Si le membre est facturable. Par défaut : `true`
`member_note`	string	Il est utilisé par finance and sales ops pour enregistrer des conditions de contrat personnalisées ou d’autres exigences de facture. Par défaut : `""`
`member_enable_budget_check`	valeur booléenne	Si ce membre a mis en place des contrôles de sécurité pour éviter les dépassements involontaires. Par défaut : `true`
`monthly_service_fee_minimum_1`	float	Dépense mensuelle minimale dans laquelle le client s’est engagé. Ces frais incluent l’impression et le suivi des clics. Ancien ou nouveau : `OLD`
`monthly_service_fee_minimum_2`	float	Dépense mensuelle minimale dans laquelle le client s’est engagé. Ces frais n’incluent pas l’impression et le suivi des clics. Ancien ou nouveau : `OLD`
`selling_enabled`	valeur booléenne	Indique si ce membre est autorisé à vendre son inventaire. Cela s’applique à la fois à la vente managée et à la vente entre réseaux. Par défaut : `true`
`seller_console_buyer_revshare_pct`	float	Ce pourcentage est facturé aux vendeurs lorsqu’ils vendent à des acheteurs sur la plateforme Xandr.<Br Remarque : La valeur de ce champ est copiée à partir du champ `seller_revshare_pct`hérité . Obligatoire Sur : `PUT`, lors de la mise à jour vers la nouvelle pricing_version. Ancien ou nouveau : `New`
`seller_bidder_buyer_revshare_pct`	float	Ce pourcentage est facturé aux vendeurs lorsqu’ils vendent à des soumissionnaires non-Xandr. Obligatoire Sur : `PUT`, lors de la mise à jour vers le nouveau `pricing_version`. Ancien ou nouveau : `New`
`auction_revshare_partner_inv_pct`	float	Pourcentage facturé aux acheteurs de type `"partner"` lorsqu’ils achètent des stocks auprès d’autres membres. Par défaut : `"0.00"` Ancien ou nouveau : `New`
`auction_revshare_partner_inv_type`	chaîne	La façon dont le pourcentage défini dans `"auction_revshare_partner_inv_pct"` est utilisé pour facturer les acheteurs partenaires. Valeurs autorisées : - `"deduction"`: Le pourcentage convenu est directement soustrait du chiffre d’affaires de la vente aux enchères de l’acheteur. - `"fee"`: Le pourcentage est facturé sous forme de frais après la vente aux enchères. Remarque : Vous ne pouvez pas définir un `auction_revshare_partner_inv_type` qui est différent de `auction_revshare_platform_inv_type`. Ils doivent tous deux être `"fee"` ou `"deduction"`. Par défaut : `"fee"` Ancien ou nouveau : `New`
`auction_revshare_platform_inv_pct`	float	Pourcentage facturé aux acheteurs de type `"platform"` lorsqu’ils achètent des stocks auprès d’autres membres. Remarque : la valeur de ce champ est copiée à partir du champ `auction_revshare_pct`. Par défaut : `"0.00"` Ancien ou nouveau : `New`
`auction_revshare_platform_inv_type`	string	La façon dont le pourcentage défini dans `"auction_revshare_platform_inv_pct"` est utilisé pour facturer les acheteurs de plateforme. Valeurs autorisées : - `"deduction"`: Le pourcentage convenu est directement soustrait du chiffre d’affaires de la vente aux enchères de l’acheteur. - `"fee"`: Le pourcentage est facturé sous forme de frais après la vente aux enchères. Remarque : - La valeur de ce champ est copiée à partir du champ `auction_revshare_type`. - Vous ne pouvez pas définir un `auction_revshare_platform_inv_type` qui est différent de `auction_revshare_partner_inv_type`. Ils doivent tous deux être `"fee"` ou `"deduction"`. Par défaut : `"fee"` Ancien ou nouveau : `New`

Exemples

Create et afficher un contrat hérité

$ cat update.json
{
  "member-contract": {
    "start_date": "2013-01-01 00:00:00",
    "end_date": "2013-06-30 23:59:59",
    "seller_type": "platform",
    "pricing_version": "2007.09.01",
  }
}

$ curl -b cookies -X POST -d @/tmp/legacy.json "http://68.67.148.153:16011/member-contract?member_id=1309"

{
    "response": {
        
        "": "",
        "num_elements": "",
        "start_element": "",
        "id": 3794,
        "count": "",
        "status": "OK"
    }
}

$ curl -b cookies "http://68.67.148.153:16011/member-contract?id=3794"
{
    "response": {
        
        "member-contract": {
            "member_note": "",
            "member_enable_budget_check": true,
            "member_is_billable": true,
            "member_name": "i8N6LZ6uN",
            "auction_revshare_platform_inv_type": "fee",
            "auction_revshare_platform_inv_pct": 0,
            "auction_revshare_partner_inv_type": "fee",
            "auction_revshare_partner_inv_pct": 0,
            "seller_bidder_buyer_revshare_pct": "",
            "seller_console_buyer_revshare_pct": "",
            "selling_enabled": true,
            "monthly_service_fee_minimum_2": "",
            "monthly_service_fee_minimum_1": "",
            "status": "in_future",
            "seller_auction_request_cpm": "",
            "cross_net_hosted_video_cpm": "",
            "managed_hosted_video_cpm": "",
            "monthly_minimum_requests": "",
            "secure_whitelabel_pixel_fee": 0,
            "seller_revshare_minimum": false,
            "seller_revshare_pct": "",
            "monthly_spend_based_minimum": "",
            "seller_serving_cpm": 0,
            "auto_renewal_term": "",
            "clicktracker_cpc": "",
            "imptracker_cpm": "",
            "creative_priority_fee_2": 25,
            "creative_priority_fee_1": 0,
            "creative_audit_fee": 0,
            "contract_type": "",
            "direct_clear_fee_pct": "",
            "adx_auction_service_fee_pct": "",
            "waive_ad_serving_fees": false,
            "monthly_minimum_imps": "",
            "mapuid_fee": 0,
            "data_siphon_fee": "",
            "note": "",
            "seller_type": "platform",
            "pricing_version": "2007.09.01",
            "auction_revshare_type": "fee",
            "apply_min_cpm_to_clearing": false,
            "auction_maximum_cpm": "",
            "clearing_revshare_pct": "",
            "auction_revshare_pct": "",
            "clearing_revshare": "",
            "monthly_minimum_spend": "",
            "creative_size_fee_per_gb": "",
            "creative_size_minimum_bytes": "",
            "auditing_fee_per_creative": "",
            "ad_serving_cpm": "",
            "auction_minimum_cpm": "",
            "auction_revshare": "",
            "end_date": "2013-06-30 23:59:59",
            "start_date": "2013-01-01 00:00:00",
            "last_activity": "2012-12-20 16:03:38",
            "member_id": 1309,
            "id": 3794
        },
        "num_elements": "",
        "start_element": "",
        "count": 1,
        "status": "OK"
    }
}

Create et afficher un contrat avec le actuel`pricing_version`

$ cat update.json
{
  "member-contract": {
    "start_date": "2013-01-01 00:00:00",
    "end_date": "2013-06-30 23:59:59",
    "seller_type": "platform",
    "pricing_version": "2013.01.02",
    "auction_revshare_partner_inv_type": "fee",
    "auction_revshare_platform_inv_type": "fee"
  }
}

$ curl -b cookies -c cookies -X POST -d @update.json "https://api.appnexus.com/member-contract?member_id=1309"

{"response":{"status":"OK","count":null,"id":7543,"start_element":null,"num_elements":null,"":null,}}

$ curl -b cookies "http://68.67.148.153:16011/member-contract?member_id=4"
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": null,
    "num_elements": null,
    "member-contracts": [
      {
        "id": 7543,
        "member_id": 4,
        "last_activity": "2012-12-07 18:30:12",
        "start_date": "2013-01-01 00:00:00",
        "end_date": "2013-06-30 23:59:59",
        "auction_revshare": null,
        "ad_serving_cpm": null,
        "auditing_fee_per_creative": null,
        "creative_size_minimum_bytes": null,
        "creative_size_fee_per_gb": null,
        "clearing_revshare": null,
        "clearing_revshare_pct": null,
        "auction_maximum_cpm": null,
        "apply_min_cpm_to_clearing": false,
        "pricing_version": "2013.01.02",
        "seller_type": "platform",
        "note": null,
        "data_siphon_fee": null,
        "mapuid_fee": "0.00",
        "waive_ad_serving_fees": false,
        "adx_auction_service_fee_pct": null,
        "direct_clear_fee_pct": null,
        "contract_type": null,
        "creative_audit_fee": "0.00",
        "creative_priority_fee_1": "0.00",
        "creative_priority_fee_2": "25.00",
        "imptracker_cpm": null,
        "clicktracker_cpc": null,
        "auto_renewal_term": null,
        "seller_serving_cpm": "0.0000",
        "secure_whitelabel_pixel_fee": "0.00",
        "managed_hosted_video_cpm": null,
        "cross_net_hosted_video_cpm": null,
        "seller_auction_request_cpm": null,
        "status": "in_future",
        "selling_enabled": true,
        "seller_console_buyer_revshare_pct": null,
        "seller_bidder_buyer_revshare_pct": null,
        "auction_revshare_partner_inv_pct": "0.00",
        "auction_revshare_partner_inv_type": "fee",
        "auction_revshare_platform_inv_pct": "0.00",
        "auction_revshare_platform_inv_type": "fee",
        "member_name": "6Ax3NT0ST",
        "member_is_billable": true,
        "member_enable_budget_check": true
      }
    ]
  }
  }

Last updated on 2025-10-22

Partager via

Service de contrat de membre

API REST

Champs JSON

Exemples

Create et afficher un contrat hérité

Create et afficher un contrat avec le actuelpricing_version

Ressources supplémentaires

Create et afficher un contrat avec le actuel`pricing_version`