API de plataforma digital: informe de revisión de marca de vendedores

Artículo
05/17/2024

Este informe proporciona una vista del rendimiento de la marca en todo el inventario. Puede:

revise qué creatividad ha servido en su inventario y cómo se ha realizado.
revisar el rendimiento creativo por estado de auditoría.
revise el rendimiento de la categoría de marca de cliente en todo el inventario.

El time_granularity valor de los datos es daily. Para obtener instrucciones sobre cómo recuperar un informe, consulte report service o el ejemplo siguiente.

Período de tiempo

El report_interval campo de la solicitud JSON debe establecerse en uno de los siguientes:

yesterday
last_7_days
last_30_days
month_to_date
last_month

Sugerencia

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.

Período de retención de datos

El período de retención de datos para este informe es de 428 días.

Dimensions

Column	Tipo	¿Filtro?	Ejemplo	Descripción
`month`	time	no	`"2010-02"`	El mes de la subasta.
`day`	time	no	`"2010-02-01"`	El día de la subasta.
`buyer_member_id`	Entero	sí	`643`	Identificador del miembro que ganó la subasta.
`buyer_seat_name`	string	no	`"My Custom Seat"`	Nombre para mostrar del código de asiento del comprador.
`buyer_seat_id`	Entero	sí	`123`	El identificador del asiento del comprador.
`buyer_seat_code`	string	no	`"Custom Seat"`	El id. de asiento del comprador personalizado (enviado por DSP) que se usó para pujar por la impresión.
`bidder`	Entero	no		En desuso.
`bidder_name`	Entero	no	`"Microsoft Invest"`	Nombre del licitador.
`bidder_id`	Entero	no	`2`	Id. del pujador del miembro.
`curator_member_id`	Entero	sí	`10652`	Identificador del miembro del conservador.
`placement_id`	Entero	sí	`546`	Identificador de la ubicación.
`placement_name`	string	no	`"300x250 Business"`	Nombre de la ubicación.
`placement`	string	no	`"300x250 Business (546)"`	En desuso.
`publisher_id`	Entero	sí	`6787`	Identificador del publicador.
`geo_country`	string	sí	`"US"`	El código del país geográfico.
`geo_country_name`	string	no	`"United States"`	Nombre del país geográfico.
`imp_type`	string	sí	`"Kept"`	En desuso.
`imp_type_id`	Entero	sí	`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.
`creative_id`	Entero	sí	`654`	Identificador de la creatividad.
`site_id`	Entero	sí	`555`	Identificador del sitio. Para obtener más información, consulte El servicio de sitio.
`site_name`	string	no	`"My Site"`	Nombre del sitio. Para obtener más información, consulte El servicio de sitio.
`brand_id`	Entero	sí	`3`	Identificador de la marca asociada a una creatividad que se sirve en el inventario del publicador.
`brand_name`	string	no	`"Ace Hardware"`	Nombre de la marca asociada a una creatividad que se sirve en el inventario del publicador.
`brand`	string	no	`"Ace Hardware (3)"`	En desuso.
`payment_type`	string	sí	`"cpm"`	Tipo de pago al agente.
`revenue_type`	string	no	`"cpm"`	La forma en que el anunciante ha aceptado pagarle.
`revenue_type_id`	Entero	sí	`4`	Identificador del tipo de ingresos. Posibles valores: `-1` = Sin pago `0` = CPM plano `1` = Costo Más CPM, `2` = Costo más margen `3` = CPC `4` = CPA `5` = Revshare `6` = Tarifa plana `7` = Variable CPM `8` = CPM estimado
`width`	Entero	sí	`250`	Ancho de la creatividad.
`height`	Entero	sí	`300`	El alto de la creatividad.
`site`	string	no	`"My Site (555)"`	En desuso.
`publisher_code`	string	no	`"My Publisher Code"`	Código personalizado para el publicador.
`site_code`	string	no	`"Site Name Code"`	Código personalizado para el sitio.
`placement_code`	string	no	`"Photos Code"`	Código personalizado para la ubicación.
`buyer_member_name`	string	no	`"Network"`	Nombre del miembro que compra.
`buyer_member`	string	no	`"Network (567)"`	En desuso.
`media_type`	string	sí	`"Banner", "Pop", "Interstitial", "Video", "Text"`	El estilo de visualización general de una creatividad que se sirve en el inventario del publicador. Puede usar el servicio de tipos de medios para ver la lista completa de tipos de medios.
`mediatype_id`	Entero	sí	`444`	Identificador del tipo de medio asociado a la creatividad que se ha servido. Para obtener más información, vea El servicio de tipo multimedia.
`publisher_name`	string	no	`"LOL - US"`	Nombre del publicador en cuyo sitio se produjo la impresión.
`publisher`	string	sí	`"LOL - US (44389)"`	En desuso.
`deal_id`	Entero	sí	`2345`	El identificador de la transacción. Para obtener más información sobre las ofertas que ha negociado con los compradores, consulte Servicio de ofertas.
`deal_name`	string	no	`"Private deal for buyer 1085 with floor of $2.50"`	Nombre de la oferta.
`deal_type`	string	sí	`1`	Identificador que representa el tipo de transacción. Posibles valores: `1` = Abrir subasta `2` = Subasta privada `4` = Garantizado mediante programación `5` = Subasta curada
`deal`	string	no	`"Private deal for buyer 1085 with floor of $2.50 (45)"`	En desuso.
`deal_code`	string	no	`"Custom code"`	Código personalizado para la oferta.
`brand_offer_category_id`	Entero	sí	`1256`	Identificador de la categoría de oferta de marca asociada a la impresión. Consulte `category_id` en la página Servicio de marca .
`brand_offer_category_name`	string	no	`"Luxury Cars"`	Nombre de la categoría de oferta de marca asociada a la impresión. Consulte `category_id` en la página Servicio de marca .
`creative_audit_status_id`	Entero	sí	`0`	Identificador del estado de auditoría de la creatividad asociada a la impresión: `0` = sin auditoría `1` = vendedor solo auditado `2` = appnexus auditado
`creative_audit_status`	string	no	`"Unaudited"`	Estado de auditoría de la creatividad asociada a la impresión: - `"Unaudited`" - `"Self Audit Only"` - `"AppNexus Audited"`
`size`	string	sí	`"728x90"`	Ancho y alto de la creatividad asociada a la impresión.

