API de plataforma digital: informe de Key Value Analytics

Artículo
05/18/2024

El informe Key Value Analytics muestra la información asociada a los valores y claves de destino definidos de la red.

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

Nota:

Etiquetas de vendedor de AppNexus

Al usar 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 se aplica a otras POSTllamadas de anuncios de cuerpo de solicitud basadas en Prebid (ut/v3/prebid, openrtb2/prebid, prebid/lfv) y OpenRTB (openrtb2).

No todas las impresiones de destinos clave-valor se incluirán en los informes. Para incluirse, los destinos deben cumplir los siguientes criterios:

La clave debe estar predefinida. Para obtener más información, vea la página Definición previa de claves y valores de destino en la interfaz de usuario.
El valor debe estar predefinido O El valor debe estar dirigido al menos a un elemento de línea o campaña.
El valor no es un intervalo 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 Report Service.

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

Si crea un informe de Key Value Analytics con el campo Intervalo establecido en Personalizado (donde la fecha de finalización es mayor que 45 días a partir de hoy), el informe (independientemente de las métricas incluidas) se agregará a una cola especial para los informes que consumen muchos recursos. Como resultado, el informe puede tardar más de lo habitual en completarse. Además, este informe que consume muchos recursos puede producir un error, debido a la cantidad de datos que se solicitan, antes de completarse. Si el informe no se completa, recibirá una notificación. Si se produce un error en la solicitud de informe, puede hacer lo siguiente:

Vuelva a ejecutar el informe más adelante.
Use un tipo de informe distinto de Key Value Analytics.
Modifique la forma de estructurar los informes (si es posible) para que no incluyan fechas mayores que hace 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 tenga que 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 una fuente de distribución de datos de nivel de registro: archivo. Para obtener más información sobre cómo modificar los informes para evitar estos problemas, consulte la página Dimensiones, métricas, filtrado y agrupación en la interfaz de usuario.

Período de retención de datos

Los datos de este informe se conservan durante 428 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: En el caso de las impresiones anteriores a 100 días, el día se devolverá en lugar de la hora.
`buyer_member_id`	Entero	Yes	`123`	Identificador del miembro de compra. Si no se compró la impresión, este campo muestra uno de los siguientes valores: `229` = PSA, `0` = Blank o `319` = Default.
`buyer_member_name`	string	No	`"My Network"`	Nombre del miembro que compra. Nota: El nombre podría ser `"Default"` o `"Default Error"`, lo que significa que no había ningún comprador para la impresión y se sirvió una creatividad predeterminada.
`buyer_member`	string	No	`"My Network (123)"`	En desuso (a partir del 17 de octubre de 2016).
`seller_member_id`	Entero	Yes	`456`	Identificador del miembro vendedor.
`seller_member_name`	string	No	`"That Seller"`	Nombre del miembro vendedor.
`seller_member`	string	No	`"That Seller (456)"`	En desuso (a partir del 17 de octubre de 2016).
`placement_id`	Entero	Yes	`1212`	Identificador de la ubicación. Nota: En el caso de las impresiones anteriores a 100 días, las ubicaciones se agregarán en una fila con `-1` como `placement_id` .
`placement_name`	string	No	`"lvillage 160x600"`	Nombre de la ubicación. Nota: En el caso de las impresiones anteriores a 100 días, las ubicaciones se agregarán en una fila con `"All placement data older than 100 days"` como `placement_name`.
`placement`	string	No	`"lvillage 160x600 (1212)"`	En desuso (a partir del 17 de octubre de 2016).
`advertiser_id`	Entero	Yes	`789`	El identificador del anunciante. Si el valor es `0`, un comprador externo compró la impresión o se mostró un valor predeterminado o PSA.
`advertiser_name`	string	No	`"AdvertiserA"`	Nombre del anunciante.
`advertiser`	string	No	`"AdvertiserA (789)"`	En desuso (a partir del 17 de octubre de 2016).
`line_item_id`	Entero	Yes	`1122`	Identificador del elemento de línea.
`line_item_name`	string	No	`"Line Item 1"`	Nombre del elemento de línea.
`line_item`	string	No	`"Line Item 1 (1122)"`	En desuso (a partir del 17 de octubre de 2016).
`campaign_id`	Entero	Yes	`222`	Identificador de la campaña.
`campaign_name`	string	No	`"Default Campaign"`	Nombre de la campaña.
`campaign`	string	No	`"Default Campaign (789)"`	En desuso (a partir del 17 de octubre de 2016).
`split_id`	Int	Yes	`342`	Identificador de la división que compró las impresiones en este conjunto de datos. Las divisiones solo se aplican a los elementos de línea aumentadas. Para cualquier informe que contenga campañas, ( `split_id` si se incluye) será `null` .
`split_name`	string	Sí	`"Mobile Split A"`	Nombre de la división que compró las impresiones en este conjunto de datos. Las divisiones solo se aplican a los elementos de línea aumentadas. Para cualquier informe que contenga campañas, ( `split_name` si se incluye) será `null`.
`publisher_id`	Entero	Yes	`555`	Identificador del publicador.
`publisher_name`	string	No	`"PublisherA"`	Nombre del publicador.
`publisher`	string	No	`"PublisherA (555)"`	En desuso (a partir del 17 de octubre de 2016).
`geo_country`	string	Sí	`"US"`	Código del país geográfico.
`imp_type`	string	Sí	`"Blank"`	Tipo de impresión. Para obtener los valores posibles, vea `imp_type_id`.
`imp_type_id`	Entero	Yes	`1`	Identificador del tipo de impresión. Valores posibles (tipos asociados entre paréntesis): - `1` ("En blanco"): sin creatividad. - `2` ("PSA"): un anuncio de servicio público se sirvió porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible. - `3` ("Error predeterminado"): una creatividad predeterminada que se sirve debido a un problema de tiempo de espera. - `4` ("Valor predeterminado"): una creatividad predeterminada que se sirve porque no había pujas válidas. - `5` ("Guardado"): la creatividad de su anunciante se ha servido en el sitio del editor. - `6` ("Reventa"): la impresión del editor se vendió a un comprador de terceros. - `7` ("RTB"): la creatividad de su anunciante se ha servido 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 a la 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 RTB no se incluyen en los informes. No se notificará una impresión con `imp_type_id` = `7` .
`creative_id`	Entero	Yes	`444`	Identificador de la creatividad. Nota: - Para las impresiones anteriores a 100 días, las creatividades se agregarán en una fila con `0` como .`creative_id` - Para seguimientos de clics o impresiones externos, `creative_id` será `"External Clicks"` o `"External Imps"`.
`creative_name`	string	No	`"Q1 2017 728x90"`	Nombre de la creatividad. - Para las impresiones anteriores a 100 días, las creatividades se agregarán en una fila con `"All creative data older than 100 days"` como .`creative_name` - Para los rastreadores de clics o impresiones externos, 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"`	Tamaño de la colocación/creatividad servida.
`advertiser_currency`	string	Sí	`"USD"`	Moneda utilizada por el anunciante.
`insertion_order_id`	Entero	Yes	`321`	Identificador del pedido de inserción asociado a la campaña que compró la impresión.
`campaign_group_id`	Entero	Yes	`432`	Identificador del grupo de campaña de la impresión.
`site_id`	Entero	Yes	`765`	Identificador del sitio. Nota: Para las impresiones anteriores a 100 días, `site_id` será `0`.
`site_name`	string	No	`"Site 1"`	Nombre del sitio.
`site`	string	No	`"Site 1 (765)"`	En desuso (a partir del 17 de octubre de 2016).
`publisher_currency`	Dinero	Yes	`"EUR"`	Moneda usada por el publicador.
`key_name`	string	Sí	`"fruit"`	Nombre de la clave de destino.
`key_value`	string	Sí	`"apple"`	Valor asociado a la clave de destino.
`key_name_label`	string	Sí	`"fruit eaten by customer"`	Etiqueta de la clave. La etiqueta puede ser una versión más descriptiva del nombre de clave.
`key_value_label`	string	Sí	`"green or red apples"`	Etiqueta del valor. La etiqueta puede ser una versión más descriptiva del valor de clave.

