API de plataforma digital: informe de facturación de ventas

Artículo
05/18/2024

Advertencia

Este informe solo debe usarse para los datos después del 30 de septiembre de 2015.

El informe de facturación de ventas se puede usar para ver los datos de facturación entre publicadores directos (vendidos entre anunciantes directos y otros compradores de plataforma).

Para obtener instrucciones sobre cómo recuperar un informe, consulte el 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
Personalizado

Sugerencia

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.

Período de retención de datos

El período de retención de datos para este informe es de 1095 días.

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.
`publisher_id`	Entero	Yes	`321`	Identificador interno del publicador.
`publisher_name`	string	No	`"Test"`	Nombre para mostrar del publicador.
`publisher_code`	Entero	Yes	`123`	Identificador externo del publicador.
`selling_currency`	string	Sí	`Yes`	Moneda de transacción utilizada por el vendedor para vender esta impresión.
`buying_currency`	string	Sí	`"USD"`	Moneda de transacción utilizada por el comprador para comprar esta impresión.
`deal_id`	Entero	Yes	`123`	Identificador interno de la oferta
`imp_type_id`	Entero	Yes	`1`	Identificador del tipo de impresión. Valores posibles (identificadores asociados entre paréntesis): - "En blanco" (`1`): no se sirve creativo. - "PSA" (`2`): un anuncio de servicio público se sirvió porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible. - "Error predeterminado" (`3`): una creatividad predeterminada que se sirve debido a un problema de tiempo de espera. - "Valor predeterminado" (`4`): una creatividad predeterminada que se sirve porque no había pujas válidas. - "Guardado" (`5`): La creatividad de su anunciante se ha servido en el sitio de su editor. - "Revender" (`6`): la impresión de su editor se vendió a un comprador de terceros. - "RTB" (`7`): la impresión del editor se vendió a un comprador de terceros. - "Error de PSA" (`8`): un anuncio de servicio público servido debido a un problema de tiempo de espera o a la falta de una creatividad predeterminada. - "Impresión externa" (`9`): una impresión de un rastreador de impresiones. - "Clic externo" (`10`): un clic de un seguimiento de clics.
`selling_imp_type`	string	Sí	`"Resold"`	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. Sugerencia: Los compradores pueden coincidir con el costo de los medios en su factura filtrando las transacciones "directas borradas".
`pricing_media_type_id`	Entero	No	`0`, `1`	Identificador de la clasificación de tipos de medios específicos del vídeo (solo para facturación). Si no tiene precios específicos de vídeo, este campo es irrelevante. Los valores posibles son: `0`, `1`, `2` y `3`.
`pricing_media_type_name`	string	No	`"Non Video"`	Nombre de la clasificación de tipo multimedia específica del vídeo (solo para facturación). Si no tiene precios específicos de vídeo, este campo es irrelevante. Los valores posibles son: - `"--"` - `"Non-Video"` - `"Video (Hosted)"` - `"Video (Non-Hosted)"`
`deal_type`	string	Sí	`"Open Auction"`	Tipo de oferta para una oferta determinada. Las opciones de tipo de oferta son: - `Open Auction` - `Private Auction` - `Curated` - `First Look` - `Programmatic Guaranteed`
`auction_charges_available`	string	Sí	`"Yes"`	Identifica la actividad facturable en la que se pueden revelar las deducciones del vendedor. Si el valor es `“yes”`, se rellenará la columna Deducciones de SASC.
`is_claims_activity`	string	Sí	`"No"`	Identifica la actividad facturable que no se pagará porque se procesó una notificación de tráfico no válido correcta en ella.
`is_cross_seat_activity`	string	Sí	`"No"`	Solo es relevante si tiene más de un miembro o asiento en la plataforma Xandr. Si lo hace, este campo le permite saber si la actividad se asoció con transacciones entre los miembros que administra y, por tanto, simplificar la conciliación de sus facturas.
`buyer_cleared`	Entero	Yes	`0`	Si el comprador paga directamente al vendedor o al conservador por el costo de los medios. Los valores aceptables son los siguientes: `0`: Xandr actúa como centro de compensación, recogiendo el costo de los medios del comprador y pagando al vendedor. `1`: Xandr no borra el efectivo; el comprador paga directamente al vendedor por el costo de los medios. `-1`: valor ficticio para la actividad sin facturar.
`curator_cleared`	Entero	Yes	`1`	Si el vendedor recibe o no los ingresos del revendedor de Xandr o del conservador. Los valores aceptables son los siguientes: `0`: el vendedor recibe los ingresos del revendedor de Xandr. `1`: el vendedor recibe los ingresos del revendedor del conservador. `-1`: valor ficticio para la actividad sin facturar.

Métricas

