Partager via

Service de soumissionnaire

Le Service des soumissionnaires relie un soumissionnaire au bus d’impression de Xandr et permet au soumissionnaire et au bus d’impression de commencer à communiquer. Votre représentant Xandr créera le soumissionnaire dans le système, et vous utiliserez le service soumissionnaire pour apporter des modifications ou récupérer votre ID de soumissionnaire.

Vous aurez peut-être besoin de votre ID de soumissionnaire pour certains services. Pour connaître votre ID de soumissionnaire, exécutez la commande « Voir tous les soumissionnaires » décrite ci-dessous.

Certaines fonctions de soumissionnaire ne sont accessibles qu’à certains utilisateurs, car elles sont basées sur des obligations contractuelles :

Modification des champs du fournisseur de données (via PUT) : nécessite un contrat d’accès aux données avec chaque fournisseur

Dans les environnements de bac à sable de soumissionnaire, toutes les fonctionnalités sont disponibles à des fins d’intégration.

API REST

HTTP, méthode Endpoint Description
GET https://api.adnxs.com/bidder/ Affichez le soumissionnaire auquel votre utilisateur dispose d’autorisations. Il n’affichera pas les soumissionnaires des autres utilisateurs.
GET https://api.adnxs.com/bidder/BIDDER_ID Voir un soumissionnaire particulier.
POST https://api.adnxs.com/bidder
(JSON de soumissionnaire)		 Ajouter un nouveau soumissionnaire.
PUT https://api.adnxs.com/bidder/BIDDER_ID
(JSON de soumissionnaire)		 Modifier un soumissionnaire existant.
DELETE https://api.adnxs.com/bidder/BIDDER_ID Supprimer un soumissionnaire existant.

Champs JSON

Champ Obligatoire Type Description
id Oui, lors de la mise à jour int ID du soumissionnaire.
short_name oui (lors de l’ajout) string Nom court facultatif pour le soumissionnaire. Bien qu’il ne soit pas techniquement obligatoire, ce champ est nécessaire pour les métriques. Il doit donc être considéré comme obligatoire.

Note: Seuls les caractères alphanumériques (A-Z, 0-9) et les traits de soulignement sont autorisés. N’utilisez pas d’espaces, de caractères spéciaux, de points ou d’autres signes de ponctuation.
name oui (lors de l’ajout) string Nom associé au soumissionnaire.
active non, la valeur par défaut est true Valeur booléenne Si le soumissionnaire recevra les demandes ou non.
bid_uri oui (lors de l’ajout) string(255) URI pour les demandes d’enchères (par exemple, /bid).
notify_uri Non string (255) URI pour les demandes de notification (par exemple, /notify). Utilisez null, et non une chaîne vide, pour définir cette valeur sur vide.

