Partager via


Soumissionnaires - Service membre

Remarque

Les membres sont intégrés au système de Xandr et gérés via le service membre.

Toute entité qui a une relation financière avec la plateforme de Xandr (généralement un acheteur ou un vendeur) doit être ajoutée au système de Xandr en tant que « membre » avant de pouvoir effectuer des transactions. Les membres peuvent être inscrits auprès du service aux membres par un enchérisseur ou par le personnel Xandr.

Membres et contrats

Avant de pouvoir acheter ou vendre des annonces, un membre a besoin d’un contrat avec Xandr. Ce contrat établit des conditions financières et des facilités de crédit (le cas échéant) et lie le membre aux conditions générales de Xandr, telles que la qualité du contenu et l’utilisation des informations d’identification personnelle. Tout soumissionnaire peut créer un membre à tout moment, mais les membres ne pourront pas soumettre d’offres tant que leur contrat n’aura pas été approuvé.

Remarque

  • Si vous recherchez des informations sur d’autres membres de la plateforme, utilisez le service membre de la plateforme.
  • Dans les environnements de bac à sable des soumissionnaires, toutes les fonctionnalités du service membre sont disponibles.
  • Le service membre n’accorde pas l’accès à l’API. Cela s’effectue via le service utilisateur.

API REST

HTTP, méthode Endpoint Description
GET https://api.adnxs.com/member Pour voir tous vos membres.
GET https://api.adnxs.com/member/MEMBER_ID Pour voir un membre particulier.

Remarque

Les appels ci-dessous sont visibles uniquement par les employés Xandr. Elles peuvent être effectuées par des utilisateurs avec l’élément « admin ». user_type

HTTP, méthode Endpoint Description
POST https://api.adnxs.com/member Pour ajouter un nouveau membre.
PUT https://api.adnxs.com/member/MEMBER_ID Pour modifier un membre existant.

Champs JSON

