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.
Un site (également appelé groupe de placement) permet de regrouper les placements à des fins de gestion. La qualité des annonces et la catégorisation de l’inventaire peuvent être définies au niveau du site, de sorte qu’elles n’ont pas besoin d’être dupliquées entre les placements. Chaque site appartient à un éditeur et chaque placement doit appartenir à un site.
Lorsque vous créez un éditeur, un site est automatiquement créé. Vous pouvez ensuite modifier ce site comme vous le souhaitez ou en créer d’autres.
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
POST |
https://api.appnexus.com/site?publisher_id=PUBLISHER_ID(site JSON) |
Ajouter un site. |
PUT |
https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_IDhttps://api.appnexus.com/site?id=SITE_ID(site JSON) |
Modifier un site existant. |
DELETE |
https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_IDhttps://api.appnexus.com/site?code=SITE_CODE&publisher_code=PUBLISHER_CODE |
Supprimer un site. |
GET |
https://api.appnexus.com/site |
Affichez tous les sites pour vos éditeurs. |
GET |
https://api.appnexus.com/site?publisher_id=PUBLISHER_ID |
Affichez tous les sites de l’un de vos éditeurs. |
GET |
https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_IDhttps://api.appnexus.com/site?id=SITE_ID |
Affichez un site spécifique pour l’un de vos éditeurs. |
GET |
https://api.appnexus.com/site?id=1,2,3 |
Affichez plusieurs sites par ID à l’aide d’une liste séparée par des virgules. |
Remarque
publisher_code et code peuvent être utilisés indifféremment avec publisher_id et id, respectivement.
Champs JSON
| Champ | Type | Description |
|---|---|---|
id |
int | ID Xandr attribué par l’API pour référencer ce site. Obligatoire Sur : PUT, dans la chaîne de requête |
code |
string (100) | Code facultatif pour ce site. |
name |
string (100) | Nom associé au site. Obligatoire le : PUT, POST |
state |
enum | État de ce site. Valeurs possibles : active ou inactive.Par défaut : active |
url |
string (255) | URL de ce site. |
publisher_id |
int | ID de l’éditeur auquel appartient ce site. Obligatoire Sur : POST/PUT, dans la chaîne de requête |
primary_content_category_id |
int | Les utilisateurs peuvent éventuellement spécifier une catégorie de contenu principale pour un placement (voir les exemples ci-dessous). Cette catégorie peut être utilisée pour le ciblage et apparaît dans les rapports. Les catégories de contenu peuvent être définies au niveau site ou placement, mais pas les deux. |
last_modified |
Timestamp | Horodatage de la dernière activité de ce placement. |
placements |
tableau d’objets | ID des placements associés à ce site. Pour plus d’informations , consultez Placements ci-dessous. |
content_categories |
tableau | Les utilisateurs peuvent éventuellement spécifier une ou plusieurs catégories de contenu pour un placement. Ces catégories peuvent être utilisées pour le ciblage et peuvent être définies au niveau Site et Placement. Au maximum 20 catégories peuvent être définies sur un site. Pour plus d’informations, consultez Catégories de contenu ci-dessous. |
intended_audience |
enum | Audience prévue du site. Ne doit pas être null si 'audited' a la valeur true. Valeurs possibles :- children - young_adult - general - maturePar défaut : null |
inventory_attributes |
tableau | Les attributs sensibles contenus par le site ; si elle est définie au niveau du site, inventory_attributes influence également les objets au niveau du placement. Le mappage des ID aux attributs est disponible ci-dessous. Le format du tableau est également contenu ci-dessous.Par défaut : null |
audited |
valeur booléenne | Indique si le site a été audité. |
publisher_join |
tableau | |
publisher_name |
string (100) | Nom de l’éditeur sous lequel se trouve le site |
supply_type |
string | Spécifie s’il s’agit d’un site affiché sur un navigateur de bureau (web), d’un site affiché sur un navigateur mobile (mobile_web) ou d’une application exécutée sur un appareil mobile (mobile_app). Cette distinction permet à l’acheteur de cibler les campagnes sur le type d’offre particulier où il souhaite publier. Par exemple, un annonceur peut charger des créations optimisées pour les navigateurs mobiles avec des pages d’accueil mobiles.Remarque : Depuis le 13 février 2018, le type d’approvisionnement configuré dans chaque enchère est détecté automatiquement par Xandr. Par conséquent, la sélection que vous effectuez ici sera remplacée par le type d’approvisionnement détecté. Cette sélection sera finalement supprimée de l’interface utilisateur. Par défaut : webRemarque : Cette note n’est visible que par les employés Xandr : les administrateurs peuvent également définir cette facebook_sidebar valeur sur . |
creative_format_action |
chaîne |
-
exclude: autoriser tous les formats créatifs à servir sur ce site, à l’exception de ceux spécifiés dans le creative_formats tableau- include: uniquement toutes les créations dont le format est inclus dans la liste spécifiée dans creative_formatsValeur par défaut : exclude. Certaines sources d’approvisionnement d’applications mobiles ne prennent pas en charge tous les formats créatifs disponibles sur Xandr. |
creative_formats |
tableau de chaînes | Formats créatifs à exclure ou à inclure dans ce site. Par défaut : text |
allowed_click_actions |
tableau de chaînes | Indique à l’acheteur quels types d’actions de clic sur les créations sont pris en charge. Le web mobile et les applications autorisent souvent des actions de clic supplémentaires au-delà du clic vers un site web, telles que cliquer pour appeler, cliquer sur sms, cliquer pour envoyer un e-mail et cliquer pour mapper. Par défaut : click-to-web only |
marketplace_map |
objet | Informe l’acheteur des types de places de marché accessibles (performances, RTB, transactions). Consultez Carte de la Place de marché ci-dessous pour connaître les définitions de champs internes. |
mobile_app_instance |
multi-objet |
Instance d’application mobile associée à ce site. Ce champ ne peut être défini que lorsque supply_type a la valeur mobile_app. Consultez Instance d’application mobile ci-dessous pour connaître les définitions de champ interne.Obligatoire sur : POST, pour les sites avec un supply_type de mobile_app. |
mobile_app_instance_id |
int | L’ID de l’application mobile instance associée à ce site. Ce champ est uniquement associé aux sites avec un supply_type de mobile_app. |
Carte de la Place de marché
| Paramètre | Type | Description |
|---|---|---|
an_audit_perf_only |
Boolean |
En lecture seule. Si le site est uniquement éligible à la demande de CPA/CPP en fonction de notre audit. Si true, alors oui.Par défaut : false |
rtb |
Valeur booléenne | Indique si l’inventaire associé au site (et à tous ses placements) fait partie de la Place de marché RTB (c’est-à-dire, éligible à la demande CPM). - Si truela valeur est , tout l’inventaire associé aux placements de ce site doit être revendu dans la Place de marché RTB.- Le champ ne peut pas être défini sur true si l’un des placements au sein du site prend en charge le type de média extensible. Pour plus d’informations sur les types de médias et les champs de sous-types, consultez le service de placement .- Si falsela valeur est , les placements extensibles au sein du site ne peuvent pas être déplacés vers un site où le champ est true.- Si défini sur false tous les inventaires associés aux placements de ce site est uniquement disponible pour les campagnes directes. Aucun inventaire associé aux placements de ce groupe de placement ne sera revendu.Par défaut : true |
performance |
Valeur booléenne | Indique si le site est éligible à la demande CPA/CCP à l’aide de la place de marché de performances mise à jour. Si true, alors oui.Par défaut : false |
deals_allowed |
Valeur booléenne | Spécifie si les transactions sont autorisées à servir sur ce site. Par défaut : true |
rtb_suspended |
Valeur booléenne |
En lecture seule. Indique que tout l’inventaire associé à ce site et à ses placements ne peut pas participer à la Place de marché RTB. Par défaut : false |
deals_suspended |
Valeur booléenne |
En lecture seule. Indique que toutes les transactions sont suspendues sur ce site. Par défaut : false |
Instance d’application mobile
| Paramètre | Type | Description |
|---|---|---|
id |
int | ID unique de cette application instance. Ce champ est facultatif sur POST; s’il est envoyé, il sera utilisé pour rechercher les bundle_id et os_family_id. Si ce champ n’est pas défini sur un PUT ou POST, vous devez transmettre les bundle_id champs et os_family_id , et un nouvel ID de instance d’application mobile est créé. |
bundle_id |
int | Si aucun champ n’est id transmis sur POST, ce champ est obligatoire. Ce champ représente l’ID de bundle de l’application mobile instance et il est utilisé pour rechercher l’ID de instance de l’application mobile. Si aucun ID de instance d’application n’est associé à cet ID d’offre groupée, un nouvel ID est créé. |
os_family_id |
int | Si aucun champ n’est id transmis sur PUT ou POST, ce champ est obligatoire. Ce champ représente l’ID unique de la famille de systèmes d’exploitation à laquelle cette application instance est associée. Si aucun ID de instance d’application n’est associé à cet ID de famille de système d’exploitation, un nouvel ID est créé. |
Placements
| Paramètre | Type | Description |
|---|---|---|
id |
int | Identificateur unique du placement. Vous pouvez utiliser le service de placement pour rechercher les ID de placement. |
code |
string | Code interne pour le placement. |
Catégories de contenu
| Paramètre | Type | Description |
|---|---|---|
id |
int | ID de la catégorie de contenu. Vous pouvez utiliser le service de catégorie de contenu pour rechercher les ID de catégorie. |
is_system |
Valeur booléenne | Indique si la catégorie de contenu est une catégorie système ("universal"). |
name |
string (100) | Nom de la catégorie. |
site |
tableau | Liste des ID qui appartiennent à cette catégorie de contenu. |
primary |
Valeur booléenne | Indique si la catégorie est la catégorie principale pour le site. Une seule catégorie peut être primaire. |
Attributs d’inventaire
| Paramètre | Type | Description |
|---|---|---|
inventory_attribute_id |
int | ID de l’attribut d’inventaire. |
name |
string (50) | En lecture seule. Nom de l’attribut d’inventaire. |
ID des attributs d’inventaire
| ID | Nom de l’attribut |
|---|---|
2 |
Politique |
4 |
Réseaux sociaux |
6 |
Partage de photos & vidéo |
8 |
Forums (modérés) |
10 |
Forums (non modélisés) |
12 |
Clics encouragés |
14 |
Langues autres que l’anglais |
16 |
Diffusion multimédia en continu |
17 |
Barres d’outils, plug-ins ou extensions |
Exemples
Ajout de catégories de contenu à un site
$ cat site
{
"site": {
"content_categories": [
{
"id": 2561,
"primary": true
},
{
"id": 2558
}
],
"name": "Site 1"
}
}
$ curl -b cookies -c cookies -X PUT -d @site 'https://api.appnexus.com/site?id=5822'
Affichage de tous les sites pour vos éditeurs
$ curl -b cookies -c cookies 'https://api.appnexus.com/site'
{
"response":{
"status":"OK",
"sites":[
{
"id":2411,
"code":null,
"name":"[Default RTB Media Buy] - ROS",
"state":"active",
"url":"",
"primary_content_category_id":null,
"last_modified":"2010-05-12 22:46:42",
"intended_audience":"general",
"inventory_attributes":[
{
"id":2,
"name":"Political"
}
]
"placements":[
],
"content_categories": [
{
"id": 2561,
"primary": true
},
{
"id": 2558
}
],
},
{
"id":2412,
"code":null,
"name":"[Weekdays Only] - ROS",
"state":"active",
"url":"",
"media_buy_id":1559,
"primary_content_category_id": 2561,
"last_modified":"2010-05-12 23:28:40",
"placements":[
],
"content_categories":null
},
{
"id":2413,
"code":null,
"name":"[Weekends Only] - ROS",
"state":"active",
"url":"",
"media_buy_id":1560,
"primary_content_category_id":null,
"last_modified":"2010-05-12 23:28:52",
"placements":[
],
"content_categories":null
},
{
"id":5775,
"code":null,
"name":"[Conversion Test] - ROS",
"state":"active",
"url":"",
"media_buy_id":4732,
"primary_content_category_id":null,
"last_modified":"2010-06-15 20:09:38",
"placements":[
{
"id":"57851"
}
],
"content_categories":null
}
],
"count":4,
"start_element":null,
"num_elements":null
}
}
Create un site avec un type d’approvisionnement d’application mobile
Dans cet exemple, nous créons un site conçu pour l’approvisionnement d’applications mobiles. Nous l’utiliserons également dans notre exemple suivant :
$ cat the-site.json
{"site":{"name":"One site to rule them all", "supply_type":"mobile_app"}}
$ curl -b cookies -X POST -d @the-site.json 'https://api.appnexus.com/site?publisher_id=102306'
{
"response":{,
"site":{
"allowed_click_actions":[
"click-to-web"
],
"creative_formats":[
"text"
],
"inventory_attributes":null,
"content_categories":null,
"placements":null,
"mobile_app_instance":null,
"member_id":1309,
"creative_format_action":"exclude",
"supply_type":"mobile_app",
"publisher_name":"RICH'S CRAZY RESELLER",
"audited":false,
"intended_audience":null,
"last_modified":"2014-02-20 20:56:03",
"primary_content_category_id":null,
"publisher_id":102306,
"url":"",
"state":"active",
"name":"One site to rule them all",
"code":null,
"id":273205
},
"num_elements":100,
"start_element":0,
"id":273205,
"count":1,
"status":"OK"
}
}
Ajouter une application mobile instance à un site
Dans cet exemple, nous avons un site préexistant avec le type de fourniture d’application mobile requis. Nous effectuons un PUT appel pour associer notre site à une application mobile existante instance, et nous pouvons voir qu’il a fonctionné en affichant l’objet mis à jour dans la réponse. Pour plus d’informations sur les instances d’application mobile, consultez Service d’instance d’application mobile.
$ cat update.json
{"site":{"supply_type":"mobile_app", "mobile_app_instance":{"id":62}}}
$ curl -b cookies -X PUT -d @update.json
{
"response":{
"site":{
"allowed_click_actions":[
"click-to-web"
],
"creative_formats":[
"text"
],
"inventory_attributes":null,
"content_categories":null,
"placements":null,
"mobile_app_instance":{
"os_family_id":3,
"bundle_id":"2342342345566666",
"id":62
},
"member_id":1309,
"creative_format_action":"exclude",
"supply_type":"mobile_app",
"publisher_name":"RICH'S CRAZY RESELLER",
"audited":false,
"intended_audience":null,
"last_modified":"2014-02-20 21:18:15",
"primary_content_category_id":null,
"publisher_id":102306,
"url":"",
"state":"active",
"name":"One site to rule them all",
"code":null,
"id":273205
},
"num_elements":100,
"start_element":0,
"id":"273205",
"count":1,
"status":"OK"
}
}