Compartir a través de

Api de plataforma digital: informe de rendimiento del segmento del conservador

  • Artículo

Nota:

Este informe solo está disponible para los conservadores.

El Informe de rendimiento de segmentos de conservador proporciona a los conservadores información sobre cómo sus segmentos de destino están contribuyendo al rendimiento general de sus ofertas seleccionadas. El informe proporciona datos sobre todos los segmentos de destino (incluidos y excluidos) que contribuyeron a las impresiones con transacciones. Para los conservadores, esto incluye toda la actividad de oferta seleccionada.

Para obtener instrucciones sobre cómo recuperar un informe, vea Report Service o el ejemplo siguiente.

Período de tiempo

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

  • last_hour
  • last_48_hours
  • hoy
  • yesterday
  • last_7_days
  • month_to_date
  • quarter_to_date
  • last_month
  • last_30_days

Período de retención de datos

Los datos de este informe se conservan durante 429 días.

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.

Dimensions

Column Tipo ¿Filtro? Ejemplo Descripción
bidder_id Entero Sí 456 Id. del pujador que compró en la transacción
bidder_name string No "That Bidder" Nombre del postor que compró en la transacción
buyer_member_id Entero Sí 789 Id. de miembro del comprador que compró en la transacción
buyer_member_name string No "That Buyer" Nombre del miembro del comprador que compró en la transacción
curated_deal_id Entero Yes 123 Identificador de la oferta curada
cureated_deal_name string No "My Deal Name" Nombre de la oferta curada
curated_line_item_id Entero Yes 123 Id. de elemento de línea del objeto miembro del conservador que posee el elemento de línea de transacción asociado a la oferta seleccionada
curated_line_item_name string No "My Curated LI" Nombre del elemento de línea del objeto miembro del conservador que posee el elemento de línea de transacción asociado a la oferta seleccionada
curator_member_id Entero Yes 123 Id. de miembro de la cuenta del conservador
curator_member_name string No "My Account" Nombre de miembro de la cuenta del conservador
day date Yes "2020-02-01" El día de la subasta
device_type string Sí "desktops & laptops" Tipo de dispositivo en el que se ha servido la impresión. Los posibles valores son:
- "desktops & laptops"
- "tablets"
- "mobile phones"
- "tv"
- "game consoles"
- "set top box"
- "media players"
- "other devices"
device_type_id Entero Yes 1 Identificador de tipo de dispositivo en el que se ha proporcionado la impresión. Los posibles valores son:
0 (otros dispositivos)
1 (equipos de escritorio & portátiles)
2 (teléfonos móviles)
3 (tabletas)
4 (tv)
5 (consolas de juegos)
6 (reproductores multimedia)
7 (cuadro de configuración superior)
device_type_name string Sí "desktops & laptops" Nombre del tipo de dispositivo en el que se ha servido la impresión. Los posibles valores son:
- "desktops & laptops"
- "tablets"
- "mobile phones"
- "tv"
- "game consoles"
- "set top box"
- "media players"
- "other devices"
geo_country_code string Sí "US" El código de país en el que se produjo la impresión. En el caso de las solicitudes de impresión para las que Xandr no recibió ninguna indicación de que el anuncio se representó (es decir, sin transacciones), no se proporciona información del país.
geo_country_name string No "United States" Nombre del país en el que se produjo la impresión. En el caso de las solicitudes de impresión para las que Xandr no recibió ninguna indicación de que el anuncio se representó (es decir, sin transacciones), no se proporciona información del país.
hour date Yes "2020-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.
media_type string No "banner" Tipo de medio asociado a la creatividad que sirvió en esta impresión. Los posibles valores son:
- "banner"
- "pop"
- "interstitial"
- "video"
- "text"
- "expandable"
- "skin"
- "facebook"
- "image and text"
- "high impact"
- "native"
- "audio"
- "Unknown"
media_type_id Entero Yes 1 Identificador de tipo de medio asociado a la creatividad que sirvió en esta impresión. Los posibles valores son:
1 (banner)
2 (pop)
3 (intersticial)
4 (vídeo)
5 (texto)
6 (ampliable)
8 (piel)
9 (facebook)
10 (imagen y texto)
11 (alto impacto)
12 (nativo)
13 (audio)
media_type_name string No "banner" Nombre de tipo de medio asociado a la creatividad que sirvió en esta impresión. Los posibles valores son:
- "banner"
- "pop"
- "interstitial"
- "video"
- "text"
- "expandable"
- "skin"
- "facebook"
- "image and text"
- "high impact"
- "native"
- "audio"
- "Unknown"
month date Yes "2020-02" El mes de la subasta
segment_id Entero Yes 123456 Identificador de un segmento que se ha dirigido a la impresión.

