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.
Les ordres d’insertion vous permettent de mieux organiser, suivre et allouer le budget à vos éléments de ligne. En outre, les intervalles budgétaires (c’est-à-dire les ensembles de dates de vol avec chacun leur propre rythme et budget) peuvent être utilisés sur les ordres d’insertion, ce qui vous permet de représenter le budget disponible d’une manière qui reflète plus précisément votre contrat avec un annonceur. Xandr suggère d’utiliser des ordres d’insertion et des intervalles budgétaires.
Les ordres d’insertion peuvent être associés à un ou plusieurs éléments de ligne. Un élément de ligne peut appartenir à plusieurs ordres d’insertion tant que les intervalles budgétaires sur ces ordres d’insertion ne se chevauchent pas.
Remarque
- Les ordres d’insertion sont activés au niveau de l’annonceur à l’aide du service annonceur (le
use_insertion_orderschamp de ce service doit être défini sur"true"). - Les éléments de ligne sont créés via le service d’élément de ligne - ALI (ou service d’élément de ligne pour les éléments de ligne hérités).
Ordres d’insertion transparents
Il existe deux types d’ordres d’insertion :
-
Transparent : ordre d’insertion transparent pour les éléments de ligne qui fournissent des paramètres de ciblage et de budget supplémentaires. Le
budget_typeparamètre des commandes d’insertion transparente peut restreindre les éléments de ligne augmentée à livraison garantie (GDALI) associés et les éléments de ligne garantis par programme (PGLI) qui ont des paramètres en conflit. Nous vous recommandons d’utiliser des ordres d’insertion transparents avecbudget_typedéfini sur"flexible"pour les GDALIs et les PGLIs afin de pouvoir associer à la fois les éléments de ligne basés sur les impressions et les revenus au même ordre d’insertion. -
Hérité (non transparent) : ordre d’insertion hérité requis pour les éléments de ligne hérités garantis et non garantis. Les commandes d’insertion héritées n’utilisent pas le
budget_intervalstableau et ne peuvent pas être utilisées avec les éléments de ligne augmentée (ALI), les éléments de ligne augmentée à livraison garantie (GDALI) et les éléments de ligne garantis par programmation (PGLI).
Les différences main de configuration pour chaque type d’ordre d’insertion sont les suivantes :
Pour créer un ordre d’insertion transparente , vous devez :
- Utilisez les champs associés au budget et au rythme, ainsi que les
start_datechamps etend_datedubudget_intervalstableau pour spécifier les dates pendant lesquelles l’ordre d’insertion doit s’exécuter, le budget disponible pendant ces dates et la façon dont les dépenses du budget doivent être rythmées. - Laissez les
start_datechamps etend_date(ainsi que les champs associés au budget ou au rythme) sur le main niveau d’ordre d’insertion défini surnull(paramètre par défaut). - Associez uniquement des éléments de ligne transparente à des ordres d’insertion transparents. Pour obtenir des instructions sur la création d’éléments de ligne transparents, consultez Service d’élément de ligne - ALI.
- Utilisez les champs associés au budget et au rythme, ainsi que les
Pour créer un ordre d’insertion hérité (non transparent), vous devez :
- Utilisez les champs associés au budget et au rythme, ainsi que les
start_datechamps etend_datede l’objet d’ordre d’insertion main pour spécifier les dates pendant lesquelles l’ordre d’insertion doit s’exécuter, le budget disponible pendant ces dates et la façon dont les dépenses du budget doivent être rythmées. - Vérifiez que le
budget_intervalschamp est défini surnull. - Associez uniquement les éléments de ligne non transparents aux ordres d’insertion non transparents. Pour obtenir des instructions sur la création d’éléments de ligne non transparents, consultez Service d’élément de ligne.
- Utilisez les champs associés au budget et au rythme, ainsi que les
Importante
Les ordres d’insertion transparents sont le modèle préféré. Vous devez utiliser le workflow d’ordre d’insertion transparent lors de la création de nouveaux ordres d’insertion. Vous ne pouvez pas convertir un ordre d’insertion non transparent en un ordre d’insertion fluide ou lier des éléments de ligne non transparents à des ordres d’insertion transparents.
Dans l’interface utilisateur, l’API budget_intervals est appelée « Périodes de facturation ».
Remarque
Commandes d’insertion pour les articles de ligne augmentée à livraison garantie (GDALI)
Pour qu’un ordre d’insertion soit associé à un article de ligne augmentée à livraison garantie (GDALI), l’ordre d’insertion doit :
- Être un ordre d’insertion transparent (les ordres d’insertion hérités ne sont pas compatibles).
- Avez
budget_typedéfini sur"flexible"ou"impression". - Ne contient pas plus d’un
budget_intervalstableau. - Avoir un budget illimité (défini via le
budget_intervalstableau).
Les ordres d’insertion qui ne correspondent pas à ce qui précède peuvent uniquement être associés à des éléments de ligne non garantis. Les paramètres ci-dessus sont également requis pour les éléments de ligne garantis par programmation (PGLI). Un ordre d’insertion avec les paramètres ci-dessus peut également être associé à des éléments de ligne non garantis.
L’association d’un profile_id (par exemple, la limitation de fréquence ou la définition d’un ciblage supplémentaire) à l’objet d’ordre d’insertion peut entraîner une prévision ou une livraison inattendues pour les IGL et les GDALIs. Il est recommandé de ne pas utiliser pour les profile_id commandes d’insertion destinées à l’utilisation avec des GDALIs.
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
POST |
https://api.appnexus.com/insertion-order?advertiser_id=ADVERTISER_ID (ordre d’insertion JSON) |
Ajoutez un nouvel ordre d’insertion. |
PUT |
https://api.appnexus.com/insertion-order?id=INSERTIONORDER_ID& advertiser_id=ADVERTISER_ID (ordre d’insertion JSON) |
Modifier un ordre d’insertion existant. |
GET |
https://api.appnexus.com/insertion-order?advertiser_id=ADVERTISER_ID | Affichez tous les ordres d’insertion d’un de vos annonceurs. |
DELETE |
https://api.appnexus.com/insertion-order?id=INSERTIONORDER_ID& advertiser_id=ADVERTISER_ID Important: La suppression d’un ordre d’insertion ne signifie pas nécessairement que les éléments de ligne associés seront supprimés, car la relation entre un ordre d’insertion et un élément de ligne peut être plusieurs à plusieurs. En outre, la suppression d’un ordre d’insertion entraîne la suppression des intervalles budgétaires associés. |
Supprimer un ordre d’insertion. |
GET |
https://api.appnexus.com/insertion-order?id=INSERTIONORDER_ID | Afficher un ordre d’insertion spécifique pour l’un de vos annonceurs. |
GET |
https://api.appnexus.com/insertion-order?id=1,2,3 | Affichez plusieurs ordres d’insertion par ID à l’aide d’une liste séparée par des virgules. |
GET |
https://api.appnexus.com/insertion-order?search=SEARCH_TERM | Recherchez les ordres d’insertion avec des ID ou des noms contenant certains caractères. |
GET |
https://api.appnexus.com/insertion-order/meta | Découvrez les champs que vous pouvez filtrer et trier. |
Champs JSON
| Champ | Type | Description |
|---|---|---|
id |
int | ID de l’ordre d’insertion. Obligatoire sur : PUT |
name |
string | Nom de l’ordre d’insertion. (Maximum de 255 caractères.) Obligatoire sur : POST |
code |
string | Code personnalisé pour l’ordre d’insertion. Le code peut contenir uniquement des caractères alphanumériques, des points, des traits de soulignement ou des tirets. Le code que vous entrez ne respecte pas la casse (les caractères en majuscules et en minuscules sont traités de la même façon). 2 objets au même niveau (par exemple, des éléments de ligne) ne peuvent pas utiliser le même code par annonceur. Par exemple, les éléments de 2 lignes ne peuvent pas utiliser le code « XYZ », mais un seul élément de ligne et sa campagne enfant le peuvent. Note: Il peut également y avoir un code personnalisé par intervalle budgétaire. Pour plus d’informations, consultez le tableau Intervalles budgétaires ci-dessous. Par défaut: null |
state |
enum | État de l’ordre d’insertion. Valeurs possibles : "active" ou "inactive".Par défaut: "active" |
advertiser_id |
int | ID de l’annonceur. Obligatoire sur : POST |
start_date |
Timestamp | Date de début de l’ordre d’insertion non transparent. Si vous créez un ordre d’insertion transparent, ne définissez pas ce champ. Par défaut: null (immédiatement) |
end_date |
Timestamp | Date de fin de l’ordre d’insertion non transparent. Si vous créez un ordre d’insertion transparent, ne définissez pas ce champ. Par défaut: null (indéfiniment) |
remaining_days |
int | Nombre de jours entre aujourd’hui et pour end_date l’ordre d’insertion. Note: Il s’agit null de si est start_date dans le futur ou si ou n’est start_dateend_date pas défini.En lecture seule. |
total_days |
int | Nombre de jours entre et start_date pour end_date l’ordre d’insertion. Note: Ce sera null si ou n’est end_datestart_date pas défini.En lecture seule. |
last_modified |
Timestamp | Heure de la dernière modification de cette campagne. En lecture seule. |
timezone |
string | Fuseau horaire par lequel le budget et les dépenses sont comptés. Pour obtenir la liste des valeurs de fuseau horaire acceptables, consultez Fuseaux horaires d’API. Note: Tous PUT les appels au advertiser service inclus set_child_timezone=true dans la chaîne de requête entraînent la substitution de tous les paramètres de fuseau horaire sur les objets de niveau inférieur (par exemple, les ordres d’insertion, les éléments de ligne) par la valeur de fuseau horaire la plus récente pour cet annonceur.Par défaut: "EST5EDT" ou le fuseau horaire de l’annonceur. |
currency |
string | Devise affectée à l’ordre d’insertion. Pour obtenir la liste complète des devises disponibles, utilisez le service monétaire en lecture seule. Note: Une fois l’ordre d’insertion créé, la devise ne peut pas être modifiée. Par défaut: Devise par défaut de l’annonceur. |
comments |
string | Commentaires sur l’ordre d’insertion. |
billing_code |
string | Code de facturation de l’ordre d’insertion. Cela s’affiche uniquement sur les factures qui sont spécifiques à l’ordre d’insertion (par exemple, si vous recevez une facture par commande d’insertion). Pour plus d’informations sur les factures, consultez « Comprendre votre facture » dans la documentation financière. Par défaut: null |
line_items |
tableau d’objets | Éléments de ligne associés à l’ordre d’insertion. Pour plus d’informations, consultez Éléments de ligne ci-dessous. Note: Les commandes d’insertion transparente peuvent uniquement être associées à des éléments de ligne transparente. Les commandes d’insertions non transparentes ne peuvent être associées qu’à des éléments de ligne non transparents. |
labels |
tableau d’objets | Étiquettes affectées à l’ordre d’insertion. Voir Étiquettes ci-dessous. |
broker_fees |
tableau d’objets |
Avertissement: Pour les éléments de ligne augmentée (ALI) : Les frais de broker sont déconseillés pour les éléments de ligne augmentés. Create les frais du partenaire et les appliquer à l’élément de ligne à l’aide du service De frais partenaires. Pour les éléments de ligne standard : - Les frais de broker créés sur une commande d’insertion s’appliquent uniquement aux articles de ligne standard. Si vous utilisez également des éléments de ligne augmentés, vous devez créer et appliquer des frais de partenaire aux ALI à l’aide du service de frais de partenaire. - Les frais de répartiteur au niveau de l’article de ligne remplacent les frais de broker au niveau de l’ordre d’insertion. Commissions que le réseau doit transmettre aux courtiers lors de la diffusion d’une publicité. Ces commissions sont déduites du chiffre d’affaires réservé (le montant que le réseau reçoit de l’annonceur) et sont généralement destinées à l’échange d’une relation avec l’annonceur. Il peut s’agir d’un pourcentage du chiffre d’affaires ou d’un CPM plat. Pour plus d’informations, consultez Frais de broker ci-dessous. |
budget_intervals |
tableau d’objets |
Note: Ce tableau s’applique uniquement à et est nécessaire pour les ordres d’insertion transparents (si l’ordre d’insertion n’est pas transparent, laissez ce champ défini sur null). Les intervalles budgétaires permettent d’attacher plusieurs intervalles de date à un ordre d’insertion, chacun avec les valeurs budgétaires correspondantes. Pour plus d’informations, consultez Intervalles budgétaires ci-dessous. Remarque : Si vous utilisez budget_intervals, les champs suivants ne doivent pas être utilisés sur l’objet d’ordre d’insertion de niveau supérieur :- lifetime_pacing- lifetime_budget- lifetime_budget_imps- enable_pacing- lifetime_pacing_span- allow_safety_pacing- daily_budget- daily_budget_imps- lifetime_pacing_pct |
budget_type |
enum | Type de budget de l’ordre d’insertion. Les valeurs peuvent être 'revenue', 'impression'ou 'flexible'.- Si ce champ est défini sur 'impression' , les lifetime_budget champs et daily_budget doivent avoir la valeur null.- Si ce champ est défini sur 'revenue' , les lifetime_budget_imps champs et daily_budget_imps doivent avoir la valeur null.- Ce champ doit être défini lorsque les quatre champs de budget du budget_intervals tableau (lifetime_budget, , daily_budgetlifetime_budget_impset daily_budget_imps) ont la valeur null.- Si ce champ est défini sur 'flexible' , le budget_intervals tableau ne peut avoir qu’un seul intervalle et les quatre champs de budget du budget_intervals tableau (lifetime_budget, lifetime_budget_imps, daily_budgetet daily_budget_imps) doivent avoir la valeur null. |
lifetime_pacing |
valeur booléenne | Si truela valeur est , l’ordre d’insertion non transparent tente de dépenser son budget de durée de vie globale uniformément sur les dates de vol de la commande d’insertion. Si true:- Vous devez établir un lifetime_budget ou lifetime_budget_imps.- Vous devez établir un start_date et end_date.- Vous ne pouvez pas définir un daily_budget.- Vous ne pouvez pas définir enable_pacing sur false.Note: Applicable uniquement aux ordres d’insertion non transparents. Par défaut: null |
lifetime_budget |
double | Budget de durée de vie en revenus. La devise revenue est définie par le currency champ .Remarque : Applicable uniquement aux ordres d’insertion non transparents. Par défaut: null (illimité) |
lifetime_budget_imps |
int | Budget de durée de vie dans les impressions. Note: Si vous ajoutez des éléments de ligne à cet ordre d’insertion, toutes les dépenses déjà associées à ces éléments de ligne avant leur ajout à l’ordre d’insertion ne sont PAS comptabilisées dans le budget de durée de vie de l’ordre d’insertion. Seules les dépenses qui se produisent lorsque l’élément de ligne est un enfant de l’ordre d’insertion sont comptabilisées. Applicable uniquement aux ordres d’insertion non transparents. Par défaut: null (illimité) |
enable_pacing |
valeur booléenne | Si truela valeur est , les dépenses seront rythmées au cours de la journée. Applicable uniquement s’il existe un daily_budget.Note: Applicable uniquement aux ordres d’insertion non transparents. |
lifetime_pacing_span |
int | En cas d’événement sous-dépensé, cela indique le nombre de jours pendant lesquels le montant sous-dépensé sera distribué. Note: Applicable uniquement aux ordres d’insertion non transparents. Par défaut: null (3 jours) |
daily_budget |
double | Budget quotidien en recettes. La devise revenue est définie par le currency champ .Note: Si vous ajoutez des éléments de ligne à cet ordre d’insertion, toutes les impressions associées à ces éléments de ligne lorsqu’ils sont ajoutés à l’ordre d’insertion ne sont PAS comptabilisées dans le budget de durée de vie de l’ordre d’insertion. Seules les impressions qui se produisent lorsque l’élément de ligne est un enfant de l’ordre d’insertion sont comptabilisées. Applicable uniquement aux ordres d’insertion non transparents. Par défaut: null (illimité) |
daily_budget_imps |
int | Budget quotidien dans les impressions. Remarque : Applicable uniquement aux ordres d’insertion non transparents. Par défaut: null (illimité) |
lifetime_pacing_pct |
double | Un double entier compris entre 50 et 150, utilisé pour définir le rythme tout au long de la durée de vie de l’ordre d’insertion. Les valeurs possibles peuvent être n’importe quel double compris entre 50 et 150 sur l’échelle suivante : - 50: Rythme en retard.- 100: Rythme uniformément.- 150: Rythme en avance sur la planification.Note: Applicable uniquement aux ordres d’insertion non transparents. Avis alpha-bêta Ce champ ou cette fonctionnalité fait partie de la fonctionnalité actuellement en phase Alpha ou Bêta. Il est donc susceptible d’être modifié. Par défaut: 100 |
profile_id |
int | Spécifie l’ID du profil attaché à l’ordre d’insertion fluide (c’est-à-dire, doit utiliser budget_intervals). Un profil peut être utilisé pour définir la façon dont l’inventaire est ciblé et/ou comment la limitation de fréquence est appliquée (pour plus d’informations, consultez Service de profil). Un profil peut également être défini au niveau de l’annonceur, de l’élément de ligne, de la campagne et de la création. Le paramètre le plus restrictif est toujours prioritaire. |
stats |
objet | L’objet stats est déconseillé (depuis le 17 octobre 2016). Utilisez plutôt le service de rapports pour obtenir des informations statistiques. |
object_stats |
objet | Nombre d’éléments de ligne totaux, actifs et inactifs sous l’ordre d’insertion. Pour inclure cet objet dans une réponse GET, transmettez object_stats=true la chaîne de requête.En lecture seule. |
viewability_standard_provider |
string | Ce champ détermine la norme par rapport à laquelle mesurer la visibilité. Par exemple : iab.Remarque : Ce champ ne peut pas être modifié et s’affiche uniquement dans des ordres d’insertion transparents. Par défaut: 'iab' |
is_running_political_ads |
valeur booléenne | Déclare si cet ordre d’insertion contient ou non de la publicité politique (définie comme publicité liée à une élection, une initiative de vote ou un candidat politique, dans le États-Unis). Si truela valeur est , l’objet political_content est modifiable. Si trueet si l’ordre d’insertion cible un état avec des exigences supplémentaires en matière de rapports politiques, de nombreux champs de political_content l’objet sont requis. Pour plus d’informations sur les exigences de l’état, consultez Implémentation d’une stratégie de publicité politique. Pour plus d’informations sur l’objet political_content , consultez Contenu politique ci-dessous.is_running_political_ads doit être défini true sur sur l’annonceur à définir true sur dans l’ordre d’insertion. Pour plus d’informations, consultez le service Annonceur.Par défaut: 0false |
political_content |
objet | Informations sur la publicité politique menée avec cette ordonnance d’insertion. La publicité politique doit être activée sur l’annonceur et sur cet ordre d’insertion pour que cet objet soit modifiable. (Autrement dit, le champ is_running_political_ads doit se trouver true à la fois sur l’annonceur et sur l’ordre d’insertion.)Pour plus d’informations sur cet objet, consultez Contenu politique ci-dessous. |
Éléments de ligne
Chaque objet du line_items tableau contient les champs suivants.
| Champ | Type | Description |
|---|---|---|
id |
int | ID numérique associé à cet élément de ligne. Obligatoire sur : POST ou PUT. |
line_item_type |
enum | Type associé à l’élément de ligne enfant. Les valeurs possibles sont les suivantes : - "standard_v1": indique que l’élément de ligne enfant est un élément de ligne standard.- "standard_v2": indique que l’élément de ligne enfant est un élément de ligne augmenté.- "guaranteed": indique que l’élément de ligne enfant est un élément de ligne garanti.- "performance": ce type d’élément de ligne a été déprécié. |
name |
string | Nom de l’élément de ligne. |
code |
string | Si vous avez choisi d’associer un nom d’identification facultatif (un « code ») à cet élément de ligne, il s’affiche ici. |
state |
chaîne | Les éléments de ligne peuvent être "active" ou "inactive". |
end_date |
date | Date à laquelle les éléments de ligne cessent de servir. |
start_date |
date | Date à laquelle les éléments de ligne commencent à servir. |
timezone |
string | Fuseau horaire avec lequel l’élément de ligne est défini sur. Cela affectera les start_date et end_date. |
Étiquettes
Vous pouvez utiliser le service d’étiquette en lecture seule pour afficher toutes les étiquettes possibles pour les éléments de ligne, les annonceurs, les ordres d’insertion et les éditeurs. Ce service vous permet également d’afficher les étiquettes qui ont déjà été appliquées à votre ordre d’insertion.
| Champ | Type | Description |
|---|---|---|
value |
string (100) | Valeur affectée à l’étiquette. Par exemple, pour l’étiquette "Sales Rep" , il peut s’agir d’un nom tel que "Michael Sellers". |
id |
int | ID de l’étiquette. Obligatoire sur : POST ou PUT. |
name |
enum | Nom de l’étiquette. Valeurs possibles : - "Trafficker"- "Sales Rep"- "Campaign Type" |
Frais de répartiteur
Avertissement
Pour les éléments de ligne augmentée (ALI) :
Les frais de broker sont déconseillés pour les éléments de ligne augmentés. Create les frais du partenaire et les appliquer à l’élément de ligne à l’aide du service De frais partenaires.
Pour les éléments de ligne standard :
- Les frais de répartiteur créés sur un ordre d’insertion s’appliquent uniquement aux articles de ligne standard. Si vous utilisez également des éléments de ligne augmentés, vous devez créer et appliquer des frais de partenaire aux ALI à l’aide du service de frais de partenaire.
- Les frais de broker au niveau de l’article remplacent les frais de broker au niveau de l’ordre d’insertion.
Remarque
La prise en charge de la position décimale pour les frais de répartiteur dans l’interface utilisateur est de 1 place après la décimale. Par exemple, si vous définissez 16,67 % comme frais de courtier dans la section Commissions, après avoir économisé, la valeur se arrondit à 16,7 %. Toutefois, il n’existe aucune restriction sur le nombre de places après la décimale si l’API du service Commande d’insertion est utilisée pour créer les frais de répartiteur.
Chaque objet du broker_fees tableau contient les champs suivants.
| Champ | Type | Description |
|---|---|---|
broker_id |
int | ID du répartiteur. |
payment_type |
enum | Type de paiement au répartiteur. Valeurs possibles : - "cpm"- "revshare" |
value |
double | Valeur du paiement, en fonction du type de paiement. |
description |
string (255) | Description en forme libre de l’entrée des frais de courtier. |
Intervalles budgétaires
Remarque
Ce tableau est utilisé uniquement pour les ordres d’insertion transparents.
Tenez compte des éléments suivants lors de l’utilisation du budget_interval tableau :
- Les intervalles budgétaires doivent contenir un
start_dateetend_date. - Les plages de dates (c’est-à-dire ,
start_dateend_date) d’intervalles budgétaires différents dans le même ordre d’insertion ne peuvent pas se chevaucher. - Les intervalles budgétaires doivent contenir un
lifetime_budgetoulifetime_budget_imps. - Les intervalles budgétaires ne peuvent pas être utilisés si des champs de budget sur l’objet
insertion_orderlui-même sont définis. - Les modifications apportées à l’intervalle budgétaire (par exemple, les dates de début ou de fin) de l’ordre d’insertion doivent être répliquées manuellement sur tous les éléments de ligne enfants (à l’aide du
line-itemservice).- Pour les éléments de ligne standard , utilisez pour
parent_interval_idlier l’élément de ligne à son ordre d’insertion parent. Les dates de l’intervalle budgétaire sont automatiquement héritées par l’élément de ligne une fois cette association établie. Consultez Service d’élément de ligne. - Pour les éléments de ligne augmentée (ALI), assurez-vous que les dates de début et de fin de chaque intervalle budgétaire sont comprises dans les dates des intervalles budgétaires de l’ordre d’insertion parent. Consultez Service d’élément de ligne (augmenté).
- Pour les éléments de ligne standard , utilisez pour
- Un maximum de 52 intervalles de budget peut être créé par ordre d’insertion.
- Si vous souhaitez que l’intervalle de budget ait un budget illimité, les 4 champs de budget du tableau (
lifetime_budget,lifetime_budget_imps,daily_budgetetdaily_budget_imps) doivent avoir la valeurnull. Cela est autorisé uniquement si lelifetime_pacingchamp est défini sur"false".
Chaque objet du budget_intervals tableau contient les champs suivants.
| Champ | Type | Description |
|---|---|---|
id |
int | ID de l’intervalle budgétaire. |
start_date |
Timestamp | Date de début de l’intervalle budgétaire. Le format doit être AAAA-MM-JJ hh :mm :ss (hh :mm :ss doit être défini sur 00). |
end_date |
Timestamp | Date de fin de l’intervalle budgétaire. Le format doit être AAAA-MM-JJ hh :mm :ss (hh :mm :ss doit être défini sur 23:59:59). Si ce champ est défini sur null, l’intervalle budgétaire de l’ordre d’insertion s’exécute indéfiniment. Si vous définissez ce champ sur 'null':- Il ne peut pas y avoir plus d’un objet dans le budget_intervals tableau (c’est-à-dire, un maximum de 1 intervalle budgétaire).- Le lifetime_pacing champ doit définir sur "false".- Le "daily_budget" champ doit être défini sur null. |
timezone |
string | Fuseau horaire par lequel le budget et les dépenses sont comptés. Pour obtenir la liste des valeurs de fuseau horaire acceptables, consultez Fuseaux horaires d’API. La valeur par défaut est "EST5EDT" ou le fuseau horaire de l’annonceur. |
code |
string | Code personnalisé pour l’intervalle budgétaire. Le code peut contenir uniquement des caractères alphanumériques, des points, des traits de soulignement ou des tirets. Le code que vous entrez ne respecte pas la casse (les caractères en majuscules et en minuscules sont traités de la même façon). |
lifetime_budget |
double | Budget de la durée de vie en revenus pour l’intervalle de budget. La devise revenue est définie par le currency champ sur l’objet insertion_order .Note: Si vous définissez également le lifetime_budget_imps champ dans ce tableau, le budget épuisé en premier entraîne l’arrêt des dépenses. La meilleure pratique consiste à définir un seul de ces champs. |
lifetime_budget_imps |
int | Budget de durée de vie dans les impressions pour l’intervalle de budget. Note: Si vous ajoutez des éléments de ligne à cet ordre d’insertion, les dépenses déjà associées à ces éléments de ligne avant leur ajout à l’ordre d’insertion ne sont pas comptabilisées dans le budget de durée de vie de l’ordre d’insertion. Seules les dépenses qui se produisent lorsque l’élément de ligne est un enfant de l’ordre d’insertion sont comptabilisées. Ce champ est null défini par défaut sur (illimité).Remarque : Si vous définissez également le lifetime_budget champ dans ce tableau, le budget épuisé en premier entraîne l’arrêt des dépenses. La meilleure pratique consiste à définir un seul de ces champs. |
lifetime_pacing |
valeur booléenne | Si truela valeur est , l’ordre d’insertion tente d’accélérer le budget de durée de vie uniformément sur l’intervalle budgétaire. Si true:- Vous devez établir un lifetime_budget ou lifetime_budget_imps.- Vous devez établir un start_date et end_date.Vous ne pouvez pas définir de daily_budget.- Vous ne pouvez pas définir enable_pacing sur false. |
daily_budget |
double |
Remarque : Ce champ est null défini par défaut sur (illimité). Utilisez plutôt l’élément de ligne pour définir cette valeur.Si vous définissez également le daily_budget_imps champ dans ce tableau, le budget épuisé en premier entraîne l’arrêt des dépenses. La meilleure pratique consiste à définir un seul de ces champs. |
daily_budget_imps |
int |
Note: Ce champ est null défini par défaut sur (illimité). Utilisez plutôt l’élément de ligne pour définir cette valeur.Si vous définissez également le daily_budget champ dans ce tableau, le budget épuisé en premier entraîne l’arrêt des dépenses. La meilleure pratique consiste à définir un seul de ces champs. |
enable_pacing |
valeur booléenne | Si truela valeur est , les dépenses seront rythmées au cours de la journée. Applicable uniquement s’il existe un daily_budget. |
lifetime_pacing_pct |
double |
Remarque : Définissez ce champ sur 100 (valeur par défaut), puis utilisez l’élément de ligne pour définir le rythme de vie.Nombre entier double compris entre 50 et 150 (et compris), utilisé pour définir le rythme tout au long d’un intervalle budgétaire. Les valeurs possibles peuvent être n’importe quel double compris entre 50 et 150 sur l’échelle suivante : - 50: Rythme en retard.- 100: Rythme uniformément.- 150: Rythme en avance sur la planification. |
Contenu politique
Ce tableau ne peut être modifié que si :
-
is_running_political_adsest vrai sur le service Annonceur. -
is_running_political_adsa la valeur true dans l’ordre d’insertion.
Ces champs doivent être remplis si vous utilisez cet ordre d’insertion pour la publicité liée à une élection, une initiative de vote ou un candidat politique au niveau local ou de l’État dans le États-Unis, ou pour la publicité liée à une élection fédérale ou à un candidat politique dans l’État de Washington. Ils ne sont pas requis pour la publicité politique au niveau fédéral dans d’autres États.
Avertissement
Nous ne validons pas les champs obligatoires pour nous assurer qu’ils sont présents lorsque vous créez un ordre d’insertion, mais votre contenu créatif pour la publicité politique locale ou d’État ou la publicité fédérale qui cible l’État de Washington ne sera pas utilisé si les champs ne sont pas remplis. Toute mise à jour de l’objet political_content doit inclure tous les champs obligatoires ou la diffusion d’annonces peut être interrompue.
| Champ | Type | Description |
|---|---|---|
billing_name |
string | Nom de la personne ou du organization qui achète des annonces sur Xandr. Celui-ci est automatiquement renseigné avec le nom du membre Xandr. En lecture seule. |
billing_address_1 |
string(255) | Adresse postale de la personne ou organization qui achète des annonces sur Xandr. Entrez les coordonnées de la personne ou de l’équipe qui peut répondre le mieux à toutes les questions sur la publicité politique dans cet ordre d’insertion. Obligatoire. |
billing_address_2 |
string(255) | Ligne supplémentaire facultative pour l’adresse de facturation de la personne ou du organization qui achète des publicités sur Xandr. |
billing_city |
string(100) | Ville de l’adresse de facturation de la personne ou du organization qui achète des annonces sur Xandr. Obligatoire. |
billing_region |
string(50) | État ou région de l’adresse de facturation de la personne ou du organization qui achète des annonces sur Xandr. Obligatoire. |
billing_postal_code |
string(50) | Code postal ou postal de l’adresse de facturation de la personne ou organization qui achète des annonces sur Xandr. Obligatoire. |
billing_country |
string(50) | Pays de l’adresse de facturation de la personne ou du organization qui achète des annonces sur Xandr. Obligatoire. |
billing_phone_code |
string(10) | Code de pays pour le numéro de téléphone de la personne ou du organization qui achète des publicités sur Xandr. Obligatoire. |
billing_phone |
string(50) | Numéro de téléphone de la personne ou du organization qui achète des annonces sur Xandr. Obligatoire. |
us_fecid |
string(50) | Numéro d’identification attribué par la Commission électorale fédérale des États-Unis. |
organization_name |
string(100) | Nom de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité (le client qui vous paie). Par exemple, un candidat, une agence ou un consultant politique. Obligatoire. |
organization_address_1 |
string(255) | Adresse de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité. Par exemple, un candidat, une agence ou un consultant politique. Obligatoire. |
organization_address_2 |
string(255) | Deuxième ligne facultative pour l’adresse de la personne, du groupe, du organization ou de l’entreprise qui annonce. |
organization_city |
string(100) | Ville dans l’adresse de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité. Obligatoire. |
organization_region |
string(50) | État ou région dans l’adresse de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité. Obligatoire. |
organization_postal_code |
string(50) | Code postal ou postal de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité. Obligatoire. |
organization_country |
string(50) | Pays de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité. Obligatoire. |
organization_phone_code |
string(10) | Code de pays pour le numéro de téléphone de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité. Obligatoire. |
organization_phone |
string(50) | Numéro de téléphone de la personne, du groupe, du organization ou de l’entreprise qui fait de la publicité. Obligatoire. |
treasurer_name |
string(100) | Trésorier pour le comité achetant les annonces, ou la personne dont le rôle correspond le plus à celui d’un trésorier. Obligatoire. |
payment_method_type |
enum(1) | Comment le organization politique vous paie. Les options sont : - "Direct Debit"- "Check"- "Credit Card"- "Other". Si cette option est sélectionnée, payment_method_other est obligatoire.Obligatoire. |
political_objective |
string(255) | Le candidat ou l’initiative de vote qui est soutenu ou opposé. Cela correspond au champ Objet des annonces dans l’interface utilisateur. Obligatoire. |
payment_method_other |
string(50) | Si "4" (Autre) est sélectionné pour payment_method_type. Détails de la façon dont vous êtes payé pour la publicité politique.Obligatoire. |
is_independent_expenditure_committee |
Valeur booléenne | Spécifie si des publicités sont payées par un comité indépendant des dépenses : c’est-à-dire un tiers qui dépense de l’argent pour des communications politiques qui préconisent expressément l’élection ou la défaite d’un candidat clairement identifié et qui ne coordonne pas avec un candidat, le comité autorisé d’un candidat ou un agent du candidat. Obligatoire. |
registration_form |
tableau | Obligatoire pour NY et NJ quand is_independent_expenditure_committee a la valeur true. L’État de New York et le New Jersey exigent des copies des formulaires d’inscription de l’État provenant de comités de dépenses indépendants effectuant des achats. Creatives ne sera pas utilisé dans l’État de New York ou dans le New Jersey tant que le formulaire n’est pas chargé. Forms doivent être chargés avec le service de formulaire d’inscription avant de pouvoir spécifier leur emplacement dans ce tableau.Le tableau doit être au format suivant : {"file_path": "PATH_AND_FILE_NAME_OF_THE_UPLOADED_FILE"} |
is_ineligible |
Valeur booléenne | Vous avertit si tous les champs requis dans le tableau ont été remplis (à l’exception political_contentregistration_formde ) pour la publicité politique au niveau de l’État ou au niveau local. Si la valeur est true, les créatifs ne serviront pas. La valeur est recalculée chaque fois que l’ordre d’insertion est mis à jour.Remarque : Si is_ineligible a la valeur false, les créatifs peuvent toujours être interdits de servir, en fonction d’autres facteurs tels que le fait que le créatif a passé l’audit ou si un formulaire d’inscription a été chargé pour les achats d’annonces dans les États qui l’exigent.Pour plus d’informations sur l’audit créatif, consultez « Résolution des problèmes créatifs et FAQ » dans la documentation de l’interface utilisateur. En lecture seule. |
government_level |
enum | Si is_running_political_ads a la valeur true. Les valeurs autorisées sont les suivantes :- state or local- federal- both (valeur par défaut)Obligatoire. |
is_accuracy_acknowledged |
Valeur booléenne | Spécifie que le membre Xandr a certifié que les political_content informations fournies sont exactes et à jour et que Xandr s’appuie sur l’exactitude des informations fournies. Si la valeur est définie 0 sur (valeur par défaut), les éléments créatifs ne sont pas autorisés à servir.Obligatoire. |
Stats
Avertissement
L’objet stats a été déconseillé (17 octobre 2016). Utilisez plutôt le service de rapports pour obtenir des informations statistiques.
Exemples
Ajouter un nouvel ordre d’insertion fluide avec des intervalles budgétaires
$ cat insertion-order.json
{
"insertion-order": {
"name": "My Insertion Order LH_EP",
"budget_intervals": [
{
"start_date": "2030-10-10 00:00:00",
"end_date": "2030-10-12 23:59:59",
"daily_budget": null,
"daily_budget_imps": 10,
"enable_pacing": true,
"lifetime_budget": null,
"lifetime_budget_imps": 980,
"lifetime_pacing": false
},
{
"start_date": "2030-10-13 00:00:00",
"end_date": "2030-10-18 23:59:59",
"daily_budget": null,
"daily_budget_imps": 10,
"enable_pacing": true,
"lifetime_budget": null,
"lifetime_budget_imps": 6,
"lifetime_pacing": false
}
]
}
}
$ curl -b cookies -X POST -d @insertion-order.json "https://api.appnexus.com/insertion-order?advertiser_id=11'
{
"response": {
"status": "OK",
"count": 1,
"start_element": 0,
"num_elements": 100,
"insertion-orders": [
{
"id": 45797,
"name": "MyInsertionOrderLH_EP",
"code": null,
"state": "active",
"advertiser_id": 64,
"start_date": null,
"end_date": null,
"last_modified": "2015-03-1718: 41: 57",
"timezone": "EST5EDT",
"currency": "USD",
"budget_type": null,
"comments": null,
"billing_code": null,
"line_items": null,
"labels": null,
"broker_fees": null,
"budget_intervals": [
{
"id": 684,
"start_date": "2030-10-10 00:00:00",
"end_date": "2030-10-12 23:59:59",
"parent_interval_id": null,
"lifetime_budget": null,
"lifetime_budget_imps": 980,
"lifetime_pacing": false,
"enable_pacing": false,
"daily_budget_imps": 10,
"daily_budget": null
},
{
"id": 685,
"start_date": "2030-10-13 00:00:00",
"end_date": "2030-10-18 23:59:59",
"parent_interval_id": null,
"lifetime_budget": null,
"lifetime_budget_imps": 6,
"lifetime_pacing": false,
"enable_pacing": false,
"daily_budget_imps": 10,
"daily_budget": null
}
],
"lifetime_pacing": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"enable_pacing": null,
"lifetime_pacing_span": null,
"allow_safety_pacing": null,
"daily_budget": null,
"daily_budget_imps": null
}
]
}
}
Ajouter un nouvel ordre d’insertion fluide avec un type de budget flexible
$ cat insertion-order.json
{
"insertion-order": {
"name": "Test-Seamless-IO-GDALI",
"advertiser_id": "33514",
"timezone": "UTC",
"budget_type": "flexible",
"budget_intervals": [{
"start_date": "2022-11-01 00:00:00",
"timezone": "UTC"
}],
"currency": "USD"
}
}
curl -b cookies -X POST -d @insertion-order.json "https://api.appnexus.com/insertion-order?advertiser_id=33514&member_id=958"
{
"response": {
"status": "OK",
"count": 1,
"id": 6784364,
"start_element": 0,
"num_elements": 100,
"insertion-order": {
"id": 6784364,
"name": "Test-Seamless-IO-GDALI",
"code": null,
"state": "active",
"advertiser_id": 33514,
"profile_id": null,
"member_id": 958,
"start_date": null,
"end_date": null,
"remaining_days": null,
"total_days": null,
"last_modified": "2022-01-26 20:00:29",
"timezone": "UTC",
"currency": "USD",
"comments": null,
"budget_type": "flexible",
"billing_code": null,
"viewability_standard_provider": "iab",
"is_running_political_ads": false,
"line_items": null,
"labels": null,
"broker_fees": null,
"budget_intervals": [{
"id": 16134020,
"object_id": 6784364,
"object_type": "insertion_order",
"start_date": "2022-11-01 00:00:00",
"end_date": null,
"timezone": "UTC",
"code": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"daily_budget_imps": null,
"daily_budget": null,
"enable_pacing": false,
"lifetime_pacing": false,
"lifetime_pacing_pct": null,
"daily_budget_imps_opt": null,
"daily_budget_opt": null
}],
"tpas_details": null,
"political_content": null,
"lifetime_pacing": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"enable_pacing": null,
"lifetime_pacing_span": null,
"allow_safety_pacing": null,
"daily_budget": null,
"daily_budget_imps": null,
"lifetime_pacing_pct": null
}
}
}
Ajouter un nouvel ordre d’insertion non transparent
$ cat insertion-order.json
{
"insertion-order":{
"name":"My Insertion Order"
}
}
$ curl -b cookies -X POST -d @insertion-order.json "https://api.appnexus.com/insertion-order?advertiser_id=11"
{
"response":{
"status":"OK",
"id":2
}
}
Afficher toutes les commandes d’insertion pour l’annonceur 11
$ curl -b cookies "https://api.appnexus.com/insertion-order?advertiser_id=11"
"response":{
"status":"OK",
"count":2,
"start_element":0,
"num_elements":100,
"insertion-orders":[
{
"id":1,
"name":"TEST CPM IO",
"code":null,
"billing_code":"3az56",
"state":"active",
"advertiser_id":11,
"start_date":"2010-07-01 00:00:00",
"end_date":"2010-09-01 23:59:59",
"last_modified":"2010-08-02 23:44:14",
"timezone":"EST5EDT",
"currency":"USD",
"budget_type": null,
"comments":null,
"users":null,
"line_items":[
{
"id":5588,
"line_item_type": "standard_v1",
"name":"Test IO Line Item CPM",
"code":null,
"state":"active",
"start_date":null,
"end_date":null,
"timezone":"EST5EDT"
}
],
"labels":null,
"broker_fees":null,
"lifetime_budget":null,
"lifetime_budget_imps":1000,
"daily_budget":null,
"daily_budget_imps":100,
"enable_pacing":true,
"lifetime_pacing":false,
"lifetime_pacing_span":null,
"allow_safety_pacing":true
},
{
"id":2,
"name":"TEST CPM IO - Expired Flight Dates",
"code":null,
"billing_code":null,
"state":"active",
"advertiser_id":2396,
"start_date":"2010-06-01 00:00:00",
"end_date":"2010-06-30 23:59:59",
"last_modified":"2010-07-30 01:29:28",
"timezone":"EST5EDT",
"currency":"USD",
"budget_type": null,
"comments":null,
"users":null,
"line_items":[
{
"id":5588,
"line_item_type": "standard_v1",
"name":"Test IO Line Item CPM",
"code":null,
"state":"active",
"start_date":null,
"end_date":null,
"timezone":"EST5EDT"
}
],
"labels":null,
"broker_fees":null,
"lifetime_budget":null,
"lifetime_budget_imps":1000,
"daily_budget":null,
"daily_budget_imps":100,
"enable_pacing":true,
"lifetime_pacing":false,
"lifetime_pacing_span":null,
"allow_safety_pacing":true
}
]
}
Supprimer un intervalle budgétaire (dans un ordre d’insertion fluide)
Remarque
La suppression d’intervalles budgétaires sur un ordre d’insertion affecte différemment les éléments de ligne sous-jacents, en fonction de leur type :
- Pour les éléments de ligne non-ALI (augmenté) : la suppression des intervalles budgétaires dans l’ordre d’insertion parent supprime automatiquement l’intervalle budgétaire approprié sur les éléments de ligne. N’essayez pas de supprimer les intervalles budgétaires de l’objet élément de ligne. Utilisez toujours l’ordre d’insertion parent pour supprimer un intervalle budgétaire.
- Pour les éléments de ligne ALI : vous ne pouvez pas supprimer un intervalle budgétaire sur une insertion parente tant que vous ne l’avez pas d’abord supprimé de tous les éléments de ligne augmentés sous-jacents associés à l’ordre d’insertion. Étant donné que les éléments de ligne augmentée peuvent avoir plusieurs intervalles de budget dans un intervalle budgétaire donné sur l’ordre d’insertion parent, veillez à supprimer tous les intervalles budgétaires sur l’élément de ligne de ligne augmentée qui entrent dans l’intervalle budgétaire de l’ordre d’insertion que vous envisagez de supprimer. Une fois que les intervalles budgétaires ont été supprimés des éléments de ligne augmentés, ils peuvent être supprimés de l’ordre d’insertion.
//To delete a budget interval, both the "start_date" and "end_date" fields must be set to null.
$ cat delete-budget-interval
{
"insertion-order": {
"budget_intervals": [
{
"id": 79970,
"start_date": null,
"end_date": null
}
]
}
}
$ curl -b cookies -X PUT -d @delete-budget-interval "https://api.appnexus.com/insertion-order?id=357903"
{
"response": {
"status": "OK",
"count": 1,
"id": "357903",
"start_element": 0,
"num_elements": 100,
"insertion-order": {
"id": 357903,
"name": "Seamless Insertion Order",
"code": null,
"state": "active",
"advertiser_id": 1133550,
"start_date": null,
"end_date": null,
"remaining_days": null,
"total_days": null,
"last_modified": "2016-07-26 21:33:34",
"timezone": "America/Argentina/Buenos_Aires",
"currency": "USD",
"budget_type": null,
"comments": null,
"billing_code": null,
"line_items": [
{
"id": 3188266,
"line_item_type": "standard_v1",
"name": "Seamless Line Item",
"code": null,
"state": "active",
"start_date": null,
"end_date": null,
"timezone": "America/Argentina/Buenos_Aires"
}
],
"spend_protection_pixels": null,
"labels": null,
"broker_fees": null,
"budget_intervals": [
{
"id": 79969,
"object_id": 357903,
"object_type": "insertion_order",
"start_date": "2016-08-01 00:00:00",
"end_date": "2016-08-31 23:59:59",
"code": null,
"timezone": "America/Argentina/Buenos_Aires",
"lifetime_budget": 100,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"enable_pacing": true,
"daily_budget_imps": null,
"daily_budget": null
}
],
"tpas_details": null,
"lifetime_pacing": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"enable_pacing": null,
"lifetime_pacing_span": null,
"allow_safety_pacing": null,
"daily_budget": null,
"daily_budget_imps": null,
"lifetime_pacing_pct": null
},
"dbg_info": {
...
}
}
}
Modifier un intervalle budgétaire (dans un ordre d’insertion transparent)
$ cat modify-budget-interval
{
"insertion-order": {
"budget_intervals": [
{
"id": 79969,
"lifetime_budget": 100
}
]
}
}
$ curl -b cookies -X PUT -d @modify-budget-interval "https://api.appnexus.com/insertion-order?id=357903"
{
"response": {
"status": "OK",
"count": 1,
"id": "357903",
"start_element": 0,
"num_elements": 100,
"insertion-order": {
"id": 357903,
"name": "Seamless Insertion Order",
"code": null,
"state": "active",
"advertiser_id": 1133550,
"start_date": null,
"end_date": null,
"remaining_days": null,
"total_days": null,
"last_modified": "2016-07-29 17:26:26",
"timezone": "America/Argentina/Buenos_Aires",
"currency": "USD",
"budget_type": null,
"comments": null,
"billing_code": null,
"line_items": null,
"spend_protection_pixels": null,
"labels": null,
"broker_fees": null,
"budget_intervals": [
{
"id": 79969,
"object_id": 357903,
"object_type": "insertion_order",
"start_date": "2016-08-01 00:00:00",
"end_date": "2016-08-31 23:59:59",
"code": null,
"timezone": "America/Argentina/Buenos_Aires",
"lifetime_budget": 100,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"enable_pacing": true,
"daily_budget_imps": null,
"daily_budget": null
}
],
"tpas_details": null,
"lifetime_pacing": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"enable_pacing": null,
"lifetime_pacing_span": null,
"allow_safety_pacing": null,
"daily_budget": null,
"daily_budget_imps": null,
"lifetime_pacing_pct": null
},
"dbg_info": {
...
}
}
}
Supprimer un ordre d’insertion
curl -b cookies -X DELETE "https://api.appnexus.com/insertion-order?id=5851054&advertiser_id=5413231"
{"response":
{
"status":"OK",
"count":1,
"start_element":null,
"num_elements":null,
"dbg_info":
{
"warnings":[],
"version":"1.0.190",
"output_term":"not_found"}
}
}
}