Sei sulla pagina 1di 10

 

​Actualizado: 2018-04-06
Documentación API Admetricks 

1) Autentificación 

Descripción: Identificarse con Admetricks para realizar consultas.

Petición 

Método: ​POST
Encabezado: (vacío)
Parámetros: ​username, password, grant_type, client_id, client_secret

● Los valores de ​username​ y ​password​, son los mismos que usas en la aplicación web.

● Los valores de ​client_id​ y c


​ lient_secret​ ​son constantes​:
○ client_id=IW8M80h7qgCaSz4hPm3gr3wJP89NiJTPyhkwPurT
○ client_secret=KnBW84uyHlxwlNrKOXyym6Ro1IT6IlYdhScdop63hHddCzJIxUwDG7VItN
gEONb1U2ebEH6fBmkYgX9LrZD4uqFJlYscHYn9MLxOm2qVccNE2WGEuePpKA7t3jQ2CvMu

Ejemplo
curl -X POST
https://clientela.admetricks.com/o/token/?grant_type=password&username=​name@company
.com​&password=​XYZXYZXYZ​&client_id=IW8M80h7qgCaSz4hPm3gr3wJP89NiJTPyhkwPurT&client_s
ecret=KnBW84uyHlxwlNrKOXyym6Ro1IT6IlYdhScdop63hHddCzJIxUwDG7VItNgEONb1U2ebEH6fBmkYg
X9LrZD4uqFJlYscHYn9MLxOm2qVccNE2WGEuePpKA7t3jQ2CvMu

Respuesta 

Encabezado (servicio disponible)


● 200: HTTP_200_OK
● 401: HTTP_401_UNAUTHORIZED​ (autentificacion)

Encabezado (servicio no disponible)


● 404: HTTP_404_NOT_FOUND
● (Timeout)

Encabezado (mal requerimiento, GET en vez de POST)


● 405: Method Not Allowed
 

​Actualizado: 2018-04-06
Datos: ​access_token

Ejemplo
{
"scope": "read write",
"expires_in": 36000,
"refresh_token": "rcACPfOgKCosTmB5Cud4M40DHV1yoa",
"access_token": "​nz7UpHBdBJqiKSYLpkKWaCFuF9YbQ5​",
"token_type": "Bearer"
}

2) Reporte de Mercado (campañas) 

Descripción: Entregar información de campañas y banners en Admetricks

Petición 

Encabezado
● Authorization ​(access_token)

Parámetros
● day (UTC-00:00)
● country
● device
● ad_type

Ejemplo
curl -X POST -H "Authorization:Bearer ​nz7UpHBdBJqiKSYLpkKWaCFuF9YbQ5​"
https://clientela.admetricks.com/market-report/data/​?day=2016-03-01&country=1&devic
e=1&ad_type=1
 

​Actualizado: 2018-04-06
 

Respuestas 

Encabezado (servicio disponible)


● 202: HTTP_202_ACCEPTED
● 400: HTTP_400_BAD_REQUEST ​(falta parámetro day)
● 401: HTTP_401_UNAUTHORIZED ​(falta autentificación)

Encabezado ​(error)
● 404: HTTP_404_NOT_FOUND
● 409: HTTP_409_CONFLICT ​(sin resultados, no hay datos, respuesta muy larga)
● 502: HTTP_502_BAD_GATEWAY ​(servicio no disponible)
● (Timeout)

Datos
● data​: datos

Opciones

Country id Device id

Chile 1 Desktop 1

Colombia 2 Mobile 2

Argentina 3
Adtype id
Brazil 4
Display 1
Spain 5
Video 2
Perú 6

Mexico 7

Puerto Rico 9

Panama 10
 

​Actualizado: 2018-04-06
Uruguay 11

Costa Rica 12

Guatemala 13

Ecuador 14

Venezuela 15

Nicaragua 16

El Salvador 17
 

