Conteúdos
GET detalhes dos programas
Quem pode utilizá-la?
Como chamá-la?
Como é a resposta
Quais os campos de dados que fornecemos?
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
GET Detalhe dos programas
Os afiliados recebem um conjunto de KPIs dos programas com os quais estão trabalhando, além disso, recebem ainda a gama de comissões (entre grupos de comissões) que recebem nos programas.
Quem pode utilizá-la?
Afiliados que têm uma associação ativa com um programa.
Como chamá-la
https://api.awin.com/publishers/45628/programmedetails?advertiserId=1001
https://api.awin.com/publishers/45628/programmedetails?advertiserId=1001&relationship=any se o parâmetro "any" de relacionamento for selecionado, o status do relacionamento atual será retornado
Adicione o parâmetro 'accessToken' para fornecer sua chave de acesso conforme descrito em Como posso gerar meu token de acesso API de Publisher?
Como é a resposta
{
"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"
}
]
}
Observação: se o programa tiver grupos de comissões fixas e percentuais, a faixa de comissões contém dois objetos:
"commissionRange": [
{
"min": 2,
"max": 11,
"type": "percentage"
},
{
"min": 1.5,
"max": 18,
"type": "amount"
}
]
Quais os campos de dados que fornecemos?
objeto das informações do programa:
| Nome do campo | Descrição |
|---|
| ID | Identificação do programa |
| name | nome do programa |
| displayUrl | URL do anunciante |
| clickThroughUrl | URL de clique do programa do anunciante |
| deeplinkEnabled | valor booleano que indica se o anunciante ativou o link direto |
| description | descrição do programa |
| membershipStatus | região primária do anunciante |
| logoUrl | URL para o logotipo do programa |
| primaryRegion | objeto que contém o nome e o código do país da região primária do programa |
| validDomains | um objeto que contém domínios a partir dos quais o anunciante aceita a transação |
| currencyCode | Código ISO da moeda do programa |
objetos KPI:
| Nome do campo | Descrição |
|---|
| averagePaymentTime | Afiliado |
| approvalPercentage | a porcentagem de aprovação refere-se à proporção de transações pendentes que são então validadas como aprovadas |
| epc | ganhos por clique |
| conversionRate | a taxa de conversão é o número total de vendas dividido pelo número total de cliques |
| validationDays | o período de validação representa o tempo médio que um anunciante leva para validar transações pendentes como Aprovado ou Recusado |
| awinIndex | uma pontuação em cem, calculada a partir de um algoritmo de EPC, porcentagem de aprovação, taxa de conversão e período de validação |
objeto de intervalo de comissão:
| Nome do campo | Descrição |
|---|
| min | comissão mínima entre grupos de comissão, seja em porcentagem ou em valor |
| max | comissão máxima entre grupos de comissão, seja em porcentagem ou em valor |
| type | porcentagem ou montante; para montante o valor está na moeda do programa (ver objeto do programaInfo) |