Remarque :
- doit notify_uri être un URI relatif. Actuellement, Xandr ne prend pas en charge l’installation de et notify_uri sur des bid_uri hôtes distincts.
- Si la valeur est null, le soumissionnaire ne reçoit pas de demandes de notification.
click_uri Non string(255) URI pour les demandes de clic (par exemple, /click). Utilisez null, et non une chaîne vide, pour définir cette valeur sur vide. Voir Cliquer sur la demande.
pixel_uri Non string(255) URI pour les requêtes de pixels (par exemple, /pixel). Utilisez null, et non une chaîne vide, pour définir cette valeur sur vide. Consultez Demande de pixels.
ready_uri oui (lors de l’ajout) string(50) L’URI d’une instance de soumissionnaire status case activée (par exemple, /ready).
audit_notify_uri Non string(255) URI pour passer des mises à jour d’audit créatif (par exemple https://send.mycompany.com/auditnotifyrequests)
parent_profile_id Non int ID du profil de soumissionnaire parent. Les profils de soumissionnaire peuvent être utilisés pour filtrer le trafic des demandes d’enchères qui atteint un soumissionnaire. Consultez Service de profil de soumissionnaire hérité et Profil du soumissionnaire - FAQ.
child_profiles Non Tableau d’objets avec l’ID des profils de soumissionnaire. Tableau d’objets spécifiant les profils enfants à utiliser. Par exemple : [{"id":123}, {"id":124}].
dongle Non string Mot de passe qui protège la sortie de débogage d’un soumissionnaire dans une impression de débogage. Voir debug_text dans la réponse aux enchères. Disponible uniquement pour les utilisateurs de type « soumissionnaire ».
notify_full_auction Non Valeur booléenne La définition de cette valeur sur « true » signifie que le bus d’impression inclut full_tag_info et bid_info dans la demande de notification. Les notifications postérieures à true l’attente (post_pendingdéfinies sur dans la demande de notification) n’incluent pas ces balises, car le rappel d’acceptation de l’offre n’a pas encore été reçu.
notify_lost non, la valeur par défaut est false Valeur booléenne Indique si le soumissionnaire est informé de toutes les offres perdues à l’URI spécifié dans le notify_uri champ. Si aucun URI n’est fourni, aucune notification n’est envoyée.
- Si truela valeur est , le soumissionnaire est informé de toutes les offres perdues.
- Si falsela valeur est , le soumissionnaire est informé uniquement des offres perdues avec des ID de code d’erreur de demande de notification supérieurs à 100. Nous ne journalisons pas les erreurs et n’envoyons pas de notification de perte si l’ID d’erreur est inférieur à 100 pour les soumissionnaires OpenRTB.
notify_pending non, la valeur par défaut est false Valeur booléenne Indique si le soumissionnaire est informé des offres en attente à l’URI spécifié dans le notify_uri champ. Si aucun URI n’est fourni, aucune notification n’est envoyée.
notify_no_bid non, la valeur par défaut est false Valeur booléenne Indique si le soumissionnaire est informé lorsqu’il n’a pas d’offre pour une demande. La notification est envoyée à l’URI spécifié dans le notify_uri champ . Si aucun URI n’est fourni, aucune notification n’est envoyée.
exclude_unowned Non Valeur booléenne Excluez l’inventaire qui n’appartient pas à un membre associé à ce soumissionnaire.
send_unaudited non, la valeur par défaut est false Valeur booléenne Cet indicateur détermine si votre soumissionnaire recevra ou non le trafic non audité.

Avertissement: À proprement parler, ce champ est déconseillé, mais il doit TOUJOURS être défini sur true. Si ce champ est défini sur false, votre soumissionnaire ne recevra aucune demande d’offre.
bid_percent Non int Pourcentage (50 = 50 %) du trafic total de la plateforme que vous souhaitez recevoir. Les demandes envoyées à votre soumissionnaire sont choisies de manière aléatoire, bien que vous puissiez choisir que votre soumissionnaire reçoive toujours des demandes d’utilisateurs dans des segments de membres associés à votre soumissionnaire. Si vous définissez bid_percent sur 0, votre soumissionnaire recevra uniquement les demandes d’utilisateurs dans au moins l’un des segments de vos membres. Ce filtre est appliqué au trafic qui passe par le service de profil de soumissionnaire hérité.
always_send_owned_segments Non Valeur booléenne Détermine si les impressions pour les utilisateurs dans des segments appartenant à ou partagés avec le soumissionnaire doivent ignorer passthrough_percent sur les profils de soumissionnaire.

Note: Cela remplace uniquement la passthrough_percent sur le profil du soumissionnaire ; toutes les autres restrictions telles que les filtres de pays, de membre, de taille ou de domaine seraient toujours prises en considération lors du choix de l’envoi ou non d’une impression au soumissionnaire.
object_limit_notify_email Non tableau de chaînes Xandr limite le nombre d’objets que chaque soumissionnaire peut créer et utiliser sur la plateforme. Cette limite inclut les objets inactifs et inutilisés. Ce champ contient les adresses e-mail qui seront averties lorsque vous atteignez les seuils de 85 %, 95 % et 100 % pour les limites d’objets.
protocol_id Non int En lecture seule. Celui-ci décrit le protocole associé à ce soumissionnaire, qui décrit le type de soumissionnaire qu’il est. Par exemple, un protocol_id de 6 signifie que ce soumissionnaire utilise la spécification OpenRTB 2.0 pour son intégration à Xandr. La valeur d’intégration par défaut pour un soumissionnaire nouvellement créé est 1, none. Il s’agit du protocole par défaut tel que défini dans Demande d’offre et Réponse d’enchère. Les soumissionnaires avec un protocol_id de 6 intègrent selon la spécification OpenRTB 2.0 (PDF).
Spécification pour OpenRTB 2.4, protocol_id: 10.
Les valeurs suivantes sont prises en charge (chaque ID est suivi du protocol_name associé à cet ID) :
- 1: none
- 2: wp7
- 3: contentads
- 4: admarket
- 5: adexpert
- 6: openrtb2.0
- 10: openrtb2.4
protocol_name Non string En lecture seule. Nom du protocole associé à ce soumissionnaire. Consultez la définition de protocol_id ci-dessus pour toutes les valeurs acceptées de protocol_id et leurs mappages aux noms.
last_activity Non Timestamp Horodatage de la dernière modification apportée à ce soumissionnaire instance.
max_seats Non Entier Les soumissionnaires qui soumissionnent avec des ID de siège d’acheteur personnalisés auront ce champ inclut une valeur supérieure à 0. Il s’agit du nombre maximal de sièges autorisés à être inscrits sous un soumissionnaire.

Note: Cette fonctionnalité est actuellement en version bêta fermée. Si vous souhaitez participer, contactez votre représentant Xandr.
default_member Non Objet Les soumissionnaires qui utilisent l’appel d’offres d’id de siège acheteur auront un membre par défaut désigné dans ce champ. Notez que le membre par défaut est le membre de facturation main pour le soumissionnaire et qu’il est également utilisé comme ID de membre pour l’inscription créative.

Note: Cette fonctionnalité est actuellement en version bêta fermée. Si vous souhaitez participer, contactez votre représentant Xandr.

Remarque

Utilisez le service de profil de soumissionnaire pour filtrer et limiter.

Pour filtrer le trafic que votre soumissionnaire recevra, utilisez le service de profil de soumissionnaire hérité. Quelques champs de filtrage et de limitation existent toujours dans le service des soumissionnaires, mais ils seront bientôt migrés vers le service profil du soumissionnaire. Les filtres de classe sont disponibles dans les deux ; Nous vous recommandons d’utiliser le service de profil de soumissionnaire pour ceux-ci.

Champs déconseillés

Champ Obligatoire Type Description
send_class_2 non, la valeur par défaut est true Valeur booléenne Cet indicateur détermine si votre soumissionnaire recevra ou non un trafic de classe 2. Notez que la limitation par classe d’inventaire est également possible via le service de profil de soumissionnaire hérité.
send_class_3 non, la valeur par défaut est true Valeur booléenne Cet indicateur détermine si votre soumissionnaire recevra ou non le trafic de classe 3. Notez que la limitation par classe d’inventaire est également possible via le service de profil de soumissionnaire hérité.
send_unaudited non, la valeur par défaut est false Valeur booléenne Cet indicateur détermine si votre soumissionnaire recevra ou non le trafic non audité.

Note: La limitation par classe d’inventaire est également possible via le service de profil de soumissionnaire hérité.

Avertissement: Vous devez définir ce champ pour voir les demandes d’enchères
Vous devez définir send_unaudited sur true pour que votre soumissionnaire reçoive les demandes de soumission. Pour plus d’informations, consultez Intégrer un soumissionnaire.
send_owned_blocklist Non Valeur booléenne Envoyer l’inventaire de liste de blocage s’il appartient à un membre associé à ce soumissionnaire.
userdata_entity_id Non int Ce champ est déconseillé.
userdata_javascript Non string Fonctions JavaScript personnalisées qui peuvent être appelées lorsqu’un soumissionnaire met à jour les données de cookie d’un utilisateur.
setuid_function Non string Nom de la fonction JavaScript à utiliser sur les appels SetUID .

Exemples

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.

Afficher les informations du soumissionnaire

Si Xandr a déjà ajouté votre soumissionnaire pour vous, vous aurez déjà des informations sur le soumissionnaire, telles que votre ID de soumissionnaire, au format JSON. Vous pouvez afficher ces informations avec la commande ci-dessous.

S curl -b cookies -c cookies "https://api.adnxs.com/bidder"
{
   "response":{
      "status":"OK",
      "bidder":{
         "id":4,
         "name":"Test Bidder",
         "short_name":"TestBidder",
         "active":true,
         "parent_profile_id": 12345,
         "child_profiles":[{"id":1000},{"id":2000},{"id":3000}],
         "bid_uri":"/bid",
         "notify_uri":"/notify",
         "click_uri":null,
         "ready_uri":null,
         "pixel_uri":"/pixel",
         "audit_notify_uri":null,
         "last_activity":"2009-01-07 22:07:08"
      }
   }
}

Modifier un soumissionnaire

Maintenant que vous connaissez votre ID de soumissionnaire, vous pouvez utiliser un fichier texte au format JSON pour modifier votre soumissionnaire. Voici un exemple JSON qui va modifier le paramètre d’URI prêt.

Remarque

Ces champs inclus seront mis à jour. Tous les autres champs resteront inchangés.

$ cat bidder
{
      "bidder":{
         "id":4,
         "ready_uri":"/ready"
      }
   }

Ensuite, vous utilisez la PUT commande pour mettre à jour ces données dans le cache du bus d’impression.

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

Maintenant, lorsque vous affichez Soumissionnaire 4, vous obtenez :

$ curl -b cookies -c cookies 'https://api.adnxs.com/bidder/4'
{
   "response":{
      "status":"OK",
      "bidder":{
         "id":4,
         "name":"Test Bidder",
         "short_name":"TestBidder",
         "active":true,
         "parent_profile_id": 12345,
         "child_profiles":[{"id":1000},{"id":2000},{"id":3000}],      
         "bid_uri":"/bid",
         "notify_uri":"/notify",
         "click_uri":null,
         "ready_uri":"/ready",
         "ready_string":"Ready:1"
         "pixel_uri":"/pixel",
         "audit_notify_uri":null,
         "last_activity":"2009-01-07 22:07:08"
      }
      }
}
  • Last updated on