API del informe de facturación de licitadores

Los compradores pueden recopilar información de transacciones mediante el Informe de facturación del ofertante para facturar a sus anunciantes.

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:

  • current_hour
  • last_hour
  • last_48_hours
  • today
  • yesterday
  • last_7_days
  • month_to_date
  • quarter_to_date
  • last_month
  • lifetime
  • month_to_yesterday
  • custom

Dimensions

Column Tipo grupo? ¿Filtro? Ejemplo Descripción
hour time Sí Sí "2010-02-01 06:00:00" La hora de la impresión.

Nota: Para las impresiones de más de 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 con una antigüedad superior a 100 días se devuelven en la zona horaria UTC.
day time Sí Sí "2010-02-01" El día de la impresión.
month time Sí Sí "2010-02" El mes de la impresión.
buyer_member_id Entero Sí Sí 123 ID interno del miembro comprador.
buyer_member_name string No No "My Buyer" Nombre para mostrar del miembro comprador.
seller_member_id Entero Sí Sí 456 Id. interno del miembro vendedor.
seller_member_name string No No "That Seller" Nombre para mostrar del miembro vendedor.
publisher_id Entero Sí Sí 321 Id. interno del editor.
geo_country string Sí Sí "US" El código del país o región geográficos.
geo_country_name string No No "United States" El nombre del país o región geográficos.
deal_id Entero Sí Sí 123 El identificador interno de la oferta.
deal_name string No No "Deal A" El nombre para mostrar del trato.
direct_cleared Entero Sí Sí 0, 1 Si el comprador paga o no al vendedor directamente por el costo de los medios. Si 0, Xandr cobra el costo de los medios del comprador y paga al vendedor. Si 1, el comprador paga directamente al vendedor por el costo de los medios.

Propina: Los compradores pueden igualar el costo de los medios en su factura filtrando las transacciones "directas compensadas".
buying_currency string Sí Sí "USD" La moneda de transacción que usa el comprador para comprar esta impresión.
selling_currency string Sí Sí "EUR" La moneda de la transacción que usa el vendedor para vender esta impresión.
imp_type_id Entero Sí Sí 7 El identificador del tipo de impresión. Valores posibles (tipos asociados entre paréntesis):
- 7 ("RTB"): La creatividad de sus compradores se sirve en el inventario de terceros.
- 9 ("Impresión externa"): Una impresión de un rastreador de impresiones.
- 10 ("Clic externo"): Un clic de un rastreador de clics.
buyer_seat_code string Sí No "1234" El id. de licencia de comprador personalizado (enviado por DSP) que se usó para pujar por la impresión.
buyer_seat_name string Sí No "test seat" El nombre para mostrar del código de asiento del comprador.

Métricas

Column Tipo Ejemplo Fórmula Descripción
imps Entero 100 imps_delivered El número total de impresiones servidas correctamente.
imps_direct_cleared Entero 100 imps_direct_cleared El número total de impresiones en las que Xandr NO recopila el coste multimedia del comprador ni paga al vendedor por las transacciones entre este par comprador-vendedor.
imps_appnexus_cleared Entero 100 imps_appnexus_cleared El número total de impresiones en las que Xandr recopila el coste multimedia del comprador y paga los pagos al vendedor por las transacciones entre este par comprador-vendedor.
buyer_media_cost dinero 123.45 buyer_media_cost El costo total del inventario comprado.
buyer_media_cost_direct_cleared dinero 123.45 buyer_media_cost en imps_direct_cleared El gasto del comprador por impresiones en las que el pago del vendedor se realiza directamente entre este par comprador-vendedor, no a través de Xandr.
buyer_media_cost_direct_cleared_buying_currency dinero 123.45 buyer_media_cost_direct_cleared_buying_currency El gasto del comprador por impresiones en las que el pago del vendedor se realiza directamente entre este par comprador-vendedor, no a través de Xandr, en la moneda de la transacción que el comprador usó para comprar la impresión.
buyer_media_cost_appnexus_cleared dinero 123.45 buyer_media_cost en imps_appnexus_cleared El gasto del comprador por las impresiones en las que Xandr paga el pago del vendedor.
buyer_media_cost_direct_cleared_buying_currency dinero 123.45 buyer_media_cost_direct_cleared_buying_currency El gasto del comprador por las impresiones en las que Xandr paga el pago al vendedor, en la moneda de la transacción que el comprador usó para comprar la impresión.
buyer_media_cost_buying_currency dinero 123.45 buyer_media_cost_buying_currency El coste total del inventario comprado, en la moneda de la transacción que el comprador usó para comprar la impresión.
creative_overage_fees dinero 123.45 creative_overage_fees Tarifas totales cobradas por las creatividades alojadas que superen el límite de tamaño de la creatividad.
creative_overage_fees_buying_currency dinero 123.45 creative_overage_fees_buying_currency Tarifas totales cobradas por las creatividades alojadas que superen el límite de tamaño de la creatividad, en la moneda de la transacción que el comprador utilizó para comprar la impresión.
auction_service_fees dinero 123.45 auction_service_fees La tarifa cobrada por las impresiones compradas de RTB especificadas en el contrato del miembro comprador. Por ejemplo, con una tarifa del 10%, si el comprador gasta $ 1,000 en inventario, Xandr le cobra una tarifa de $ 100. Recibirán una factura por $ 1,000 de costo de medios y $ 100 por cargo por servicio de subasta de compradores (BASC) por un total de $ 1,100.