Métricas

Column	Tipo	Ejemplo	Fórmula	Description
`imps`	Entero	`34534`	Duendes	Número total de impresiones (incluidos los valores predeterminados).
`clicks`	Entero	`345`	Clics	Número total de clics en todas las impresiones.
`cost`	Dinero	`16.833378`	Costo	Cantidad total de costo de medios para el publicador directo y el inventario comprado en tiempo real.
`revenue`	Dinero	`25.767257`	booked_revenue + reseller_revenue	La suma de los ingresos reservados y los ingresos del revendedor.
`booked_revenue`	Dinero	`25.767257`	booked_revenue	Los ingresos totales reservados a través de anunciantes directos (artículo de línea).
`reseller_revenue`	Dinero	`0`	reseller_revenue	Los ingresos totales de las impresiones revendidas a través de publicadores directos.
`profit`	Dinero	`970.40`	booked_revenue: total_cost	Ingresos reservados menos costo total.
`cpm`	Dinero	`1.66051685393258`	(costo /imps) x 1000	El costo por 1000 impresiones.
`total_convs`	Entero	`5`	total_convs	Número total de conversiones posteriores y posteriores al clic.
`convs_rate`	double	`0.000221877080097626`	total_convs/imps	Tasa de conversiones a impresiones.
`ctr`	double	`0.002327`	clics o imps	Tasa de clics en impresiones.
`rpm`	Dinero	`2.60548314606741`	(ingresos/imps) x 1000	Ingresos por 1000 impresiones.
`ppm`	Dinero	`0.944966292134831`	(beneficio /imps) x 1000	En desuso. El beneficio por 1000 impresiones.
`convs_per_mm`	double	`221.877080097625`	(total_convs/imps) x 1000 000	Número de conversiones por millón de impresiones.
`imps_viewed`	Entero	`30,450`	imps_viewed	El número de impresiones medidas que se pueden ver según la definición de visualización de IAB, que indica que una impresión es visible si el 50 % de los píxeles se ven durante 1 segundo consecutivo.
`view_measured_imps`	Entero	`10,120`	view_measured_imps	Número total de impresiones que se midieron para la visibilidad.
`view_rate`	double	`58%`	view_rate	Porcentaje de impresiones que se pudieron ver del número total de impresiones medidas para la visibilidad. (Imps/View Measured Imps)
`view_measurement_rate`	double	`45%`	view_measurement_rate	Porcentaje de impresiones medidas para la visibilidad del número total de impresiones. (Ver imps/imps medidos)
`total_cost`	Dinero	`123.45`	total_cost = media_cost + data_costs + partner_fees + comisiones + serving_fees + publisher_revenue	Importe total de los costos acumulados durante el período de tiempo notificado. Por lo general, esto incluye dos tipos de costos, costos presupuestados (costo de medios, costo de datos, cuotas de asociados, cuotas de servicio, comisiones) e ingresos del publicador si realiza un seguimiento de los pagos del publicador en la plataforma. Nota: Hemos agregado lógica para evitar el recuento doble de cuotas de terceros durante el período de cambio importante.
`total_cost_ecpm`	Dinero	`123.45`	(total_cost/imps) * 1000	Costo total por 1000 imps.
`total_cost_ecpc`	Dinero	`123.45`	total_cost/clics	Costo total por clic.
`total_cost_ecpa`	Dinero	`123.45`	total_cost/conversiones	Costo total por conversión.
`network_profit`	Dinero	`123.45`	(booked_revenue + reseller_revenue): total_cost	La suma de los ingresos reservados y los ingresos del revendedor menos el costo total.
`network_profit_ecpm`	Dinero	`123.45`	(network_profit/imps) * 1000	Beneficio de red por 1000 imps.
`network_profit_ecpc`	Dinero	`123.45`	network_profit/clics	Beneficio de red por clic.
`network_profit_ecpa`	Dinero	`123.45`	network_profit/conversiones	Beneficio de red por conversión.
`network_profit_margin`	Dinero	`123.45`	network_profit/(booked_revenue + reseller_revenue)	Margen de beneficio de red.
`profit_ecpm`	Dinero	`123.45`	((booked_revenue - total_cost)/imps) * 1000	Beneficio por 1000 imps.
`profit_ecpc`	Dinero	`123.45`	(booked_revenue - total_cost)/clicks	Beneficio por clic.
`profit_ecpa`	Dinero	`123.45`	(booked_revenue - total_cost)/conversiones	Beneficio por conversión.
`profit_margin`	Dinero	`123.45`	(booked_revenue - total_cost)/booked_revenue	Margen de ganancia del comprador.

