e-planning api de acceso xml manual de uso v 4.3 · e-planning api de acceso xml manual de uso v...

e-planning

API de acceso XML

Manual de uso

v 4.3.8

29/12/2010

Material confidencial – Restringido a clientes del servicio e-planning ad server

Caraytech S.A.

ÍndiceIntroducción.......................................................................................9Objetos...............................................................................................9

Identificadores................................................................................9Funcionamiento..............................................................................9

Autenticación..............................................................................9Acceso.........................................................................................9

Algunas operaciones disponibles.....................................................10Listado de espacios......................................................................11

Parámetros posibles: ...............................................................11Ejemplos de URLs con parámetros:......................................11

Respuesta:................................................................................11Ejemplo de respuesta............................................................12

Creación de espacio.....................................................................13Parámetros obligatorios:..........................................................13Parámetros opcionales:............................................................14Respuesta:................................................................................14

Ejemplo de respuesta sin errores.........................................14Ejemplo de respuesta con errores........................................14

Modificación de espacio...............................................................14Parámetros obligatorios:..........................................................15Respuesta:................................................................................15


Archivar Espacio..........................................................................16Requisitos:................................................................................16Parámetros obligatorios:..........................................................16Respuesta: ...............................................................................16

Ejemplo de respuesta sin errores.........................................16Activar espacio.............................................................................17

Requisitos:................................................................................17Parámetros obligatorios:..........................................................17Respuesta: ...............................................................................17

Ejemplo de respuesta sin errores.........................................17Planificador de inventario por espacios.......................................17

Parámetros obligatorios: .........................................................17Ejemplo de URLs con parámetros:.......................................18


Borrar un espacio.........................................................................18Requisitos:................................................................................19Parámetros obligatorios:..........................................................19Ejemplo de request:..................................................................19Respuesta:................................................................................19

Ejemplo de respuesta sin errores.........................................19Listado de secciones.....................................................................19



Creación de sección.....................................................................21Parámetros obligatorios:..........................................................21Respuesta:................................................................................21


Modificación de sección...............................................................22Parámetros obligatorios:..........................................................22Respuesta:................................................................................22


Borrar una sección.......................................................................22Requisitos:................................................................................23Parámetros obligatorios:..........................................................23Ejemplo de request:..................................................................23Respuesta:................................................................................23

Ejemplo de respuesta sin errores.........................................23Archivar secciones.......................................................................23


Ejemplo de respuesta sin errores.........................................24Activar secciones..........................................................................24


Ejemplo de respuesta sin errores.........................................24Listado de sitios............................................................................25



Creación de sitio...........................................................................26Parámetros obligatorios:..........................................................26Respuesta:................................................................................26


Modificación de sitio....................................................................27Parámetros obligatorios:..........................................................27Respuesta:................................................................................28

Ejemplo de respuesta sin errores.........................................28

Ejemplo de respuesta con errores........................................28Borrar un sitio..............................................................................28

Requisitos:................................................................................28Parámetros obligatorios:..........................................................28Ejemplo de request:..................................................................28Respuesta:................................................................................28

Ejemplo de respuesta sin errores.........................................29Archivar sitio................................................................................29


Ejemplo de respuesta sin errores.........................................29Activar sitio..................................................................................29


Ejemplo de respuesta sin errores.........................................30Listado de grupos de espacios.....................................................30


Listado de anunciantes.................................................................31Parámetros posibles: ...............................................................31

Ejemplos de URLs con parámetros:......................................31Respuesta:................................................................................31

Ejemplo de respuesta............................................................32Información de un anunciante.....................................................32

Parámetros obligatorios: .........................................................33Respuesta:................................................................................33

Ejemplo de respuesta............................................................34Listado de pautas.........................................................................35



Información de una pauta............................................................37Parámetro obligatorio: .............................................................37

Ejemplos de URL con parámetro:.........................................37Respuesta:................................................................................37

Ejemplo de respuesta............................................................38Creación de anunciante................................................................39

Parámetros obligatorios:..........................................................39Parámetros opcionales:............................................................39Respuesta:................................................................................39


Creación de pauta........................................................................40

Requisitos:................................................................................40Parámetros obligatorios:..........................................................40Parámetros opcionales:............................................................42- Si se desea segmentar la pauta a uno o más paises, se deberán agregar los siguientes parámetros:............................43Parámetros opcionales, disponibles en interfaz de agencia o network:....................................................................................43Ejemplo de request:..................................................................44Respuesta:................................................................................45


Modificación de pauta..................................................................46Requisitos:................................................................................46Parámetros obligatorios:..........................................................46Parámetros opcionales:............................................................46Ejemplo de request:..................................................................46Respuesta:................................................................................47


Modificación de fechas y cantidades de pauta.............................48Requisitos:................................................................................48Parámetros obligatorios:..........................................................48Parámetros opcionales:............................................................48Ejemplo de request:..................................................................49Respuesta:................................................................................49


Modificación de tipo de pauta......................................................50Requisitos:................................................................................50Parámetros obligatorios:..........................................................50Ejemplo de request:..................................................................50Respuesta:................................................................................51


Suspensión de pauta....................................................................51Requisitos:................................................................................51Parámetros obligatorios:..........................................................51Ejemplo de request:..................................................................51Respuesta:................................................................................52

Ejemplo de respuesta sin errores.........................................52Aprobación de pauta....................................................................52


Ejemplo de respuesta sin errores.........................................53

Cancelación de pauta...................................................................53Requisitos:................................................................................53Parámetros obligatorios:..........................................................53Ejemplo de request:..................................................................53Respuesta:................................................................................53

Ejemplo de respuesta sin errores.........................................53Finalización de pauta...................................................................54


Ejemplo de respuesta sin errores.........................................54Reactivación de pauta..................................................................54


Ejemplo de respuesta sin errores.........................................55Listado de usuarios......................................................................55

Ejemplos de URLs con parámetros:.........................................55Respuesta:................................................................................56

Ejemplo de respuesta............................................................56Listado de palabras clave.............................................................56

Respuesta:................................................................................57Ejemplo de respuesta ..............................................................57

Información de una palabra clave................................................58Requisitos:................................................................................58Parámetros obligatorios:..........................................................58Ejemplo de request:..................................................................58Respuesta:................................................................................58Ejemplo de respuesta ..............................................................59

Borrado de anuncio......................................................................59Parámetros obligatorios:..........................................................59Parámetros opcionales:............................................................59Ejemplo de request:..................................................................59Respuesta:................................................................................60

Ejemplo de respuesta sin errores.........................................60Informes dinámicos......................................................................61

Parámetros obligatorios:..........................................................61Parámetros opcionales:............................................................61Ejemplo de request:..................................................................61Respuesta:................................................................................62

Ejemplo de respuesta ...........................................................62Informes preconfigurados............................................................63

Fecha de actualización.............................................................63DSM (sistema de compra en línea autoservicio)..............................64

Listado de compras......................................................................64Parámetros opcionales:............................................................64Respuesta:................................................................................64Ejemplo de respuesta ..............................................................64

Listado de compras extendido......................................................65Parámetros opcionales:............................................................65Respuesta:................................................................................65

Información de una compra.........................................................66Parámetros obligatorios:..........................................................67Respuesta:................................................................................67Ejemplo de respuesta ..............................................................69

Información de un producto.........................................................71Parámetros obligatorios:..........................................................71Respuesta:................................................................................71Ejemplo de respuesta ..............................................................72

Acceso a un archivo de imagen de un producto...........................72Parámetros obligatorios:..........................................................72Respuesta.................................................................................73

Información de un combo.............................................................73Parámetros obligatorios:..........................................................73Respuesta:................................................................................73Ejemplo de respuesta ..............................................................73

Listado de registros......................................................................74Parámetros opcionales:............................................................74Respuesta:................................................................................74Ejemplo de respuesta ..............................................................75

Apéndice I - Referencias..................................................................76Estados de pautas........................................................................76Tipos de comercialización de pautas (tipoventa_id)....................76Modos de precios para pautas.....................................................76Intervalos de activación de pautas...............................................77Modos de distribución de pautas (ptmodo_id).............................77Acción al retrasarse una pauta....................................................77Tipos de sitios y anunciantes (variable sitipo_id).........................78Monedas (variable moneda_id)....................................................78Tipos de tamaños de espacios (variable tamano_tipo).................79Reglas para nómbres válidos.......................................................79Filtros para informes dinámicos...................................................79Objetos para informes dinámicos.................................................80Tipos de palabras clave................................................................81Estados de compras......................................................................81Estados de pagos..........................................................................82Pasarelas de pagos (sistema_pago_id).........................................82Tipo de contribuyente (tax_status_id)..........................................83Tipos de documento (tipodoc_id).................................................83Estados de registros.....................................................................84

Apéndice II – Historial de cambios..................................................85Versión 4.1:..................................................................................85Versión 4.0.19:.............................................................................85Versión 4.0.18:.............................................................................85Versión 4.0.16:.............................................................................85Versión 4.0.12:.............................................................................85Versión 4.0.11:.............................................................................85Versión 4.0.10:.............................................................................85Versión 4.0.13:.............................................................................85Versión 4.0.13c:............................................................................86Versión 4.0.14:.............................................................................86Versión 4.2.1:...............................................................................86Versión 4.2.1b:.............................................................................86Versión 4.2.1c...............................................................................86Versión 4.2.1d..............................................................................86Versión 4.2.3................................................................................86Versión 4.2.4................................................................................86Versión 4.2.6................................................................................87Versión 4.2.7................................................................................87Versión 4.3...................................................................................87Versión 4.3.3................................................................................87Versión 4.3.4................................................................................87Versión 4.3.8................................................................................87

IntroducciónEl presente documento es el manual de uso del API de acceso de e-planning ad server. El documento está orientado a usuarios del servicio que deseen integrar e-planning ad server con sus propios sistemas propietarios. Antes de leer este documento se sugiere familiarizarse con el producto y leer el Manual del Usuario.

El API permite realizar operaciones básicas sobre los objetos gestionados por e-planning ad server, como ser pautas, anunciantes, espacios, etc. Las operaciones posibles pueden ser la creación de nuevos objetos, modificación, listados, etc. El API, permite, por ejemplo, que un sistema de gestión interno de la empresa cree automáticamente las pautas en e-planning ad server y lleve su control para poder realizar la facturación.

El API funciona utilizando HTTPS como protocolo de comunicación y XML como formato de intercambio de datos. Para acceder al API es necesario tener creado un usuario en e-planning ad server, el cual se puede crear en la solapa Usuarios.

ObjetosLos objetos disponibles a través del API son los mismos que se pueden administrar a través de la interfaz web, con ciertas limitaciones. Los atributos accesibles son los mismos que se ven en la interfaz web. Cualquier objeto creado a traves del API se puede ver instantáneamente en la interfaz web y viceversa.

IdentificadoresCada objeto gestionable a traves del API tiene un identificador único de tipo numérico. Por ejemplo, para una pauta, el identificador se llama pauta_id y su valor es un número entero. Ej: 54435. Cada vez que en el API se debe realizar una operación sobre un objeto específico, se lo referencia mediante su identificador.

FuncionamientoEl acceso al API se puede realizar mediante cualquier lenguaje de programación que permita realizar requests HTTPS y parsear archivos XML. Por ejemplo, Java, Perl, C#, C, etc.

Autenticación

Para autenticación se utiliza la autenticación básica del protocolo HTTP (Basic Authentication). El API no utiliza cookies. En cada request que realice al sistema deberá incluir el nombre de usuario contraseña.

Acceso

Para acceder al API, primero hay que conocer el URL base. Éste depende de cuál es el data center de e-planning desde el cual se brinda el servicio:

− Estados Unidos: https://admin.us.e-planning.net/

− Argentina: https://admin.ar.e-planning.net/

Más adelante se da el URL relativo para cada una de las operaciones. Éste se deberá combinar con el URL base para formar el URL completo de cada operación. Por ejemplo, si Ud. utiliza el servicio del data center de Estados Unidos, y desea obtener un listado de pautas, el URL lo forma de la siguiente manera:

URL base:

https://admin.us.e-planning.net/

URL de la operación:

/admin/adnet/pub/admin/pautas.html?op=l

- URL completo:

