API de plataforma digital: informe de Curator Analytics

Nota:

Este informe solo está disponible para curadores.

El Informe de Análisis del Curador proporciona a los curadores información sobre cómo fluye el dinero de la demanda a la oferta dentro de su mercado curado.

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
  • hoy
  • yesterday
  • month_to_date
  • last_month
  • de duración

Período de retención de datos

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

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.

Intervalos de tiempo, incluidas las fechas de hace más de 45 días

Si crea informes de Curator Analytics con el conjunto en "lifetime", su informe (independientemente de las report_interval 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 solicitados, estos informes que hacen un uso intensivo de recursos pueden fallar antes de completarse. Si no se completa el informe, recibirás una notificación. Si se produce un error en la solicitud de denuncia o se elimina, puede:

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

Dimensions

Column Tipo ¿Filtro? Ejemplo Descripción
bidder_id Entero 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
billing_currency string "USD" La moneda que Xandr factura al curador
brand_id Entero 1234 Id. de marca asociado al recurso creativo que sirvió en el acuerdo seleccionado
brand_name string No "That Brand" Marca asociada al recurso creativo que sirvió en el acuerdo seleccionado
buyer_member string No "That Buyer (789)" Nombre del miembro del comprador que compró en la transacción con su ID de miembro entre paréntesis
buyer_member_id Entero 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 string No "My Deal Name (123)" Nombre de la oferta seleccionada con su identificador de oferta entre paréntesis
curated_deal_advertiser_id Entero 123 Id. de anunciante del objeto miembro curador que posee la línea de pedido de negocio asociada a la oferta seleccionada
curated_deal_advertiser_name string No "That Advertiser" Nombre del anunciante del objeto miembro curador que posee la línea de pedido de negocio asociada a la oferta seleccionada
curated_deal_id Entero 123 Id. de oferta seleccionada
curated_deal_insertion_order_id Entero 123 Id. de orden de inserción del objeto miembro curador que posee el elemento de línea de negocio asociado con el negocio curado
curated_deal_line_item_id Entero 123 Id. de línea de pedido del objeto miembro curador que posee la línea de pedido asociada a la oferta seleccionada
curated_deal_insertion_order_name string No "IO Name" Nombre de orden de inserción del objeto miembro curador que posee el elemento de línea de negocio asociado con el negocio curado
curated_deal_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
curated_deal_name string No "My Deal Name" Nombre de la oferta seleccionada
curator_margin_type Entero No "Percent" Tipo de margen (si un curador tiene un margen asociado a la partida). Posibles valores:
- "Unknown"
- "Percent"
- "CPM"
curator_margin_type_filterable Entero 1 Tipo de margen filtrable (si un curador tiene un margen asociado a la línea de pedido). Posibles valores:
0 (Desconocido)
1 (Porcentaje)
2 (CPM)
curator_member string No "My Account (123)" Nombre de miembro de la cuenta del curador con su ID de miembro entre paréntesis
curator_member_id Entero 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 "2020-02-01" El día de la subasta
device_type string "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"
geo_country string "US" El país o región en el que tuvo lugar 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 "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"
member_currency string "USD" La moneda asociada con el asiento del miembro curador
member_id Entero 789 ID de miembro de la cuenta del curador
mobile_application_id string "343200656" (iOS) o
"com.rovio.angrybirds"
(Android)
El id. de la aplicación móvil asociado a la creatividad que sirvió en esta impresión
mobile_application_name string No "Angry Birds" El nombre de la aplicación móvil asociado a la creatividad que sirvió en esta impresión
month date "2020-02" El mes de la subasta
placement string No "Ivillage 160x600 (456)" Nombre del emplazamiento del vendedor en el que se realizó la transacción seleccionada con el identificador del emplazamiento entre corchetes
placement_group_id Entero 4321 Identificador del grupo de selección de ubicación del vendedor en el que se ha realizado la transacción seleccionada
placement_group_name string No "Placement Group Name" Ubicación: Nombre del grupo del vendedor donde se realizó la transacción seleccionada
placement_id Entero 456 Identificador de colocación del vendedor donde se realizó la transacción seleccionada
placement_name string No "Ivillage 160x600" Nombre de colocación del vendedor donde se ha realizado la transacción mantenida
publisher_id Entero 321 Id. del editor del vendedor donde se ha realizado la transacción seleccionada
publisher_name string "Newscorp" Nombre del editor del vendedor donde se ha servido la transacción seleccionada
seller_deal string No "That Seller Deal (6543)" El nombre de la oferta del vendedor se incluye en una oferta seleccionada con el id. de la oferta del vendedor entre paréntesis

Nota: Si corresponde, dado que no todas las ofertas seleccionadas incluirán una oferta de vendedor
seller_deal_id Entero 6543 El id. de la oferta del vendedor que se incluye en una oferta seleccionada
Nota: Si corresponde, dado que no todas las ofertas seleccionadas incluirán una oferta de vendedor
seller_deal_name string No "That Seller Deal" El nombre de la oferta del vendedor que se incluye en una oferta seleccionada

Nota: Si corresponde, dado que no todas las ofertas seleccionadas incluirán una oferta de vendedor
seller_deal_type_id Entero No 2 El identificador del tipo de oferta de vendedor que se incluye en una oferta curada, si procede. Los posibles valores son:
1 (Subasta abierta)
2 (Subasta privada)
seller_deal_type_name string "Private Marketplace" El nombre del tipo de oferta de vendedor que se incluye en una oferta curada, si procede. Los posibles valores son:
- "---" (Subasta abierta)
- "Private Marketplace" (Subasta privada)
seller_member_id Entero 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
site_domain string No "bestsiteever.com" Dominio del sitio o aplicación donde se ha realizado la transacción mantenida
size string "320x50" El tamaño de la creatividad
video_context string "pre-roll" El tipo de formato de vídeo en el que se publicó la transacción seleccionada. Los posibles valores son:
- "unknown"
- "pre-roll"
- "mid-roll"
- "post-roll"
- "outstream"
video_content_duration string "Short-Form" Longitud del contenido en segundos (dos opciones: corto (menos de 480s), largo (más de 480s)).
content_delivery_type string "VOD" El tipo de entrega de contenido en streaming.
video_content_genre string "Action" El género principal del programa en el que se reproducirá el anuncio.
video_program_type string "Movie" La categorización de nivel superior del programa en el que se reproducirá el anuncio.
video_content_rating string "Children(7+)" El tipo de clasificación del contenido.

Métricas

Nota:

Las métricas de clics están disponibles para las impresiones compradas a través de Microsoft Invest. Las métricas de vídeo están disponibles para las impresiones compradas a través de cualquier DSP.

Column Tipo Ejemplo Fórmula Descripción
curator_margin dinero 2.57676 curator_margin El beneficio que obtiene un curador de una transacción

Nota: Cuando se toma como porcentaje, el margen del curador se calcula a partir de los ingresos del curador.
curator_net_media_cost dinero 20.6138056 curator_revenue - curator_margin - curator_tech_fees El monto del gasto que un curador envía a los vendedores de intercambio, neto de los honorarios y márgenes del curador, si corresponde. Es lo mismo que los ingresos brutos del vendedor, incluidos los honorarios del vendedor.
curator_revenue dinero 25.767257 curator_revenue El monto del gasto que un comprador envía al curador, neto de los honorarios del comprador, si corresponde. Esto es lo mismo que el costo de los medios del comprador, sin incluir las tarifas del comprador.
curator_tech_fees dinero 2.5767257 curator_tech_fees Las tarifas que Xandr cobra a un curador por una transacción
curator_total_cost dinero 23.1905313 curator_revenue - curator_margin La cantidad de gasto que un curador envía a la bolsa y a los vendedores de la bolsa, neto del margen del curador pero bruto de los honorarios del curador
imps Entero 2340 Diablillos El número de impresiones entregadas
viewdef_viewed_imps Entero 1638 viewdef_viewed_imps El número de impresiones medidas que fueron visibles, según la definición de visibilidad del comprador
viewdef_view_rate double 0.70 viewdef_view_rate El número de impresiones medidas que eran visibles, según la definición de visibilidad del comprador, dividido por el número de impresiones medidas
viewed_imps Entero 1872 viewed_imps El número de impresiones medidas que fueron visibles, según la definición de visibilidad de IAB, que establece que una impresión es visible si el 50 % de los píxeles están a la vista durante 1 segundo consecutivo
view_measurable_imps Entero 172 view_measurable_imps El número total de impresiones que se midieron para la visibilidad.
clicks Entero 7 clics El número total de clics en todas las impresiones. Para Microsoft Invest, se admiten clics de todos los tipos de medios. En el caso de los DSP externos, solo se admiten clics de los tipos de medios nativos y de vídeo.
ctr double 0.3 Clics / Diablillos La proporción de clics frente a diablillos.
buyer_cpc dinero 3.68 curator_revenue / clics Los ingresos del curador se dividen por los clics.
video_errors Entero 45 video_errors El número total de veces que se ha producido un error.
video_starts Entero 2335 video_starts El número total de veces que se ha descargado e iniciado el primer segmento de la creatividad de vídeo.
video_start_rate double 0.99786 video_starts / diablillos La proporción de inicios de vídeo frente a diablillos.
video_skips Entero 12 video_skips El número total de veces que un usuario se ha saltado el vídeo.
video_skip_rate double 0.0051282 video_skips / diablillos La proporción de saltos de vídeo frente a diablillos.
video_25_pcts Entero 2100 video_25_pcts El número total de veces que el vídeo completó el 25 % de la duración total.
video_50_pcts Entero 2000 video_50_pcts El número total de veces que el vídeo completó el 50 % de toda la duración.
video_75_pcts Entero 1900 video_75_pcts El número total de veces que el vídeo completó el 75 % de toda la duración.
video_completions Entero 1800 video_completions El número total de veces que se ha reproducido el vídeo durante toda la duración.
video_completion_rate double 0.76923 video_completions / diablillos La proporción de finalizaciones de vídeo frente a diablillos.
buyer_cost_per_video_complete dinero 0.014315 curator_revenue / video_completions Ingresos del curador divididos por finalización de videos.
buyer_cpm dinero 11.01164 curator_revenue / diablillos * 1000 Los ingresos del curador divididos por los diablillos expresados como un CPM. Si una oferta seleccionada de precio fijo obtiene impresiones de un vendedor mediante subastas de segundo precio, el precio de compensación de la oferta seleccionada puede ser inferior al precio fijo configurado.

Ejemplo

Crear una solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type de "curator_analytics", 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_analytics

{
    "report": {
        "columns": [
            "hour",
            "buyer_member_name",
            "curated_deal",
            "imps",
            "curator_revenue",
            "curator_margin"
        ],
        "format": "csv",
        "report_interval": "today",
        "report_type": "curator_analytics"
    }
}

POST la solicitud al servicio de informes

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

{
   "response":{
      "status":"OK",
      "report_id":"6b177543a9411ffa67b09bdf5e76cac1"
   }
}

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=6b177543a9411ffa67b09bdf5e76cac1'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2020-08-25 13:03:37",
         "json_request":"{\"report\":{\"report_type\":\"curator_analytics\",\"columns\":[\"hour\",\"buyer_member_name\",\"curated_deal\",\"imps\",\"curator_revenue\",\"curator_margin\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"member_id\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
         "url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
      },
      "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=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/curator_analytics.csv

Nota:

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