API de plataforma digital: informe de uso de proveedores

Este informe de red proporciona los detalles sobre el uso de datos o plataforma con tecnología de proveedores externos (por ejemplo, proveedores de segmentos de usuario), los costos de ese uso de datos o funciones, y las partidas/campañas en las que se aplicaron los costos de los proveedores.

Período de tiempo

El report_interval campo de la solicitud JSON debe establecerse en uno de los siguientes:

  • hoy
  • yesterday
  • last_7_days
  • last_30_days
  • month_to_date
  • quarter_to_date
  • last_month
  • de duración

El time_granularity de los datos es hourly. Para obtener instrucciones sobre cómo recuperar un informe, consulte el Servicio de informes o los ejemplos siguientes.

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.

Período de retención de datos

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

Dimensions

Column Tipo ¿Filtro? Ejemplo Descripción
month date sí "2010-02" El mes en el que se produjo la subasta asociada a la impresión.
day date sí "2010-02-01" El día en que se produjo la subasta asociada a la impresión.
hour date sí "2010-02-01 05:00:00" La hora en la que se produjo la subasta asociada a la impresión.
buyer_member_id Entero sí 643 Id. del miembro que utilizó los datos proporcionados por el proveedor externo (por ejemplo, proveedores de segmentos de usuarios).
geo_country string sí "US" El código del país o región geográficos asociado a la impresión.
geo_country_name string no "United States" El nombre del país o región geográficos asociado a la impresión.
geo_country_code string sí "CA" Cadena de dos caracteres que indica el país o región asociado a la impresión.
campaign_id Entero sí 31 El identificador de la campaña asociada a la impresión que utilizó la segmentación de datos de terceros.
campaign_name string no "Prospect Campaign" El nombre de la campaña asociada a la impresión que utilizó la segmentación por datos de terceros.
campaign string no "Prospect Campaign (31)" El nombre y el identificador de la campaña asociados a la impresión.
campaign_group_type_id Entero sí 154 El identificador del tipo de grupo de campaña que compró esta impresión. Se usa en informes divididos.
split_id Entero sí 342 El identificador de la división que compró las impresiones de este conjunto de datos. Las divisiones solo se aplican a las líneas de pedido aumentadas. Para cualquier informe que contenga campañas, el split_id (si se incluye) será null.
split_name string no "Mobile Split A" El nombre de la división que compró las impresiones de este conjunto de datos. Las divisiones solo se aplican a las líneas de pedido aumentadas. Para cualquier informe que contenga campañas, el split_name (si se incluye) será null.
split string no "Mobile Split A (342)" El nombre y el id. de la división.
line_item_name string no "Fall Apparel" El nombre de la línea de pedido asociada a la impresión que utilizó la segmentación de datos de terceros.
targeted_segment_ids string no "935035, 935146" La lista de identificadores separados por comas para cada uno de los segmentos que se usan al segmentar.
advertiser_currency string sí "USD" La moneda preferida del anunciante. Esta preferencia se puede establecer mediante el Servicio de anunciantes.
insertion_order_id Entero sí 1243 El identificador de la orden de inserción asociada a la impresión que usaba la segmentación por datos de terceros.
insertion_order_name string no "IO001" El nombre de la orden de inserción asociada a la impresión que usaba la segmentación de datos de terceros.
insertion_order_code string no "IOABC-1243" El código definido por el usuario asociado con el orden de inserción.
insertion_order string no "IO001 (1243)" El nombre y el identificador de la orden de inserción asociada a la impresión que usó la segmentación de datos de terceros.
advertiser_id Entero sí 9843 El id. del anunciante asociado a la impresión. Si el valor es 0, o bien la impresión la compró un comprador externo, o bien se mostró un valor predeterminado o PSA.
advertiser_name string no "ADVUS" El nombre del anunciante asociado a la impresión.
advertiser string no "ADVUS (9843)" El nombre y el id. del anunciante asociados a la impresión.
line_item_id Entero sí 9865 El identificador de la línea de pedido asociada a la impresión que utilizó la segmentación de datos de terceros.
line_item_code string no "LI001" El código definido por el usuario asociado a la línea de pedido.
line_item string no "Fall Apparel (9865)" El nombre y el identificador de la línea de pedido asociada a la impresión que utilizó la segmentación de datos de terceros.
vendor_id Entero sí 76 El identificador del proveedor externo (por ejemplo, proveedores de segmentos de usuario) cuyo uso y costo de datos se incluyen en este informe.
vendor_name string no "AXM" El nombre del proveedor externo.
vendor string no "AXM (76)" El nombre y la identificación del proveedor externo.
vendor_type string no "Segment Marketplace" El tipo de proveedor en función de los datos de terceros que proporcione.
Los valores permitidos son:
- Segment Marketplace
- Cross Device Graph
- Measurement
- Offline Attribution
- Unknown Vendor Type
cost_type string no "Segment Data Costs" El tipo de costo incurrido para el uso de datos proporcionado por los proveedores externos. Los valores permitidos son:
- Segment Data Costs
- Feature Costs
- Unknown Vendor Type
buying_currency string sí "USD" La moneda de la transacción que el comprador usó para comprar esta impresión.
cpm_usd dinero sí 7.8 Costo por mil, o mil (mille = mil en latín) expresado en USD. Un modelo de precios en el que los anunciantes pagan por cada 1000 impresiones de su anuncio servido.

