API de plataforma digital: informe de análisis de valor clave

El informe Análisis de valor clave muestra la información asociada a las claves y valores de segmentación definidos de la red.

Las impresiones con segmentación de clave/valor servirán y se reportarán solo para aquellas impresiones registradas por una etiqueta de emplazamiento que contiene el prefijo kw_ en el nombre de la clave. Por ejemplo, una etiqueta de selección de ubicación que contiene keyname=value1 no servirá y, por lo tanto, no se registrará, mientras que una etiqueta de ubicación que contiene kw_keyname=value1 servirá y se registrará. Esto se aplica a GETlas llamadas de anuncios de cadena de consulta basadas en los siguientes tipos de etiquetas: /tt, /ttj, /fpt, /mtj/pt/vmap/jpt/ssptv/ssvmap/ptv/map/mob/prebid/amp, .

Nota:

Etiquetas de vendedor de AppNexus

Cuando use la etiqueta de vendedor, omita el prefijo kw_ . AST tiene el objeto de palabra clave en el cuerpo de la solicitud (ut/v3), por lo que el prefijo no es necesario. Lo mismo ocurre con otras POSTllamadas de anuncios del cuerpo de solicitud basadas en Prebid (ut/v3/prebid, openrtb2/prebid, prebid/lfv) y OpenRTB (openrtb2).

No todas las impresiones de los segmentos clave/valor se incluirán en los informes. Para ser incluidos, los segmentos deben cumplir los siguientes criterios:

La clave debe estar predefinida. Para obtener más información, consulta la página Pre-defining Targeting keys and Values in the UI.
El valor debe estar predefinido O el valor debe tener como destino al menos una línea de pedido o campaña.
El valor no es un rango numérico (mayor o menor que).
El valor no incluye un carácter comodín.

Período de tiempo

El report_interval campo de la solicitud JSON se puede establecer en uno de los siguientes:

hoy
yesterday
last_24_hours
last_48_hours
last_7_days
last_month
month_to_date
quarter_to_date

Nota:

Para ejecutar un informe para un período de tiempo personalizado, establezca los campos y end_date en la start_date solicitud de informe. Para obtener más información sobre estos campos, vea Servicio de informes.

Fechas que se producen hace más de 45 días

Si crea un informe de análisis de valor clave con el campo Rango establecido en Personalizado (donde la fecha de finalización es superior a 45 días a partir de hoy), el informe (independientemente de las métricas incluidas) se agregará a una cola especial para informes de "uso intensivo de recursos". Como resultado, el informe puede tardar más de lo habitual en completarse. Además, debido a la cantidad de datos que se solicitan, este informe que hace un uso intensivo de recursos puede fallar antes de completarse. Si no se completa el informe, recibirás una notificación. Si se produce un error en la solicitud de informe, puede:

Vuelva a ejecutar el informe más tarde.
Use un tipo de informe distinto de Análisis de valor clave.
Modifique la forma en que estructura los informes (si es posible) para que no incluyan fechas anteriores a 45 días.

Si solicita con frecuencia informes de Key Value Analytics que incluyen fechas de hace más de 45 días, es posible que deba considerar la posibilidad de ejecutar estos informes a través de la API, almacenar en caché los datos y usar fuentes de informes masivas o fuentes de datos de nivel de registro: archivo. Para obtener más información sobre cómo modificar los informes para evitar estos problemas, consulta la página Dimensiones, métricas, filtrado y agrupación de la interfaz de usuario.

Período de retención de datos

Los datos de este informe tienen el siguiente período de retención:

Retención por hora: 100 días
Retención diaria: 500 días

Dimensions

