Vista de Pauta

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

URL: /admin/jsapi/pauta?op=v 

Parámetro obligatorio:

•  pauta_id:  identificador de la pauta. 

 

Ejemplos de URL con parámetro:

/admin/jsapi/pauta?op=v&pauta_id=5521 

 

Respuesta: 

 ·           status: parámetro que indica el estado de la operación, si la misma se desarrollo en forma correcta, el valor sera 200. 

 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 valores posibles en Referencias   -  Estados de pautas

    .       encoded_id: id de pauta encodeado. Para se utilizado en tags.

·           tipoventa_id: tipo de comercialización de la pauta. Ver valores posibles en Referencias - Tipos de comercialización de pautas.

·           custom_id: identificador personalizado

·           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 Referencias - Modo de distribución de pautas.

·           fecha_inicio: fecha de inicio de la pauta

·           fecha_fin: fecha de finalización de la pauta.  Si tuviera, ya que 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

·           target_country: si la pauta estuviera segmentada por país, el objeto contendrá dos objetos más, de lo contrario el objeto se mostrará vacío:

           - type: indica el tipo de segmentación por país, muestra los valores  1, -1 y 2 para “Mostrar la pauta en estos países”, “No mostrar la pauta en estos países” y “Mostrar la pauta cuando el país es desconocido ” respectivamente.

            - countries: listado de los países elegidos .Ver valores posibles en  Referencias - Países. 

·           target_perfil: si la pauta estuviera segmentada por perfil, el tag contendrá un tag más, de lo contrario el tag se mostrará vacío:

            - perfil_id: contiene un listado de los ids de los perfiles segmentados en la pauta.

·           precio_venta_anunciante: si se puede cobrar a anunciantes el tag contendrá 2 tags, de lo contrario se mostrará vacío:

            - tmodo: muestra el método de cobro a anunciantes, puede contener los valores 0, 1 y 3 para “No especificado”, “Mismo precio para todos los espacios y códigos de conversión” y “Precios distintos por espacio” respectivamente.

            - precio: se mostrará en caso de que el tmodo sea 1 o 3.

  En caso de que sea 1, contendrá un sólo item que contiene los tags:

- precio: contiene el precio asignado.

- moneda_id: contiene el id de la moneda asignada (ver apéndice de monedas).

- tprecio: tipo del precio, puede ser 1, 2, 3 o 4 para CPM, CPC, CPA y Sponsor respectivamente.
 
En caso de que sea 3, contendrá un listado de items que corresponden a cada espacio. Cada uno de los mismos contendrá los  mismos campos que en tmodo = 1 pero  se le suman las etiquetas:

·                       - nombre_espacio: contiene el nombre completo del espacio.

·                       - espacio_id: id del espacio.

·           pago_sitio: el contenido del campo funciona de la misma manera que el de precio_venta_anunciante.

·           observaciones: observaciones de la pauta.

·           target_keywords: si estuviera habilitada la segmentación por palabras claves el contendrá 2 etiquetas, de lo contrario estará vacío:

                   - keywords: contiene una lista de items, cada ítem contendrá:

                   - tkeyword_id: contiene el id la palabra clave.

              - comparación: puede contener los valores 1, 2, 3, 4 o 5, para “Comparación exacta” o “Listado de valores”, “Valor mínimo”, “Valor máximo”, “Valor máximo y mínimo”, “Comparación parcial” respectivamente.

  Según el modo de comparación se agregan más tags al contenido de keywords.

                   Si la comparación es 1 o 5, se agrega la etiqueta values, la cuál contiene las keywords por las cuales se está segmentando.

                   Si la comparación es de 2, se agrega la etiqueta min_value la cual contiene el valor mínimo indicado.

                   Si la comparación es de 3, se agrega la etiqueta max_value la cual contiene el valor máximo indicado.

                   Si la comparación es de 4, se agregan las etiquetas de max_value y min_value.

         - type: indica el tipo de segmentación por palabras clave, puede contener los valores 0 o 1 para “Debe coincidir al menos una palabra clave” y “Deben coincidir todas las palabras claves” respectivamente.       

·           intervalo_activacion: indica con ids qué tipo de intervalo fue seleccionado en la pauta (ej: '1' - Simple - Fecha de inicio y fecha de fin) .Ver valores posibles en  Referencias - Intervalos de activación de pautas.

·           limite_dinero_dia: Indica, si fue seleccionado cuando se creo la pauta, el valor limite de gasto por día.

·           max_impresiones_sesion: indica la cantidad máxima de impresiones por sesión del usuario.

·           max_impresiones_usuario: indica la cantidad máxima de impresiones por usuario.

·           max_acciones_dia: cantidad máxima de acciones por día.