Métricas

Column Tipo Filtro Ejemplo Fórmula Descripción
imps Entero sí 34534 Diablillos El número total de impresiones que usaron datos de terceros para publicar el anuncio.
third_party_costs dinero sí 5.20 third_party_costs Valor monetario total de los costos de segmentos de datos, costos de características u otros.
transaction_tax dinero no .43 transaction_tax Los impuestos aplicables sobre las ventas, el valor añadido, los bienes y servicios o impuestos similares (impuestos sobre transacciones) se aplicarán a sus transacciones con Microsoft en función de la ubicación comercial de la cuenta del cliente proporcionada en la experiencia de incorporación.
vendor_costs dinero no 5.00 vendor_costs Los costes totales, incluidos, entre otros, los costes de datos de segmento y los costes de características.
Costes de características: Costes incurridos al utilizar una función de plataforma como Nielsen Digital Ad Ratings (DAR), Nielsen Catalina Solutions (NCS) y Cross Device.
Segmentar costes de datos: Todos los costos relacionados con el uso de segmentos en el mercado de datos. Aplicable cuando se aplican segmentos específicos en las líneas de pedido y los precios asociados se muestran en la plataforma.
vendor_costs_buying_currency dinero no 1.50 vendor_costs_buying_currency Los costos de proveedor expresados en la moneda de transacción utilizada por el comprador.

Ejemplos