https://admin.us.e-planning.net/admin/adnet/pub/admin/pautas.html?op=l

Para acceder a la interfaz, no es necesario realizar un login explícito. Basta con realizar el primer request de una operación particular para quedar logueado en la interfaz. Lo que sí es necesario al terminar la sesión es desconectarse de la interfaz. La operación se realiza mediante un request al URL

/admin/?relogin=<random>

Deberá reemplazar <random> por un número al azar, como puede ser la cantidad de segundos del día actual, u otro número entero. Ej:

/admin/?relogin=43242341

Algunas operaciones disponibles

− Listado de espacios− Borrar un espacio− Listado de secciones− Listado de sitios− Listado de anunciantes− Listado de pautas− Información de una pauta− Creación de anunciante− Creación de pauta


https://admin.us.e-planning.net/admin/adnet/pub/admin/pautas.html?op=l


https://admin.ar.e-planning.net/

− Cada operación tiene un URL y parametros posibles.− Todos los parametros se deben especificar en el URL con el formato url-

encoded. − Los nombres de los parámetros se deben especificar en minúsculas, tal

como se muestra en los ejemplos.− Las operaciones que consultan datos se realizan mediante el metodo

GET. Las que modifican datos, mediante POST. En este caso (POST), los parámetros se deben enviar en el cuerpo del mensaje (Request Body).

− En los listados se pueden especificar filtros, mediante parametros. Si no se especifican parametros, por default se muestran todos los objetos disponibles.

A continuación se brinda información detallada de cada operación.

Listado de espaciosLista los espacios creados en el sistema.

URL: /admin/adnet/pub/admin/espacios.html?op=l&o=xml

Parámetros posibles:

− sitio_id: especifica el código de sitio. Sólo mostrará espacios de ese sitio. Si no se especifica ni tampoco se especifica el parámetro seccion_id, muestra todos los espacios existentes.

− seccion_id: especifica el código de sección. Sólo mostrará espacios de esa sección. Si no se especifica muestra todos los del sitio.

− estado: estado del espacio. Si no se especifica muestra todos. Los valores posibles son:

− act: activo

− arc: archivado

− all: todos

Ejemplos de URLs con parámetros:

/admin/adnet/pub/admin/espacios.html?op=l&estado=act&o=xml

/admin/adnet/pub/admin/espacios.html?op=l&sitio_id=4324&o=xml

/admin/adnet/pub/admin/espacios.html?op=l&seccion_id=132&estado=arc&o=xml

Respuesta:

Contiene una lista de objetos <espacio>. El identificador se especifica mediante el atributo espacio_id y los datos presentados son los siguientes:

− sitio_id: identificador del sitio al cual pertenece el espacio

− sitio: nombre del sitio al cual pertenece el espacio

− seccion_id: identificador de la sección a la cual pertenece el espacio

− seccion: nombre de la sección a la cual pertenece el espacio

− nombre: nombre del espacio

− tamano: especificación del tamaño del espacio. Si el tamaño es fijo, el formato del atributo es: f/<ancho>x<alto>. Si no, el valor es uno de:

− v: variable – acepta anuncios de cualquier tamaño

− i: invisible: sólo acepta pops y layers

− t: texto – sólo acepta anuncios de texto

− url: dirección URL donde está pegado el código del espacio

− click_ventana_nueva: indicación de si el click en anuncios de este espacio se abre en una nueva ventana (1) o no (0).

− estado: campo de bits con el estado del espacio. El bit 128 indica si está archivado (128) o activo (0). El bit 16 indica si tuvo impresiones en las últimas 24 horas (16) o no las tuvo (0).

− fecha_alta: fecha de creación del espacio.

− fecha_baja: si el espacio hubiera sido borrado, indica la fecha en que fue borrado.

Ejemplo de respuesta

<lista>

<espacio espacio_id=”123”>

<sitio_id>5512</sitio_id>

<sitio>Autos.com</sitio>

<seccion_id>1325</seccion_id>

<seccion>Home</seccion>

<nombre>Header</nombre>

<tamano>f/420x40</tamano>

<estado>0</estado>

<url>http://www.autos.com/</url>

<fecha_alta>2006-03-22 13:45:35</fecha_alta>

<click_ventana_nueva>1</click_ventana_nueva>

<fecha_baja/>

http://www.autos.com/

</espacio>




<seccion_id>1329</seccion_id>

<seccion>Deportivos</seccion>

<nombre>Sky</nombre>

<tamano>v</tamano>

<estado>0</estado>

<url>http://www.autos.com/deportivos/</url>


<click_ventana_nueva>0</click_ventana_nueva>

<fecha_baja/>

</espacio>

</lista>

Creación de espacioCrea un espacio en el sistema. Permite luego agregarle pautas. Se debe conocer antes el identificador del sitio y la sección al que pertenece el nuevo espacio.

El request se debe realizar con el método POST

URL: /admin/adnet/pub/admin/espacios.html?op=a&o=xml

Parámetros obligatorios:

− descripcion: nombre del espacio. Debe tener al menos 2 caracteres. Se recomienda que contenga únicamente números y letras, sin espacios.

− sitio_id: identificador del sitio al cual pertenece el espacio

− seccion_id: identificador de la sección a la cual pertenece el espacio

− tamano_tipo: tipo de tamaño del espacio. En el Anexo Tipos de tamaños de espacios se indican las opciones posibles. Si elige tamaño fijo, deberá especificar además los siguientes 2 paramétros:

− width: ancho en pixeles (sólo para tamaño fijo)

− height: alto en pixeles (sólo para tamaño fijo)

− url: URL de la página donde estará pegado el código de espacio. Si en las preferencias globales indicó que es obligatorio ingresar la URL de los espacios, entonces deberá indicarlo siempre.

http://www.autos.com/deportivos/

− atributos_1 (sólo si tiene habilitado el módulo DSM): deberá indicar 1 si el espacio podrá ser comercializado por DSM o 0 en caso contrario.

Parámetros opcionales:

− peso_maximo_anuncios: peso máximo en bytes que podrán tener los anuncios que se suban a este espacio

− link_newwindow: si se especifica este parámetro con valor 1, entonces por default cualquier clic en un anuncio de este espacio se abrirá en una ventana nueva. Este valor se puede luego asignar pauta por pauta luego de crear la pauta.

Respuesta:

Contiene un objeto <operacion> que a su vez contiene un tag <resultado>. El valor de resultado puede ser 1 (operación exitosa) o 0 (operación fallida).

Si la operación es fallida, se agrega además un listado de errores, mediante tags <error>, que contienen el atributo atributo, que especifica el nombre del atributo con error, y mensaje, con el mensaje de error.

Ejemplo de respuesta sin errores

<operacion>

<resultado>1</resultado>

<identificador>52112</identificador>

</operacion>

Ejemplo de respuesta con errores

<operacion>


<errores>

<error atributo=”sitio_id” mensaje=”Sitio inexistente”/>

</errores>

</operacion>

Modificación de espacio

Modifica un espacio existente. Se debe conocer su identificador (espacio_id).


URL: /admin/adnet/pub/admin/espacios.html?op=m&o=xml


− espacio_id: el identificador de la sección a modificar

− descripcion: nombre del espacio. Debe tener al menos 2 caracteres. Se recomienda que contenga únicamente números y letras, sin espacios.

− tamano_tipo: tipo de tamaño del espacio. En el Anexo Tipos de tamaños de espacios se indican las opciones posibles. Si elige tamaño fijo, deberá especificar además los siguientes 2 paramétros:

− width: ancho en pixeles (sólo para tamaño fijo)

− height: alto en pixeles (sólo para tamaño fijo)

− url: URL de la página donde estará pegado el código de espacio. Si en las preferencias globales indicó que es obligatorio ingresar la URL de los espacios, entonces deberá indicarlo siempre.

− atributos_1 (sólo si tiene habilitado el módulo DSM): deberá indicar 1 si el espacio podrá ser comercializado por DSM o 0 en caso contrario.


− peso_maximo_anuncios: peso máximo en bytes que podrán tener los anuncios que se suban a este espacio

− link_newwindow: si se especifica este parámetro con valor 1, entonces por default cualquier clic en un anuncio de este espacio se abrirá en una ventana nueva. Este valor se puede luego asignar pauta por pauta luego de crear la pauta.

Respuesta:




<operacion>


</operacion>


<operacion>


<errores>


</errores>

</operacion>

Archivar Espacio

Archiva un espacio seleccionado.


URL: /admin/adnet/pub/admin/espacios.html?op=arch&o=xml

Requisitos:

− El espacio debe estar en estado Activo

− Se debe conocer su identificador (espacio_id)


− espacio_id: el identificador del espacio a modificar

Respuesta:




<operacion>


</operacion>

Activar espacio

Activa un espacio seleccionado.


URL: /admin/adnet/pub/admin/espacios.html?op=act&o=xml

Requisitos:

− El espacio debe estar en estado Archivado



− espacio_id: el identificador del espacio a modificar

Respuesta:




<operacion>


</operacion>

Planificador de inventario por espaciosBrinda una estimación de tráfico e impresiones vendidas por espacio para fechas futuras.

URL: /admin/adnet/pub/admin/espacios.html?op=i&o=xml


− fecha_inicio: fecha a partir de la cual se realiza la estimación. Se debe indicar utilizando el formato de fechas seleccionado por el usuario. La fecha debe ser posterior a la fecha actual. Ejemplo: si hoy es 13/12/2007,

la primera fecha válida es 14/12/2007.

− fecha_fin: fecha hasta la cual se realiza la estimación. Se debe indicar utilizando el formato de fechas seleccionado por el usuario. La fecha no debe ser más de 6 meses en el futuro.

− espacio_id: espacio para el cual se realizará la estimación.

− granularidad: granularidad de la estimación

− d: por día

− h: por día y hora

Ejemplo de URLs con parámetros:

/admin/adnet/pub/admin/espacios.html?op=i&o=xml&espacio_id=4342&fecha_inicio=13%2F12%2F2007&fecha_fin=18%2F12%2F2007&granularidad=d

Respuesta:

Contiene una lista de objetos <estimacion>. Cada uno contiene:

− inicio: timestamp de inicio de la estimación, en segundos desde 1970

− fin: timestamp de fin de la estimación, en segundos desde 1970

− impresiones: impresiones estimadas para el período

− vendidas: impresiones vendidas para el período


<lista>

<estimacion fin=”1229219999” impresiones=”100” vendidas=”50” inicio=”1229133600”>

<estimacion fin=”1229306999” impresiones=”120” vendidas=”20” inicio=”1229220000”>

</lista>

Borrar un espacioBorra un espacio del sistema.

URL: /admin/adnet/pub/admin/espacios.html?op=b&o=xml

Requisitos:

− El espacio no debe haber sido borrado previamente



Se debe incluir el parámetro espacio_id, el identificador del espacio.

Ejemplo de request:

URL: /admin/adnet/pub/admin/espacios.html?op=b&o=xml&espacio_id=4431

− Respuesta:




<operacion>


</operacion>

Listado de seccionesLista las secciones creados en el sistema.

URL: /admin/adnet/pub/admin/secciones.html?op=l&o=xml


− sitio_id: especifica el código de sitio. Sólo mostrará secciones de ese sitio. Si no se especifica, muestra todas las secciones.

− estado: estado de la sección. Si no se especifica, muestra todas. Los valores posibles son:

− act: activa

− arc: archivada

− all: todos


/admin/adnet/pub/admin/secciones.html?op=l&estado=act&o=xml

/admin/adnet/pub/admin/secciones.html?op=l&sitio_id=4324&o=xml

/admin/adnet/pub/admin/secciones.html?op=l&sitio_id=132&estado=arc&o=xml

Respuesta:

Contiene una lista de objetos <seccion>. El identificador se especifica mediante el atributo seccion_id y los datos presentados son los siguientes:

− sitio_id: identificador del sitio al cual pertenece la sección

− sitio: nombre del sitio al cual pertenecela sección

− nombre: nombre de la sección

− estado: indica si la sección está activa (0) o archivada (1)

− fecha_alta: fecha de creación de la sección

− fecha_baja: si la sección hubiera sido borrada, indica la fecha en que fue borrada.


<lista>

<seccion seccion_id=”123”>



<nombre>Home</nombre>

<estado>0</estado>


<fecha_baja/>