·           target_os: indica la segmentación por sistema operativo. Si la misma se encuentra desactivada, este elemento se encontrara vacío. Si la segmentación esta activada, este elemento va a estar formado por:

            -type: indica que tipo de segmentación por OS se selecciono. sus valores pueden ser:

                       1  mostrar a estos sistemas operativos

                       -1  no mostrar a estos sistemas operativos

                       3 mostrar  a estas versiones de sistemas operativos

                       4 no mostrar a estas versiones de sistemas operativos

            - target: lista de sistemas operativos o versiones de sistemas operativos.

                      

·           target_bproduct: indica la segmentación por navegador. Si la misma se encuentra desactivada, este elemento se encontraría vacío. Si la segmentación esta activada, este elemento va a estar formado por:

            - type: indica si la segmentación es positiva o negativa, si el valor es 1, la misma es positiva y si el valor es -1, esta es negativa.

            - browsers: lista de navegadores

·           target_bptype: indica la segmentación por tipo de navegador. Si la misma se encuentra desactivada, este elemento se encontraría vacío. Si la segmentación esta activada, este elemento va a estar formado por:

            - type: indica si la segmentación es positiva o negativa, si el valor es 1, la misma es positiva y si el valor es -1, esta es negativa.

            - bptypes: lista de códigos de los tipo de navegadores seleccionados

·           target_mobbrand: Indica la segmentación mobile por marca de dispositivo, si la misma esta desactivada, este elemento se encontrara vacío, si se encuentra activada, va a contener dos elementos :

- type: va a tener el valor 1 si la segmentación es positiva, y el valor -1 si la segmentación es negativa.

- mobbrand: lista de códigos que identifican a las marcas seleccionadas.

·           target_mobmodel: Indica la segmentación mobile por modelo de dispositivo, si la misma esta desactivada, este elemento se encontrara vacío, si se encuentra activada, va a contener dos elementos :

- type: va a tener el valor 1 si la segmentación es positiva, y el valor -1 si la segmentación es negativa.

- mobmodel: lista de códigos que identifican a las modelos seleccionados.

·           intervalo_sesiones: este objeto indica cada cuantas horas se considera que caduca la sesión del usuario.

·           pct: indica los códigos de conversiones asociados a la pauta. Si no se encuentra asociado ningún código de conversión, el elemento se recibirá vacío. Si hay algún código de conversión asociado, pct va a estar compuesto por:

            - pct: su valor es 1

            - pauta_tracer_id: lista de los códigos de conversión  asociados.

·           target_geo: Indica la segmentación geográfica seleccionada en la pauta. Si esta segmentación se encuentra desactivada, este objeto vendrá vacío. Si la misma se encuentra activada va a estar compuesta de 3 objetos:

            - target_filtro: Indica el tipo de segmentacion seleccionada.

            los distintos valores posibles son: 1 - ciudad, 2 - región, 3 - código postal, 4 - código de área telefónico, 5 - red.

            - target_filtro_signo: Indica si la segmentación es negativa o positiva.

            - target_filtro_id : Lista de elementos del tipo indicado en target_filtro.

·           target_refhosts: Indica los dominios por los cuales la pauta se encuentra segmentada. Contiene dos elementos dentro:

            -target_refhosts : Lista de dominios

            -target_refhost: Si es 0 indica segmentación negativa, si es un 1 indica segmentación positiva.

 

·           mobfeatures: Este objeto indica características mobile por las cuales segmentamos positivamente o negativamente. Esta compuesto por dos elementos:

            - target_moboptions_neg : Lista de características por las cuales la pauta esta segmentada negativamente.

            - target_moboptions_pos : Lista de características por las cuales la pauta esta segmentada positivamente.

 

Ejemplo de respuesta:

 

Ejemplo en PHP:

Loguearse a API y obtener info de una pauta (mediante su pauta_id):

    $username       = 'usuario@dominio';
    $password        = 'reemplazar_por_pass';
    $url                   = 'https://admin.us.e-planning.net/admin/jsapi/pauta?op=v'; //Vista de pauta
    $postData         = 'pauta_id=433256';

    //Iniciando sesión cURL
    $process   = curl_init($url);
    curl_setopt($process, CURLOPT_HEADER, 0);
    curl_setopt($process, CURLOPT_USERPWD, $username . ':' . $password);
    curl_setopt($process, CURLOPT_TIMEOUT, 30);
    curl_setopt($process, CURLOPT_POST, 1);
    curl_setopt($process, CURLOPT_POSTFIELDS, $postData);
    curl_setopt($process, CURLOPT_RETURNTRANSFER, TRUE);
    $return     = curl_exec($process);

    //Se obtiene por ej. el json de respuesta y con json_decode se obtiene el array equivalente
    $arrReturn  = json_decode($return, true);

Referencias:
Donde $arrReturn['pauta']['nombre'] corresponde al nombre de una pauta que se recorre de un array previo.
Los valores de los parametros deben ser pasados encodeados (urlencode).