API de plataforma digital: informe de facturación de compra
Advertencia
Este informe solo debe usarse para los datos después del 30 de septiembre de 2015.
El informe de facturación de compra se puede usar para ver los datos de facturación entre impresiones directas de anunciantes (compradas entre publicadores directos e inventario en tiempo real).
Para obtener instrucciones sobre cómo recuperar un informe, consulte Servicio de informes.
Período de tiempo
El report_interval
campo de la solicitud JSON se puede establecer en uno de los siguientes:
- last_hour
- hoy
- yesterday
- last_48_hours
- last_7_days
- last_30_days
- month_to_date
- quarter_to_date
- last_month
- vida
- costumbre
Período de retención de datos
El período de retención de datos para este informe es de 1095 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 Report Service.
Dimensions
Column | Tipo | ¿Filtro? | Ejemplo | Descripción |
---|---|---|---|---|
hour |
time | No | "2010-02-01 06:00:00" |
La hora de la impresión. Nota: En el caso de las impresiones anteriores a 100 días, los datos por hora se agregan en una fila con "AAAA-MM-DD 00:00:00" como la hora ('AAAA-MM-DD' es el día UTC en el que se produjo la actividad). Esto hará que parezca que toda la actividad ocurrió a medianoche. Todos los datos diarios anteriores a 100 días se devuelven en la zona horaria UTC. |
day |
time | No | "2010-02-01" |
El día de la impresión. |
month |
time | No | "2010-02" |
El mes de la impresión. |
buyer_member_id |
Entero | Yes | 123 |
Identificador interno del miembro comprador. |
buyer_member_name |
string | No | "My Network" |
Nombre para mostrar del miembro comprador. |
seller_member_id |
Entero | Yes | 456 |
Id. interno del miembro del vendedor. |
seller_member_name |
string | No | "That Seller" |
Nombre para mostrar del miembro del vendedor. |
advertiser_id |
Entero | Yes | 789 |
Id. interno del anunciante. |
advertiser_name |
string | No | "Verizon" |
Nombre para mostrar del anunciante. |
advertiser_code |
string | No | "Advertiser Code" |
Código externo asociado a un anunciante. |
insertion_order_id |
Entero | Yes | 451 |
Identificador interno del orden de inserción. |
insertion_order_name |
string | No | "Q1-2014" |
Nombre para mostrar del orden de inserción. |
insertion_order_code |
string | No | "Insertion Order Code" |
Código externo asociado a un orden de inserción. |
line_item_id |
Entero | Yes | 932 |
Identificador interno del elemento de línea. |
line_item_name |
string | No | "$3 CPM Verizon Remarketing" |
Nombre para mostrar del elemento de línea. |
line_item_code |
string | No | "Line Item Code" |
Código externo asociado a un elemento de línea. |
campaign_id |
Entero | Yes | 728 |
Identificador interno de la campaña. |
campaign_name |
string | No | "Test" |
Nombre para mostrar de la campaña. |
campaign_code |
string | No | "Campaign Code" |
Código externo asociado a una campaña. |
publisher_id |
Entero | Yes | 321 |
Identificador interno del publicador. |
publisher_name |
string | No | "Test" |
Nombre para mostrar del publicador. |
deal_id |
Entero | Yes | 123 |
Identificador interno de la transacción. |
deal_name |
string | No | "Deal A" |
Nombre para mostrar de la oferta. |
buying_currency |
string | Sí | "USD" |
Moneda de transacción utilizada por el comprador para comprar esta impresión. |
selling_currency |
string | Sí | "EUR" |
Moneda de transacción utilizada por el vendedor para vender esta impresión. |
imp_type_id |
Entero | Yes | 1 |
Identificador del tipo de impresión. Valores posibles (tipos asociados entre paréntesis): - 1 ("Blank") : no se sirve creativo.- 2 ("PSA") : se sirvió un anuncio de servicio público porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible.- 3 ("Default Error") : una creatividad predeterminada que se sirve debido a un problema de tiempo de espera.- 4 ("Default") : un creativo predeterminado servido porque no había ofertas válidas.- 5 ("Kept") : la creatividad de su anunciante se ha servido en el sitio de su editor.- 6 ("Resold") : la impresión del editor se vendió a un comprador de terceros.- 7 ("RTB") : la creatividad de su anunciante se sirve en el inventario de terceros.- 8 ("PSA Error") : un anuncio de servicio público servido debido a un problema de tiempo de espera o a la falta de una creatividad predeterminada.- 9 ("External Impression") : una impresión de un rastreador de impresiones.- 10 ("External Click") : un clic de un seguimiento de clics. |
imp_type |
string | Sí | "Blank" |
Tipo de impresión. Para obtener los valores posibles, vea imp_type_id . |
cleared_direct |
Entero | Yes |
0 , 1 |
Si el comprador paga directamente al vendedor por el costo de los medios. Si 0 es , Xandr recopila el costo de los medios del comprador y paga al vendedor. Si 1 es , el comprador paga directamente al vendedor el costo de los medios.Propina: Los compradores pueden coincidir con el costo de los medios en su factura filtrando las transacciones "directas borradas". |
marketplace_clearing_event |
string | Sí | "Views - Standard Display" |
Nombre del evento de subasta subyacente que se realizó (por ejemplo, impresión, impresión visible, vídeo completado). Para obtener más información, consulte Resultados garantizados y estándares de visualización admitidos en la documentación de la interfaz de usuario. |
split_id |
Entero | sí | 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 . |
Métricas
Column | Tipo | Ejemplo | Fórmula | Descripción |
---|---|---|---|---|
imps |
Entero | 123456 |
Duendes | Número total de impresiones. |
clicks |
Entero | 123456 |
Clics | Número total de clics en todas las impresiones. |
convs |
Entero | 123456 |
total_convs | Número total de conversiones en todas las impresiones. |
booked_revenue |
dinero | 123.45 |
booked_revenue | Ingresos de red reservados a través de anunciantes directos. |
booked_revenue_dollars_buying_currency |
dinero | 123.45 |
booked_revenue_dollars_buying_currency | Ingresos de red reservados a través de anunciantes directos, en la moneda de transacción que el comprador usó para comprar la impresión. |
buyer_media_cost |
dinero | 123.45 |
buyer_media_cost | Costo total del inventario comprado. |
buyer_media_cost_buying_currency |
dinero | 123.45 |
buyer_media_cost_buying_currency | El costo total del inventario comprado, en la moneda de transacción que el comprador usó para comprar la impresión. |
auction_service_deduction |
dinero | 123.45 |
auction_service_deduction | Las deducciones totales cobradas por impresiones compradas a terceros. Estas deducciones se incluyen en el costo multimedia del comprador y se deducen al calcular el pago del vendedor. Para obtener más información, consulte Mecánica de cargos del servicio de subastas de compradores. |
auction_service_deduction_buying_currency |
dinero | 123.45 |
auction_service_deduction_buying_currency | Las deducciones totales cobradas por las impresiones compradas a terceros, en la moneda de transacción que el comprador usó para comprar la impresión. Estas deducciones se incluyen en el costo multimedia del comprador y se deducen al calcular el pago del vendedor. Para obtener más información, consulte Mecánica de cargos del servicio de subastas de compradores. |
net_media_cost |
dinero | 123.45 |
net_media_cost | Importe total que se va a pagar por las compras de medios, menos la deducción del servicio de subastas. |
net_media_cost_buying_currency |
dinero | 123.45 |
net_media_cost_buying_currency | Importe total a pagar por las compras de medios, menos la deducción del servicio de subasta, en la moneda de transacción que el comprador usó para comprar la impresión. |
creative_overage_fees |
dinero | 123.45 |
creative_overage_fees | Tarifas totales que se cobran por las creatividades hospedadas que superan el límite de tamaño creativo. |
creative_overage_fees_buying_currency |
dinero | 123.45 |
creative_overage_fees_buying_currency | Tasas totales cobradas por las creatividades hospedadas que superan el límite de tamaño creativo, en la moneda de transacción que el comprador usó para comprar la impresión. |
auction_service_fees |
dinero | 123.45 |
auction_service_fees | Cargos totales cobrados por impresiones compradas a terceros. Estas tarifas se cobran además del costo de medios del comprador. Para obtener más información, consulte Mecánica de cargos del servicio de subastas de compradores. |
auction_service_fees_buying_currency |
dinero | 123.45 |
auction_service_fees_buying_currency | Tasas totales cobradas por impresiones compradas a terceros, en la moneda de transacción que el comprador usó para comprar la impresión. Estas tarifas se cobran además del costo de medios del comprador. Para obtener más información, consulte Mecánica de cargos del servicio de subastas de compradores. |
marketplace_clearing_event_units |
Entero | 23 |
marketplace_clearing_event_units | Número total de eventos comprados (para el evento de compensación asociado). Al comprar un evento de compensación distinto de la impresión (por ejemplo, impresiones visibles), el número de eventos facturados será menor que el número de impresiones. Para obtener más información, consulte Resultados garantizados en la documentación de la interfaz de usuario. |
exchange_cost |
dinero | 4.32 |
exchange_cost | Cantidad sacada del intercambio que se va a dar al vendedor. Si no usa un elemento de línea con un modelo de pago de resultados garantizados, el valor de esta métrica es igual a Net Media Cost. |
ecpm_conversion_deduction |
dinero | 3.2 |
ecpm_conversion_deduction | Cantidad que Xandr saca de una oferta o pago de resultados garantizados para cubrir los servicios de predicción de resultados posteriores a la subasta y conversión de eCPM. Si no usa un elemento de línea con un modelo de pago de resultados garantizados 0 , el valor de este campo es igual a .Para obtener más información sobre cómo se calcula esta tarifa, consulte Descripción de las tasas de conversión de pago. |
go_market_making_fee |
dinero | 0.48 |
go_market_making_fee | Cuota basada en porcentajes que Xandr saca de una oferta o pago de resultados garantizados para cubrir el riesgo incurrido al proporcionar resultados garantizados. El valor de este campo es igual 0 cuando no se usa un elemento de línea de resultados garantizados. Si no usa un elemento de línea con un modelo de pago de resultados garantizados 0 , el valor de este campo es igual a .El objetivo de esta cuota es del 10 %, pero el porcentaje real utilizado varía en función de la precisión de predicción que cambia continuamente: Go Market Making Fee Percentage = Fixed Percentage (10%) ± Prediction Variability (un porcentaje positivo o negativo que cambia en función de la precisión de predicción de desplazamiento) Para obtener más información sobre cómo se calcula esta tarifa, consulte Descripción de las tasas de conversión de pago. |
Ejemplos
Creación de la solicitud de informe con formato JSON
El archivo JSON debe incluir , report_type
"buyer_invoice_report"
así como las columnas (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
, excel
o html
). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.
$ cat buyer_invoice_report.json
{
"report": {
"format": "csv",
"report_interval": "last_48_hours",
"columns": [
"seller_member_name",
"buyer_member_name",
"imps",
"clicks",
"convs"
],
"report_type": "buyer_invoice_report"
}
}
POST
la solicitud a Reporting Service que especifica un identificador de miembro reemplazando INSERT_DESIRED_MEMBER_ID
$ curl -b cookies -c cookies -X POST -d @buyer_invoice_report.json 'https://api.appnexus.com/report?member_id=INSERT_DESIRED_MEMBER_ID'
{
"response": {
"status": "OK",
"report_id": "39c4855a07e92433947886b5aabd267d", <=== COPY THIS report_id as you will need it to check the status of your report and to download your report
"existing": false,
"dbg_info": {
...
}
}
}
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=39c4855a07e92433947886b5aabd267d'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2015-11-17 21:27:21",
"cache_hit": false,
"fact_cache_hit": false,
"fact_cache_error": null,
"json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"last_48_hours\",\"columns\":[\"seller_member_name\",\"buyer_member_name\",\"imps\",\"clicks\",\"convs\"],\"report_type\":\"buyer_invoice_report\",\"filters\":[{\"buyer_member_id\":\"668\"},{\"is_delivered\":{\"value\":[\"1\"],\"operator\":\"=\"}},{\"is_valid_buyer\":{\"value\":[\"1\"],\"operator\":\"=\"}},{\"is_valid_buying_imp_type\":{\"value\":[\"1\"],\"operator\":\"=\"}}]}}",
"header_info": "Report ID:,39c4855a07e92433947886b5aabd267d\r\nRun at:,2015-11-17 21:27:21\r\nStart date:,2015-11-15 21:00:00\r\nEnd date:,2015-11-17 20:00:00\r\nTimezone:,\r\nUser:,Huanqing Liu (171989)\r\n",
"row_count": "309",
"report_size": "15583",
"internal_info": "{\"report_id\":\"39c4855a07e92433947886b5aabd267d\",\"expected_query_cost\":\"1\",\"processor\":\"20.bm-report-processor.prod.nym2\",\"last_processor_run_on\":\"20.bm-report-processor.prod.nym2\",\"cache_miss\":1,\"query\":\" SELECT seller_member_id AS alias_1,CASE WHEN transaction_type = 1 THEN 'Blank' WHEN transaction_type = 3 THEN 'Default Error' WHEN transaction_type = 4 THEN 'Default' WHEN transaction_type = 2 THEN 'PSA' WHEN transaction_type = 8 THEN 'PSA Error' WHEN transaction_type IN (5,6,7,9,10,11) THEN CAST(BUYER_MEMBER_ID AS VARCHAR(7)) ELSE 'Unknown' END AS alias_2,SUM(IMPS) AS alias_3,SUM(CLICKS) AS alias_4,sum(convs) AS alias_5 FROM agg_combined_billing fact WHERE 1=1 AND ymdh >= '2015-11-15 21:00:00' AND ymdh < '2015-11-17 20:00:00' AND buyer_member_id IN ('668') AND is_delivered IN ('1') AND CASE WHEN has_dw_buy=1 OR is_dw_buyer=0 THEN 1 ELSE 0 END IN ('1') AND CASE WHEN transaction_type in (7, 9, 10, 11) THEN 1 ELSE 0 END IN ('1') GROUP BY alias_1, alias_2 LIMIT 1000000001\\n-- [member_id] \\n-- [report_id] 39c4855a07e92433947886b5aabd267d\"}",
"user_id": "171989",
"entity_id": "0",
"started_on": "2015-11-17 21:27:22",
"finished_on": "2015-11-17 21:27:24",
"query_time": "0",
"url": "report-download?id=39c4855a07e92433947886b5aabd267d"
},
"execution_status": "ready",
"_was_this_status_cached_": 0,
"dbg_info": {
...
}
}
}
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 -c cookies 'https://api.appnexus.com/report-download?id=39c4855a07e92433947886b5aabd267d' > buyer_invoice_report.csv
Nota:
Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.