Nota: Los conservadores que ejecutan este informe solo verán los segmentos que asignan a sus objetos de elemento de línea de transacción. Por ejemplo, un conservador que extrae este informe no verá segmentos vinculados a una oferta de vendedores de terceros que están comprando.
segment_name string No "That Segment" Nombre de un segmento que se ha dirigido a la impresión.

Nota: Los conservadores que ejecutan este informe solo verán los segmentos que asignan a sus objetos de elemento de línea de transacción. Por ejemplo, un conservador que extrae este informe no verá segmentos vinculados a una oferta de vendedores de terceros que están comprando.
segment_owner_id Entero Yes 789 Identificador de miembro del propietario del segmento propietario de los segmentos de destino
segment_owner_name string No "That Segment Owner" Nombre de miembro del propietario del segmento propietario de los segmentos de destino
seller_member_id Entero Yes 4567 Id. de miembro del vendedor donde se atendió la transacción seleccionada
seller_member_name string No "That Seller" Nombre del miembro del vendedor donde se ha servido la transacción seleccionada
supply_strategy string Sí "Deals" Distingue entre los diferentes canales de suministro utilizados para obtener impresiones para el conservador.

Nota: Solo "Open Exchange" y "Deals" son relevantes actualmente para el conservador.
supply_type_id Entero Yes 0 Identificador del tipo de suministro del anuncio que se representó. Los posibles valores son:
0 (web)
1 (mobile_web)
2 (mobile_app)
supply_type_name string Sí "web" Nombre del tipo de suministro del anuncio que se representó. Los posibles valores son:
- "web"
- "mobile_web"
- "mobile_app"
targeting_type string Sí "Inclusion" Si el segmento ha contribuido a la selección de destino del elemento de línea al incluirse o excluirse. Los posibles valores son:
- "Inclusion"
- "Exclusion"

Métricas

Column Tipo Ejemplo Descripción
targeted_curator_media_cost Dinero 31.513709 La cantidad de gasto (transacda a través de impresiones dirigidas por el segmento) que un conservador envió a los vendedores de intercambios netamente de cuotas y márgenes del conservador, si procede
targeted_curator_media_cost_ecpm Dinero 1.6654 La cantidad de gasto (transacciones a través de impresiones dirigidas por el segmento, expresadas como un eCPM basado en impresiones transacdas) un conservador enviado a vendedores de intercambios netos de tarifas y márgenes del conservador, si procede
targeted_curator_revenue Dinero 48.4185 La cantidad de gasto (transacciones a través de impresiones dirigidas por el segmento) que un comprador envió al conservador neto de las tarifas del comprador, si procede
targeted_curator_revenue_ecpm Dinero 2.5588 La cantidad de gasto (transacciones a través de impresiones dirigidas por el segmento, expresadas como un eCPM basado en impresiones dirigidas) un comprador enviado al conservador neto de los honorarios del comprador, si procede
targeted_impressions Entero 18922 Número de impresiones con transacciones dirigidas al segmento
targeted_view_measured_impressions Entero 17867 Número de impresiones con transacciones que Xandr midió la visualización en el segmento de destino
targeted_viewable_impressions Entero 14135 Número de impresiones visualizadas que el segmento de destino

Ejemplo

Create una solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type de "curator_segment_performance", así como ( columns dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir granularidad (year, month, day) y especificar el formato en el que se deben devolver los datos (csv, excelo html). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.

$ cat curator_segment_performance

{
    "report": {
        "report_type": "curator_segment_performance",
        "columns": [
            "curated_deal_id",
            "cureated_deal_name",
            "segment_id",
            "segment_name",
            "targeting_type",
            "targeted_impressions",
            "targeted_curator_revenue"
        ],
        "report_interval": "today",
        "format": "csv"
    }
}

POST la solicitud al servicio de informes

$ curl -b cookies -X POST -d @curator_segment_performance 'https://api.appnexus.com/report'

{
    "response": {
        "status": "OK",
        "report_id": "a2c95fcff2d8759e69cec123364f9b32"
    }
}

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=a2c95fcff2d8759e69cec123364f9b32'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2020-09-04 12:46:08",
            "json_request": "{\"report\":{\"report_type\":\"curator_segment_performance\",\"columns\":[\"curated_deal_id\",\"cureated_deal_name\",\"segment_id\",\"segment_name\",\"targeting_type\",\"targeted_impressions\",\"targeted_curator_revenue\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"curator_member_id\":\"12025\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1599264000,\"start_date\":1599177600,\"user_id\":\"123456\"}",
            "url": "report-download?id=a2c95fcff2d8759e69cec123364f9b32"
        },
        "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 servicio y el identificador de informe en el url campo de la respuesta anterior GET . Al identificar el archivo en el que desea guardar, asegúrese de usar la extensión de archivo de "format" que especificó en su 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=a2c95fcff2d8759e69cec123364f9b32' > /tmp/curator_segment_performance.csv

Nota:

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