Partager via


Service TinyTag

Le service TinyTag vous permet de créer des ID TinyTag, de les modifier et de les afficher.

Les ID sont associés à des informations sur l’espace publicitaire, telles que la taille, le prix de réserve et les marques ou les créations autorisées à s’exécuter dans cet espace. Ces informations sont stockées côté serveur avec Xandr et sont faciles à modifier.

Les ID TinyTag peuvent être utilisés dans tinyTags, qui sont placés directement sur les pages de l’éditeur et prennent la forme https://ib.``adnxs``.com/tt?id=1de base . Des informations supplémentaires peuvent être transmises dans un TinyTag à l’aide de paramètres TinyTag dynamiques.

Notez que le membre associé à l’ID TinyTag dispose d’un droit de premier refus sur l’inventaire et reçoit un crédit (ou de l’argent) si un autre membre l’achète.

API REST

HTTP, méthode Endpoint Description
SUPPRIMER https://api.adnxs.com/tt/MEMBER_ID/TAG_ID Supprimer un TinyTag existant.
GET https://api.adnxs.com/tt/MEMBER_ID Afficher toutes les TinyTags d’un membre.
GET https://api.adnxs.com/tt/MEMBER_ID/TAG_ID Affichez un TinyTag particulier.
POST https://api.adnxs.com/tt/MEMBER_ID
(balise JSON)
Create un nouveau TinyTag.
PUT https://api.adnxs.com/tt/MEMBER_ID/TAG_ID
(balise JSON)
Modifier un TinyTag existant.

Champs JSON