</espacio>




<nombre>Deportiva</nombre>

<estado>1</estado>


<fecha_baja/>

</espacio>

</lista>

Creación de secciónCrea una sección en el sistema. Permite luego agregarle espacios. Se debe conocer antes el identificador del sitio al que pertenece la nueva sección.


URL: /admin/adnet/pub/admin/secciones.html?op=a&o=xml


− nombre: nombre de la sección. Solo se permiten los siguientes caracteres: 0-9 a-z A-Z y guión bajo (_). No se permiten nombres repetidos de secciones dentro del mismo sitio.

− sitio_id: identificador del sitio al cual pertenece la sección

Respuesta:




<operacion>



</operacion>


<operacion>


<errores>


</errores>

</operacion>

Modificación de secciónModifica una sección existente. Se debe conocer su identificador (seccion_id).


URL: /admin/adnet/pub/admin/secciones.html?op=m&o=xml


− seccion_id: el identificador de la sección a modificar

− nombre: nombre de la sección. Solo se permiten los siguientes caracteres: 0-9 a-z A-Z y guión bajo (_). No se permiten nombres repetidos de secciones dentro del mismo sitio.

Respuesta:




<operacion>


</operacion>


<operacion>


<errores>

<error atributo=”nombre” mensaje=”Nombre invalido”/>

</errores>

</operacion>

Borrar una secciónBorra una sección del sistema.

URL: /admin/adnet/pub/admin/secciones.html?op=b&o=xml

Requisitos:

− La sección debe existir y no debe haber sido borrada previamente

− La sección no debe contener espacios activos ni archivados

− Se debe conocer su identificador (seccion_id)


Se debe incluir el parámetro seccion_id, el identificador de la sección.

Ejemplo de request:

URL: /admin/adnet/pub/admin/secciones.html?op=b&o=xml&seccion_id=9942

− Respuesta:




<operacion>


</operacion>

Archivar secciones

Archiva una sección seleccionada.


URL: /admin/adnet/pub/admin/secciones.html?op=arch&o=xml

Requisitos:

− La sección debe estar en estado Activa.

− Se debe conocer su identificador (sección_id)



Respuesta:




<operacion>


</operacion>

Activar secciones

Activa una sección seleccionada.


URL: /admin/adnet/pub/admin/secciones.html?op=act&o=xml

Requisitos:

− La sección debe estar en estado Archivada

− Se debe conocer su identificador (seccion_id)



Respuesta:




<operacion>


</operacion>

Listado de sitiosLista las sitios creados en el sistema.

URL: /admin/adnet/pub/admin/sitios.html?op=l&=o=xml


− estado: estado del sitio. Si no se especifica, muestra todos. Los valores posibles son:

− act: activa

− arc: archivada

− all: todos


/admin/adnet/pub/admin/sitios.html?op=l&o=xml

/admin/adnet/pub/admin/sitios.html?op=l&estado=act&o=xml

/admin/adnet/pub/admin/sitios.html?op=l&estado=arc&o=xml

Respuesta:

Contiene una lista de objetos <sitio>. El identificador se especifica mediante el atributo sitio_id y los datos presentados son los siguientes:

− nombre: nombre del sitio

− url: URL del sitio

− observaciones: comentarios acerca del sitio

− estado: indica si el sitio está activo (0) o archivado (1)

− custom_id: identificador personalizado

− fecha_alta: fecha de creación del sitio

− fecha_baja: si el sitio hubiera sido borrado, indica la fecha en que fue borrado.


<lista>

<sitio sitio_id=”123”>

<nombre>Autos.com</nombre>

<estado>0</estado>

<observaciones/>

<custom_id/>

<url>http://www.autos.com/</url>


<fecha_baja/>

</sitio>

<sitio sitio_id=”129”>

<nombre>Telefonos.com</nombre>

<estado>1</estado>

<observaciones>Venta de telefonos on-line</observaciones>

<custom_id>999</custom_id>

<url>http://www.telefonos.com/</url>


<fecha_baja/>

</sitio>

</lista>

Creación de sitioCrea un sitio en el sistema.


URL: /admin/adnet/pub/admin/sitios.html?op=a&o=xml


− nombre: nombre del sitio. Debe tener al menos 2 caracteres. Se recomienda que contenga únicamente números y letras, sin espacios.


− sitipo_id: (solo en caso de interfaz Network o Agencias) tipo de sitipo – para indicar si es un sitio propio (64) o ajeno (2).

− atributos_1: (sólo interfaz Networks) permite indicar que el sitio deberá aprobar los anuncios antes de que se publiquen. Indique 1 o 0 según corresponda.

− atributos_2: (sólo si tiene habilitado DSM): para indicar si el sitio estará habilitado para correr pautas de DSM

Respuesta:

Contiene un objeto <operacion> que a su vez contiene un tag <resultado>.

El valor de resultado puede ser 1 (operación exitosa) o 0 (operación fallida).



<operacion>



</operacion>


<operacion>


<errores>


</errores>

</operacion>

Modificación de sitioModifica un sitio existente. Se debe conocer su identificador.


URL: /admin/adnet/pub/admin/sitios.html?op=m&o=xml


− nombre: nombre del sitio. Debe tener al menos 2 caracteres. Se recomienda que contenga únicamente números y letras, sin espacios.


− sitipo_id: (solo en caso de interfaz Network o Agencias) tipo de sitipo – para indicar si es un sitio propio (64) o ajeno (2).

− atributos_1: (sólo interfaz Networks) permite indicar que el sitio deberá aprobar los anuncios antes de que se publiquen. Indique 1 o 0 según corresponda.

− atributos_2: (sólo si tiene habilitado DSM): para indicar si el sitio estará habilitado para correr pautas de DSM

Respuesta:




<operacion>


</operacion>


<operacion>


<errores>


</errores>

</operacion>

Borrar un sitioBorra un sitio del sistema. Se debe conocer su identificador.

URL: /admin/adnet/pub/admin/sitios.html?op=b&o=xml

Requisitos:

− El sitio no debe tener pautas asociadas.


Se debe incluir el parámetro sitio_id, el identificador del sitio.

Ejemplo de request:

URL: /admin/adnet/pub/admin/sitios.html?op=b&o=xml&sitio_id=4199

− Respuesta:


Si la operación es fallida, se agrega además un listado de errores, mediante tags <error>, que contienen el atributo atributo, que especifica el nombre

del atributo con error, y mensaje, con el mensaje de error.


<operacion>


</operacion>

Archivar sitioArchiva un sitio seleccionado.


URL: /admin/adnet/pub/admin/sitios.html?op=arch&o=xml

Requisitos:

− El sitio debe estar en estado Activo

− Se debe conocer su identificador (sitio_id)


− sitio_id: el identificador del sitio a modificar

Respuesta:




<operacion>


</operacion>

Activar sitio

Activa un sitio seleccionado.


URL: /admin/adnet/pub/admin/sitios.html?op=act&o=xml

Requisitos:

− El sitio debe estar en estado Archivado

− Se debe conocer su identificador (sitio_id)


− sitio_id: el identificador del sitio a modificar

Respuesta:




<operacion>


</operacion>

Listado de grupos de espaciosLista los grupos de espacios

URL: /admin/adnet/pub/admin/grupo_espacio.html?op=l&o=xml

Respuesta:

Contiene una lista de objetos <gespacio>. El identificador se especifica mediante el atributo gespacio_id y los datos presentados son los siguientes:

− nombre: nombre del grupo

− fecha_alta: fecha de creación del grupo

− fecha_baja: si el grupo hubiera sido borrado, indica la fecha en que fue borrado.

− espacio_id: listado de los espacios que pertenecen al grupo.


<lista>

<gespacio gespacio_id=”123”>

<nombre>Lat</nombre>


<fecha_baja/>

<espacio_id>

<item id="1">12429</item>



</espacio_id>

</gespacio>

</lista>

Listado de anunciantesLista las anunciantes creados en el sistema.

URL: /admin/adnet/pub/admin/anunciantes.html?op=l&o=xml


− estado: estado del anunciante. Si no se especifica, muestra todos. Los valores posibles son:

− act: activa

− arc: archivada

− all: todos


/admin/adnet/pub/admin/anunciantes.html?op=l&o=xml

/admin/adnet/pub/admin/anunciantes.html?op=l&estado=act&o=xml

/admin/adnet/pub/admin/anunciantes.html?op=l&estado=arc&o=xml

Respuesta:

Contiene una lista de objetos <anunciante>. El identificador se especifica mediante el atributo anunciante_id y los datos presentados son los siguientes:

− nombre: nombre del anunciante

− url: URL del sitio web del anunciante

− observaciones: comentarios acerca del anunciante

− estado: indica si el anunciante está activo (0) o archivado (1)


− fecha_alta: fecha de creación del anunciante

− fecha_baja: si el anunciante hubiera sido borrado, indica la fecha en que fue borrado.


<lista>

<anunciante anunciante_id=”123”>

<nombre>Ad4all</nombre>

<estado>0</estado>

<observaciones/>

<custom_id/>

<url>http://www.ad4all.com/</url>


<fecha_baja/>

</anunciante>

<anunciante anunciante_id=”129”>

<nombre>MarketingDirecto.com</nombre>

<estado>1</estado>

<observaciones/>

<custom_id/>

<url>http://www.marketingdirecto.com/</url>


<fecha_baja/>

</anunciante>

</lista>

Información de un anuncianteBrinda toda la información acerca un anunciante específico.

URL: /admin/adnet/pub/admin/pautas.html?op=v&o=xml


− anunciante_id: identificador del anunciante.

Respuesta:

Contiene un lista de objeto <anunciante> con los siguientes atributos:


− url: URL del sitio web del anunciante

− observaciones: comentarios acerca del anunciante

− estado: indica si el anunciante está activo (0) o archivado (1)




Si se utiliza el servicio DSM, y el anunciante se registró el mismo (es un anunciante con Autogestión), se incluyen además los datos de la registración bajo el tag registracion:

− nombre: nombre del usuario que se registró

− apellido: apellido del usuario

− tipo_persona: 0 si se trata de persona física, o 1 para persona jurídica

− fecha_nacimiento

− tax_id: identificador tributario

− razon_social: si se trata de una persona jurídica

− email

− nro_documento: número de documento de la persona, en caso que lo haya ingresado

− cargo

− telefono

− Además, dentro de la etiqueta domicilio se incluyen los siguientes atributos:

− direccion: calle y número

− ciudad

− region

− cp: código postal

− pais


<?xml version="1.0" encoding="iso8859-1" standalone="yes"?>

<anunciante anunciante_id="16282">


<registracion>

<domicilio>

<pais>Argentina</pais>

<region></region>

<ciudad>aqui</ciudad>

<cp>19</cp>

<direccion>aqui</direccion>

</domicilio>

<telefono>2544684</telefono>

<cargo></cargo>

<nro_documento>21523446</nro_documento>

<email>[email protected]</email>

<razon_social>anunciante de pruebas</razon_social>

<fecha_nacimiento>1990-01-01</fecha_nacimiento>

<tax_id></tax_id>

<tipo_persona>0</tipo_persona>

<apellido>Pruebas</apellido>

<nombre>Juan</nombre>

</registracion>


<agencia_id>16282</agencia_id>

<observaciones></observaciones>

<empresa_id>0</empresa_id>

<fecha_baja></fecha_baja>

<estado>1</estado>

<anunciante_id>16282</anunciante_id>

<industria_id></industria_id>

<url>http://www.eplanning.net/</url>

<nombre>anunciante de pruebas</nombre>

</anunciante>

Listado de pautasLista las pautas creadas en el sistema.

URL: /admin/adnet/pub/admin/pautas.html?op=l&o=xml


− ptestado_id: estado de la pauta. Si no se especifica, muestra pautas de todos los estados. Vea más adelante los valores posibles bajo Estados de pautas

− anunciante_id: identificador del anunciante. Si no se especifica, muestra pautas de todos los anunciantes.

− mes_ano: para mostrar sólo las pautas de un período determinado. Se indica mes y año con el siguiente formato: MM/AAAA. Ejemplo: 03/2006.


/admin/adnet/pub/admin/pautas.html?op=l&o=xml

/admin/adnet/pub/admin/pautas.html?op=l&estado=ACT&o=xml