Column	Tipo	Ejemplo	Fórmula	Description
`seller_billable_imps`	Entero	`123456`	Duendes	Número total de impresiones facturables.
`imps_filtered`	Entero	`2365`	imps_filtered	El número total de impresiones filtradas por la revisión de calidad del inventario de Xandr (por ejemplo, las impresiones de un comprador bloqueado).
`clicks`	Entero		Clics	Número total de clics en todas las impresiones.
`convs`	Entero	`123456`	total_convs	Número total de conversiones en todas las impresiones.
`reseller_revenue`	Dinero	`123.45`	seller_revenue	Los ingresos generados a través de ventas a compradores externos (RTB), en USD.
`reseller_revenue_selling_currency`	Dinero	`123.45`	reseller_revenue_selling_currency	Los ingresos generados a través de ventas a compradores externos (RTB) en la moneda de transacción que el vendedor usó para vender la impresión.
`seller_media_cost`	Dinero	`123.45`	seller_media_cost	Importe que se debe al publicador, en USD.
`seller_media_cost_selling_currency`	Dinero	`123.45`	seller_media_cost_selling_currency	Importe que se debe al publicador, en la moneda de transacción que el vendedor usó para vender la impresión.
`gross_seller_revenue`	Dinero	`123.45`	gross_seller_revenue	Ingresos del vendedor antes de las deducciones de SASC.
`SASC_deduction`	Dinero	`122`	SASC_deduction	Cargo por servicio de subasta de vendedores, también conocido como Parte de ingresos del vendedor en algunos contratos, SASC es el cargo por vender inventario a compradores de terceros. Se cita como un porcentaje del costo multimedia del comprador, y se deduce antes del cálculo de los ingresos del vendedor. Deducido de la oferta en el momento de la subasta.
`SASC_fees`	Dinero	`111`	SASC_fees	Se cobra como un modelo de costo más en el que las tarifas no se deducen de la oferta y se facturan al cliente.
`bad_debt_fees`	Dinero	`124`	bad_debt_fees	Una cantidad acordada que cobramos para garantizar el pago al vendedor independientemente de si el comprador nos paga o no. Se cobra como un modelo de costo más en el que las tarifas no se deducen de la oferta y se facturan al cliente.
`bad_debt_deductions`	Dinero	`155`	bad_debt_deductions	Una cantidad acordada que cobramos para garantizar el pago al vendedor independientemente de si el comprador nos paga o no. Deducido de la oferta en el momento de la subasta.

Ejemplo

Create una solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type de "seller_pricing_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 (, , ) y especificar en el "format" que se deben devolver los datos (csv, excelo html). daymonthyear Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.

$ cat seller_pricing_report.json

{
    "report": {
        "format": "csv",
        "report_interval": "last_48_hours",
        "columns": [
            "seller_member_name",
            "buyer_member_name",
            "imps",
            "clicks",
            "convs"
        ],
        "report_type": "seller_pricing_report"
    }
}

`POST` la solicitud al servicio de informes que especifica un identificador de miembro reemplazando `INSERT_DESIRED_MEMBER_ID`

$ curl -b cookies -c cookies -X POST -d @seller_pricing_report_request.json 'https://api.appnexus.com/report?member_id=INSERT_DESIRED_MEMBER_ID'

{
  "response": {
    "status": "OK",
    "report_id": "9282cde2a86670d9861b77b8fc0954ad", <=== COPY THIS report_id as you will need it to check the status of your report and to download your report
    "existing": false,
    "cached": true
    }
  }
}

`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=9282cde2a86670d9861b77b8fc0954ad'

{
  "response": {
    "status": "OK",
    "report": {
      "name": null,
      "created_on": "2015-11-17 22:15:52",
      "cache_hit": true,
      "fact_cache_hit": true,
      "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\":\"seller_pricing_report\",\"filters\":[{\"seller_member_id\":\"2414\"},{\"is_delivered\":{\"value\":[\"1\"],\"operator\":\"=\"}},{\"is_valid_seller\":{\"value\":[\"1\"],\"operator\":\"=\"}}]}}",
      "header_info": "Report ID:,6adf8e4e075f93f7dfba164fe8cddab3\r\nRun at:,2015-11-17 22:15:30\r\nStart date:,2015-11-15 22:00:00\r\nEnd date:,2015-11-17 20:00:00\r\nTimezone:,\r\nUser:,Huanqing Liu (171989)\r\n",
      "row_count": "0",
      "report_size": "56",
      "internal_info": "{\"report_id\":\"9282cde2a86670d9861b77b8fc0954ad\",\"cache_hit_using\":\"6adf8e4e075f93f7dfba164fe8cddab3\",\"cache_cause\":1,\"controller_cache_hit\":true}",
      "user_id": "171989",
      "entity_id": "0",
      "started_on": "1970-01-01 00:00:01",
      "finished_on": "2015-11-17 22:15:52",
      "query_time": null,
      "url": "report-download?id=9282cde2a86670d9861b77b8fc0954ad"
    },
    "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.

Sugerencia

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=9282cde2a86670d9861b77b8fc0954ad' > seller_pricing_report.csv

Compartir a través de

API de plataforma digital: informe de facturación de ventas

Período de tiempo

Período de retención de datos

Dimensions

Métricas

Ejemplo

Create una solicitud de informe con formato JSON

`POST` la solicitud al servicio de informes que especifica un identificador de miembro reemplazando `INSERT_DESIRED_MEMBER_ID`

`GET` estado del informe del servicio de informes

`GET` los datos del informe del servicio de descarga de informes

Recursos adicionales

Compartir a través de

API de plataforma digital: informe de facturación de ventas

Período de tiempo

Período de retención de datos

Dimensions

Métricas

Ejemplo

Create una solicitud de informe con formato JSON

POST la solicitud al servicio de informes que especifica un identificador de miembro reemplazando INSERT_DESIRED_MEMBER_ID

GET estado del informe del servicio de informes

GET los datos del informe del servicio de descarga de informes

Recursos adicionales

`POST` la solicitud al servicio de informes que especifica un identificador de miembro reemplazando `INSERT_DESIRED_MEMBER_ID`

`GET` estado del informe del servicio de informes

`GET` los datos del informe del servicio de descarga de informes