​Actualizado: 2018-04-06
Ejemplo
{
{
"meta": {},
"data": [
{
"sold_bys": "google",
"metrics_count": 4,
"industry_id": 178,
"ad_link":
"http://ads.admetricks.com/banner_9a2a1e3ce054214036b243b76c11011b.jpg",
"device": "desktop",
"ad_lengths": "0",
"country": "chile",
"screenshot_link":
"http://screenshots.admetricks.com/cache_id9c82a01f221b46bdbc3a821f0930eed0.jpg",
"brand": "natura",
"campaign": "",
"ad_type_id": 1,
"website": "lanacion.cl",
"industry": "belleza e higiene - maquillaje y desmaquillaje",
"metrics_blocker_avg": 0,
"device_id": 1,
"brand_id": 661,
"ad_type": "display",
"campaign_id": 4634185,
"date": "2016-10-01",
"ad_sizes": "120x600,300x250,300x600,728x90",
"website_sections": "regiones,vida y estilo,reportajes",
"website_id": 465,
"campaign_landing_page":
"natura.cl/espacio/seve-almendras-dulces-100-ml-48977",
"metrics_valuation": 1134,
"metrics_impressions": 3766,
"ad_servers": "2mdn.net",
"metrics_impact": 308,
"country_id": 1
},
...
}

   
 

​Actualizado: 2018-04-06
Columnas de datos, descripción y ejemplo 

Nombre Tipo y largo Vacío Descripción Ejemplo

date varchar(255) NO Fecha 2015-03-02

campaign_id int(11) NO Identificador de campaña 71090

campaign varchar(255) SI Nombre de campaña PROYECTOS


EN VENTA

campaign_landin varchar(10000) SI Link de campaña http://www.absal


g_page .cl/

ad_link varchar(255) NO Anuncio "http://ads.admet


ricks.com/banne
r_461ef5c4476e
968994dfa0a4eb
0178d3.swf"

brand_id int(11) NO Identificador de un avisador 1131


o marca

brand varchar(255) NO Nombre de un avisador o Absal


marca

industry_id int(11) NO Identificador de industria o 13


rubro

industry varchar(255) NO Nombre de industria o Inmobiliarias y


rubro Propiedades

website_id int(11) NO Identificador de medio o 19


soporte

website varchar(255) NO Nombre de medio o soporte emol.com

metrics_impact bigint(20) NO Impacto de campaña, 4793443


equivalente a valor.

metrics_valuation bigint(20) NO Valorización en pesos 169110


chilenos

device varchar(255) NO Tipo de dispositivo desktop

ad_type varchar(255) NO Tipo de publicidad display

sold_bys varchar(255) SI Quien la vendió others


 

​Actualizado: 2018-04-06
metrics_count int(11) NO Cantidad de anuncios 5

ad_lengths varchar(255) SI Largos de publicidades 0

country varchar(255) NO País Chile

country_id int(11) NO País ID 1

screenshot_link varchar(255) NO Pantallazo de captura http://screenshot


s.admetricks.co
m/cache_id9c82
a01f221b46bdbc
3a821f0930eed0
.jpg

metrics_blocker_ int(11) SI Si la publicidad bloquea la 0.2111


avg pantalla

ad_type varchar(255) NO Tipo de publicidad display

ad_type_id int(11) NO Tipo de publicidad 1

ad_sizes varchar(255) NO Tamaños de publicidad 120x600,300x25


0,300x600,728x
90

website_sections varchar(255) SI Secciones de website home

ad_servers varchar(255) SI Adservers 2mdn.net

   
 

​Actualizado: 2018-04-06
Links a una campaña en admetricks 

Son de la siguiente manera:

http://web.admetricks.com/#/campaign?name=falabella&request_filters=eyJjYW1wYWlnbnMiOn
siaW5jbHVkZSI6W3siaWQiOiI0NDQ1NjA2In1dfSwiYWRfdHlwZXMiOnsiaW5jbHVkZSI6W3sia
WQiOjF9XX0sImNvdW50cmllcyI6eyJpbmNsdWRlIjpbeyJpZCI6MX1dfSwiZGV2aWNlcyI6eyJpb
mNsdWRlIjpbeyJpZCI6MX1dfSwib3JkZXJfYnkiOiJ2YWx1YXRpb24iLCJkYXRlX3JhbmdlIjp7InN
0YXJ0IjoiMjAxNy0wMS0xOVQwMDowMDowMC4wMDBaIiwiZW5kIjoiMjAxNy0wMS0xOVQyMz
o1OTo1OS45OTlaIn19

En donde

name​ = ​campaign (name) a mostrar en el sitio


request_filters​ = filtros de la consulta.

Esta encodeado en base64, des-encodeando el ejemplo nos entrega el siguiente json:

{
"campaigns": {
"include": [{
"id": "4445606"
}]
},
"ad_types": {
"include": [{
"id": 1
}]
},
"countries": {
"include": [{
"id": 1
}]
},
"devices": {
"include": [{
"id": 1
}]
},
"order_by": "valuation",
"date_range": {
"start": "2017-01-19T00:00:00.000Z",
"end": "2017-01-19T23:59:59.999Z"
}
}

Todos esos parámetros ya los tienen en su lado del servicio market.


 

​Actualizado: 2018-04-06

Actualizaciones

Para mantener la data actualizada es conveniente traer la información del día de ayer y 5 días
hacía atrás, pues la información se disponibiliza en tiempo real pero se va enriqueciendo.

Limites

THROTTLE_RATE_BURST 120/min
THROTTLE_RATE_MARKET_REPORT_DATA 1000/day
THROTTLE_RATE_SUSTAINED 6000/day

Cliente API

https://www.getpostman.com/apps
 

​Actualizado: 2018-04-06

Potrebbero piacerti anche