Crear solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type de "buyer_vendor_usage_analytics", así como las columnas (dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir la granularidad (month, day, hour) 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_vendor_usage_analytics  
{
    "report": {
        "report_type": "buyer_vendor_usage_analytics",
        "format": "csv",
        "report_interval": "last_7_days",
        "columns": [
            "imps",
            "line_item_id",
            "vendor_costs",
            "sales_tax",
            "vendor_type",
            "vendor"
        ],
        "orders": [
            "line_item_id",
            "vendor_costs",
            "vendor_type"
        ]
    }
}

POST la solicitud al servicio de informes

POST la solicitud JSON para recuperar un identificador de informe.

$ curl -b cookies -c cookies -X post -d @buyer_vendor_usage_analytics "https://api.appnexus.com/report"
{
    "response": {
        "report_id": "d89151942729f768dcac4586288ff7eb",
        "status": "OK",
        "dbg_info": {
            "user::read_limit": 100,
            "user::write_limit": 60,
            "read_limit": 100,
            "write_limit": 60,
            "user::read_limit_seconds": 60,
            "user::write_limit_seconds": 60,
            "read_limit_seconds": 60,
            "write_limit_seconds": 60,
            "instance": "50.bm-report-processor.prod.nym2",
            "version": "1.73.238",
            "time": 712.83793449402,
            "start_microtime": 1686106227,
            "warnings": [],
            "api_cache_hit": "0",
            "output_term": null,
            "edge_forwarded_dbg_info": {
                "user::read_limit": 100,
                "user::write_limit": 60,
                "read_limit": 100,
                "write_limit": 60,
                "user::read_limit_seconds": 60,
                "user::write_limit_seconds": 60,
                "read_limit_seconds": 60,
                "write_limit_seconds": 60,
                "instance": "37.report-processor.prod.nym2",
                "version": "1.73.238",
                "time": 708.98699760437,
                "start_microtime": 1686106227,
                "warnings": [],
                "api_cache_hit": "0",
                "output_term": "report_id"
            },
            "edge_forwarded": true,
            "edge_forwarded_by": "50.bm-report-processor.prod.nym2",
            "edge_forwarded_to": "http://report-processor-edge.adnxs.net/report"
        }
    }
}

GET el estado del informe desde el servicio Informe

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.appnexus.com/report?id=d89151942729f768dcac4586288ff7eb'
{
    "response": {
        "status": "OK",
        "report": {
            "id": "d89151942729f768dcac4586288ff7eb",
            "name": "",
            "created_on": "2023-06-07 02:50:27",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": "",
            "json_request": "{\"report\":{\"report_type\":\"buyer_vendor_usage_analytics\",\"format\":\"csv\",\"report_interval\":\"last_7_days\",\"columns\":[\"imps\",\"line_item_id\",\"vendor_costs\",\"sales_tax\",\"vendor_type\",\"vendor\"],\"orders\":[{\"order_by\":\"line_item_id\",\"direction\":\"ASC\"},{\"order_by\":\"vendor_costs\",\"direction\":\"ASC\"},{\"order_by\":\"vendor_type\",\"direction\":\"ASC\"}],\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"buyer_member_id\":\"958\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1686096000,\"start_date\":1685491200,\"user_id\":\"4814\"}",
            "header_info": "Report type: buyer_vendor_usage_analyticss\nReport ID: d89151942729f768dcac4586288ff7eb\nRun at: 2023-06-07 04:08:58 UTC\nRequested Start date: 2023-05-31 00:00:00 UTC\nRequested End date: 2023-06-07 00:00:00 UTC\nTimezone: UTC\n",
            "user_id": "4814",
            "member_id": "958",
            "bidder_id": "2",
            "entity_id": "958",
            "row_count": 0,
            "report_size": 61,
            "url": "report-download?id=d89151942729f768dcac4586288ff7eb"
        },
        "execution_status": "ready",
        "_was_this_status_cached_": 0,
        "dbg_info": {
            "user::read_limit": 100,
            "user::write_limit": 60,
            "read_limit": 100,
            "write_limit": 60,
            "user::read_limit_seconds": 60,
            "user::write_limit_seconds": 60,
            "read_limit_seconds": 60,
            "write_limit_seconds": 60,
            "instance": "50.bm-report-processor.prod.nym2",
            "version": "1.73.238",
            "time": 454.48088645935,
            "start_microtime": 1686110938,
            "warnings": [],
            "api_cache_hit": "0",
            "output_term": null,
            "edge_forwarded_dbg_info": {
                "user::read_limit": 100,
                "user::write_limit": 60,
                "read_limit": 100,
                "write_limit": 60,
                "user::read_limit_seconds": 60,
                "user::write_limit_seconds": 60,
                "read_limit_seconds": 60,
                "write_limit_seconds": 60,
                "instance": "37.report-processor.prod.nym2",
                "version": "1.73.238",
                "time": 448.82392883301,
                "start_microtime": 1686110938,
                "warnings": [],
                "api_cache_hit": "0",
                "output_term": "report"
            },
            "edge_forwarded": true,
            "edge_forwarded_by": "50.bm-report-processor.prod.nym2",
            "edge_forwarded_to": "http://report-processor-edge.adnxs.net/report"
        }
    }
}

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 del informe, pero esta vez al servicio de descarga de informes . Puede encontrar el servicio y el ID del informe en el url campo de la respuesta a su llamada anterior GET . Al identificar el archivo que desea guardar, asegúrese de usar la extensión de archivo "format" que especificó en la llamada inicial POST , por ejemplo, CSV.

curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=d89151942729f768dcac4586288ff7eb' > /tmp/buyer_vendor_usage_analytics.csv

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.

Nota:

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

  • Last updated on