Column	Tipo	¿Filtro?	Ejemplo	Descripción
`month`	date	No	`"2010-02"`	El mes de la subasta.
`day`	date	No	`"2010-02-01"`	El día de la subasta.
`hour`	date	No	`"2010-02-01 06:00:00"`	La hora de la subasta. Nota: Para las impresiones de más de 100 días, se devolverá el día en lugar de la hora.
`buyer_member_id`	Entero	Sí	`123`	El identificador del miembro comprador. Si la impresión no se ha comprado, este campo muestra uno de los siguientes valores: `229` = PSA, `0` = En blanco o `319` = Predeterminado.
`buyer_member_name`	string	No	`"My Network"`	El nombre del miembro comprador. Nota: El nombre podría ser `"Default"` o `"Default Error"`, lo que significa que no hubo ningún comprador para la impresión y se ha enviado una creatividad predeterminada.
`buyer_member`	string	No	`"My Network (123)"`	En desuso (a partir del 17 de octubre de 2016).
`seller_member_id`	Entero	Sí	`456`	El identificador del miembro vendedor.
`seller_member_name`	string	No	`"That Seller"`	El nombre del miembro vendedor.
`seller_member`	string	No	`"That Seller (456)"`	En desuso (a partir del 17 de octubre de 2016).
`placement_id`	Entero	Sí	`1212`	El id. de la ubicación. Nota: Para las impresiones de más de 100 días, las ubicaciones se agregarán en una fila con `-1` el `placement_id` formato .
`placement_name`	string	No	`"lvillage 160x600"`	El nombre del emplazamiento. Nota: Para las impresiones de más de 100 días, las ubicaciones se agregarán en una fila con `"All placement data older than 100 days"` el `placement_name`formato .
`placement`	string	No	`"lvillage 160x600 (1212)"`	En desuso (a partir del 17 de octubre de 2016).
`advertiser_id`	Entero	Sí	`789`	El identificador del anunciante. Si el valor es `0`, o bien la impresión la compró un comprador externo, o bien se mostró un valor predeterminado o PSA.
`advertiser_name`	string	No	`"AdvertiserA"`	El nombre del anunciante.
`advertiser`	string	No	`"AdvertiserA (789)"`	En desuso (a partir del 17 de octubre de 2016).
`line_item_id`	Entero	Sí	`1122`	El identificador del elemento de línea.
`line_item_name`	string	No	`"Line Item 1"`	El nombre de la línea de pedido.
`line_item`	string	No	`"Line Item 1 (1122)"`	En desuso (a partir del 17 de octubre de 2016).
`campaign_id`	Entero	Sí	`222`	El identificador de la campaña.
`campaign_name`	string	No	`"Default Campaign"`	El nombre de la campaña.
`campaign`	string	No	`"Default Campaign (789)"`	En desuso (a partir del 17 de octubre de 2016).
`split_id`	Int	Sí	`342`	El identificador de la división que compró las impresiones de este conjunto de datos. Las divisiones solo se aplican a las líneas de pedido aumentadas. Para cualquier informe que contenga campañas, el `split_id` (si se incluye) será `null` .
`split_name`	string	Sí	`"Mobile Split A"`	El nombre de la división que compró las impresiones de este conjunto de datos. Las divisiones solo se aplican a las líneas de pedido aumentadas. Para cualquier informe que contenga campañas, el `split_name` (si se incluye) será `null`.
`publisher_id`	Entero	Sí	`555`	El Id. del publicador.
`publisher_name`	string	No	`"PublisherA"`	El nombre del editor.
`publisher`	string	No	`"PublisherA (555)"`	En desuso (a partir del 17 de octubre de 2016).
`geo_country`	string	Sí	`"US"`	El código del país o región geográficos.
`imp_type`	string	Sí	`"Blank"`	El tipo de impresión. Para conocer los posibles valores, consulta `imp_type_id`.
`imp_type_id`	Entero	Sí	`1`	El identificador del tipo de impresión. Valores posibles (tipos asociados entre paréntesis): - `1` ("Blank"): No se sirve ninguna creatividad. - `2` ("PSA"): se publicó un anuncio de servicio público porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible. - `3` ("Error predeterminado"): una creatividad predeterminada servida debido a un problema de tiempo de espera. - `4` ("Predeterminado"): se publicó una creatividad predeterminada porque no había pujas válidas. - `5` ("Conservado"): el recurso creativo de su anunciante se sirve en el sitio de su editor. - `6` ("Revendida"): la impresión de su editor se vendió a un comprador externo. - `7` ("RTB"): el recurso creativo del anunciante publicado en el inventario de terceros. - `8` ("Error de PSA"): un anuncio de servicio público servido debido a un problema de tiempo de espera o falta de una creatividad predeterminada. - `9` ("Impresión externa"): una impresión de un rastreador de impresiones. - `10` ("Clic externo"): un clic de un rastreador de clics. Nota: Las subastas de RTB no se incluyen en los informes. No se informará de una impresión con `imp_type_id` = `7` .
`creative_id`	Entero	Sí	`444`	El Id. del creativo. Nota: - Para las impresiones de más de 100 días, las creatividades se agregarán en una fila con `0` el `creative_id`formato . - Para los rastreadores de clics o impresiones externas, `creative_id` será `"External Clicks"` o `"External Imps"`.
`creative_name`	string	No	`"Q1 2017 728x90"`	El nombre del creativo. - Para las impresiones de más de 100 días, las creatividades se agregarán en una fila con `"All creative data older than 100 days"` el `creative_name`formato . - Para los rastreadores de clics o impresiones externas, creative_name será `"External Clicks"` o `"External Imps"`.
`creative`	string	No	`"Q1 2017 728x90 (444)"`	En desuso (a partir del 17 de octubre de 2016).
`size`	string	Sí	`"728x90"`	El tamaño de la ubicación/creatividad servida.
`advertiser_currency`	string	Sí	`"USD"`	La moneda que usa el anunciante.
`insertion_order_id`	Entero	Sí	`321`	El Id. de la orden de inserción asociada a la campaña que ha comprado la impresión.
`campaign_group_id`	Entero	Sí	`432`	El identificador del grupo de campaña de la impresión.
`site_id`	Entero	Sí	`765`	El identificador del sitio. Nota: Para las impresiones de más de 100 días, la `site_id` será `0`.
`site_name`	string	No	`"Site 1"`	El nombre del sitio.
`site`	string	No	`"Site 1 (765)"`	En desuso (a partir del 17 de octubre de 2016).
`publisher_currency`	dinero	Sí	`"EUR"`	La moneda que usa el editor.
`key_name`	string	Sí	`"fruit"`	El nombre de la clave de segmentación.
`key_value`	string	Sí	`"apple"`	El valor asociado a la clave de segmentación.
`key_name_label`	string	Sí	`"fruit eaten by customer"`	La etiqueta de la llave. La etiqueta puede ser una versión más descriptiva del nombre de clave.
`key_value_label`	string	Sí	`"green or red apples"`	La etiqueta del valor. La etiqueta puede ser una versión más descriptiva del valor de clave.