/admin/adnet/pub/admin/pautas.html?op=l&estado=4&anunciante_id=135&o=xml

/admin/adnet/pub/admin/pautas.html?op=l&anunciante_id=135&mes_ano=11/2005&o=xml

Respuesta:

Contiene una lista de objetos <pauta>. El identificador se especifica mediante el atributo pauta_id y los datos presentados son los siguientes:

− nombre: nombre de la pauta

− pauta_id: identificador de la pauta

− anunciante_id: identificador del anunciante

− anunciante: nombre del anunciante

− ptestado_id: código de estado de la pauta. Ver referencia bajo Estados de pautas

− tipoventa_id: tipo de comercialización de la pauta. Ver referencia bajo Tipos de comercialización de pautas.

− cantidad_total: cantidad total contratada (de impresiones, clics o conversiones, según el tipo de venta). Es opcional para pautas de tipo

Sponsor.

− impresiones_cumplidas: cantidad de impresiones cumplidas

− clicks_cumplidos: cantidad de clicks cumplidos.


− fecha_inicio: fecha de inicio de la pauta

− fecha_fin: fecha de finalización de la pauta. Es opcional.

− fecha_alta: fecha de creación de la pauta.

− fecha_baja: si el anunciante hubiera sido borrada, indica la fecha en que fue borrada.

− target_sitio_id: listado de los identificadores de los sitios asociados a la pauta

− target_espacio_id: listado de los identificadores de los espacios asociados a la pauta

− peso: peso de la pauta (de 1 a 100)

− prioridad: prioridad otorgada a la pauta (de 1 a 10)

− ptmodo_id: modo de distribución de las acciones asignadas a la pauta. Ver valores posibles en anexo Modo de distribución de pautas


<lista>

<pauta pauta_id="11703">

<anunciante>fdafdafdaf ss</anunciante>

<fecha_fin>2009-07-08 13:35:00</fecha_fin>

<target_espacio_id>



</target_espacio_id>


<fecha_baja/>

<cantidad_cumplida>0</cantidad_cumplida>

<nombre>fdafda</nombre>

<pauta_id>11703</pauta_id>

<tipoventa_id>1</tipoventa_id>

<custom_id/>

<prioridad>1</prioridad>

<clicks_cumplidos>0</clicks_cumplidos>

<cantidad_total>200000</cantidad_total>

<ptestado_id>4</ptestado_id>


<impresiones_cumplidas>0</impresiones_cumplidas>

<peso>100</peso>

<target_sitio_id>


</target_sitio_id>

<ptmodo_id>1</ptmodo_id>

<fecha_inicio>2009-06-08 13:35:00</fecha_inicio>

</pauta>

</lista>

Información de una pautaDa información acerca de una pauta previamente creada en el sistema.

URL: /admin/adnet/pub/admin/pautas.html?op=v&o=xml

Parámetro obligatorio:

− pauta_id: identificador de la pauta.

Ejemplos de URL con parámetro:

/admin/adnet/pub/admin/pautas.html?op=v&o=xml&pauta_id=5521

Respuesta:

Contiene un objeto <pauta>. El identificador se especifica mediante el atributo pauta_id y los datos presentados son los siguientes:

− nombre: nombre de la pauta

− anunciante_id: identificador del anunciante

− anunciante: nombre del anunciante

− ptestado_id: código de estado de la pauta. Ver referencia bajo Estados de pautas

− tipoventa_id: tipo de comercialización de la pauta. Ver referencia bajo

Tipos de comercialización de pautas.


− cantidad_total: cantidad total contratada (de impresiones, clicks o conversiones, según el tipo de venta). Es opcional para pautas de tipo Sponsor.

− cantidad_cumplida: cantidad cumplida de lo contratado. Puede ser impresiones, clicks o conversiones, según el tipo de comercialización.

− impresiones_cumplidas: cantidad de impresiones cumplidas

− clicks_cumplidos: cantidad de clicks cumplidos.

− peso: peso de la pauta (de 1 a 100)

− prioridad: prioridad otorgada a la pauta (de 1 a 10)

− ptmodo_id: modo de distribución de las acciones asignadas a la pauta. Ver valores posibles en anexo Modo de distribución de pautas

− fecha_inicio: fecha de inicio de la pauta

− fecha_fin: fecha de finalización de la pauta. Es opcional.

− fecha_alta: fecha de creación de la pauta.

− fecha_baja: si el anunciante hubiera sido borrada, indica la fecha en que fue borrada.

− target_sitio_id: listado de los identificadores de los sitios asociados a la pauta

− target_espacio_id: listado de los identificadores de los espacios asociados a la pauta


<pauta pauta_id=”123”>

<nombre>Septiembre Clicks</nombre>


<anunciante>InSPect Tech</anunciante>

<tipoventa_id>2</tipoventa_id>


<cantidad_total>5000</cantidad_total>

<cantidad_cumplida>524</cantidad_cumplida>

<impresiones_cumplidas>135912</impresiones_cumplidas><clicks_cumplidos>1652</clicks_cumplidos>

<fecha_inicio>2006-01-21 15:00:00</fecha_inicio>

<fecha_fin>2006-02-18 23:59:59</fecha_fin>


<fecha_baja/>

</pauta>

Creación de anuncianteCrea un anunciante en el sistema. Permite luego agregarle pautas.


URL: /admin/adnet/pub/admin/anunciantes.html?op=a&o=xml


− a_nombre: nombre del anunciante. Debe cumplir con las reglas para nombres válidos (ver más adelante).

− a_url: URL. Debe comenzar con http:// y ser un URL válido.

− sitipo_id: sólo si tiene activo el servicio DSM. Debe especificar el tipo de anunciante a crear. Ver Apéndice I para valores posibles.


− a_observaciones: observaciones acerca del anunciante.

Respuesta:




<operacion>



</operacion>


<operacion>


<errores>

<error atributo=”a_nombre” mensaje=”El nombre ingresado es inválido”/>

</errores>

</operacion>

Creación de pautaCrea una pauta en el sistema. Permite luego asignarle anuncios.


URL: /admin/adnet/pub/admin/pautas.html?op=a&o=xml

Requisitos:

Antes de crear una pauta, deben estar creados en el sistema:

− El anunciante. Se debe conocer su identificador.

− El o los sitios donde va a correr la pauta. Se deben conocer sus identificadores.

− El o los espacios donde va a correr la pauta. Se deben conocer sus identificadores.

− Si está activada la optimización por eCPM para ciertas prioridades, debe tomarlo en cuenta al cargar la pauta si carga una pauta cuya prioridad tiene activa la optimización por eCPM, ya que deberá indicar obligatoriamente los parámetros prioridad_prueba, cantidad_impresiones_prueba, e indicar además el precio de la pauta. Puede controlar qué prioridades están activas para optimización por eCPM en las preferencias del sistema.


− nombre: nombre de la pauta. Debe cumplir con las reglas para nombres válidos (ver más adelante). No puede haber pautas del mismo anunciante con el mismo nombre, por más que hayan sido borradas.

− sitio_id: identificador del anunciante.

− tipoventa_id: tipo de comercialización. Ver la referencia más adelante.

− cpa_tracer_id: sólo si eligió CPA como tipo de comercialización, debe indicar el identificador del código de conversión relacionado.

− pauta_tracer_id: si eligió CPA como tipo de comercialización, obligatoriamente debe indicar en este campo el mismo valor ingresado en en cpa_tracer_id.

− cantidad_total: cantidad de impresiones, clicks o conversiones, según el tipo de comercialización de la pauta. El parámetro es opcional en el caso de pautas Sponsor y no se debe incluir en el caso de pautas donde se

indica la cantidad de acciones espacio por espacio (ver parámetro acciones_por_espacio más abajo).

− prioridad: prioridad de la pauta en relación a otras que compiten por el mismo espacio. Valores posibles: de 1 a 10.

− peso: peso de la pauta en relación a otras que compiten por el mismo espacio. Valores posibles: de 1 a 100.

− intervalo_activacion: identificador del intervalo de activación de la pauta. Ver valores posibles más adelante en Referencias. Según el valor, ingresado se deben ingresar además los siguientes parámetros:

− Para pauta con una fecha de inicio y una fecha de fin:

− fecha_inicio: fecha de inicio de la pauta, en el formato definido para el usuario en la interfaz (DD/MM/AAAA o MM/DD/AAAA).

− hora_inicio: hora de inicio de la pauta, en HH:MM:SS.

− fecha_fin: fecha de fin de la pauta. Debe ser posterior a la fecha de inicio.

− hora_fin: hora de finalización de la pauta.

− Para pautas con múltiples fechas de inicio y fin:

− fecha_inicio_0, fecha_inicio_1, ... hasta fecha_inicio_9: fechas de inicio (es obligatorio ingresar al menos 1). No se pueden solapar.

− fecha_fin_0, fecha_fin_1, ... hasta fecha_fin_9: fechas de fin, correspondientes a cada una de las fechas de inicio ingresadas.

− Para pautas con horario semanal:

− target_horario_semanal_0: horario para el lunes. Se deben indicar cada una de las horas en que estará activa la pauta el lunes. Ej: “9 10 11 12 13 14 15 16” para una pauta que funcionará desde las 9:00 hasta las 16:59.

− target_horario_semanal_1 a 6: idem para martes a domingo.

− ptmodo_id: para pautas no sponsor, se debe especificar el modo de distrubición de las impresiones, clicks o conversiones. Ver los valores posibles más adelante en Referencias – Modo de distribución de pautas.

− target_sitio_id: listado de sitios, separados por espacios, donde correrá la pauta. Utilizar los identificadores.

− target_espacio_id: identificadores de los espacios donde correrá la pauta.

− accion_retraso_fecha_fin: sólo para pautas no Sponsor, debe indicar qué realizar cuando la pauta llega a la fecha de fin sin haber cumplido la cantidad establecida. Ver valores posibles más adelante en Referencias – Acción al retrasarse una Pauta.

Si la prioridad elegida tiene activa la optimización por eCPM, además son obligatorios los siguientes atributos:

- prioridad_prueba: prioridad de la pauta durante el período de prueba

- cantidad_impresiones_prueba: cantidad de impresiones que debe correr la pauta durante el período de prueba


Estos son algunos de los parámetros opcionales y no son todos los que están disponibles a través de la interfaz web. Para poder realizar un ajuste completo de la pauta, se debe realizar a través de la interfaz web.

− numero_oc: número de orden de compra, utilizado a modo de identificador. Puede contener como máximo 16 caracteres.

− fecha_oc: fecha de orden de compra. Solo se puede especificar si especifica también numero_oc. En caso contrario será ignorada.

− acciones_por_espacio: 0 o 1. Si es 1, permite especificar la cantidad de acciones (impresiones, clicks o conversiones) espacio por espacio. Ej: la pauta corre 40.000 impresiones en el espacio A y 20.000 en el espacio B. Si se indica 1, se debe especificar, por cada espacio, el parámetro:

− cantidad_total_<espacio_id>: cantidad de acciones para el espacio <espacio_id>.

− max_impresiones_usuario: cantidad máxima de veces que cada usuario puede ver la pauta. Número entre 1 y 254.

− max_impresiones_sesion: cantidad máxima de veces que cada usuario puede ver la pauta en una sesión. Número entre 1 y 254.

− intervalo_sesiones: intervalo entre sesiones, en horas. Número entre 1 y 720. Ver el Manual del Usuario para obtener una explicación de estos últimos 3 parámetros.

− stop_after_click: índique 1 si desea que una vez que un usuario cliqueó en una pauta, ésta no se le muestre más.

− max_acciones_hora: cantidad máxima de acciones a mostrar por hora. Por ejemplo, si la pauta es por impresiones, y se indica el número 1.000 en este parámetro, no mostrará mas de 1.000 impresiones por hora. Si es por clicds, no mostrará más de 1.000 clics por hora.

− max_acciones_dia: ídem anterior, pero por día.

− max_acciones_semana: ídem por semana

− max_acciones_mes: ídem por mes.

− optim_banners_ctr: índique 1 si desea que el peso de los anuncios de la pauta se optimice automáticamente.