Ejemplo

Create una solicitud de informe JSON

El archivo JSON debe incluir el report_type de "seller_brand_review", 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, excelo html). daymonthyear Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.

$ cat seller_brand_review
{"report":
    {
        "format": "csv",
        "report_interval": "yesterday",
        "row_per": ["geo_country"],
        "columns": ["placement_id","imp_type_id","creative_id","brand_id","geo_country"],
        "report_type": "seller_brand_review"
    }
}

`POST` la solicitud al servicio de informes

POST la solicitud JSON para recuperar un identificador de informe.

$ curl -b cookies -c cookies -X post -d @seller_brand_review "https://api.appnexus.com/report"
{
   "response":{
      "status":"OK",
      "report_id":"c445bca183a3d338dc1c5b85a3d484f5"
   }
}

`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 -c cookies 'https://api.appnexus.com/report?id=c445bca183a3d338dc1c5b85a3d484f5'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2014-11-19 22:33:31",
            "json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"yesterday\",\"row_per\":[\"geo_country\"],\"columns\":[\"placement_id\",\"imp_type_id\",\"creative_id\",\"brand_id\",\"geo_country\"],\"report_type\":\"seller_brand_review\",\"filters\":[{\"seller_member_id\":\"958\"}]}}",
            "url": "report-download?id=c445bca183a3d338dc1c5b85a3d484f5"
        },
        "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.

Sugerencia

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 -c cookies 'https://api.appnexus.com/report-download?id=c445bca183a3d338dc1c5b85a3d484f5' > /tmp/seller_brand_review.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 revisión de marca de vendedores

Período de tiempo

Período de retención de datos

Dimensions

Métricas

Ejemplo

Create una 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 revisión de marca de vendedores

Período de tiempo

Período de retención de datos

Dimensions

Métricas

Ejemplo

Create una 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