Métricas

Column	Tipo	Ejemplo	Fórmula	Description
`imps`	Entero	`234123`	Duendes	Número total de impresiones.
`clicks`	Entero	`545`	Clics	Número total de clics.
`ctr`	double	`0.2327836`	clics o imps	Tasa de clics: la proporción de clics con impresiones, expresada como un 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 publicadores directos.
`revenue`	Dinero	`250.00`	booked_revenue + reseller_revenue	Los ingresos totales.
`rpm`	Dinero	`1.25`	ingresos/1000 imps	Los ingresos por cada 1000 impresiones, incluidos los valores predeterminados, las PSA y los errores. Para obtener más información sobre estos tipos de impresiones, vea `imp_type_id`.
`booked_revenue_dollars`	Dinero	`500.00`	booked_revenue_dollars	La cantidad de dólares obtenida por esta red en la impresión.
`imps_blocklisted`	Entero	`20`	imps_blocklisted	Número de impresiones que no sirvieron porque un sitio estaba en una lista de bloqueos.
`total_conversions`	Entero	`5`	total_conversions	Número total de conversiones posteriores y posteriores al clic.
`conversions_rate`	double	`0.000221877080097626`	total_conversions/imps	Tasa de conversiones a impresiones.
`cpm`	Dinero	`1.66051685393258`	(costo /imps) x 1000	El costo por 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/imps	Tasa de conversiones posteriores a la vista en impresiones.
`post_click_convs`	Entero	`3`	post_click_convs	Número total de conversiones registradas después de hacer clic.
`post_click_convs_rate`	double	`0.0002`	post_click_convs/imps	Tasa de conversiones posteriores al clic en impresiones.
`imps_master_creative`	Entero	`1276`	imps_master_creative	Número total de impresiones de la creatividad maestra en el bloqueo de carreteras de nivel de página. Nota: Esta métrica está en pruebas alfa y no está disponible para todos los clientes.

Ejemplos

Create 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 granularidad (, , ) y especificar en el "format" que se deben devolver los datos ("csv", "excel"o "html"). daymonthyear Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.

$ 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` estado del informe del servicio de informes

Realice una GET llamada con el identificador de informe para recuperar el estado del informe. Continúe realizando esta GET llamada hasta que execution_status sea "ready". A continuación, 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 de informe, pero esta vez al servicio de descarga de informes . Puede encontrar el identificador de servicio e informe en el url campo de la respuesta a la llamada anterior GET . Al identificar el archivo en el que desea guardar, asegúrese de usar la extensión de archivo del formato de archivo que especificó en la inicial POST.

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.

Compartir a través de

API de plataforma digital: informe de Key Value Analytics

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

Create la solicitud de informe JSON

`POST` la solicitud al servicio de informes

`GET` estado del informe del servicio de informes

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

Recursos adicionales

Compartir a través de

API de plataforma digital: informe de Key Value Analytics

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

Create la solicitud de informe JSON

POST la solicitud al servicio de informes

GET estado del informe del servicio de informes

GET los datos del informe del servicio de descarga de informes

Recursos adicionales

`POST` la solicitud al servicio de informes

`GET` estado del informe del servicio de informes

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