Champ Obligatoire Type Description
acb_code Non string(32) Pas couramment utilisé.
active non, la valeur par défaut est active int La valeur booléenne détermine si le segment peut être utilisé
ad_profile_id Non int Il s’agit de l’ID du profil d’approbation publicitaire utilisé pour les normes de qualité créative.
audit_level Non enum Valeurs pour l’auto-audit uniquement.
Remarque : les auto-audits au niveau du site peuvent être remplacés au niveau du placement (tinytag).
Valeurs possibles :
- « tinytag » : utilisez cette valeur si le champ audité est défini sur true dans le placement.
- « site » : utilisez cette valeur si le champ audité a la valeur false dans le placement, mais true dans le site.
audited Non valeur booléenne Si la valeur est true, le placement a été auto-audité par le propriétaire.
code Non string(100) Champ défini par l’utilisateur pour appeler une balise via des codes. Vous trouverez plus d’informations sur la page Tinytag.
code2 Non string(100) Deuxième code, si vous le souhaitez.
content_retrieval_timeout_ms Non int
- Si 0la valeur est , le serveur publicitaire utilise la valeur du service membre.
- La valeur par défaut est 0 si elle n’est pas fournie à l’API sur PUT ou POST appelle.
- Si le serveur publicitaire lit un 0 dans ce champ, il effectue une recherche de membre et utilise le délai d’expiration par défaut défini par le service membre (en supposant qu’il est également différent de zéro).
- Lors de la création d’un TinyTag, aucune des valeurs n’est copiée dans ce champ à partir des paramètres par défaut du membre. Vous devez les spécifier explicitement dans vos appels à POST. Pour plus d’informations, consultez le default_content_retrieval_timeout_ms champ du service membre.
default_calculation_type Non enum Cela détermine le seuil de prix de l’offre en dessous duquel un créatif par défaut est servi. Vous pouvez choisir si ce seuil correspond au chiffre d’affaires brut du réseau ou au chiffre d’affaires net de l’éditeur. S’il n’y a pas de campagnes éligibles supplémentaires, ni de créations par défaut disponibles, un psa est servi. Valeurs possibles : « brut » ou « net ».
default_creative_id Non int Création par défaut à exécuter si aucune offre ne respecte le prix de réserve.
default_creatives Non tableau Les créations par défaut qui s’affichent au lieu d’un PSA lorsqu’il n’y a pas de gagnant aux enchères. Pour chaque élément créatif par défaut, le prix de réserve est défini avec le champ « price » dans le tableau. Pour plus d’informations, consultez Créations par défaut ci-dessous.
Remarque : Pour les placements de pops : le placement ne s’affiche pas si le prix de réserve n’est pas atteint, sauf dans le cas d’une prépape.
default_referrer_url Non string Si un profil de visibilité est défini pour masquer les URL d’inventaire dans vos demandes d’enchères, vous pouvez définir ce champ pour passer une URL de vanité à la place. Cela est particulièrement utile dans les cas où les éditeurs ne souhaitent pas partager des domaines réels, mais veulent néanmoins que les acheteurs puissent les identifier par domaine. Notez toutefois que le domaine de la vanité ne peut pas être ciblé directement par les campagnes Xandr, bien qu’il puisse être ciblé par des soumissionnaires externes.
enable_for_mediation Non valeur booléenne - C’est la source de vérité pour savoir si un TinyTag doit accepter le contenu médiat
- Sauf si défini sur PUT ou POST, ce champ hérite de sa valeur par défaut du membre. Si la valeur par défaut est modifiée sur le service membre, cette action n’a pas d’impact rétroactif sur les TinyTags créées précédemment ; ils continuent à être définis sur l’ancienne valeur par défaut. En d’autres termes, la valeur de ce champ ne peut pas être mise à jour rétroactivement en définissant le membre par défaut. Pour plus d’informations, consultez le default_enable_for_mediation champ du service membre.
estimated_clear_prices Non Le montant de la soumission qui a historiquement remporté la majorité (95%) des enchères tierces auxquelles elle participe. Pour plus d’informations, consultez Prix clair estimé ci-dessous.
exclusive non, la valeur par défaut est false valeur booléenne En lecture seule. Ce champ a été déprécié. Ce champ servait auparavant de valeur par défaut pour le comportement exclusif sur un TinyTag. Ce paramètre est maintenant contrôlé via le rtb champ dans l’objet marketplace_map du site service.
floor_application_target Non enum Type d’enchères auxquelles le prix de réserve est appliqué. Valeurs possibles :
-« external_only » - Le prix de réserve est appliqué uniquement aux enchères externes (le membre acheteur et le membre vendeur sont différents). Utilisez cette option si vous préférez servir une impression d’apprentissage managé disponible plutôt qu’une valeur par défaut, même si cela signifie dépasser le pourcentage maximal de volume quotidien pour learn.
- « external_non_preferred » - Le prix de réserve est appliqué aux offres externes (le membre achetant et le membre vendeur sont différents) ou lorsque l’impression est une impression d’apprentissage managé disponible qui dépasse le pourcentage maximal de volume quotidien pour learn. Utilisez cette option si vous préférez servir une valeur par défaut plutôt qu’une impression d’apprentissage managé disponible qui dépasserait le pourcentage maximal de volume quotidien pour learn.
- « all » : le prix de réserve est appliqué à toutes les offres, à l’exception des impressions d’apprentissage managées, dans le pourcentage maximal du volume quotidien pour learn.
height Non int Hauteur de la balise en pixels.
hide_referer valeur booléenne N’affichez pas la page de référence.
id non, uniquement lors de la modification int ID Xandr attribué par l’API pour référencer cette balise.
intended_audiences Non enum Valeurs pour l’auto-audit uniquement. Valeurs possibles : « general », « children », « young_adult » ou « mature ».
inventory_attributes Non tableau Valeurs pour l’auto-audit uniquement. Il s’agit d’un tableau d’objets avec des ID. Consultez service d’attribut d’inventaire pour obtenir la liste des ID.
is_resizable Non valeur booléenne Si le placement utilise un iFrame convivial et que vous souhaitez qu’il soit redimensionné pour s’adapter à des créations plus petites ou plus grandes, définissez ce champ sur true.
last_activity Non Timestamp Horodatage de la dernière modification de cette balise minuscule.
media_subtypes Non enum Déconseillé. Utilisez supported_media_types et supported_media_subtypes à la place.
member_id oui int ID de membre propriétaire de cette balise. Requis pour l’appel, mais pas json.
name Non string Nom associé au TinyTag
pixel_type Non enum Identifie le type de pixel. Les valeurs possibles sont « script » ou « image ».
pixel_url Non string Emplacement que le pixel avertit lorsqu’un utilisateur clique sur ce placement.
pixel_url_secure Non valeur booléenne Indique si l’URL de pixel pointe vers une page web encyptée.
pop_values Non tableau Si le supported_media_type est « Pop » ou si le supported_media_subtypes est « Popup » ou « Popunder », ce tableau définit le comportement de la fenêtre contextuelle. Pour plus d’informations, consultez Valeurs contextuelles ci-dessous.
position Non enum « above », « below » ou « unknown » : position du TinyTag par rapport au pliage de page
publisher_id Non int ID de l’éditeur associé au site sur lequel se trouve la balise.
reserve_price non, la valeur par défaut est $0 double Prix de réserve de l’annonce dans $CPM : il s’agit du prix le plus bas pour lequel le propriétaire d’inventaire est prêt à vendre, sinon la création par défaut est servie.
Remarque : ce champ est répertorié sous la forme « price » dans la liste /meta.
segments Non Tableau d’objets Un utilisateur affichant ce TinyTag est placé dans tous les segments spécifiés Exemple : "segments": [ {"segment_id":1} ]
site_id oui int ID du site auquel la balise est associée. La hiérarchie est Étiquettes de sites>. Pour plus d’informations sur le service de site, appelez GEThttps://api.adnxs.com/site/meta.
supported_media_subtypes Non tableau Sous-types de média autorisés à servir sur le placement. Pour plus d’informations, consultez Sous-types de média pris en charge ci-dessous.
supported_media_types Non tableau Types de médias autorisés à servir sur le placement. Pour plus d’informations, consultez Types de supports pris en charge ci-dessous.
tag_data Non string Autres informations, souvent des données démographiques ou descriptives. Envoyé uniquement au soumissionnaire du propriétaire. Voir aussi qs_data dans TinyTags.
Remarque : ce champ est répertorié comme « other_data » dans la liste /meta.
use_detected_domain non, la valeur par défaut est true. valeur booléenne En lecture seule. Indique s’il faut utiliser le domaine détecté par rapport au domaine signalé. La valeur par défaut est true pour tous les clients.
visibility_profile_id Non int ID du profil de visibilité affecté directement au placement.
width Non int Largeur de la balise en pixels.

