API de plataforma digital: servicio de informes guardados

  • Artículo

El servicio de informes guardados se puede usar para crear informes nuevos que se guardan y se pueden recuperar en cualquier momento. Son útiles para los informes que se ejecutan con frecuencia. El servicio de informes guardado actúa como contenedor alrededor del servicio de informes.

Nota:

Hay un límite de 100 000 filas por informe.

Algunos hechos que hay que tener en cuenta sobre los informes guardados:

  • Los informes guardados expiran después de 6 meses. Debe crear un nuevo informe guardado después de 6 meses.
  • Los informes guardados no pueden tener un intervalo de fechas de duración o personalizado .
  • Los informes guardados se ejecutan en el orden en que se crearon originalmente. Por ejemplo, si crea dos informes diarios, el informe diario creado primero se ejecutará primero cada día.
  • Los informes diarios se ejecutan y envían cada día a diferentes horas a lo largo del día.
  • Los informes semanales se ejecutan y envían el lunes de cada semana durante los 7 días anteriores.
  • Los informes mensuales se ejecutan y envían el primer día de cada mes.

API de REST

Nota:

Los informes guardados por otros usuarios dentro de la red (miembro) no se devolverán en estas llamadas. Solo se devolverán los informes guardados por su cuenta de usuario.

Http (método) Endpoint Description
GET https://api.appnexus.com/saved-report?advertiser_id=ADVERTISER_ID Para ver todos los informes guardados de un anunciante.
GET https://api.appnexus.com/saved-report?publisher_id=PUBLISHER_ID Para ver todos los informes guardados de un publicador.
GET https://api.appnexus.com/saved-report?id=SAVED_REPORT_ID Para ver un informe guardado específico.
POST https://api.appnexus.com/saved-report?advertiser_id=ADVERTISER_ID Para agregar un nuevo informe guardado para un anunciante.
POST https://api.appnexus.com/saved-report?publisher_id=PUBLISHER_ID Para agregar un nuevo informe guardado para un publicador.
PUT https://api.appnexus.com/saved-report?advertiser_id=ADVERTISER_ID Para modificar un informe guardado existente para un anunciante.
PUT https://api.appnexus.com/saved-report?publisher_id=PUBLISHER_ID Para modificar un informe guardado existente para el publicador.
DELETE https://api.appnexus.com/saved-report?id=SAVED_REPORT_ID Para eliminar un informe guardado existente.

Campos JSON

Campo Tipo Descripción
category string Categoría del informe.
created_on string Fecha y hora en que se creó el informe guardado.
emails matriz Lista de correos electrónicos para enviar el informe. La matriz debe tener el formato ["email_address1@domain.com", "email_address2@domain.com", ...]
entity_id Entero Identificador de entidad del usuario que crea el informe. Esto establece el ámbito del informe.
expires_on string Fecha y hora en que expira un informe guardado. Esto está limitado actualmente a un año en el futuro. La fecha y hora se debe especificar en el formato "YYYY-MM-DD HH:MM:SS" donde se especifica la hora en formato de 24 horas.
Obligatorio activado:POST y PUT.
format enumeración Formato en el que se guardarán los resultados del informe. Valores posibles: "excel" o "csv".
id Entero Identificador interno asociado al informe guardado.
Obligatorio activado:PUT
last_modified string Fecha y hora en que se modificó por última vez el informe guardado.
name string Nombre del informe que se muestra en la interfaz de usuario. La longitud máxima es de 100 caracteres.
report objeto Informe definido en el mismo formato que se usa en Reporting Service.
scheduling enumeración Frecuencia con la que se ejecuta el informe. Valores posibles: "daily", "weekly"o "monthly".

Ejemplos

Adición de un nuevo informe guardado para un publicador

  1. Construya un JSON de informe (como se describe en Report Service: paso 1).
  2. POST json en el servicio de informes guardados.
  3. Almacene el identificador que se devuelve.
$ cat saved-report

{
   "saved-report":{
      "name":"Publisher Report Last 48 Hours",
      "report":{
         "report_type":"publisher_analytics",
         "columns":[
            "publisher_revenue",
            "imps_total",
            "imps_sold",
            "imps_default",
            "clicks",
            "ctr",
            "month",
            "day",
            "hour",
            "geo_country",
            "size",
            "placement",
            "total_convs",
            "convs_rate",
            "publisher_rpm"
         ],
         "row_per":[
            "month",
            "day",
            "hour",
            "geo_country",
            "size",
            "placement_id"
         ],
         "timezone":"EST",
         "report_interval":"last_48_hours"
      },
      "scheduling":"daily",
      "format":"excel",
      "emails":[
         "reporting@publisher.com",
         "noreply@publisher.com"
      ],
      "expires_on":"2010-10-31 0:00:00"
   }
}

$ curl -b cookies -c cookies -X post --data-binary @saved-report 'https://api.appnexus.com/saved-report?publisher_id=35'

{
   "response":{
      "status":"OK",
      "id":39
   }
}

Ejecución y recuperación de un informe guardado

Nota:

Debe realizar este paso cada vez que desee recuperar un informe actualizado.

  1. POST en el servicio de informes con el identificador de arriba y almacene el devuelto report_id.
  2. Compruebe el estado del informe con en GET el servicio de informes con report_id (como se describe en Servicio de informes: paso 3).
  3. GET el informe del report-download servicio (como se describe en Servicio de informes: paso 4).
$ curl -b cookies -c cookies -X post "https://api.appnexus.com/report?saved_report_id=39&publisher_id=35"

{
   "response":{
      "status":"OK",
      "report_id":"fa16873114e1d5697091069e45bccec0"
   }
}

$ curl -b cookies -c cookies "https://api.appnexus.com/report?id=fa16873114e1d5697091069e45bccec0"

{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2010-06-10 15:53:07",
         "json_request":"{\"report\":{\"report_type\":\"publisher_analytics\",\"columns\":[\"publisher_revenue\",\"imps_total\",
             \"imps_sold\",\"imps_default\",\"clicks\",\"ctr\",\"month\",\"day\",\"hour\",\"geo_country\",\"size\",\"placement\",
             \"total_convs\",\"convs_rate\",\"publisher_rpm\"],\"row_per\":[\"month\",\"day\",\"hour\",\"geo_country\",\"size\",
             \"placement_id\"],\"timezone\":\"EST\",\"report_interval\":\"last_48_hours\",\"filters\":[{\"publisher_id\":\"4642\"},
             {\"publisher_id\":\"4642\"}]}}",
         "data":"publisher_revenue,imps_total,imps_sold,imps_default,clicks,ctr,month,day,hour,geo_country,size,placement,total_convs,convs_rate,publisher_rpm\r\n"
      },
      "execution_status":"ready"
   }
}

 
$ curl -i -b cookies -c cookies 'https://api.appnexus.com/report-download?id=fa16873114e1d5697091069e45bccec0' > /tmp/publisher_analytics.csv