Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Avertissement
Nous avons désactivé le protocole Supply Integration (ASI) (anciennement AppNexus Supply Integration) pour les intégrations d’approvisionnement côté serveur à compter du 1er octobre 2017. Nous vous encourageons vivement à migrer votre approvisionnement vers le protocole OpenRTB. Tous les éléments de cette section sont du contenu hérité.
Pour envoyer une demande d’enchère à Xandr, utilisez POST un fichier au format JSON contenant les détails de la demande d’enchère au point de terminaison suivant :
https://ib.adnxs.com/asi?member_id=YOUR_PROD_MEMBER_ID
Pour les tests dans notre environnement de test client, vous accédez POST au point de terminaison :
https://ib.client-testing.adnxs.net/asi?member_id=YOUR_TESTING_MEMBER_ID
Pour obtenir des conseils sur la mise en forme de votre demande, consultez les exemples en bas de la page.
Champs JSON
Lorsque les champs sont disponibles pour les valeurs internes et externes (par exemple, int_blocked_categories et ext_blocked_categories), incluez un seul des champs dans votre fichier au format JSON. Si les deux sont inclus, la valeur interne est utilisée.
| Champ | Type | Description |
|---|---|---|
an_user_id |
int | ID Xandr de l’utilisateur qui consulte la page. Vous incluez ce champ si vous stockez des mappages d’ID utilisateur dans votre système. Pour plus d’informations, consultez Mappage d’ID utilisateur. Obligatoire : oui, si ext_user_id n’est pas inclus. |
ext_user_id |
string | ID de partenaire de fourniture pour l’utilisateur qui consulte la page. Vous incluez ce champ si vous stockez des mappages d’ID utilisateur avec Xandr. Pour plus d’informations, consultez Mappage d’ID utilisateur. Obligatoire : oui, si an_user_id n’est pas inclus. |
ext_auction_id |
string | ID de partenaire fournisseur pour la vente aux enchères. Obligatoire : oui |
width |
int | Largeur du placement. Obligatoire : oui |
height |
int | Hauteur du placement. Obligatoire : oui |
ad_format |
enum | Format du créatif qui doit être retourné. Valeurs possibles : « iframe », « javascript » ou « vast ». Remarque sur VAST : Le format « vaste » n’est pas pris en charge. Toutefois, consultez la demande d’offre VAST dans la section Exemples de ce à quoi peut ressembler une demande d’offre pour un créatif vidéo VAST. Obligatoire : oui |
template_id |
int |
Pas encore pris en charge. Pour les vidéos créatives VAST, vous souhaiterez peut-être que Xandr inclue des paramètres personnalisés dans le ad_tag champ de la réponse d’enchère. Pour ce faire, Xandr peut créer un « modèle de fourniture » pour vous, que vous référencez ensuite ici lors de la demande de vidéo VAST. Pour plus d’informations, consultez Modèles d’approvisionnement dans la documentation réponse aux enchères.Obligatoire : non |
ip_address |
string | Adresse IP de l’utilisateur qui consulte la page. Obligatoire : non |
is_secure |
valeur booléenne | True ou false. Le partenaire fournisseur peut demander une version SSL du créatif en définissant cette valeur sur true. |
page_url |
string | Domaine complet de la demande d’enchère (ne pas passer d’URL encodée). Obligatoire : non |
position |
enum | Position du placement sur la page. Valeurs possibles : « above » (above the fold), « below » (sous le pli) ou « unknown ». Par défaut: « unknown » Obligatoire : non |
ext_pub_code |
string | Code du partenaire de fourniture pour l’éditeur. Obligatoire : non |
ext_placement_code |
chaîne | Code du partenaire de fourniture pour le placement. Obligatoire : non |
an_placement_id |
int | ID Xandr pour le placement. Pour récupérer les ID de placement, utilisez le service placement. Obligatoire : non |
language |
int | ID X de la langue de la page. Pour récupérer les ID de langue, utilisez le service de langage. Valeur par défaut : 0 Obligatoire : non |
user_agent |
string | Agent utilisateur pour la requête (c’est-à-dire, le navigateur). Obligatoire : non |
int_blocked_technical_attributes |
tableau de ints | ID Xandr pour les attributs techniques créatifs qui ne sont pas autorisés. Pour récupérer les ID d’attribut technique, utilisez le service d’attributs techniques. Obligatoire : non |
ext_blocked_technical_attributes |
tableau de ints | ID de partenaire de fourniture pour les attributs techniques créatifs qui ne sont pas autorisés. Obligatoire : non |
int_blocked_categories |
tableau de ints | ID Xandr pour les catégories créatives qui ne sont pas autorisées. Pour récupérer les ID de catégorie, utilisez le service category. Obligatoire : non |
ext_blocked_categories |
tableau de ints | ID de partenaire de fourniture pour les catégories créatives qui ne sont pas autorisées. Obligatoire : non |
int_content_categories |
tableau de ints | ID Xandr pour les catégories de contenu appliquées au placement. Vous pouvez utiliser le service de catégorie de contenu pour afficher toutes les valeurs possibles. Cela inclut les catégories de contenu personnalisées créées par le partenaire fournisseur sous son membre Xandr. Valeur par défaut : 0 Obligatoire : non |
ext_content_categories |
tableau de ints | ID de partenaire de fourniture pour les catégories de contenu appliquées au placement. Valeur par défaut : 0 Obligatoire : non |
blocked_urls |
tableau de chaînes | URL de page d’accueil créatives qui ne sont pas autorisées. Jusqu’à 20 URL peuvent être bloquées. Consultez l’exemple de mise en forme ci-dessous. Obligatoire : non |
blocked_languages |
tableau de ints | Langues créatives qui ne sont pas autorisées. Pour récupérer les ID de langue, utilisez le service de langage. Obligatoire : non |
int_blocked_brands |
tableau de ints | ID Xandr pour les marques qui ne sont pas autorisées. Pour récupérer les ID de marque, utilisez le Service de marque. Obligatoire : non |
age |
int | Âge de l’utilisateur qui consulte la page. Valeur par défaut : 0 Obligatoire : non |
gender |
enum | Sexe de l’utilisateur qui consulte la page. Valeurs possibles : « mâle », « femelle » ou « inconnu ». Par défaut: « unknown » Obligatoire : non |
supply_type |
enum | Environnement d’affichage. Valeurs possibles : « web », « mobile_app », « mobile_web », « in-stream-video » ou « other ». Pointe: La valeur de remplace le type d’approvisionnement supply_type défini au niveau du site .Note: Le format « in-stream-video » n’est pas encore pris en charge. Par défaut: « web » Obligatoire : non |
Exemple de mise en forme : blocked_urls
{
"blocked_urls": [
"landingpage1.com",
"landingpage2.com"
]
}
Mappage de positionnement
Xandr n’envoie une offre que lorsque nous pouvons mapper votre demande à un placement dans Xandr. Nous recherchons les éléments suivants dans l’ordre suivant :
an_placement_idext_placement_code-
ext_pub_code(balise par défaut de l’éditeur) - Placement par défaut de votre membre (configuré pour votre compte par votre responsable technique de compte avant même que les informations d’identification de connexion de production soient affectées).
Si aucun des éléments ci-dessus n’est disponible, Xandr n’envoie pas d’offre. Notez que chacun ext_placement_code ne peut mapper qu’à un seul emplacement dans Xandr, et que chacun ext_pub_code peut mapper à un seul éditeur dans Xandr.
Exemples
Envoi d’une demande d’offre minimalement acceptable
Create un fichier au format JSON comprenant uniquement les champs obligatoires. Cet exemple utilise le champ , mais vous pouvez utiliser
ext_user_idà laan_user_idplace.$ cat bid_request | { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "ad_format":"iframe", "width": 300, "height": 250 }POSTfichier au format JSON. Veillez à inclure votre ID de membre dans la chaîne de requête.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envoi d’une demande d’enchère qui inclut uniquement des valeurs Xandr
Create un fichier au format JSON avec les champs des valeurs Xandr au lieu de fournir des valeurs de partenaire, par exemple,
an_user_idau lieu deext_user_idetint_blocked_technical_attributesau lieu deext_blocked_technical_attributes."$ cat bid_request"{ "an_user_id":1089773736613054100, "ext_auction_id":"395dj2j2j2dd", "width":300, "height":250, "ad_format":"iframe", "ip_address":"38.108.249.106", "page_url":"publisher.com", "position":"above", "ext_pub_code":"203pub", "ext_site_code":"145site", "an_placement_id":40, "language":1, "user_agent":"Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "int_blocked_technical_attributes":[ 6, 10, 11 ], "int_blocked_categories":[ 16, 17, 19 ], "int_content_categories":[ 5, 6, 7 ], "blocked_urls":[ "landingpage1.com", "landingpage2.com", "landingpage3.com", "landingpage4.com", "landingpage5.com" ], "blocked_languages":[ 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "age":25, "gender":"male", "supply_type":"web" }POSTfichier au format JSON. Veillez à inclure votre ID de membre dans la chaîne de requête.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envoi d’une demande d’enchère qui inclut uniquement des valeurs externes
Create un fichier au format JSON avec les champs pour fournir des valeurs de partenaire au lieu de valeurs Xandr, par exemple,
ext_placement_codeau lieu dean_placement_idetext_blocked_categoriesau lieu deint_blocked_categories.$ cat bid_request { "ext_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "width": 300, "height": 250, "ad_format": "iframe", "ip_address": "38.108.249.106", "page_url": "publisher.com", "position": "above", "ext_pub_code": "203pub", "ext_site_code": "145site", "ext_placement_code": "40placement", "language": 1, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "ext_blocked_technical_attributes": [ 3, 5, 8 ], "ext_blocked_categories": [ 2, 15, 20 ], "ext_content_categories": [ 2, 9, 13 ], "blocked_urls": [ "landingpage1.com", "landingpage2.com", "landingpage3.com", "landingpage4.com", "landingpage5.com" ], "blocked_languages": [ 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "age": 25, "gender": "male", "supply_type": "web" }POSTfichier au format JSON. Veillez à inclure votre ID de membre dans la chaîne de requête.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envoi d’une demande d’enchère qui n’inclut pas de détails de blocage
Si vous configurez des profils publicitaires pour appliquer les préférences de vos éditeurs, vous n’avez pas besoin de spécifier les détails de blocage dans votre demande d’offre.
Create un fichier au format JSON à l’exclusion des champs de blocage des attributs techniques, des catégories créatives, des catégories de contenu, des URL et des langues.
$ cat bid_request { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "width": 300, "height": 250, "ad_format": "iframe", "ip_address": "38.108.249.106", "page_url": "publisher.com", "position": "above", "ext_pub_code": "203pub", "ext_site_code": "145site", "an_placement_id": "40", "language": 1, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "age": 25, "gender": "male", "supply_type": "web" }POSTfichier au format JSON. Veillez à inclure votre ID de membre dans la chaîne de requête.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Envoi d’une demande d’offre pour un créatif vidéo VAST (NON ENCORE PRIS EN CHARGE)
Lorsque vous demandez un créatif vidéo VAST :
- Doit
ad_formatêtre défini sur « vast ». - Doit
widthêtre défini sur 1. - Doit
heightêtre défini sur 1. - La demande doit correspondre à un emplacement dans le système Xandr qui autorise les créatifs du type de média « Vidéo » ou toute combinaison des sous-types de médias « VAST de 15 secondes », « VASTE de 30 secondes » ou « Autre VASTE ». Si la demande est mappée à un placement non vidéo, AppNexus répond avec une erreur (le format de la publicité de la demande ne correspond pas au format de placement). Pour plus d’informations sur la façon dont nous recherchons le placement à utiliser, consultez Mappage de placement ci-dessus.
- Ne passez pas ou
ext_blocked_technical_attributespour définir les duréesint_blocked_technical_attributesde vidéo VAST souhaitées. Au lieu de cela, comme mentionné ci-dessus, le placement Xandr doit définir la durée de la vidéo VAST autorisée. - Si vous avez demandé à Xandr de configurer un modèle d’approvisionnement pour inclure des paramètres personnalisés dans le
ad_tagchamp de notre réponse d’offre, définisseztemplate_idsur l’ID de ce modèle d’approvisionnement. Pour plus d’informations, consultez Modèles d’approvisionnement dans la documentation réponse aux enchères.
Create un fichier au format JSON conformément aux exigences ci-dessus. Cet exemple suppose qu’il existe un emplacement spécifique dans le système Xandr défini pour autoriser les créations vidéo VAST. L’ID de ce placement est passé dans le
an_placement_idchamp .$ cat bid_request { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "ad_format":"vast", "width": 1, "height": 1. "an_placement_id": 204, "tmpl_id": 4, "ip_address": "38.108.249.106", "page_url": "ibdo.com", "position": "unknown", "language": 0, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "age": 25, "gender": "female" }POSTfichier au format JSON. Veillez à inclure votre ID de membre dans la chaîne de requête.curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'