API de plataforma digital: informe de uso de datos

Este informe proporciona detalles relacionados con el uso que hace de los datos proporcionados por terceros (por ejemplo, proveedores de segmentos de usuarios), los costes de uso de esos datos y las líneas de pedido/campañas en las que se usaron esos datos para dirigirse a los usuarios.

Los datos de este informe se conservan durante 60 días. El time_granularity de los datos es hourly. Para obtener instrucciones sobre cómo recuperar un informe, consulte el Servicio de informes 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
  • de duración

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.

Dimensions

Column Tipo ¿Filtro? Ejemplo Descripció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 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" El código del país o región geográficos asociado a la impresión.
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.
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.
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.
buyer_member_id Entero sí 643 El identificador del miembro que usó los datos de terceros.
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.
data_provider_id Entero sí 517 El identificador del tercero que proporcionó los datos de segmentación.
month date sí "2010-02" El mes en que se produjo la subasta asociada a la impresión
data_provider_name string no "Peer 39 (Data Provider)" El nombre y la identificación del tercero que proporcionó los datos de segmentación.
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.
geo_country_name string no "United States" El nombre del país o región geográficos asociado a la impresió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.
split_name string Sí "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.

Métricas

Column Tipo Ejemplo Fórmula Descripción
imps Entero 34534 Diablillos El número total de impresiones que usaron datos de terceros para publicar el anuncio.
data_costs dinero 3.50 El valor monetario de los segmentos de datos que se compraron a proveedores de datos de terceros.
transaction_tax dinero .43 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.
data_type string Segment Las opciones disponibles son Segmento y Entre dispositivos
Métricas disponibles en la moneda local
data_costs_buying_currency dinero 3.50 El valor monetario de los segmentos de datos que se compraron a proveedores de datos de terceros. Representado en la moneda del anunciante

Ejemplo

Crear una solicitud de informe JSON

El archivo JSON debe incluir el report_type of , "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 la granularidad (month, day, hour) y especificar la forma en que "format" 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_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 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.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 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 en el que desea guardarlo, asegúrese de usar la extensión de archivo del formato de archivo que especificó en POSTel 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.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.

  • Last updated on