− cobro_anunciante_tprecio_modo: modo de precios. Permite indicar precios globales para todo la pauta (todos los espacios tienen el mismo precio) o precios por espacio (cada espacio tiene un precio distinto). Var valores posibles bajo de Referencias – Modos de precios. Es obligatorio indicar un valor si desea indicar el precio de la pauta. Además, si definió en las preferencias del sistema que es obligatorio indicar precios para

todas las pautas, o si está creando una pauta con optimización por eCPM, es obligatorio indicar un valor para este atributo.

− Si se eligió modo de precios global:

− cobro_anunciante_tprecio_venta: forma de comercialización de la pauta con el anunciante. Vea valores posibles bajo Referencias – Tipo de comercialización de pautas. No es necesario que el valor sea el mismo que tipoventa_id. tipoventa_id determina cuántas veces se va a mostrar la pauta. Este parámetro determina cómo se la va a cobrar.

− cobro_anunciante_moneda_id: identificador de la moneda en la cual se vende la pauta al anunciante. Ver Apéndice Monedas.

− cobro_anunciante_precio: precio de la pauta para el anunciante. Si la pauta se comercializa por impresiones, indique el precio por CPM. Si es por clicks (CPC), indique el precio por cada click. Si es sponsor, indique el precio total de la pauta.

− Si se eligió modo de precios por espacio, por cada espacio_id seleccionado debe especificar los siguientes parámetros, reemplazando <espacio_id> por el código del espacio:

− cobro_anunciante_tprecio_venta_<espacio_id>: forma de comercialización para el espacio. Ídem cobro_anunciante_tprecio_venta.

− cobro_anunciante_moneda_id_<espacio_id>: moneda de comercialización del espacio. Ver Apéndice Monedas.

− cobro_anunciante_precio_<espacio_id>: precio para el espacio.

- Si se desea segmentar la pauta a uno o más paises, se deberán agregar los siguientes parámetros:

- target_ccountries: listado de códigos ISO-3166 de paises separados por espacio (ej: “US CA MX”)

- target_country: indicar 1 para segmentación positiva (la pauta se muestra si el usuario está en alguno de los paises indicados) o -1 para segmentación negativa (la pauta se muestra si el usuario NO está en ninguno de los paises indicados).

Parámetros opcionales, disponibles en interfaz de agencia o network:

− pago_sitio_tprecio_modo: modo de precio – global o por espacio. Ídem cobro_anunciante_tprecio_modo.

− Si eligió precios globales:

− pago_sitio_tprecio_venta: forma que la pauta se le pagará al sitio. Ídem cobro_anunciante_tprecio_venta.

− pago_sitio_moneda_id: moneda en que se le pagará al sitio. Ver Apéndice Monedas.

− pago_sitio_precio: precio que se le pagará al sitio. Ver cobro_anunciante_precio.

− Si se eligió modo de precios por espacio, por cada espacio_id seleccionado debe especificar los siguientes parámetros, reemplazando <espacio_id> por el código del espacio:

− pago_sitio_tprecio_venta_<espacio_id>: forma de comercialización para el espacio. Ídem cobro_anunciante_tprecio_venta.

− pago_sitio_moneda_id_<espacio_id>: moneda de comercialización del espacio. Ver Apéndice Monedas.

− pago_sitio_precio_<espacio_id>: precio para el espacio.

Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=a&o=xml

Parámetros:

nombre=Test+CPM&sitio_id=52432&tipoventa_id=1&cantidad_total=100000&prioridad=1&peso=1&intervalo_activacion=1&fecha_inicio=23/03/2006&fecha_fin=23/04/2006&hora_inicio=15:00:00&hora_fin=23:59:59&ptmodo_id=1&target_sitio_id=13212&target_espacio_id=45234+541+4256&accion_retraso_fecha_fin=0&cobro_anunciante_tprecio_modo=3&cobro_anunciante_tprecio_venta_45234=1&cobro_anunciante_moneda_id_45234=1&cobro_anunciante_precio_45234=3.50&cobro_anunciante_tprecio_venta_541=1&cobro_anunciante_moneda_id_541=1&cobro_anunciante_precio_541=2.50&cobro_anunciante_tprecio_venta_4256=2&cobro_anunciante_moneda_id_4256=1&cobro_anunciante_precio_4256=0.20

Explicación de los parámetros:

− nombre: Test CPM

− sitio_id: 52432 – el identificador del anunciante dueño de la pauta

− tipoventa_id: 1 (pauta por CPM)

− cantidad_total: 100000 impresiones

− prioridad: 1

− peso: 1

− intervalo_activacion: fecha de inicio y fecha de fin

− fecha_inicio: 23/03/2006

− fecha_fin: 23/04/2006

− hora_inicio: 15:00:00

− hora_fin: 23:59:59

− ptmodo_id: 1 – distribución uniforme de impresiones

− target_sitio_id: 13212 – el identificador del sitio donde correrá la pauta.

− target_espacio_id: 45234, 541, 426. La pauta correrá en esos 3 espacios.

− accion_retraso_fecha_fin: 0 – continuar hasta cumplir la pauta.

− cobro_anunciante_tprecio_modo: 3 – precios distintos por espacio

− cobro_anunciante_tprecio_venta_45234, cobro_anunciante_moneda_id_45234, cobro_anunciante_precio_45234: el espacio 45234 se vende por CPM, en moneda 1 (dólares) a un precio de 3,50 el CPM.

− cobro_anunciante_tprecio_venta_541, cobro_anunciante_moneda_id_541, cobro_anunciante_precio_541: el espacio 541 se vende por CPM, en moneda 1 (dólares) a un precio de 2,50 el CPM.

− cobro_anunciante_tprecio_venta_4256, cobro_anunciante_moneda_id_4256, cobro_anunciante_precio_4256: el espacio 4256 se vende por CPC, en moneda 1 (dólares) a un precio de 0,20 el click.

Respuesta:




<operacion>



</operacion>


<operacion>


<errores>

<error atributo=”nombre” mensaje=”El nombre ingresado es inválido”/>

<error atributo=”anunciante_id” mensaje=”Código de anunciante inválido”>

<error atributo=”fecha_fin” mensaje=”La fecha de fin no puede ser anterior a la fecha de inicio”>

</errores>

</operacion>

Modificación de pautaModificación de datos de una pauta previamente creada. La operación es muy similar a la creación, con la diferencia que se debe incluir el identificador de la pauta a modificar. Atención: si Ud. realizó modificaciones a la pauta a través de la interfaz de administración, al realizar la modificación a través del API estos cambios se perderán, a menos que los especifique también en el request del API.


URL: /admin/adnet/pub/admin/pautas.html?op=m&o=xml

Requisitos:

− La pauta debe estar creada

− Se debe conocer su identificador (pauta_id)

− La pauta no debe haber sido cancelada.

− Todos los requisitos para creación de pautas.


Se debe incluir el parámetro pauta_id, con el identificador de la pauta. Además, se deben incluir todos los mismo parámetros que para la creación. No se puede omitir ninguno, con las siguientes excepciones:

- Si la pauta ya se ha iniciado, no se puede modificar el parametro fecha_inicio ni hora_inicio, por lo tanto no es necesario incluirlos en el request.


Los mismos parámetros que para la creación de pautas.

Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=m&o=xml

Parámetros:

pauta_id=43242&nombre=Test+CPM&sitio_id=52432&tipoventa_id=1&cantidad_total=100000&prioridad=1&peso=1&intervalo_activacion=1&fecha_inicio=23/03/2006&fecha_fin=23/04/2006&hora_inicio=15:00:00&hora_fin=23:59:59&ptmodo_id=1&target_sitio_id=13212&target_espacio_id=45234+541+4256&accion_retraso_fecha_fin=0



− nombre: Test CPM

− sitio_id: 52432 – el identificador del anunciante dueño de la pauta

− tipoventa_id: 1 (pauta por CPM)


− prioridad: 1

− peso: 1

− intervalo_activacion: fecha de inicio y fecha de fin


− fecha_fin: 23/04/2006


− hora_fin: 23:59:59

− ptmodo_id: 1 – distribución uniforme de impresiones

− target_sitio_id: 13212 – el identificador del sitio donde correrá la pauta.

− target_espacio_id: 45234, 541, 426. La pauta correrá en esos 3 espacios.

− accion_retraso_fecha_fin: 0 – continuar hasta cumplir la pauta.

Respuesta:




<operacion>


</operacion>


<operacion>


<errores>

<error atributo=”nombre” mensaje=”El nombre ingresado es inválido”/>

<error atributo=”anunciante_id” mensaje=”Código de anunciante inválido”>


</errores>

</operacion>

Modificación de fechas y cantidades de pautaModificación de los siguientes atributos de una pauta: fecha_inicio, fecha_fin, cantidad_total.


URL: /admin/adnet/pub/admin/pautas.html?op=mfc&o=xml

Requisitos:




− La pauta no debe tener múltiples fechas de inicio y fin

− La pauta no debe tener asignaciones de acciones (impresiones o clicks) por espacio.

− Si la pauta ya comenzó, no se puede modificar la fecha de inicio.

− La pauta no debe haberse completado.

− La fecha de inicio siempre debe ser futura. La fecha de fin debe ser posterior a la fecha de inicio y también futura.


Se debe incluir el parámetro pauta_id, con el identificador de la pauta. Además, se deben incluir los siguientes parámetros:

- fecha_inicio: fecha de inicio de la pauta. Sólo se puede indicar si la pauta está en estado Programada o Programada y Aprobada. Debe ser una fecha futura.

- fecha_fin: fecha de finalización de la pauta. Debe ser una fecha futura y mayor que la fecha de inicio.

- cantidad_total: cantidad de impresiones, clicks o conversiones asignada a la pauta. Debe ser un número entero mayor o igual a la cantidad de impresiones (o clicks o conversiones) ya cumplidas. Ej: si la pauta ya cumplió 5.000 impresiones, no se puede especificar una cantidad menor a 5.000.


− hora_inicio: hora de inicio de la pauta. Si no se la especifica, se toma como 00:00:00.

− hora_fin: hora de fin de la pauta, en la fecha_fin. Si se la omite, se toma el

valor 23:59:59.

Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=mfc&o=xml

Parámetros:

pauta_id=43242&&cantidad_total=100000&fecha_inicio=23/03/2006&fecha_fin=23/04/2006&hora_inicio=15:00:00&hora_fin=23:59:59





− fecha_fin: 23/04/2006


− hora_fin: 23:59:59

− Respuesta:




<operacion>


</operacion>


<operacion>


<errores>


</errores>

</operacion>

Modificación de tipo de pautaPermite modificar una pauta Sponsor a CPM o CPC y todas las combinaciones entre estos tres tipos.


URL: /admin/adnet/pub/admin/pautas.html?op=mt&o=xml

Requisitos:




− La pauta no debe tener múltiples fechas de inicio y fin

− La pauta no debe tener asignaciones de acciones (impresiones o clicks) por espacio.

− La pauta no debe tener límites de acciones por intervalos de tiempo (ej: por hora, por semana, etc)

− La pauta no debe haberse completado.


Se debe incluir el parámetro pauta_id, con el identificador de la pauta. Además, se deben incluir los siguientes parámetros:

- tipoventa_id: tipo de venta de la pauta. Ver valores posibles en Anexo. Sólo se puede indicar las opciones CPM, CPC o Sponsor.

- cantidad_total: cantidad de impresiones o clics asignada a la pauta. Debe ser un número entero mayor o igual a la cantidad de impresiones (o clicks o conversiones) ya cumplidas. Ej: si la pauta ya cumplió 5.000 impresiones, no se puede especificar una cantidad menor a 5.000. El valor es opcional para el caso de pautas Sponsor.

Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=mt&o=xml

Parámetros:

pauta_id=43242&&cantidad_total=100000&tipoventa_id=1




− tipoventa_id: 1 – pauta por CPM

− Respuesta:




<operacion>


</operacion>


<operacion>


<errores>

<error atributo=”cantidad_total” mensaje=”La cantidad de impresiones no puede ser inferior a la cantidad ya cumplida por la pauta”>

</errores>

</operacion>

Suspensión de pautaSuspende una pauta que está activa

URL: /admin/adnet/pub/admin/pautas.html?op=sus&o=xml

Requisitos:

− La pauta debe estar activa



Se debe incluir el parámetro pauta_id, con el identificador de la pauta.

Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=sus&o=xml