Champ Type Description
active Boolean Indique si le membre peut fournir et/ou enchérir pour l’inventaire.
agent_id chaîne Utilisé pour les membres de l’agrégateur d’inventaire.
allow_ad_profile_override Ce champ n’est pas utilisé actuellement.
audit_notify_email string Chaque fois que Xandr audite un élément créatif appartenant à ce membre, une réponse détaillée est envoyée à cette adresse e-mail. La réponse inclut la status d’audit du créateur et toutes les raisons pour lesquelles le créateur n’a pas réussi l’audit. Ce champ prend en charge plusieurs adresses e-mail séparées par des virgules.
bidder_id int Soumissionnaire qui gère l’appel d’offres pour le membre. Peut être vide pour les membres qui vendent uniquement des stocks.
billing_address_1 string(255) Première ligne de l’adresse du membre.
billing_address_2 string(255) Deuxième ligne de l’adresse du membre.
billing_city string(100) Ville de l’adresse du membre.
billing_country string(50) Pays du membre.
billing_name string(100) Nom de facturation (à qui écrire les vérifications).
Obligatoire Sur :POST.
billing_postal_code string(50) Code postal de l’adresse du membre.
billing_region string Région de l’adresse du membre.
buyer_clearing_fee_pct double Pourcentage du CPM payé pour l’inventaire facturé sous forme de frais.
buyer_credit_limit double Limite de crédit pour ce membre lors de l’achat d’inventaire via Xandr. En lecture seule.
code string(100) Méthode facultative pour ajouter une identification interne.
contact_email Ce champ n’est pas utilisé actuellement.
default_ad_profile_id int Si vous souhaitez définir un profil publicitaire pour tous les TinyTag appartenant à un membre.
default_tag_id int ID du créatif à servir dans le cas où des balises sont appelées à l’aide de codes inconnus.
dongle chaîne Mot de passe qui peut être passé dans une enchère de débogage (en tant que paramètre « dongle ») qui permettra à un membre d’accéder à la sortie de débogage appropriée de son soumissionnaire.
email_code string(50) Email code est une valeur unique utilisée lorsque les TinyTags sont traités via notre outil de traitement des étiquettes d’e-mail. Doit être une valeur alphanumérique.
id int ID du membre.
Obligatoire Sur :PUT.
last_activity Timestamp Horodatage de la dernière modification apportée à ce soumissionnaire instance.
platform_exposure Pour plus d’informations, voir ci-dessous.
price_buckets tableau Lors de l’utilisation de balises de préemption, un membre vendeur peut exiger un compartiment de prix pour la tarification du serveur publicitaire tiers. Selon le type d’intégration requis par un serveur d’adserver tiers, les valeurs peuvent être [{"price_bucket": 10}, {"price_bucket": 20}. . . ]
ou
[{"price_bucket": 10, "width": 300, "height":200", "pixel_url": "https://..."}, . . . ].
prioritize_margin Valeur booléenne S’il "true"est défini sur , Xandr effectue une case activée d’enchère/aucune enchère pour les campagnes gérées en fonction des paramètres de marge minimale d’élément de ligne.

S’il "false"est défini sur , Xandr n’effectue pas de case activée d’enchère/aucune enchère pour les campagnes gérées en fonction de l’élément de ligne minimal.
seller_revshare_pct double En lecture seule pour les utilisateurs et les membres soumissionnaires.
Pourcentage que Xandr retire du chiffre d’affaires vendeur.
serving_domain tableau de chaînes Utilisé lors de la génération d’étiquettes pour la vente de membres. (c’est-à-dire mycompany.adnxs.com à la place ib.adnxs.comde ).
"serving_domain": {"cname": null,"type": null}
En lecture seule.
sherlock_notify_email chaîne Chaque fois que Sherlock, notre système d’analyse de création automatisé, analyse un créatif appartenant à ce membre, une réponse est envoyée à cette adresse e-mail. La réponse inclut la status d’audit du créateur et toutes les raisons pour lesquelles le créateur n’a pas réussi l’audit. Pour plus d’informations, consultez Sherlock.
Ce champ prend en charge plusieurs adresses e-mail séparées par des virgules.
timezone string Le fuseau horaire du membre est le fuseau horaire par défaut pour vos rapports.
Pour connaître les valeurs possibles, consultez Fuseaux horaires de création de rapports.
La valeur par défaut est "EST5EDT".

Exposition de la plateforme

Le paramètre d’exposition de la plateforme détermine la façon dont votre compte est affiché aux autres membres de la plateforme. Il existe trois valeurs qui entraînent des comportements légèrement différents, comme indiqué ci-dessous :

Valeur d’exposition de la plateforme Comportement
hidden Le membre n’est pas affiché.

Note: La définition de platform_exposure sur "hidden" masque votre membre "name" et "domain" vos champs dans notre fichier sellers.json et répertorie votre siège de membre comme "is_confidential": 1. Par exemple, consultez hidden l’exemple.
Cela peut limiter la monétisation de votre inventaire, car certains DSP peuvent ne pas choisir d’acheter des impressions de vendeurs qui ne sont pas transparents dans l’objet "schain" .
private Le membre est affiché en tant que « Membre 123 », où 123 est l’ID de membre.
public Le membre s’affiche à l’aide du nom de facturation.

Note: La définition platform_exposure de sur "public" affiche votre membre "name" et "domain" vos champs dans notre fichier sellers.json . Par exemple, consultez public l’exemple.

hidden Exemple


{
  "seller_id": "8253",
  "is_confidential": 1,
  "seller_type": "PUBLISHER"
}

public Exemple


{
  "seller_id": "7694",
  "seller_type": "INTERMEDIARY",
  "domain": "groupm.com",
  "name": "Xaxis – Slovakia Marketplace"
}

L’exemple JSON ci-dessous montre comment définir ce paramètre.

{
  "member": {
    "platform_exposure": "public"
  }
}

Jeton d’authentification

L’authentification est toujours la première étape lors de l’utilisation des services d’API. Le jeton d’authentification peut ensuite être écrit dans notre fichier de cookie pour une utilisation ultérieure. Pour obtenir des instructions plus détaillées, consultez Service d’authentification.

Exemples

Create un fichier au format JSON décrivant le membre

Les seuls champs obligatoires sont billing_name et bidder_id si le membre est associé à un soumissionnaire, mais étant donné qu’un membre a une relation financière avec Xandr, vous voudrez probablement inclure d’autres informations relatives à la facturation.

$ cat member
{
        "member" : {
                "active" : true,
                "billing_name" : "My Company",
                "bidder_id" : 2,
                "billing_address_1" : "One Coke Way",
                "billing_city" : "Atlanta",
                "billing_region" : "GA",
                "billing_country" : "US",
        "email_code" : "cola"
        }
}

Ajouter le fichier membre au cache du bus d’impression

$ curl -b cookies -c cookies -X POST --data-binary @member 'https://api.adnxs.com/member'
{
        "response":{
                "status":"OK","id":1
        }
}

À présent, modifiez le membre via un fichier au format JSON modifié

$ cat member_mod
{
        "member" : {
                "active" : true,
                "billing_name" : "My Company",
                "bidder_id" : 2,
                "billing_address_1" : "Building 5",
                "billing_address_2" : "Company Complex",
                "billing_city" : "Atlanta",
                "billing_region" : "GA",
                "billing_country" : "US",
                "billing_postal_code" : "33608"
        }
}

Mettre à jour les informations de membre dans le cache du bus d’impression, à l’aide de l’ID de membre

$ curl -b cookies -c cookies-X PUT --data-binary @member_mod 'https://api.adnxs.com/member/1'
{
        "response":{
                "status":"OK"
        }
}

Afficher des informations sur le membre

$ curl -b cookies -c cookies 'https://api.adnxs.com/member/1'
{
   "response":{
      "status":"OK",
      "member": {
        "id": 334,
        "agent_id": null,
        "code": null,
        "active": true,
        "buyer_credit_limit": 0,
        "billing_name" : "My Company",
                "bidder_id" : 2,
                "billing_address_1" : "Building 5",
                "billing_address_2" : "Company Complex",
                "billing_city" : "Atlanta",
                "billing_region" : "GA",
                "billing_country" : "US",
                "billing_postal_code" : "33608"
        "email_code": "cola",
        "seller_revshare_pct": 95,
        "price_buckets": [
        ],
        "default_tag_id": null,
        "default_ad_profile_id": 251,
        "buyer_clearing_fee_pct": null,
        "serving_domain": {
          "cname": null,
          "type": null
        },
        "last_activity": "2010-04-08 03:38:16",
        "timezone": "EST5EDT"
      }
   }
}