API de plataforma digital: informe de uso de datos
En este informe se proporcionan detalles relacionados con el uso de los datos proporcionados por terceros (por ejemplo, proveedores de segmentos de usuarios), los costos de ese uso de datos y los elementos de línea o campañas en los que se usaron esos datos para dirigirse a los usuarios.
Los datos de este informe se conservan durante 60 días. El time_granularity valor de los datos es hourly. Para obtener instrucciones sobre cómo recuperar un informe, consulte report service o el ejemplo siguiente.
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
- Vida
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 |
|---|---|---|---|---|
geo_country_code |
string | sí | "CA" |
Cadena de dos caracteres que indica el país asociado a la impresión. |
campaign |
string | no | "Prospect Campaign (31)" |
En desuso (a partir del 17 de octubre de 2016). |
data_provider |
string | no | "Peer 39 (Data Provider) (517)" |
En desuso (a partir del 17 de octubre de 2016). |
geo_country |
string | sí | "US" |
Código del país geográfico asociado a la impresión. |
targeted_segment_ids |
string | no | "935035, 935146" |
Lista separada por comas de identificadores para cada uno de los segmentos utilizados al seleccionar como destino. |
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" |
Hora en la que se produjo la subasta asociada a la impresión. |
campaign_id |
Entero | sí | 31 |
Identificador de la campaña asociada a la impresión que usó la segmentación de datos de terceros. |
buyer_member_id |
Entero | sí | 643 |
Identificador del miembro que usó los datos de terceros. |
split_id |
Entero | Yes | 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. |
data_provider_id |
Entero | sí | 517 |
Identificador del tercero que proporcionó los datos de destino. |
month |
date | sí | "2010-02" |
Mes en el que se produjo la subasta asociada a la impresión |
data_provider_name |
string | no | "Peer 39 (Data Provider)" |
Nombre e identificador del tercero que proporcionó los datos de destino. |
campaign_name |
string | no | "Prospect Campaign" |
Nombre de la campaña asociada a la impresión que usó la segmentación de datos de terceros. |
geo_country_name |
string | no | "United States" |
Nombre del país geográfico asociado a la impresión. |
line_item_name |
string | no | "Fall Apparel" |
Nombre del elemento de línea asociado a la impresión que usó la segmentación de datos de terceros. |
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 | Description |
|---|---|---|---|---|
imps |
Entero | 34534 |
Duendes | Número total de impresiones que usaron datos de terceros para publicar el anuncio. |
data_costs |
Dinero | 3.50 |
Valor monetario de los segmentos de datos que se compraron a proveedores de datos de terceros. | |
sales_tax |
Dinero | .43 |
Importe del impuesto de ventas cobrado. Este campo solo se rellena cuando la dirección de facturación del comprador se encuentra en uno de los siguientes estados de EE. UU.: NY, TX o NJ. Xandr es requerido (por el regulador estatal local correspondiente) para cobrar este impuesto. | |
data_type |
string | Segment |
Las opciones disponibles son Segment (Segmento) y Cross Device (Entre dispositivos). | |
| Métricas disponibles en moneda local | ||||
data_costs_buying_currency |
Dinero | 3.50 |
Valor monetario de los segmentos de datos que se compraron a proveedores de datos de terceros. Representado en la moneda del anunciante |
Ejemplo
Create una solicitud de informe JSON
El archivo JSON debe incluir el report_type de "buyer_data_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 granularidad (, , ) y especificar en el "format" que se deben devolver los datos ("csv", "excel"o "html"). hourdaymonth Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.
$ cat buyer_data_usage_analytics
{"report":
{
"format": "csv",
"report_interval": "yesterday",
"row_per": ["geo_country"],
"columns": ["imps","campaign_id","geo_country"],
"report_type": "buyer_data_usage_analytics"
}
}
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 @seller_brand_review "https://api.appnexus.com/report"
{
"response":{
"status":"OK",
"report_id":"c445bca183a3d338dc1c5b85a3d484f5"
}
}
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=c445bca183a3d338dc1c5b85a3d484f5'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2014-11-19 22:33:31",
"json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"yesterday\",\"row_per\":[\"geo_country\"],\"columns\":[\"imps\",\"campaign_id\",\"geo_country\"],\"report_type\":\"buyer_data_usage_analytics\",\"filters\":[{\"buyer_member_id\":\"958\"}]}}",
"url": "report-download?id=c445bca183a3d338dc1c5b85a3d484f5"
},
"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 identificador de servicio e informe en el url campo de la respuesta a la llamada anterior GET . Al identificar el archivo en el que desea guardar, asegúrese de usar la extensión de archivo del formato de archivo que especificó en la 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=c445bca183a3d338dc1c5b85a3d484f5' > /tmp/buyer_data_usage_analytics.csv
Nota:
Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.