API de plataforma digital: informe de rendimiento del segmento Curator

Nota:

Este informe solo está disponible para curadores.

El Informe de rendimiento del segmento del curador proporciona a los curadores información sobre cómo sus segmentos objetivo están contribuyendo al rendimiento general de sus acuerdos seleccionados. El informe proporciona datos de todos los segmentos segmentados (incluye y excluye) que contribuyeron a las impresiones de transacciones. Para los curadores, esto incluye toda la actividad de acuerdos curados.

Para obtener instrucciones sobre cómo recuperar un informe, consulte Servicio de informes 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 Servicio de informes.

Dimensions

Column Tipo ¿Filtro? Ejemplo Descripción
bidder_id Entero Sí 456 ID del postor 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 Sí 123 Id. de oferta seleccionada
cureated_deal_name string No "My Deal Name" Nombre de la oferta seleccionada
curated_line_item_id Entero Sí 123 Id. de línea de pedido del objeto miembro curador que posee la línea de pedido asociada a la oferta seleccionada
curated_line_item_name string No "My Curated LI" Nombre de línea de pedido del objeto miembro curador que posee la línea de pedido asociada a la oferta seleccionada
curator_member_id Entero Sí 123 ID de miembro de la cuenta del curador
curator_member_name string No "My Account" Nombre del miembro de la cuenta del curador
day date Sí "2020-02-01" El día de la subasta
device_type string Sí "desktops & laptops" Tipo de dispositivo en el que se ha publicado 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 Sí 1 Identificador de tipo de dispositivo en el que se ha publicado 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 (decodificador)
device_type_name string Sí "desktops & laptops" Nombre del tipo de dispositivo en el que se ha publicado 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 impresiones para las que Xandr no recibió ninguna indicación de que el anuncio se mostró (es decir, no se realizó ninguna transacción), no se proporciona información sobre el país o la región.
geo_country_name string No "United States" El nombre del país o región en el que se produjo la impresión. En el caso de las solicitudes de impresiones para las que Xandr no recibió ninguna indicación de que el anuncio se mostró (es decir, no se realizó ninguna transacción), no se proporciona información sobre el país o la región.
hour date Sí "2020-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.
media_type string No "banner" Tipo de medio asociado al creativo 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 Sí 1 Id. de tipo de medio asociado al creativo que sirvió en esta impresión. Los posibles valores son:
1 (banner)
2 (pop)
3 (intersticial)
4 (vídeo)
5 (texto)
6 (expandible)
8 (piel)
9 (Facebook)
10 (imagen y texto)
11 (alto impacto)
12 (nativo)
13 (audio)
media_type_name string No "banner" Nombre del tipo de medio asociado al creativo 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 Sí "2020-02" El mes de la subasta
segment_id Entero Sí 123456 Identificador de un segmento destinado a la impresión.

Nota: Los curadores que ejecuten este informe solo verán los segmentos que asignen a sus objetos de línea de negocio. Por ejemplo, un curador que obtenga este informe no verá segmentos vinculados a un acuerdo de vendedor externo que está comprando.
segment_name string No "That Segment" Nombre de un segmento que tuvo como destino la impresión.

Nota: Los curadores que ejecuten este informe solo verán los segmentos que asignen a sus objetos de línea de negocio. Por ejemplo, un curador que obtenga este informe no verá segmentos vinculados a un acuerdo de vendedor externo que está comprando.
segment_owner_id Entero Sí 789 Id. de miembro del propietario del segmento propietario del segmento (s) de destino
segment_owner_name string No "That Segment Owner" Nombre de miembro del propietario del segmento propietario del segmento propietario de los segmentos de destino
seller_member_id Entero Sí 4567 Id. de miembro del vendedor donde se ha realizado la transacción protegida
seller_member_name string No "That Seller" Nombre de miembro del vendedor donde se ha realizado la transacción protegida
supply_strategy string Sí "Deals" Distingue entre los diferentes canales de suministro utilizados para obtener impresiones para el curador.

Nota: Solo "Open Exchange" y "Deals" actualmente son relevantes para el curador.
supply_type_id Entero Sí 0 Identificador del tipo de suministro del anuncio que se ha representado. 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 ha representado. Los posibles valores son:
- "web"
- "mobile_web"
- "mobile_app"
targeting_type string Sí "Inclusion" Si el segmento ha contribuido a la segmentación de la línea de pedido 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 (realizado a través de impresiones dirigidas por el segmento) que un curador envió a los vendedores de intercambio neto de honorarios y márgenes del curador, si corresponde.
targeted_curator_media_cost_ecpm dinero 1.6654 La cantidad de gasto (realizado a través de impresiones dirigidas por el segmento, expresado como un eCPM basado en impresiones realizadas) que un curador envía a los vendedores de intercambio neto de honorarios y márgenes del curador, si corresponde
targeted_curator_revenue dinero 48.4185 La cantidad de gasto (realizada a través de impresiones dirigidas por el segmento) que un comprador envió al curador neta de tarifas del comprador, si corresponde.
targeted_curator_revenue_ecpm dinero 2.5588 La cantidad de gasto (realizado a través de impresiones dirigidas por el segmento, expresado como un eCPM basado en impresiones específicas) que un comprador envió al curador neto de tarifas del comprador, si corresponde
targeted_impressions Entero 18922 El número de impresiones transaccionadas que segmentó el segmento
targeted_view_measured_impressions Entero 17867 El número de impresiones transaccionadas en las que Xandr midió la visibilidad del segmento objetivo
targeted_viewable_impressions Entero 14135 El número de impresiones vistas que segmentó el segmento

Ejemplo

Crear una solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type de "curator_segment_performance", así como el columns (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 el formato en el que 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 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 el estado del informe desde el servicio de informes

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=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 ID del informe, pero esta vez al servicio de descarga de informes . Puede encontrar el servicio y el ID de informe en el url campo de la respuesta anterior GET . Al identificar el archivo en el que desea guardarlo, asegúrese de usar la extensión de archivo que especificó en POSTel "format" 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=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.

  • Last updated on