Parámetros:

pauta_id=43242



− Respuesta:




<operacion>


</operacion>

Aprobación de pautaAprueba una pauta para que comience a ejecutarse.

URL: /admin/adnet/pub/admin/pautas.html?op=apr&o=xml

Requisitos:

− La pauta debe estar en estado Inicial o Programada


− El usuario debe tener el permiso de aprobación de pautas



Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=apr&o=xml

Parámetros:

pauta_id=43242



− Respuesta:




<operacion>


</operacion>

Cancelación de pautaCancela una pauta creada – la misma deja de correr.

URL: /admin/adnet/pub/admin/pautas.html?op=b&o=xml

Requisitos:

− Se debe conocer el identificador (pauta_id)

− El usuario debe tener el permiso de borrado de pautas



Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=b&o=xml

Parámetros:

pauta_id=43242



− Respuesta:




<operacion>


</operacion>

Finalización de pautaPasa una pauta al estado Completada – la pauta deja de correr

URL: /admin/adnet/pub/admin/pautas.html?op=completar&o=xml

Requisitos:

− La pauta debe estar en estado Activa o Activa/Fuera de horario


− El usuario debe tener el permiso de completar/finalizar pautas



Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=completar&o=xml

Parámetros:

pauta_id=43242



− Respuesta:




<operacion>


</operacion>

Reactivación de pautaPasa una pauta del estado Completada a Activa, siempre y cuando la misma haya sido completada dentro de los últimos 30 días.

URL: /admin/adnet/pub/admin/pautas.html?op=ap&o=xml

Requisitos:

− La pauta debe estar en estado Completada


− El usuario debe tener el permiso de reactivar pautas



Ejemplo de request:

URL: /admin/adnet/pub/admin/pautas.html?op=ap&o=xml

Parámetros:

pauta_id=43242



− Respuesta:




<operacion>


</operacion>

Listado de usuariosLista las usuarios creados en el sistema.

URL: /admin/adnet/pub/admin/usuarios.html?op=l&o=xml


/admin/adnet/pub/admin/usuarios.html?op=l&o=xml

Respuesta:

Contiene una lista de objetos <usuario>. El identificador se especifica mediante el atributo usuario_id y los datos presentados son los siguientes:

− sitio_id: identificador del sitio, anunciante, agencia o network a la cual pertenece el usuario

− fecha_ultima_sesion: fecha de inicio de la ultima sesión abierta por el usuario en la interfaz

− estado: campo de bits que indica el estado del usuario. 1=bloqueado administrativamente, 2=bloqueado por falta de uso, 4=de uso interno

− login: identificación del usuario para acceso a la interfaz

− nombre

− apellido




<lista>

<usuario usuario_id="1922">


<fecha_ultima_sesion>2009-09-28 13:25:18</fecha_ultima_sesion>

<fecha_baja></fecha_baja>


<estado>0</estado>

<login>ana</login>

<usuario_id>1922</usuario_id>

<apellido>Balcarce</apellido>

<nombre>Ana</nombre>

</usuario>

</lista>

Listado de palabras claveObtiene un listado de las palabras clave configuradas en el sistema.

URL: /admin/adnet/pub/admin/tkeywords.html?op=l&o=xml

Respuesta:

Contiene una lista de objetos <tkeyword>. El identificador se especifica mediante el atributo tkeyword_id y los datos presentados son los siguientes:

− nombre: nombre de la palabra clave

− fecha_alta: fecha de creación

− tipo: ver anexo Tipos de palabras clave

− tkeyword_id: identificador de la palabra clave

− clave_tag: identificador utilizado en los tags para enviar el valor del keyword a e-planning

− opciones: listado de elementos con las opciones posibles para la palabra clave en cuestion (sólo válido en palabras clave de tipo Texto con opciones o Tabla de datos)


<lista>

<tkeyword tkeyword_id="24">

<tipo>4</tipo>


<tkeyword_id>24</tkeyword_id>

<opciones>

<item id="1">gato</item>

<item id="2">oso</item>

<item id="3">perro</item>

<item id="4">serpiente</item>

</opciones>

<fecha_baja/>

<clave_tag>animal</clave_tag>

<nombre>animal</nombre>

</tkeyword>


<tipo>2</tipo>



<opciones/>

<fecha_baja/>

<clave_tag>end</clave_tag>

<nombre>Numero con decimales</nombre>

</tkeyword>

Información de una palabra claveDevuelve todos los datos de una palabra clave específica.

URL: /admin/adnet/pub/admin/tkeywords.html?op=v&o=xml

Requisitos:

− Se debe conocer el identificador (tkeyword_id)


Se debe incluir el parámetro tkeyword_id, con el identificador de la palabra clave.

Ejemplo de request:

URL: /admin/adnet/pub/admin/tkeywords.html?op=v&o=xml

Parámetros:

tkeyword_id=43



− Respuesta:

Contiene un objeto <tkeyword> con los siguientes datos:

− nombre: nombre de la palabra clave


− tipo: ver anexo Tipos de palabras clave


− clave_tag: identificador utilizado en los tags para enviar el valor del keyword a e-planning

− opciones: listado de elementos con las opciones posibles para la palabra clave en cuestion (sólo válido en palabras clave de tipo Texto con opciones o Tabla de datos)



<tipo>4</tipo>



<opciones>

<item id="1">gato</item>

<item id="2">oso</item>

<item id="3">perro</item>

<item id="4">serpiente</item>

</opciones>

<fecha_baja/>

<clave_tag>animal</clave_tag>

<nombre>animal</nombre>

</tkeyword>

Borrado de anuncioBorra un anuncio del sistema. Funciona de dos maneras: si no se especifica el parámetro forzar, el sistema controla si el anuncio está asociado a alguna pauta y sólo lo borra si no está asociado a ninguna. Si se especifica la opción forzar, el sistema lo desasocia de cualquier pauta a la que esté asociada antes de borrarlo. Un anuncio borrado no se puede recuperar.

URL: /admin/adnet/pub/admin/anunciantes.html?op=bb&o=xml


- banner_id: identificador del anuncio a borrar

- anunciante_id: identificador del anunciante al cual pertenece el anuncio


− forzar: 1 (se especifica el valor 1)

Ejemplo de request:

URL: /admin/adnet/pub/admin/anunciantes.html?op=bb&o=xml

Parámetros:

− banner_id=43242

− anunciante_id=1234

− forzar=1

− Respuesta:




<operacion>


</operacion>

Informes dinámicosEl API permite acceder a diversos informes del sistema: impresiones y clicks por pauta, por sitio, por espacio, etc. Mediante parámetros se especifica qué información se desea obtener y la respuesta se devuelve en formato CSV. Se debe elegir por qué objeto filtrar (parámetro filter1_id) y luego qué columnas debe tener el informe. Se pueden elegir 1 o 2 columnas, además de las columnas generadas por el sistema que son impresiones, clicks, usuarios únicos, Ips únicas, etc.

El request se debe realizar con el método GET

URL: /admin/adnet/pub/stats/informedinamico.csv?


- filter1_id: código de filtro (pauta, sitio, espacio, etc). Se definen en el anexo Filtros para informes dinámicos.

- objeto_id: código del objeto para el cual se muestra el informe. Si, por ejemplo, en filter1_id se eligió filtrar por una pauta, aquí se debe especificar el ID de esa pauta (pauta_id).

- fechasshortcut_id: se debe incluir siempre con el valor 0.

- fecha_inicio: fecha de inicio del informe

- fecha_fin: fecha de fin del informe. Esta fecha se incluye dentro del informe. Por ejemplo, si se indica fecha_fin 11/11/2006, el informe se muestra hasta las 23:59:59 de esa fecha.


− columna1_id: objeto a mostrar en la primera columna del informe. Los valores posibles se listan en el anexo Objetos para informes dinámicos.

− columna2_id: objeto a mostrar en la segunda columna.

Ejemplo de request:

URL: /admin/adnet/pub/stats/informedinamico.csv

Parámetros:

filter1_id=1&objeto_id=4324&fechasshortcut_id=0&fecha_inicio=1/11/2006&fecha_fin=30/11/2006&columna1_id=12

− filter1_id: filtrar por una pauta (código 1)

− objeto_id: ID de la pauta filtrada

− columna1_id: informe por fecha (código 12)

− fechasshortcut_id: debe ir siempre en 0

− fecha_fin: el informe se brinda desde las 0 horas del 1/11/2006

− fecha_fin: el informe se brinda hasta las 23:59:59 del 30/11/2006

− Respuesta:

Se devuelve un archivo de formato CSV, separado por punto y coma y con comillas dobles como delimitador de todos los campos. En la primera línea se incluye un header


"Date";"Impressions";"Clicks";"Unique users";"Unique IPs";"Click-through rate"

"11/23/2006";"9,721";"0";"9,463";"9,112";"0 %"

"11/24/2006";"8,877";"0";"8,666";"8,486";"0 %"

"11/25/2006";"8,595";"0";"8,382";"8,203";"0 %"

"11/26/2006";"8,462";"0";"8,228";"7,942";"0 %"

"11/27/2006";"9,080";"0";"8,873";"8,415";"0 %"

"11/28/2006";"8,352";"0";"8,111";"7,805";"0 %"

"11/29/2006";"7,441";"0";"7,236";"6,949";"0 %"

"11/30/2006";"4,301";"0";"0";"0";"0 %"

Informes preconfiguradosAdemás de los informes dinámicos, existe otro tipo de informes, llamados preconfigurados. Estos están programados en el sistema y permiten realizar consultas específicas ya prearmadas. Para ejecutar un informe de estos a través del API, es necesario saber antes cuál es su código de informe. El mismo se puede obtener ingresando a la interfaz, elegiendo el informe, y obteniendo su identificador: informe_id. La salida es a través de un archivo CSV, al igual que en los informes dinámicos.

El request se debe realizar con el método GET. El URL se puede obtener ingresando a la interfaz y haciendo click en Exportar Datos.

Fecha de actualización

Para obtener la fecha de actualización de un informe, reemplazar en el URL anterior informe.csv por informe.html y luego agregar a los parámetros:

&o=xml&act=1

Esto emitirá una respuesta del tipo:

<informe informe_id="IDENTIFICADOR"><fecha_actualizacion>TIMESTAMP</fecha_actualizacion></informe>

La fecha se devuelve en segundos desde 1970.

Ejemplo:

<informe informe_id="269"><fecha_actualizacion>1184900400</fecha_actualizacion></informe>

DSM (sistema de compra en línea autoservicio)

Listado de comprasObtiene un listado de las compras realizadas.

URL: /admin/adnet/pub/admin/compras.html?op=l&o=xml


− fecha_inicio y fecha_fin: muestra sólo compras creadas dentro de ese rango de fechas

− pago_fecha_inicio y pago_fecha_fin: sólo muestra compras cuyo pago se efectivizó dentro del rango especificado

Se puede indicar el rango de fechas de compra o el rango de fechas de pago, pero no los dos. Las fechas se deben indicar según el formato seleccionado en la interfaz para el usuario. (DD/MM/AAAA HH:MM:SS o MM/DD/AAAA HH:MM:SS)

Respuesta:

Contiene una lista de objetos <compra>. El identificador se especifica mediante el atributo compra_id . Hasta la versión 4.3, la compras solamente podían ser realizadas por usuarios de anunciantes. A partir de la versión 4.3, las agencias también pueden comprar pautas, y por lo tanto el usuario puede pertenecer a una agencia. Los datos presentados son los siguientes:

− moneda_id: moneda de la compra – ver valores posibles en anexo de monedas

− importe: importe total de la compra


− estado: ver anexo Estados de compras

− usuario_id: identificador del usuario que realizó la compra

− anunciante_id: en caso que la compra haya sido realizada por un anunciante, identificador del anunciante que la realizó.

− agencia_id: en caso que la compra haya sido realizada por una agencia, identificador de la agencia que la realizó.


<lista>

<compra compra_id="145">


<moneda_id>19</moneda_id>


<compra_id>145</compra_id>

<importe>120.0000</importe>


<agencia_id></agencia_id>

<estado>1</estado>

</compra>

<compra compra_id="146">


<moneda_id>19</moneda_id>


<compra_id>146</compra_id>

<importe>120.0000</importe>

<estado>1</estado>

