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.
Remarque
Ce service est actuellement disponible pour un ensemble limité de clients et d’employés Microsoft uniquement.
Ces documents (et la fonctionnalité associée) sont visibles uniquement pour les clients sélectionnés. N’envoyez pas de liens vers ces documents ou mention cette fonctionnalité aux clients, sauf si vous avez confirmé qu’ils doivent y avoir accès.
Le service d’ajustement est utilisé pour apporter des modifications aux valeurs des revenus réservés et des coûts multimédias dans les rapports.
Types d’ajustement
Vous pouvez actuellement effectuer trois types d’ajustements de rapports :
Ajustements de l’annonceur
-
advertiser_revenue- Ce type d’ajustement modifie le chiffre d’affaires réservé et/ou les impressions, les clics et les conversions que vous voyez dans les rapports d’un annonceur et ajuste le paiement de vos coûts multimédias pour les éditeurs de partage de nouveau. Consultez le premier exemple ci-dessous pour plus d’informations sur la façon dont le paiement aux éditeurs revshare est ajusté. -
advertiser_credit- Ce type d’ajustement modifie le chiffre d’affaires réservé et/ou les impressions, les clics et les conversions que vous voyez dans les rapports pour un annonceur. Il n’ajuste pas le paiement de vos coûts multimédias aux éditeurs de repartage.
Ajustements de l’éditeur
"publisher" - Ce type d’ajustement modifie le coût du média et/ou les impressions, clics et conversions que vous voyez dans les rapports pour un éditeur.
Status d’ajustement
Les ajustements sont appliqués de façon asynchrone aux rapports et apparaissent plusieurs heures après leur création. Le service d’ajustement fournit une interface pour case activée la status actuelle d’un ajustement.
Remarque
Pour que les ajustements soient traités, les objets associés doivent être actifs. Par exemple, si un élément de ligne est inactif, les travaux d’ajustement associés ne sont pas exécutés.
L’état peut être l’une des valeurs suivantes :
| État | Description |
|---|---|
new |
Des ajustements ont été effectués dans le système. |
pending |
L’ajustement a été récupéré pour traitement. |
processing |
L’ajustement est en cours de traitement. |
propagating |
L’ajustement est terminé et se propage aux caches de rapports. |
completed |
L’ajustement est terminé et doit être disponible dans les rapports. |
failed |
Erreur lors du traitement de l’ajustement. |
cancelled |
Ajustement annulé par l’utilisateur. |
API REST
| HTTP, méthode | Endpoint | Description |
|---|---|---|
POST |
https://api.appnexus.com/adjustment |
Pour ajouter un nouvel ajustement |
PUT |
https://api.appnexus.com/adjustment?id=ADJUSTMENT_ID |
Pour modifier ou annuler un ajustement existant : |
GET |
https://api.appnexus.com/adjustment |
Pour afficher tous les ajustements : |
GET |
https://api.appnexus.com/adjustment?advertiser_id=ADVERTISER_ID |
Pour afficher tous les ajustements pour un annonceur : |
GET |
https://api.appnexus.com/adjustment?id=ADJUSTMENT_ID |
Pour afficher un ajustement spécifique : |
GET |
https://api.appnexus.com/adjustment?state=new,processing,propagating,pending,completed,failed,cancelled |
Pour afficher tous les ajustements dans un état donné : |
GET |
https://api.appnexus.com/adjustment?like_start_date=START_DATE&like_end_date=END_DATE |
Pour afficher tous les ajustements au cours d’une période donnée : |
Champs JSON
Généralités
| Champ | Type | Description |
|---|---|---|
adjustment_type |
enum |
Par défaut : "advertiser_revenue"Type d’ajustement. Valeurs possibles : - "advertiser_revenue" - Ajuste le montant des revenus de l’annonceur sur le réseau et réattribue également les paiements de repartage aux éditeurs.- "advertiser_credit" - Modifie uniquement le montant des revenus de l’annonceur, mais ne réattribue pas les paiements de l’éditeur.- "publisher" - Ajuste le coût média payé par le réseau à l’éditeur. |
created_on |
DateHeure | Date et heure de création de la demande d’ajustement. |
end_date |
DateHeure |
Par défaut : Yesterday Date de fin de la période d’ajustement. Cela doit être au moins 24 heures dans le passé. |
id |
int |
Par défaut : nombre incrémenté automatiquement (par exemple, 123) Obligatoire Sur : PUT, dans la chaîne de requête.Identificateur unique de l’ajustement. |
last_modified |
DateHeure | Date et heure de la dernière modification de la demande d’ajustement. |
member_id |
int | ID du membre propriétaire de l’ajustement. |
notes |
string | Remarque facultative à associer à cet ajustement. |
start_date |
DateHeure |
Obligatoire sur : POST Date de début de l’ajustement. Les ajustements seront appliqués uniformément sur l’intervalle de temps défini par start_date et end_date.Les ajustements ne sont éligibles au traitement que s’ils ont un start_date dans les 90 jours suivant la tentative d’exécution de l’ajustement. |
status |
enum |
Par défaut : "new" État de traitement actuel de l’ajustement. Valeurs possibles : - "new" - "processing" - "propagating" - "pending" - "completed" - "failed" - "cancelled". |
timezone |
string |
Valeur par défaut : fuseau horaire du membre par défaut Fuseau horaire dans lequel l’ajustement sera effectué. Des ajustements seront effectués à la première heure du jour du fuseau horaire donné. Pour obtenir la liste des valeurs de fuseau horaire acceptables, consultez Fuseaux horaires d’API. |
user_id |
int | ID de l’utilisateur qui a effectué l’ajustement. |
Ajustements de l’annonceur
| Champ | Type | Description |
|---|---|---|
booked_revenue |
double | Le nouveau chiffre d’affaires réservé payé par l’annonceur au réseau sur la période d’ajustement donnée (start_date à end_date). Si la null valeur est définie ou laissée à vide, le chiffre d’affaires réservé ne sera pas modifié. |
clicks |
int | Valeur facultative pour le nombre de clics sur la période d’ajustement. Notez que la modification du nombre de clics sur un élément de ligne DUT n’affectera pas le chiffre d’affaires réservé de l’élément de ligne. S’il est défini sur null ou laissé vide, les clics ne sont pas modifiés. |
delete_overlapping_adjustments |
valeur booléenne |
Valeur par défaut : true, si adjustment_type est "advertiser_revenue" Si truela valeur est , tous les ajustements antérieurs au même élément de ligne dans la date de début/de fin de l’ajustement actuel sont supprimés avant l’application de l’ajustement. |
imps |
int | Valeur facultative pour le nombre d’impressions sur la période d’ajustement. Notez que la modification du nombre d’imps sur un élément de ligne CPM n’affecte pas le chiffre d’affaires réservé de l’élément de ligne. Pour modifier le paiement de l’annonceur au réseau, vous devez définir booked_revenue séparément. S’il est défini sur null ou laissé vide, les imps ne sont pas modifiés. |
line_item_id |
int |
Obligatoire sur : POST, si adjustment_type est "advertiser_revenue" ou "advertiser_credit".ID de l’élément de ligne à ajuster. |
post_click_convs |
int | Valeur facultative pour le nombre de conversions post-clic sur la période d’ajustement. Notez que la modification du nombre de conversions post-clic sur un élément de ligne CPA n’affecte pas le chiffre d’affaires réservé de l’élément de ligne. Si la valeur est définie null sur ou est vide, les conversions post-clic ne sont pas modifiées. |
post_view_convs |
int | Valeur facultative pour le nombre de conversions de post-affichage sur la période d’ajustement. Notez que la modification du nombre de conversions d’affichage de publication sur un élément de ligne CPA n’affecte pas le chiffre d’affaires réservé de l’élément de ligne. S’il est défini sur null ou laissé vide, les conversions de post-affichage ne seront pas modifiées. |
Ajustements de l’éditeur
| Champ | Type | Décrit |
|---|---|---|
clicks |
int | Valeur facultative pour le nombre de clics sur la période d’ajustement. |
country |
string | Code à deux lettres pour le pays pour lequel les données d’impression seront ajustées. |
height |
int | Hauteur des placements pour lesquels les données seront ajustées. |
imp_types |
string |
Par défaut : "kept"Types d’impressions pour lesquels les données seront ajustées. Valeurs possibles : - "default": un élément créatif par défaut a été fourni, car aucune offre de campagne ou aucun autre élément créatif n’était éligible.- "kept": l’un de vos annonceurs gérés a servi un créatif.- "resold": L’impression a été vendue à un acheteur tiers. |
imps |
int | Valeur facultative pour le nombre d’impressions sur la période d’ajustement. |
media_cost |
Argent | Le coût des nouveaux médias payé par le réseau à l’éditeur sur la période d’ajustement donnée (start_date à end_date). S’il null est défini sur ou laissé vide, le coût du support n’est pas modifié. |
media_type |
objet | Type de média pour lequel les données seront ajustées. Valeurs possibles : - "banner" - "pop" - "text" - "interstitial" - "expandable" - "video". |
placement_id |
int |
Obligatoire Sur : POST, si adjustment_type a la valeur "publisher". ID du placement pour lequel les données seront ajustées. |
post_click_convs |
int | Valeur facultative pour le nombre de conversions post-clic sur la période d’ajustement. |
post_view_convs |
int | Valeur facultative pour le nombre de conversions de post-affichage sur la période d’ajustement. |
publisher_id |
int | ID de l’éditeur pour lequel les données seront ajustées. |
site_id |
int | ID du site pour lequel les données seront ajustées. |
width |
int | Largeur des emplacements pour lesquels les données seront ajustées. |
Exemples
Ajustement du chiffre d’affaires et du nombre d’impressions des annonceurs avec attribution aux éditeurs
Pour "advertiser_revenue" les ajustements, l’attribution des ajustements de recettes comptabilisées aux éditeurs de repartage est effectuée proportionnellement en fonction du nombre d’impressions servies par un éditeur.
Remarque
- L’annonceur exécute un élément de ligne CPM de 1 $.
- Xandr enregistre 10 000 impressions et 10 $ de recettes réservées pour cet article de ligne, servi dans 3 éditeurs.
- L’annonceur enregistre 9 000 impressions et offre à payer 9 $.
Rapport avant ajustement
| Élément de ligne de l’annonceur | Éditeur | Règle de paiement | Impressions | Chiffre d’affaires réservé | Coût du média |
|---|---|---|---|---|---|
| Élément de ligne CPM $1 | Éditeur 1 | Règle de paiement revshare 60 % | 1 000 | 1,00 $ | 0,60 $ |
| Élément de ligne CPM $1 | Éditeur 2 | Règle de paiement revshare 60 % | 5,000 | $5.00 | 3,00 $ |
| Élément de ligne CPM $1 | Éditeur 3 | Règle de paiement CPM de 0,50 $ | 1 000 | 1,00 $ | $0.50 |
| Élément de ligne CPM $1 | Éditeur 4 | Règle de paiement revshare 70 % | 3,000 | 3,00 $ | 2,10 $ |
Pour ajuster le chiffre d’affaires à 9 $ et les impressions à 9 000 pour l’élément de ligne, vous créez et POST le fichier au format JSON suivant :
$ cat adjustment
{
"adjustment": {
"adjustment_type": "advertiser_revenue",
"line_item_id": 4243,
"booked_revenue": 9.00,
"imps": 9000
"start_date": "2011-01-01 00:00:00",
"end_date": "2011-01-01 23:59:59",
"note": "This is a note..."
}
}
$ curl -b cookies -c cookies -X POST -d @adjustment 'https://api.appnexus.com/adjustment'
Rapport après ajustement
| Élément de ligne de l’annonceur | Éditeur | Règle de paiement | Impressions ajustées | Chiffre d’affaires rajusté | Coût du support ajusté |
|---|---|---|---|---|---|
| Élément de ligne CPM $1 | Éditeur 1 | Règle de paiement revshare 60 % | 1 000 | 0,90 $ | 0,54 $ |
| Élément de ligne CPM $1 | Éditeur 2 | Règle de paiement revshare 60 % | 5,000 | 4,50 $ | 2,70 $ |
| Élément de ligne CPM $1 | Éditeur 2 | Règle de paiement CPM de 0,50 $ | 1 000 | 0,90 $ | $0.50 |
| Élément de ligne CPM $1 | Éditeur 3 | Règle de paiement revshare 70 % | 3,000 | 2,70 $ | 1,89 $ |
| Élément de ligne CPM $1 | - | - | -1,000 | $0.00 | $0.00 |
Remarque
Nous insérons une ligne supplémentaire pour les modifications apportées aux nombres d’impression, de clic ou de conversion. Cette ligne s’affiche dans les rapports réseau lors du regroupement par Publisher. Toutefois, cette ligne n’apparaît pas dans les rapports exécutés par les annonceurs, car ils ne peuvent pas les regrouper par serveur de publication.
Le coût des médias n’est pas ajusté pour les éditeurs payés sur une base cpm, ni pour les paiements aux autres membres de la plateforme.
Ajustement du chiffre d’affaires publicitaire et de l’impression, des clics et du nombre de conversions sans attribution aux éditeurs
$ cat adjustment
{
"adjustment": {
"adjustment_type": "advertiser_credit",
"line_item_id": 4321,
"booked_revenue": 100.00,
"imps": 10000,
"clicks": 10,
"conversions": 1,
"start_date": "2011-01-01 00:00:00",
"end_date": "2011-01-01 23:59:59",
"note": "This is a note..."
}
}
Ajustement du coût multimédia de l’éditeur et du nombre d’impressions pour les placements servis avec des créatifs
Rapport avant ajustement
| Éditeur | Site | Placement | Règle de paiement | Pays | Size | Type de média | Type de paiement | Coût du média | Lutins |
|---|---|---|---|---|---|---|---|---|---|
| NY Post | Professionnel | Page d’accueil | $1 CPM | US | 728x90 | Bannière | Propriétaire CPM | 1 | 1000 |
| NY Post | Professionnel | Page d’accueil | $1 CPM | CA | 728x90 | Bannière | Propriétaire CPM | 0.5 | 500 |
| NY Post | Professionnel | Fenêtre contextuelle de la page d’accueil | $10 CPM | US | 0x0 | Popup | Propriétaire CPM | 10 | 1000 |
| NY Post | Professionnel | Page d’accueil | $2 CPM | US | 300x250 | Bannière | Propriétaire CPM | 2 | 1000 |
| NY Post | Professionnel | Page d’accueil | 60 % revshare | GO | 300x250 | Bannière | Partage de rév. propriétaire | 1.25 | 500 |
Pour ajuster le coût multimédia à 10 $ et les impressions à 3 500 , vous créez et POST le fichier au format JSON suivant :
$ cat adjustment
{
"adjustment": {
"adjustment_type": "publisher",
"publisher_id": 23,
"media_cost": 10.00,
"imps": 3500,
"start_date": "2011-01-01 00:00:00",
"end_date": "2011-01-01 23:59:59",
"note": "This is a note...",
"imp_types": [
"resold"
]
}
}
$ curl -b cookies -c cookies -X POST -d @adjustment 'https://api.appnexus.com/adjustment'
Rapport après ajustement
| ID d’ajustement | Éditeur | Site | Placement | Règle de paiement | Pays | Size | Type de média | Type de paiement | Coût du média | Lutins |
|---|---|---|---|---|---|---|---|---|---|---|
| 0 | NY Post | Professionnel | Page d’accueil | $1 CPM | US | 728x90 | Bannière | Propriétaire CPM | 1 | 1000 |
| 1 | NY Post | Professionnel | Page d’accueil | $1 CPM | US | 728x90 | Bannière | Propriétaire CPM | -0.322033898305085 | -125 |
| 0 | NY Post | Professionnel | Page d’accueil | $1 CPM | CA | 728x90 | Bannière | Propriétaire CPM | 0.5 | 500 |
| 1 | NY Post | Professionnel | Page d’accueil | $1 CPM | CA | 728x90 | Bannière | Propriétaire CPM | -0.161016949152542 | -62.5 |
| 0 | NY Post | Professionnel | Fenêtre contextuelle de la page d’accueil | $10 CPM | US | 0x0 | Popup | Propriétaire CPM | 10 | 1000 |
| 1 | NY Post | Professionnel | Fenêtre contextuelle de la page d’accueil | $10 CPM | US | 0x0 | Popup | Propriétaire CPM | 3.22033898305085 | -125 |
| 0 | NY Post | Professionnel | Page d’accueil | $2 CPM | US | 300x250 | Bannière | Propriétaire CPM | 2 | 1000 |
| 1 | NY Post | Professionnel | Page d’accueil | $2 CPM | US | 300x250 | Bannière | Propriétaire CPM | -0.64406779661017 | -125 |
| 0 | NY Post | Professionnel | Page d’accueil | 60 % revshare | GO | 300x250 | Bannière | Partage de rév. propriétaire | 1.25 | 500 |
| 1 | NY Post | Professionnel | Page d’accueil | 60 % revshare | GO | 300x250 | Bannière | Partage de rév. propriétaire | -0.402542372881356 | -62.5 |
Annulation d’un ajustement
Vous pouvez annuler les ajustements qui ont le status "new" ou "pending".
$ cat modify_adjustment
{
"adjustment": {
"id": 5,
"status": "cancelled"
}
}
$ curl -b cookies -c cookies -X PUT -d @modify_adjustment 'https://api.appnexus.com/adjustment'
Affichage de tous les ajustements
$ curl -b cookies -c cookies 'https://api.appnexus.com/adjustment'
{
"response": {
"status": "OK",
"count": 2,
"start_element": 0,
"num_elements": 100,
"adjustments": [
{
"id": 5,
"member_id": 294,
"line_item_id": 2725,
"timezone": "EST5EDT",
"start_date": "2011-03-02 00:00:00",
"end_date": "2011-03-04 23:59:59",
"status": "completed",
"adjustment_type": "advertiser_revenue",
"booked_revenue": 100,
"imps": 2000,
"clicks": null,
"post_click_convs": null,
"post_view_convs": null,
"notes": null,
"created_on": "0000-00-00 00:00:00",
"last_modified": "2011-03-15 17:56:40",
"publisher_id": null,
"site_id": null,
"placement_id": null,
"payment_rule_id": null,
"width": null,
"height": null,
"country": null,
"imp_type_kept": false,
"imp_type_resold": false,
"imp_type_default": false,
"media_cost": null,
"delete_overlapping_adjustments": false,
"media_type": null,
"user": null,
"imp_types": null
},
{
"id": 6,
"member_id": 294,
"line_item_id": 2725,
"timezone": "EST5EDT",
"start_date": "2011-03-02 00:00:00",
"end_date": "2011-03-04 23:59:59",
"status": "completed",
"adjustment_type": "advertiser_revenue",
"booked_revenue": 200,
"imps": 1000,
"clicks": null,
"post_click_convs": null,
"post_view_convs": null,
"notes": null,
"created_on": "0000-00-00 00:00:00",
"last_modified": "2011-03-16 22:56:29",
"publisher_id": null,
"site_id": null,
"placement_id": null,
"payment_rule_id": null,
"width": null,
"height": null,
"country": null,
"imp_type_kept": false,
"imp_type_resold": false,
"imp_type_default": false,
"media_cost": null,
"delete_overlapping_adjustments": false,
"media_type": null,
"user": null,
"imp_types": null
},
...
]
}
}