Existen dos tipos:
- Para las filas que son direct_cleared, su tarifa de compensación directa se registraría en este campo.
- Si tiene su cargo por servicio de subasta del comprador (BASC) establecido como una tarifa en lugar de una deducción, también se registrará aquí un valor. Puede diferenciar agrupando por la dimensión direct_cleared al extraer el informe.
auction_service_fees_buying_currency dinero 123.45 auction_service_fees_buying_currency La tarifa cobrada por las impresiones compradas por RTB especificada en el contrato del miembro comprador, en la moneda de la transacción que el comprador utilizó para comprar la impresión.
auction_service_deduction dinero 123.45 auction_service_deduction La deducción de las impresiones compradas de RTB especificada en el contrato del miembro comprador. Por ejemplo, con una deducción del 10 %, si presupuestan 1000 USD para su campaña, Xandr toma 100 USD de eso, dejando al comprador con 900 USD que se usan para comprar inventario del vendedor. Creative Auction Service Change (CASC) también estará representado aquí. Para el ejemplo anterior, el comprador recibirá una factura por $ 1,000 de costo de medios, que incluye los cargos de Xandr de deducción.

Advertencia: Este campo coincide con auction_service_fees si su contrato tiene una tasa de cargo por servicio de subasta de compradores (BASC) superior al 0 %.
auction_service_deduction_buying_currency dinero 123.45 auction_service_deduction_buying_currency La deducción de las impresiones compradas por RTB especificada en el contrato del miembro comprador, en la moneda de la transacción que el comprador usó para comprar la impresión.
buyer_ecpm dinero 123.45 buyer_media_cost / imps_delivered * 1000 El coste por impresión del comprador, expresado en eCPM.
buyer_ecpm_buying_currency dinero 123.45 buyer_ecpm, expresada en la moneda del comprador El coste por impresión del comprador en la moneda seleccionada. Para obtener una lista de las monedas admitidas, consulte Monedas admitidas.

Ejemplos

Crear la solicitud de informe con formato JSON

El archivo JSON debe incluir el report_typebidder_pricing_report, 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 buyer_invoice_report_request.json
{
    "report": {
        "format": "csv",
        "report_interval": "last_48_hours",
        "columns": [
            "seller_member_name",
            "buyer_member_name",
            "imps"
        ],
        "report_type": "bidder_pricing_report"
    }
}

POST la solicitud al servicio de informes

$ curl -b cookies -c cookies -X POST -d @bidder_pricing_report_request.json 'https://api.adnxs.com/report'
{
 "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 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 -c cookies 'https://api.adnxs.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\",\"report_type\":\"bidder_pricing_report\"}}",
     "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": "{...}",
     "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 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 -c cookies 'https://api.adnxs.com/report-download?id=39c4855a07e92433947886b5aabd267d' > bidder_pricing_report.csv
  • Last updated on