<anunciante_id></anunciante_id>

<agencia_id>566</agencia_id>

</compra>

</lista>

Listado de compras extendidoObtiene un listado de las compras realizadas con toda la información existente de cada compra (pagos, productos, pautas, etc(.

URL: /admin/adnet/pub/admin/compras.html?op=l&o=xml&sc=1


− fecha_inicio: fecha a partir de la cual se listan compras.

− fecha_fin: fecha hasta la cual se listan compras.

Ambos parámetros son opcionales, pero en caso que se especifique uno se deberá especificar el otro también. Las fechas se deben indicar según el formato seleccionado en la interfaz para el usuario. (DD/MM/AAAA HH:MM:SS o MM/DD/AAAA HH:MM:SS)

Respuesta:

Contiene una lista de objetos <compra>. La descripción de cada objeto se indica en el siguiente párrafo, “Información de una compra”.

Información de una compraObtiene el detalle de una compra. Una compra está compuesta por hasta siete estructuras:

− compra: la compra en sí, con información del cliente e importe total

− compra detalle: los items comprados (pautas o productos) y los precios de cada uno

− pago: pago realizado para cancelar la compra. Una compra puede tener varios pagos asociados. Por ejemplo, un usuario puede elegir pagar con tarjeta de crédito, su tarjeta es rechazada y luego elige pagar por depósito bancario. En este caso, la misma compra tiene 2 pagos asociados. Todos los pagos deben ser por el importe total, y solo se permite realizar un nuevo pago si ninguno de los anteriores fue aceptado. En otras palabras, se evita que el usuario pague dos veces la misma compra.

− pago – response: respuesta de la pasarela de pagos, conteniendo el estado de la respuesta (aceptado/rechazado/etc) Un mismo pago puede recibir varias respuestas. Por ejemplo, PayPal envía una respuesta sincrónica cuando redirecciona al usuario hacia e-planning, y pocos segundos más tarde envía una respuesta asincrónica, directamente desde los servidores de PayPal, para confirmar la compra. También puede ocurrir que si el usuario intenta con varias tarjetas de crédito, la pasarela envíe una respuesta por cada intento.

− pago – response - detalle: variables adicionales enviadas por la pasarela de pagos. Son particulares de cada pasarela y pueden incluir por ejemplo el modo de pago o el código de autorización.

− anunciante: si la compra fue realizada por un anunciante, se indican aquí los datos del mismo. Si no, se indica el parámetro siguiente:

− agencia: se indican los datos de la agencia que realizó la compra.

Respecto a anunciante y agencia, sólo se indica uno de los dos, y siempre se indica uno. Además, en caso que este disponible, se indica el domicilio de la agencia o anunciante.

Respecto a los estados, tanto la compra como el pago o pago-response tienen todos un atributo estado. La lógica es la siguiente: la compra se crea en estado pendiente. Cuando el usuario elige el modo de pago, se crea también el pago en estado pendiente. Cuando llega una respuesta, si la misma es positiva (compra aprobada o confirmada), tanto la respuesta como el pago se setean en aprobada o confirmada y la compra se setea en

aprobada. Si la respuesta por otra parte es negativa (rechazada), el pago se setea en rechazado y la compra continua en estado pendiente, ya que se puede realizar un nuevo pago en el futuro. Si después de cierto tiempo la compra continúa pendiente, se pasa a estado anulada.

URL: /admin/adnet/pub/admin/compras.html?op=vd&o=xml


- compra_id: el identificador de la compra, que se puede obtener del listado de compras

Respuesta:

Contiene un objeto <compra>. El identificador se especifica mediante el atributo compra_id y los datos presentados son los siguientes:

− moneda_id: moneda de la compra – ver valores posibles en anexo de monedas

− importe: importe total de la compra


− estado: ver anexo Estados de compras

− usuario_id: identificador del usuario del anunciante que realizó la compra

− anunciante_id: identificador del anunciante que realizó la compra

− detalles: lista de objetos compra - detalle, cada uno con los siguientes atributos:

− importe: importe del item

− iva: iva del item

− moneda_id: identificador de la moneda utilizada

− Si se trata de una pauta:

− pauta_id: identificador de la pauta comprada

− packaventa_id: pack seleccionado por el usuario

− Si se trata de un producto:

− dsmproductoconf_id: identificador del producto comprado. Se incluye además toda la información del producto según se detalla en “Información de un producto”

− Si se trata de un combo:

− dsmcomboconf_id: identificador del combo comprado. Se incluye además toda la información del combo según se detalla en “Información de un combo”.

− pagos: listado de objetos pago, cada uno con los siguientes atributos:

− estado: estado del pago – ver Anexo Estados de pagos

− pago_id: identificador del pago

− sistema_pago_id: identificador de la pasarela de pagos utilizada – ver Anexo Pasarelas de pagos

− fecha_alta: fecha en que se comenzó el pago. Es la fecha en que el usuario eligió pagar y fue redirigido a la pasarela de pagos.

− responses: listado de objetos response, cada uno con los siguientes atributos:

− pago_response_id: identificador

− client_ip: IP del usuario o del servidor de la pasarela de pagos desde la cual se recibió la respuesta

− estado de la respuesta: ver Anexo Estados de Pagos.

− tipo: indica si la respuesta fue sincrónica (s), es decir, que vino del usuario, o asincrónica (a), que vino del servidor de la pasarela de pagos.

− detalles: atributos enviados por la pasarela de pagos en su respuesta. Son particulares de cada pasarela de pagos. Cada atributo consiste en un objeto detalle con los siguientes campos:

− clave: nombre del atributo

− valor: valor del atributo

− anunciante: información del anunciante

− agencia_id: identificador de la agencia asociada al anunciante (opcional)

− industria_id: código de industria


− observaciones


− razon_social: razón social

− url: dirección de la página web

− tipo_persona: 0 para persona física, 1 para persona jurídica

− tax_id: identificador tributario (ej: VAT, NIT, RUT u otros)

− tax_status_id: tipo de contribuyente – ver valores posibles en Anexo Tipo de Contribuyente

− Los siguiente parámetros se incluyen dentro del anunciante provisoriamente, pero serán removidos en versiones siguientes:

− cargo: cargo del usuario


− nro_documento: número de documento

− tipodoc_id: tipo de documento (ver Anexo Tipo de Documento)

− agencia: información de la agencia


− observaciones


− url: dirección de la página web

− domicilio: información de un domicilio (de anunciante o agencia)

− direccion: calle y número

− ciudad

− cp: código postal (opcional)

− region: estado, región o departamento

− país


<compra anunciante_id="15981" agencia_id=”” compra_id="264" estado="3" fecha_alta="0000-00-00 00:00:00" importe="200.0000" moneda_id="1" usuario_id="1765">

<detalles>

<detalle importe="200.0000" iva="0.0000" moneda_id="1" packventa_id="13" pauta_id="11642"/>

</detalles>

<anunciante agencia_id=”” cargo=”” custom_id=”” fecha_nacimiento=”” industria_id=”” nombre=”Test” nro_documento=”” observaciones=”” razon_social=”Test SA” tax_id=”” tax_status_id=”” tipo_persona=”0” tipodoc=”” url=”http://www.test.com/”>

<domicilio ciudad=”Lanus” cp=”4324” direccion=”Avda Hip Yrigoyen 443” pais=”Argentina” region=”Buenos Aires”/>

</anunciante>

<pagos>

<pago estado="1" fecha_alta="2009-05-11 14:58:26" pago_id="281" sistema_pago_id="6"/>

<pago estado="1" fecha_alta="2009-05-11 15:10:11" pago_id="282" sistema_pago_id="6"/>

<pago estado="3" fecha_alta="2009-05-11 15:21:37" pago_id="283" sistema_pago_id="6">

<responses>

<response client_ip="6476" estado="3" fecha="2009-05-11 15:22:05"

http://www.test.com/

pago_response_id="75" tipo="a">

<detalles>

<detalle clave="a 2" valor="" />

<detalle clave="business" valor="[email protected]" />

<detalle clave="charset" valor="windows-1252" />

<detalle clave="first_name" valor="Test" />

<detalle clave="item_name1" valor="paypal" />

<detalle clave="item_number1" valor="42e755e4c8c4d11460b97bcdb722f97f3bc4a56f9112be14" />

<detalle clave="last_name" valor="User" />

<detalle clave="mc_currency" valor="USD" />

<detalle clave="mc_fee" valor="0.45" />

<detalle clave="mc_gross" valor="5.26" />

<detalle clave="mc_gross_1" valor="5.26" />

<detalle clave="mc_handling" valor="0.00" />

<detalle clave="mc_handling1" valor="0.00" />

<detalle clave="mc_shipping" valor="0.00" />

<detalle clave="mc_shipping1" valor="0.00" />

<detalle clave="notify_version" valor="2.8" />

<detalle clave="num_cart_items" valor="1" />

<detalle clave="o" valor="html" />

<detalle clave="option_name1_1" valor="924c6c8a090558e4881fbc0b892ee22b7aae513d4e886aa9" />

<detalle clave="option_selection1_1" valor="" />

<detalle clave="order_id" valor="42e755e4c8c4d11460b97bcdb722f97f3bc4a56f9112be14" />

<detalle clave="payer_email" valor="[email protected]" />

<detalle clave="payer_id" valor="Z53HD4PAK5T2C" />

<detalle clave="payer_status" valor="verified" />

<detalle clave="payment_date" valor="12:02:19 Jun 18, 2009 PDT" />

<detalle clave="payment_fee" valor="0.45" />

<detalle clave="payment_gross" valor="5.26" />

<detalle clave="payment_status" valor="Completed" />

<detalle clave="payment_type" valor="instant" />

<detalle clave="protection_eligibility" valor="Ineligible" />

<detalle clave="quantity1" valor="1" />

<detalle clave="receiver_email" valor="[email protected]" />

<detalle clave="receiver_id" valor="N9DX3KG4TZWCA" />

<detalle clave="residence_country" valor="US" />

<detalle clave="tax" valor="0.00" />

<detalle clave="tax1" valor="0.00" />

<detalle clave="test_ipn" valor="1" />

<detalle clave="transaction_subject" valor="Shopping Cart" />

<detalle clave="txn_id" valor="5KA8878298448953W" />

<detalle clave="txn_type" valor="cart" />

<detalle clave="verify_sign" valor="AzdrjT9lkqchJ-IVRZ9LrAPFO6OiACo7QyLH6P.XB7qraMV9i4O1Y9Tz" />

</detalles>

</response>

</responses>

</pago>

</pagos>

</compra>

Información de un productoObtiene el detalle de un producto comprado, con su configuración. Un producto tiene un nombre y una clase de producto asignado, así como una serie de atributos que dependen de la clase de producto.

URL: /admin/adnet/pub/admin/compras.html?op=vpc&o=xml


- dsmproductoconf_id: el identificador del producto, que se puede obtener de la información de detalles de una compra.

Respuesta:

Contiene un objeto <productoconf>. El identificador se especifica mediante el atributo dsmproductoconf_id y los datos presentados son los

siguientes:

− dsmproducto_id: identificador de la clase de producto.

− nombre: nombre de la clase de producto

− atributos: listado de elementos atributo para cada uno de los atributos definido:

− atributo: nombre del atributo según se definió en la interfaz

− dsmatributo_id: identificador del atributo

− valor: valor ingresado por el usuario para el atributo. En el caso de atributos de tipo Imagen, el archivo se debe obtener realizando otro request al API, según se indica a continuación.



<productoconf dsmproducto_id="2" dsmproductoconf_id="74" producto="GPS">

<atributos>

<atributo atributo="Nombre de la empresa:" dsmatributo_id="18" valor="soy un gps" />

<atributo atributo="Descripción" dsmatributo_id="19" valor="gps" />

<atributo atributo="Calle:" dsmatributo_id="20" valor="libertad" />

<atributo atributo="Numero:" dsmatributo_id="21" valor="24" />

<atributo atributo="Intersección:" dsmatributo_id="22" valor="pacheco" />

<atributo atributo="Localidad:" dsmatributo_id="23" valor="rosales" />

<atributo atributo="Partido:" dsmatributo_id="24" valor="punta gorda" />

<atributo atributo="Provincia:" dsmatributo_id="25" valor="durazno" />

<atributo atributo="Logo" dsmatributo_id="26" valor="26" />

</atributos>

</productoconf>

Acceso a un archivo de imagen de un productoBaja el archivo subido por el usuario como atributo de la configuración de un producto.

URL: /admin/adnet/pub/admin/compras.html?op=vpi&o=xml


- dsmproductoconf_id: el identificador del producto, que se puede obtener de la información de detalles de una compra.

- dsmatributo_id: identificador del atributo que contiene la imagen. Se puede obtener de los detalles de un producto.

Respuesta

Se devuelve el archivo de la imagen tal como lo subió el usuario. Se utiliza siempre como content type image/gif.

Información de un comboObtiene el detalle de un combo comprado.

URL: /admin/adnet/pub/admin/compras.html?op=vcc&o=xml


- dsmcomboconf_id: el identificador del combo, que se puede obtener de la información de detalles de una compra.

Respuesta:

Contiene un objeto <comboconf>. El identificador se especifica mediante el atributo dsmcomboconf_id y los datos presentados son los siguientes:

− combo: nombre de la clase de combo tal como se definió en la interfaz

− combo_id: identificador de la clase de combo

− productos: listado de productos y pautas que componen el combo, dentro de elementos producto: Cada uno tiene los siguientes atributos

− Si es una pauta:

− packventa_id: identificador del pack seleccionado

− pauta_id: identificador de la pauta creada

− Si es un producto:

− dsmproductoconf_id: identificador del producto configurado. Su información se puede obtener mediante la visualización de información de un producto, descripta más arriba.


<comboconf combo="1- Combo Oro" combo_id="6"

dsmcomboconf_id="85">

<productos>

<producto packventa_id="6" pauta_id="11796" />

<producto dsmproductoconf_id="75" />

</productos>

</comboconf>

Listado de registrosObtiene un listado de los registros de anunciantes al sistema.

URL: /admin/adnet/pub/admin/registraciones.html?op=l&o=xml


− fecha_inicio: fecha a partir de la cual se listan registros.

− fecha_fin: fecha hasta la cual se listan registros.

Ambos parámetros son opcionales, pero en caso que se especifique uno se deberá especificar el otro también. Las fechas se deben indicar según el formato seleccionado en la interfaz para el usuario. (DD/MM/AAAA HH:MM:SS o MM/DD/AAAA HH:MM:SS)

Respuesta:

Contiene una lista de objetos <registro>. Cada registro puede estar confirmado o no. Si el registro está confirmado, quiere decir que además existe un anunciante asociado, y se indica el anunciante_id correspondiente. Además, en próximas versiones se podrán realizar registros de sitios (publishers). Por eso hay que tomar en cuenta el parámetro sitipo_id, para determinar si el registro corresponde a un anunciante o a un sitio.

Los datos presentados son los siguientes:

− apellido: apellido de la persona

− nombre: nombre de la persona


− cargo

− email

− estado: ver anexo Estados de Registros

− sitipo_id: tipo de organización. Por ahora solo puede recibir el valor 1024, que corresponde a anunciante.

− anunciante_id: en caso que el registro haya sido confirmado, y se trate de un registro de anunciante, se indica aquí el identificado del anunciante relacionado.


− tipodoc_id: tipo de documento de la persona – ver anexo Tipos de Documento

− nro_documento: número de documento de la persona

− razon_social

− tax_id: identificador tributario

− tax_status: tipo de contribuyente

− telefono

− tipo_persona: 0 para persona física, 1 para persona jurídica

− tax_id: identificador tributario (ej: VAT, NIT, RUT u otros)

− tax_status_id: tipo de contribuyente – ver valores posibles en Anexo Tipo de Contribuyente

− domicilio: indica el domicilio relacionado



<lista>

<registro anunciante_id="16133" apellido="De Pino" cargo="" email="[email protected]" estado="3" fecha_alta="2007-11-05 11:13:56" fecha_nacimiento="" nombre="Juan" nro_documento="" razon_social="Bur" sitipo_id="1024" tax_id="" tax_status_id="" telefono="4322 1111" tipo_persona="0" tipodoc_id="" />

</lista>

Apéndice I - Referencias

Estados de pautas

Código Descripción

ACT Activas y activas fuera de horario

1 En definición

2 Programada

3 Programada y aprobada

4 Activa

5 Suspendida

6 Rechazada

7 Cancelada

8 Completada

20 Activa fuera de horario

Tipos de comercialización de pautas (tipoventa_id)


1 CPM

2 CPC

3 CPA

4 Sponsor

Modos de precios para pautas


1Precios globales para toda la pauta: todos los espacios y creatividades tienen el mismo precio

3Precios por espacio: se pueden definir precios distintos por cada espacio

Intervalos de activación de pautas


1 Simple: fecha de inicio y fecha de fin

2 Fecha de inicio y fecha de fin + horario semanal

3 Múltiples fechas de inicio y fin

4 Fecha de inicio sin fecha de fin

5 Fecha de inicio sin fecha de fin + horario semanal

Modos de distribución de pautas (ptmodo_id)


1 Distribución uniforme

2 Lo antes posible

3Distribución uniforme – redistribuir si la pauta se adelanta

Acción al retrasarse una pauta


0 Continuar hasta cumplir la cantidad estipulada

524288 Suspender la pauta en la fecha de fin

1048576 Marcar la pauta como completada

Tipos de sitios y anunciantes (variable sitipo_id)


4 Anunciante estándar

1024 Anunciante de autogestión

Monedas (variable moneda_id)


1 Dólar estadounidense

2 Euro

3 Libra esterlina

4 Franco suizo

5 Baaht tailandés

7 Bolivar venezolano

8 Boliviano de Bolivia

9 Real de Brasil

19 Peso argentino

21 Uruguay

23 Peso chileno

24 Peso colombiano

25 Peso cubano

29 Yen


Tipos de tamaños de espacios (variable tamano_tipo)


f

Tamaño fijo. Sólo se podrán subir anuncios del tamaño especificado, o también anuncios que se muestren por arriba o por fuera del espacio (layers, pops)

vTamaño variable. Se podrá subir cualquier tipo de anuncio de cualquier tamaño.

iInvisible. Sólo para subir anuncios que se muestran por sobre la página (layers) o en una nueva ventana (pops)

t Texto. Sólo para mostrar links de texto.

Reglas para nómbres válidosLos nombres de objetos deben contener al menos una letra y no pueden contener ninguno de los siguientes caracteres: < > \ " ' = & /

Filtros para informes dinámicos


1 Pauta

3 Espacio

4 Sitio

5 Anunciante

14 Sección

16 Conversiones

18 Global (toda la información – sin filtro)


Objetos para informes dinámicos


1 Pauta

2 Anunciante

3 Espacio

4 Anuncio

5 País

6 Sitio

7 Idioma

8 Navegador

9 Sistema operativo

10 Ciudad

11 Región

12 Fecha

13 Fecha y hora

14 Año y mes

15 Año

16 Mes del año

17 Semana del año

18 Semana del mes

19 Día del mes

20 Día de la semana

21 Hora del día


22 Prioridad de pauta

23 Peso de pauta

24 Sección

25 Tamaño del anuncio

25 Código de conversión

27 Red

28 Grupo de pautas

Tipos de palabras clave


1 Número entero

2 Número con decimales

3 Texto libre

4 Texto con opciones

5 Tabla de datos

Estados de compras


1 Pendiente – aún no se ha registrado el pago efectivo

2Aprobada – el usuario realizó el pago y se efectivizo la compra

5

Anulada – ya sea manualmente o porque pasó demasiado tiempo desde que se realizó la compra y nunca se recibió el pago

Estados de pagos


1

Pendiente – el usuario eligio una pasarela de pago pero aún no se recibió una respuesta o la pasarela indicó que el pago está aún pendiente

2Aprobado – el usuario realizó el pago y se recibió una confirmación sincrónica de la pasarela de pagos

3Confirmado – el pago se realizó y se recibió una confirmación asincrónica de la pasarela de pagos

4Rechazado – el usuario intento realizar el pago y el mismo fue rechazado

Pasarelas de pagos (sistema_pago_id)


1 NPS

2 PayPal

3 Pago Fácil

4 Depósito bancario (con confirmación manual)

5Pago Fácil (con envío de notificaciones de pagos vía email)

6 Pagos Online

7 Pagamento Digital

8 e-Collect

9 Débito en cuenta corriente

Tipo de contribuyente (tax_status_id)

El código depende del país del anunciante.

País Código Descripción

AR 1 Responsable inscripto

AR 2 Responsable no inscripto

AR 3 Responsable monotributo

AR 4 Consumidor final

AR 5 Exento

CO 1 Régimen común

CO 2 Régimen simplificado

CO 3 Exento

CO 4 Excluido

Tipos de documento (tipodoc_id)

tipodoc_id

País Descripción

1 AR DNI

2 AR CI

3 AR LC

4 AR LE

5 AR Pasaporte

6 CO CC

7 CL CI

8 BR RG

9 MX CURP

tipodoc_id

País Descripción

10 PE DNI

11 UY CI

41Cualquie

raID Card

42Cualquie

raPassport

Estados de registros


1 Pendiente

2 E-mail de confirmación enviado

3Confirmado – cuando el registro requiere confirmación y ha sido confirmado

4Activo – cuando el registro no requiere confirmación y se activa directamente

Apéndice II – Historial de cambios

Versión 4.1:− Reactivación de pautas

Versión 4.0.19:− Cancelación, finalización y aprobación de pautas

Versión 4.0.18:− Suspensión de pautas

Versión 4.0.16:− Documentación de informes dinámicos.

Versión 4.0.12:− Modificación parcial de pauta: permite modificar fechas y cantidad

total.

Versión 4.0.11:− Posibilidad de indicar cantidad de acciones por espcio (parámetros

acciones_por_espacio y cantidad_total_<espacio_id>).

Versión 4.0.10:− Se agrega la posibilidad de indicar precios distintos por espacio en

cada pauta. Nuevos parámetros: cobro_anunciante_tprecio_modo y pago_sitio_tprecio_modo. Además, se agregan los parámetros cobro_anunciante_tprecio_venta_<espacio_id>, cobro_anunciante_moneda_id_<espacio_id>, cobro_anunciante_precio_<espacio_id>, pago_sitio_tprecio_venta_<espacio_id>, pago_sitio_moneda_id_<espacio_id>, pago_sitio_precio_<espacio_id>

Versión 4.0.13:− Se agrega posibilidad de modificar el tipo de venta de una pauta.

− Creación de anunciantes de autogestión

− Indicación de precios y opciones para pautas por eCPM

− Tabla de monedas

Versión 4.0.13c:− Planificador de inventario por espacios

Versión 4.0.14:− Listado de palabras claves

− Obtención de datos de una palabra clave

Versión 4.2.1:− Listado de grupos de espacios

− Nuevos atributos en la información de una pauta

Versión 4.2.1b:− Nuevos atributos en listado de pautas

− Corrección de URL de listado de sitios

− Corrección de los valores posibles para estado de espacios

Versión 4.2.1c− DSM: listado e información de compras

Versión 4.2.1d− DSM: modificación en los estados de compras

− DSM: modificación en la estructura de información de una compra

Versión 4.2.3− Creción de pauta: segmentación por paises

− Creción de espacios

Versión 4.2.4− DSM: información de productos y combos.

− DSM: posibilidad de filtrar por fechas el listado de compras

− Borrado de anuncio

Versión 4.2.6− Listado de anunciantes, sitios y pautas: se incluye el identificador

personalizado

− Listado de usuarios

Versión 4.2.7− Listado de compras extendido

Versión 4.3− DSM: información del anunciante en listado de compras.

− DSM: modificación en listado y vista de compras: puede haber compras con agencia y sin anunciantes

Versión 4.3.3− DSM: listado de registros

− DSM: listado de compras – se permite filtrar por fecha de pago

Versión 4.3.4− DSM: información de un anunciante

Versión 4.3.8− Se agrego la explicacion del campo pauta_tracer_id al agregar una pauta

CPA.

− Alta, baja y modificación de sitios y secciones

− Activar y archivar espacios, sitios y secciones.

− Modificación de espacio.

e-planning api de acceso xml manual de uso v 4.3 · e-planning api de acceso xml manual de uso v...

Documents