Métricas

Column	Tipo	Ejemplo	Fórmula	Descripción
`imps`	Entero	`234123`	Diablillos	El número total de impresiones.
`clicks`	Entero	`545`	clics	El número total de clics.
`ctr`	double	`0.2327836`	Clics / Diablillos	La tasa de clics: la relación entre clics y impresiones, expresada como porcentaje.
`booked_revenue`	dinero	`150.00`	booked_revenue	Los ingresos totales reservados a través de anunciantes directos.
`reseller_revenue`	dinero	`100.00`	reseller_revenue	Los ingresos totales de las impresiones revendidas a través de editores directos.
`revenue`	dinero	`250.00`	booked_revenue + reseller_revenue	Los ingresos totales.
`rpm`	dinero	`1.25`	Ingresos / 1000 diablillos	Los ingresos por cada 1000 impresiones, incluidos los valores predeterminados, los PSA y los errores. Para obtener más información acerca de estos tipos de impresión, consulta `imp_type_id`.
`booked_revenue_dollars`	dinero	`500.00`	booked_revenue_dollars	El importe en dólares que ganó esta red con la impresión.
`imps_blocklisted`	Entero	`20`	imps_blocklisted	El número de impresiones que no se publicaron porque un sitio estaba en una lista de bloqueo.
`total_conversions`	Entero	`5`	total_conversions	El número total de conversiones posteriores a la vista y a los clics.
`conversions_rate`	double	`0.000221877080097626`	total_conversions / diablillos	La tasa de conversiones a impresiones.
`cpm`	dinero	`1.66051685393258`	(costo / diablillos) x 1000	El coste por cada 1000 impresiones.
`post_view_convs`	Entero	`2`	post_view_convs	Número total de conversiones posteriores a la vista registradas.
`post_view_convs_rate`	double	`0.00013`	post_view_convs / diablillos	La tasa de conversiones posteriores a la vista en impresiones.
`post_click_convs`	Entero	`3`	post_click_convs	Número total de conversiones registradas posteriores al clic.
`post_click_convs_rate`	double	`0.0002`	post_click_convs / diablillos	La tasa de conversiones posteriores al clic en impresiones.
`imps_master_creative`	Entero	`1276`	imps_master_creative	El número total de impresiones de la creatividad maestra en el bloqueo de carretera a nivel de página. Nota: Esta métrica está en pruebas alfa y no está disponible para todos los clientes.

