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 están disponibles solo a pedido; usa el Portal de soporte técnico de Microsoft Advertising. 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. También tenga en cuenta:

  • Nuestras bases de datos contienen 30 días de datos históricos de disponibilidad de inventario. Por lo tanto, los informes se limitan a este período de tiempo.
  • Es posible que se apliquen restricciones de informes adicionales a las impresiones móviles. Ponte en contacto con tu 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 de informe. Para obtener más información sobre estos campos, vea Servicio de informes.

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 "2023-04-18" El día de la impresión.
month date "2023-04" El mes de la impresión.
seller_member_id Entero 9876 Id. interno del miembro vendedor.
seller_member_name string No "CNN" Nombre para mostrar del miembro vendedor.
size string "120"x"600" El tamaño estándar de una creatividad. Para obtener más información sobre los tamaños, consulte standard_sizes devuelto de Servicio para miembros.
geo_country string "US" El código del país o región geográficos asociado a la impresión.
imp_type_id Entero 5 El identificador del tipo de impresión. Valores posibles (tipos asociados entre paréntesis):
- 1 ("Blank"): No se sirve ninguna creatividad.
- 2 ("PSA"): se publicó un anuncio de servicio público porque no había ofertas válidas y no había ninguna creatividad predeterminada disponible.
- 3 ("Error predeterminado"): una creatividad predeterminada servida debido a un problema de tiempo de espera.
- 4 ("Predeterminado"): se publicó una creatividad predeterminada porque no había pujas válidas.
- 5 ("Conservado"): el recurso creativo de su anunciante se sirve en el sitio de su editor.
- 6 ("Revendida"): la impresión de su editor se vendió a un comprador externo.
- 7 ("RTB"): el recurso creativo del anunciante publicado 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 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 5 El identificador asociado a un tipo de contenido multimedia determinado. Por ejemplo, vídeo. Para obtener más información, consulte Servicio de tipo multimedia.
audit_type_id Entero 2 El código entero para la prioridad de la auditoría. Valores permitidos:
- 1: Standard
- 2: Prioridad
browser_id Entero 3 Id. 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)" El nombre de la aplicación móvil seguido del ID en formato de Xandr.
language_id Entero 1 Id. asociado a un explorador determinado. Por ejemplo, inglés. Para obtener más información, consulte Servicio lingüístico.
operating_system_family_id Entero 5 Identificador asociado a una determinada familia de sistemas operativos. Por ejemplo, Microsoft Windows. Para obtener más información, consulte Servicio de familia del sistema operativo.
datacenter_id Entero 001 El Id. del centro de datos utilizado para enrutar la solicitud a los asociados de demanda.
seller_join_date Entero 20220901 La fecha en que se agregó un miembro vendedor. Si es menos de un año, se mostrará la fecha exacta; Si es superior a un año, la fecha de unión se mostrará como +1 año.
mobile_application_id string "343200656" (iOS) o "com.rovio.angrybirds" (Android) Un id. de Apple App Store segmentable, un nombre de paquete de Google Play o un id. de aplicación de Windows.
device_type Entero 1 Identificador de tipo de dispositivo en el que se ha publicado 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 (decodificador)

Métricas

Column Tipo Ejemplo Fórmula Descripción
imps Entero 1000 Diablillos El número de impresiones disponibles.

Ejemplos

Crear la solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type de "platform_inventory_avail", así como el columns (dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir la granularidad (year, month, day) 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 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 el estado del informe desde el servicio Informe

$ 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 ID del informe, pero esta vez al servicio de descarga de informes . Puede encontrar el servicio y el ID de informe en el url campo de la respuesta anterior GET . Al identificar el archivo en el que desea guardarlo, asegúrese de usar la extensión de archivo que especificó en POSTel "format" 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 '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.