Types de médias pris en charge

Les éléments créatifs sont classés par type de média et sous-type de média. Le type de média définit le style d’affichage général du créatif, par exemple, « Bannière », et le sous-type multimédia définit le style d’affichage spécifique des éléments créatifs, par exemple, « Bannière standard » ou « Vidéo dans la bannière ». Vous pouvez utiliser ce tableau pour limiter le type de média, le style d’affichage général des éléments créatifs, qui peuvent servir sur un placement. Pour limiter le sous-type multimédia, le style d’affichage spécifique des éléments créatifs, utilisez le tableau supported_media_subtypes (voir Sous-types multimédias pris en charge ci-dessous).

Champ Type Description
id int ID du sous-type de média autorisé.
name string En lecture seule. Nom du sous-type de média autorisé.

Sous-types de média pris en charge

Les éléments créatifs sont classés par type de média et sous-type de média. Le type de média définit le style d’affichage général du créatif, par exemple, « Bannière », et le sous-type multimédia définit le style d’affichage spécifique des éléments créatifs, par exemple, « Bannière standard » ou « Vidéo dans la bannière ». Vous pouvez utiliser ce tableau pour limiter le sous-type multimédia, le style d’affichage spécifique des éléments créatifs, qui peut servir sur un placement. Pour limiter le type de média, le style d’affichage général des éléments créatifs, utilisez le tableau supported_media_types (voir Sous-types multimédias pris en charge ci-dessus).

Champ Type Description
id int ID du sous-type de média autorisé.
name string En lecture seule. Nom du sous-type de média autorisé.

Remarques sur les types de médias et les sous-types de médias pris en charge

  • Si vous ne spécifiez pas les types de médias pris en charge ou les sous-types de média pris en charge, le type de média « Bannière » est autorisé par défaut.

  • Vous pouvez combiner les types de médias « Bannière » et « Texte » et n’importe quelle combinaison de leurs sous-types multimédias sur un emplacement unique, mais vous ne pouvez pas combiner les autres types de médias et sous-types de médias. Cette limitation garantit que seuls les contenus créatifs appropriés sont servis sur un placement. Par exemple, un placement qui autorise les créatifs du type de média « Vidéo » est destiné à être transmis à un lecteur vidéo ; il n’aurait pas de sens de permettre à des créatifs d’un autre type de média, comme « Interstitial », de servir sur le placement.

  • Vous pouvez définir un emplacement pour autoriser le type de média « Extensible » ou l’un de ses sous-types pour l’inventaire direct. Si vous souhaitez prendre en charge les créations extensibles pour les placements qui sont disponibles pour la revente à d’autres membres de la plateforme, indiquez l’URL pour prendre en charge la vérification.