Ejemplos

Crear la solicitud de informe JSON

El archivo JSON debe incluir el report_type de "key_value_analytics", así como las columnas (dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir la granularidad (year, month, day) y especificar la forma en que "format" se deben devolver los datos ("csv", "excel", o "html"). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, vea el servicio de informes.

$ cat key_value_analytics

{"report":
    {
        "report_type":"key_value_analytics",
        "columns":[
            "hour",
            "seller_member_id",
            "key_name",
            "key_name_label",
            "key_value",
            "key_value_label",
            "imps",
            "clicks",
            "revenue",
            "ctr"
        ],
        "report_interval":"last_48_hours",
        "format":"csv"
    }
}

`POST` la solicitud al servicio de informes

POST la solicitud JSON para recuperar un identificador de informe.

$ curl -b cookies -X post -d @key_value_analytics "https://api.appnexus.com/report?advertiser_id=123"

{
   "response":{
      "status":"OK",
      "report_id":"09b6979a6a4c3805bdac8921378d3622"
   }
}

`GET` el estado del informe desde el servicio Informe

Realice una GET llamada con el id. de informe para recuperar el estado del informe. Continúe realizando esta GET llamada hasta que se execution_status ."ready" Después, use el servicio de descarga de informes para guardar los datos del informe en un archivo, como se describe en el paso siguiente.

$ curl -b cookies 'https://api.appnexus.com/report?id=09b6979a6a4c3805bdac8921378d3622'

{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2016-12-11 19:15:48",
         "json_request": "{\"report\":{\"report_type\":\"key_value_analytics\",
             \"columns\":[\"hour\",\"seller_member_id\",
             \"key_name\",\"key_name_label\",\"key_value\",\"key_value_label\",
             \"imps\",\"clicks\",\"revenue\",\"ctr\"],
             \"report_interval\":\"last_48_hours\",\"format\":\"csv\",\"filters\":[{\"advertiser_id\":\"123\"}]}}",
             "url":"report-download?id=b97897a7864dd8f34e7457226c7af592"
      },
      "execution_status":"ready"
   }
}

`GET` los datos del informe del servicio de descarga de informes

Para descargar los datos del informe en un archivo, realice otra GET llamada con el identificador del informe, pero esta vez al servicio de descarga de informes . Puede encontrar el servicio y el ID del informe en el url campo de la respuesta a su llamada anterior GET . Al identificar el archivo en el que desea guardarlo, asegúrese de usar la extensión de archivo del formato de archivo que especificó en POSTel archivo .

Nota:

Si se produce un error durante la descarga, el encabezado de respuesta incluirá un código de error HTTP y un mensaje. Use -i o -v en la llamada para exponer el encabezado de respuesta.

curl -b cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/key_value_analytics.csv

Nota:

Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.

Last updated on 2026-08-18

API de plataforma digital: informe de análisis de valor clave

Período de tiempo

Fechas que se producen hace más de 45 días

Período de retención de datos

Dimensions

Métricas

Ejemplos

Crear la solicitud de informe JSON

POST la solicitud al servicio de informes

GET el estado del informe desde el servicio Informe

GET los datos del informe del servicio de descarga de informes

Recursos adicionales

`POST` la solicitud al servicio de informes

`GET` el estado del informe desde el servicio Informe

`GET` los datos del informe del servicio de descarga de informes