Si adjunta un archivo, debe ser POST con encoding multipart/form-data. Si no se adjunta archivo, puede ser GET.
URL: /admin/jsapi/pautabanner?op=ab
Requisitos:
Antes de crear un anuncio, deben estar creados en el sistema:
- El anunciante y la Pauta a la cual estará asociado el anuncio. Se debe conocer el identificador de la pauta.
- El o los espacios donde va a correr la pauta. Se deben conocer sus identificadores.
Parámetros obligatorios comunes a todos los formatos:
- pauta_id: identificador de la pauta a la cual se quiere asociar el nuevo anuncio.
- banformato_id: identificador de formato del anuncio a crear. Ver valores posibles en Referencias.
- nombre: nombre del anuncio. Debe cumplir con las reglas para nombres válidos. No puede haber anuncios del mismo anunciante con el mismo nombre.
- layer_efecto: indentifica el tipo de efectos a aplicar al banner. Ver valores posibles en Referencias.
- alttext: titulo del anuncio. En anuncios con efectos, el titulo puede seleccionar como una opcion visible para el usuario final.
- linkurl: la url de click, o landing page del anuncio.
- prioridad: prioridad del anuncio en relación a otros asociados a la misma pauta. Valores posibles: de 1 a 10.
- peso: peso del anuncio en relación a otros asociados a la misma pauta. Valores posibles: de 1 a 100.
- url_conteo / url_conteo2 / url_conteo3: permite incorporar pixels tracking externas para conteo conjunto de impresiones.
- target_espacio_id_xxxx=xxxx (sustituir los xxxx por el identificador del espacio).
Parámetros adicionales para formato LINK DE TEXTO: - font_size: tamaño de la fuente
- font_family: el nombre que identifica la fuente en el sistema.
- font_color: color seleccionado para fuente en codigo RGB
- html_code: codigo HTML para V3. En caso de Utilizar V4 se ingresan las etiquetas '<html></html>'.
- link_texto_descripcion: lineas descriptivas del anuncio, para el caso de seleccionar efectos del anuncio con 'decripción'. Se pueden enviar la linea descriptiva 1 y 2 por separado dentro del mismo parametro. Se deben enviar ambas lineas separadas por '\n' (CR / 0x13). Si se está enviando por navegador en metodo GET utilizar dicho caracter encodeado %0A
- link_texto_url: url visible (puede ser una url simplificada que permita visualizar mejor la marca), para el caso de seleccionar efectos del anuncio con 'url'
Parámetros adicionales para formato GIF/JPG/PNG: - origen: puede tomar los valores 'file' (si se adjunta un archivo) o 'url' (si se especifica una url donde esta hosteado el anuncio)
- archivo: indicar el archivo de la imagen, en el caso de haber seleccionado origen=file. El archivo se debe adjuntar con método POST y con encoding multipart/form-data
- url_anuncio: indicar la url donde esta alojada la imagen, en el caso de seleccionar origen=url
- text_align: puede tomar los valores 'left' 'center' o 'right', y determina la posición del anuncio en pantalla.
- link_texto_descripcion: lineas descriptivas del anuncio, para el caso de seleccionar efectos del anuncio con 'descripción'. Se pueden enviar la linea descriptiva 1 y 2 por separado dentro del mismo parámetro. Se deben enviar ambas lineas separadas por '\n' (CR / 0x13). Si se está enviando por navegador en método GET utilizar dicho carácter encodeado %0A
- link_texto_url: url visible (puede ser una url simplificada que permita visualizar mejor la marca), para el caso de seleccionar efectos del anuncio con 'url'
Parámetros adicionales para formato Flash:
- origen: puede tomar los valores 'file' (si se adjunta un archivo) o 'url' (si se especifica una url donde esta hosteado el anuncio)
- archivo: indicar el archivo de la imagen, en el caso de haber seleccionado origen=file. El archivo se debe adjuntar con método POST y con encoding multipart/form-data
- url_anuncio: indicar la url donde esta alojada la imagen, en el caso de seleccionar origen=url
- text_align: puede tomar los valores 'left' 'center' o 'right', y determina la posición del anuncio en pantalla.
- flash_background_type: puede tomar los valores 't' 'm' o 'c' según se quiere aplicar transparent, movie o color. En el caso de seleccionar la opcion 'c' , se debe enviar el parametro adicional flash_background_color indicando el color en código RGB
Ejemplo de request para JPEG:
https://admin.eu.e-planning.net/admin/jsapi/pautabanner?op=ab&pauta_id=3180&banformato_id=7&nombre=banneruploadAPI&alttext=title&layer_efecto=0&linkurl=http://www.e-planning.net&prioridad=1&peso=100&target_espacio_id_7479=7479&origen=url&url_anuncio=http://demos.e-planning.net/Anuncio_234x60.JPG&text_align=left
Respuesta:
Contiene un objeto pauta_banner_id , indicando el id del anuncio creado y un objeto status, que indica el estado del resultado, en este caso 200, indica que el anuncio se creo correctamente.
Si la operación es fallida, mediante el objeto errors, muestra un listado de errores, indicando:
- un atributo que indica cada campo erróneo.
- y el valor de cada uno de esos atributos indicando mensaje de error correspondiente.
También contiene un objeto status, que indica que el resultado fue erróneo.
Ejemplo de respuesta sin errores
| {'status':200,'pauta_banner_id':'1938757'} |
Ejemplo respuesta con errores
| {'errors':{'nombre':'Ya existe otro anuncio con el mismo nombre. Por favor elija otro.'},'status':400} |