Créations par défaut

Vous utilisez ce tableau pour affecter des éléments créatifs par défaut au placement. Notez les conditions suivantes :

  • Un élément créatif par défaut ne doit pas avoir expiré. Pour plus d’informations, consultez le champ is_expired dans Creative Service.
  • Un élément créatif par défaut doit être affecté à un modèle créatif qui correspond aux supported_media_types et supported_media_subtypes du placement. Par exemple, si le placement autorise les éléments créatifs du type de média « Bannière », vous ne pouvez pas associer des éléments créatifs par défaut qui utilisent un modèle créatif pour le type de média « Interstitial ». Pour plus d’informations, consultez le champ modèle dans Creative Service .
  • Si le placement est dimensionné (les champs « width » et « height » sont définis pour le placement), ce tableau ne doit contenir qu’un seul élément créatif avec les dimensions correspondantes.
Champ Type Description
height int Hauteur du créatif par défaut.
id int ID de la création par défaut.
name chaîne En lecture seule. Nom du créatif par défaut.
price double Prix de réserve pour le créatif par défaut. Une enchère gagnante doit être supérieure à ce prix.
width int Largeur du créatif par défaut.

Valeurs contextuelles

Si le supported_media_type est « Pop » ou si le supported_media_subtypes est « Popup » ou « Popunder », ces champs doivent être inclus dans le tableau « pop_values ». Consultez l’exemple ci-dessous.

Champ Type Description Par défaut
pop_freq_duration int Voir pop_freq_times. Aucune limite de fréquence
pop_freq_times int Nombre de fois où la balise peut être transférée à un utilisateur unique en pop_frequency_duration secondes. N’a aucun effet lorsque pop_is_prepop a la valeur true. Aucune limite de fréquence
pop_is_prepop valeur booléenne Si la valeur est true, la balise est une balise prepop et sert dans une fenêtre que la page de l’éditeur a déjà ouverte. false
pop_max_height int Hauteur maximale du créatif. Si pop_max_height est spécifié, toute valeur créative affichée par la balise doit avoir une hauteur égale ou inférieure à pop_max_height pas de hauteur maximale
pop_max_width int Si pop_max_width est spécifié, tout élément créatif affiché par la balise doit avoir une largeur égale ou inférieure à pop_max_width pas de largeur maximale

Estimation des prix clairs

Champ Type Description
average_price double Il s’agit de la moyenne de toutes les offres soumises pour ce placement.
clear_price int Le montant de l’offre qui a historiquement remporté la majorité (95%) des enchères tierces auxquelles elle participe pour ce placement.
height int Lors de l’exportation des étiquettes de placement sans taille à servir, cela détermine la hauteur du placement.
Vérifié valeur booléenne Indique si les prix créés sont vérifiés.
largeur int Lors de l’exportation de balises de placement sans taille à servir, cela détermine la largeur du placement.

Exemple

Étape 1. Create un fichier au format JSON avec les paramètres appropriés

$ cat tag
 {
     
"tinytag": 
{
         
"width": "728",
         
"height": "90",
         
"reserve_price": "5.00",
         
"default_creative_id": 212,
         
"active": true,
         
"tag_data": "male/22",
         
"ad_profile_id": 234
     }
 }

Étape 2. Ajouter le fichier TinyTag au cache Imp Bus à l’aide de votre ID de membre

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

Étape 3. Afficher la balise que vous avez créée à l’aide de l’ID de balise 1234

$ curl -b cookies -c cookies https://api.adnxs.com/tt/1/1234


$ curl -b cookies -c cookies [adnxs.com/tt/1/1234](https://api.adnxs.com/tt/1/1234)

{
    "response": {
        "tinytag": {
            "id": 1234,
            "width": "728",
            "height": "90",
            "member_id": 1,
            "reserve_price": 5.00,
            "default_creative_id": 212,
            "tag_data": "male\/22",
            "active": true,
            "ad_profile_id": 234
        },
        "status": "OK"
    }
}