API de plataforma digital: informe de disponibilidad de inventario
Los informes de disponibilidad de inventario ofrecen información sobre los tipos de inventario disponibles en la plataforma. Estos informes solo están disponibles por solicitud; use el portal de soporte técnico. Debido a la estructura de nuestras bases de datos de disponibilidad de impresiones, las dimensiones de los informes se limitan a las que se describen a continuación. Tenga en cuenta también lo siguiente:
- Nuestras bases de datos contienen datos de disponibilidad de inventario históricos de 30 días. Por lo tanto, los informes se limitan a este período de tiempo.
- Se pueden aplicar restricciones adicionales de informes a las impresiones móviles. Póngase en contacto con su representante de Xandr para obtener más información.
Período de tiempo
Puede ejecutar este informe para un período de tiempo personalizado, establecer los campos y end_date en la start_date solicitud del informe. Para obtener más información sobre estos campos, vea Report Service.
Período de retención de datos
Los datos de este informe se conservan durante 30 días.
Dimensions
| Column | Tipo | ¿Filtro? | Ejemplo | Descripción |
|---|---|---|---|---|
day |
date | Yes | "2023-04-18" |
El día de la impresión. |
month |
date | Yes | "2023-04" |
El mes de la impresión. |
seller_member_id |
Entero | Yes | 9876 |
Identificador interno del miembro vendedor. |
seller_member_name |
string | No | "CNN" |
Nombre para mostrar del miembro del vendedor. |
size |
string | Sí | "120"x"600" |
Tamaño estándar de un creativo. Para obtener más información sobre los tamaños, consulte standard_sizes Devolución del servicio para miembros. |
geo_country |
string | Sí | "US" |
Código del país geográfico asociado a la impresión. |
imp_type_id |
Entero | Yes | 5 |
Identificador del tipo de impresión. Valores posibles (tipos asociados entre paréntesis): - 1 ("En blanco"): sin creatividad.- 2 ("PSA"): un anuncio de servicio público se sirvió porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible.- 3 ("Error predeterminado"): una creatividad predeterminada que se sirve debido a un problema de tiempo de espera.- 4 ("Valor predeterminado"): una creatividad predeterminada que se sirve porque no había pujas válidas.- 5 ("Guardado"): la creatividad de su anunciante se ha servido en el sitio del editor.- 6 ("Reventa"): la impresión del editor se vendió a un comprador de terceros.- 7 ("RTB"): la creatividad de su anunciante se ha servido en el inventario de terceros.- 8 ("Error de PSA"): un anuncio de servicio público servido debido a un problema de tiempo de espera o a la falta de una creatividad predeterminada.- 9 ("Impresión externa"): una impresión de un rastreador de impresiones.- 10 ("Clic externo"): un clic de un rastreador de clics. |
media_type_id |
Entero | Yes | 5 |
Identificador asociado a un tipo de medio determinado. Por ejemplo, vídeo. Para obtener más información, consulte Media Type Service. |
audit_type_id |
Entero | Yes | 2 |
Código entero para la prioridad de la auditoría. Valores permitidos: - 1:Estándar- 2:Prioridad |
browser_id |
Entero | Yes | 3 |
Identificador asociado a un explorador determinado. Por ejemplo, Microsoft Edge. Para obtener más información, consulte Servicio de explorador. |
mobile_application |
string | No | "Angry Birds (com.rovio.angrybirds)" |
Nombre de la aplicación móvil seguido del identificador en formato Xandr. |
language_id |
Entero | Yes | 1 |
Identificador asociado a un explorador determinado. Por ejemplo, inglés. Para obtener más información, consulte Language Service. |
operating_system_family_id |
Entero | Yes | 5 |
Identificador asociado a una determinada familia de sistemas operativos. Por ejemplo, Microsoft Windows. Para obtener más información, consulte Servicio de familia de sistemas operativos. |
datacenter_id |
Entero | Yes | 001 |
Identificador del centro de datos usado para enrutar la solicitud a asociados de demanda. |
seller_join_date |
Entero | Yes | 20220901 |
Fecha en la que se agregó un miembro del vendedor. Si es menor que un año, se mostrará la fecha exacta; si se supera un año, la fecha de unión se mostrará como +1 año. |
mobile_application_id |
string | Sí | "343200656" (iOS) o "com.rovio.angrybirds" (Android) |
Un identificador de apple App Store de destino, un nombre de paquete de Google Play o un identificador de aplicación de Windows. |
device_type |
Entero | Yes | 1 |
Identificador de tipo de dispositivo en el que se ha proporcionado la impresión. Los posibles valores son: - 0 (otros dispositivos)- 1 (equipos de escritorio & portátiles)- 2 (teléfonos móviles)- 3 (tabletas)- 4 (tv)- 5 (consolas de juegos)- 6 (reproductores multimedia)- 7 (cuadro de configuración superior) |
Métricas
| Column | Tipo | Ejemplo | Fórmula | Description |
|---|---|---|---|---|
imps |
Entero | 1000 |
Duendes | Número de impresiones disponibles. |
Ejemplos
Create la solicitud de informe con formato JSON
El archivo JSON debe incluir el report_type de "platform_inventory_avail", así como ( columns dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir granularidad (year, month, day) y especificar el formato en el que se deben devolver los datos (csv, excelo html). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, consulte Report Service.
$ cat platform_inventory_avail
{
"report": {
"columns": [
"day",
"seller_member_name",
"audit_type",
"size",
"device_type",
"operating_system_family",
"geo_country",
"imps"
],
"format": "csv",
"report_interval": "today",
"report_type": "platform_inventory_avail"
}
}
POST la solicitud al servicio de informes
$ curl -b cookies -X POST -d @platform_inventory_avail 'https://api.appnexus.com/report'
{
"response":{
"status":"OK",
"report_id":"6b177543a9411ffa67b09bdf5e76cac1"
}
}
GET estado del informe del servicio de informes
$ curl -b cookies 'https://api.appnexus.com/report?id=6b177543a9411ffa67b09bdf5e76cac1'
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2020-08-25 13:03:37",
"json_request":"{\"report\":{\"report_type\":\"platform_inventory_avail\",\"columns\":[\"day\",\"seller_member_name\",\"audit_type\",\"imps\",\"size\",\"device_type\,\"operating_system_family\,\"geo_country\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"device_type\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
"url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
},
"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.
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 'https://api.appnexus.com/report-download?id=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/platform_inventory_avail.csv
Nota:
Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.