Contenu
GET programmedetails
Qui peut l'utiliser
Comment l'appeler
À quoi ressemble la réponse
Quels champs de données fournissons-nous
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
GET programmedetails
Les éditeurs reçoivent un ensemble de KPI des programmes avec lesquels ils travaillent, ainsi que la gamme de commissions (à travers les groupes de commission) qu'ils reçoivent dans les programmes.
Qui peut l'utiliser
Les éditeurs qui ont un membre actif d’un programme.
Comment l'appeler
https://api.awin.com/publishers/45628/programmedetails?advertiserId=1001
https://api.awin.com/publishers/45628/programmedetails?advertiserId=1001&relationship=any si le paramètre de relation " any " est sélectionné, l'état actuel de la relation sera renvoyé.
Ajoutez le paramètre 'accessToken' pour fournir votre clé d'accès comme décrit dans le document Comment puis-je générer ma clé d'accès à l'API éditeur ?
À quoi ressemble la réponse
{
"programmeInfo": {
"displayUrl": "https://www.example.com",
"logoUrl": "http://www.affiliatewindow.com/logos/1001/logo.gif",
"clickThroughUrl": "http://www.awin1.com/awclick.php?mid=1001&id=45628",
"id": 1001,
"name": "Example Advertiser",
"currencyCode": "GBP",
"deeplinkEnabled": "true",
"description": "Advertiser programme description.",
"membershipStatus": "joined",
"primaryRegion": {
"name": "United Kingdom",
"countryCode": "GB"
}
"validDomains": [
{
"domain": "www.exampledomain1.com"
},
{
"domain": "www.anotherexample.com"
},
{
"domain": "www.example.com"
}
]
},
"kpi": {
"averagePaymentTime": "44",
"approvalPercentage": 70.19,
"epc": 0.47,
"conversionRate": 2.09,
"validationDays": 9,
"awinIndex": 67.65
},
"commissionRange": [
{
"min": 0,
"max": 50,
"type": "amount"
}
]
}
Remarque: si le programme comporte à la fois des groupes de commissions fixes et en pourcentage, la fourchette de commissions contient deux objets :
"commissionRange": [
{
"min": 2,
"max": 11,
"type": "percentage"
},
{
"min": 1.5,
"max": 18,
"type": "amount"
}
]
Quels champs de données fournissons-nous ?
Objet programmeInfo :
| Nom du champ | Description |
|---|
| ID | ID du programme |
| name | nom du programme |
| displayUrl | URL de l’annonceur |
| clickThroughUrl | URL de clics du programme de l'annonceur |
| deeplinkEnabled | valeur booléenne indiquant si le lien profond est activé chez l'annonceur |
| description | description du programme |
| membershipStatus | statut d'adhésion entre l'éditeur et le programme de l'annonceur. Peut être inscrit, en attente, suspendu, rejeté et non inscrit. |
| logoUrl | URL vers le logo du programme |
| primaryRegion | objet qui contient le nom et le countryCode de la région principale du programme |
| validDomains | un objet qui contient les domaines dont l'annonceur accepte la transaction |
| currencyCode | Code ISO de la devise du programme |
objet kpi :
| Nom du champ | Description |
|---|
| averagePaymentTime | publisher |
| approvalPercentage | le pourcentage de validation correspond à la proportion de transactions en attente qui sont ensuite validées comme approuvées. |
| epc | gains par clic |
| conversionRate | le taux de conversion est le nombre total de ventes divisé par le nombre total de clics |
| validationDays | la période de validation représente le temps moyen que prend un annonceur pour valider les transactions en attente comme étant soit validées, soit refusées. |
| awinIndex | un score sur cent, calculé à partir d'un algorithme d'EPC, de pourcentage d'approbation, de taux de conversion et de période de validation. |
commissionRange objet :
| Nom du champ | Description |
|---|
| Min | commission minimale entre les groupes de commissions, en pourcentage ou en montant |
| max | commission maximale entre les groupes de commissions, en pourcentage ou en montant |
| type | pourcentage ou montant ; pour le montant, la valeur est dans la devise du programme (voir l’objet programmeInfo) |
