API de Ads Activity Report Alpha

El informe Actividad de los anuncios es un vista centralizada del rendimiento de tus anuncios. Combina los datos, las métricas y de la API de informes de red y la API de informes de mediación, así como datos de ofertas en un solo informe unificado.

La API de Ads Activity Report brinda mejoras adicionales a partir de la herramienta de API de informes y API de informes de red como se muestra en la siguiente tabla:

API de informes de red API de informes de mediación API de Ads Activity Report
Rendimiento de la red ✅ ✅ ✅
Rendimiento en cascada ✅ ✅
Rendimiento de las ofertas ✅
Rendimiento de los experimentos A/B de mediación ✅
Informes por hora ✅
Tamaño del informe 100,000 100,000 500,000

Métricas, dimensiones y filtros de dimensiones

Las siguientes métricas se agregaron a la API de Ads Activity Report en además de muchas de las métricas disponibles en la API de informes de red y la API de informes de mediación.

Métrica Descripción
BID_REQUEST Indica la cantidad de solicitudes realizadas a la fuente de anuncios de licitación.
BIDS_IN_AUCTION Indica la cantidad de ofertas enviadas por la fuente del anuncio que participaron en subastas de licitación.
WINNING_BIDS Indica la cantidad de ofertas que ganaron una subasta de ofertas.

Las siguientes dimensiones nuevas se incluyen en la API de Ads Activity Report.

Dimensión Descripción
SEMANA Es la fecha del primer día de la semana (de acuerdo con el idioma código mencionado en la configuración de localización) en el formato AAAAMMDD (para por ejemplo, “20210701”). Las solicitudes solo pueden especificar una de las siguientes opciones: DATE, WEEK o MONTH en la dimensión de tiempo.
HORA Es la hora en formato HH en la hora PST. Por ejemplo, "05" para las 5 a.m. PST, "13" desde la 1:00 p.m. PST. La dimensión DATE también se debe especificar en la solicitud. R se muestra un máximo de 28 días de datos cuando se especifica la dimensión HORA. Fechas de inicio del período que sean superiores a 28 días antes de la fecha actual se muestra un error.
MEDIATION_AB_TEST (nombre del experimento) Ver el rendimiento por prueba A/B de mediación. Es obligatorio especificarlo. si se especifica la dimensión VARIANT.
MEDIATION_AB_TEST_VARIANT (variante A, variante B) Consulta el rendimiento por variante de prueba A/B de mediación.
Nombre de la dimensión en la API de informes de mediación Nombre de la dimensión en la API de Ads Activity Report Descripción
AD_UNIT1 AD_UNIT_ID Es el ID único de la unidad de anuncios (por ejemplo, "123456789").
AD_UNIT_NAME Es el nombre de la unidad de anuncios.
APLICACIÓN1 APP_ID Indica el ID único de la aplicación para dispositivos móviles (por ejemplo, "1234567890").
APP_NAME Corresponde al nombre de la app.
AD_SOURCE1 AD_SOURCE_ID Indica el ID único de la fuente del anuncio (por ejemplo, "1234567890123456789").
AD_SOURCE_NAME Es el nombre de la fuente del anuncio (por ejemplo, "Red de AdMob").
AD_SOURCE_INSTANCE1 AD_SOURCE_INSTANCE_ID Indica el ID único de la instancia de la fuente del anuncio (por ejemplo, "123456789012").
AD_SOURCE_INSTANCE_NAME Es el nombre de la instancia de la fuente del anuncio (por ejemplo, "AdMob (predeterminado)").
GRUPO_DE_MEDIACIÓN1 MEDIATION_GROUP_ID Es el ID único del grupo de mediación (por ejemplo, "1234567890").
MEDIATION_GROUP_NAME Es el ID único del grupo de mediación (por ejemplo, "AdMob (predeterminado)").

1: Consulta Scalars para obtener más información.

Las siguientes dimensiones tienen un formato actualizado.

Nombre de la dimensión en la API de informes de mediación Descripción en la API de informes de mediación Descripción en la API de Ads Activity Report
ESTIMATED_EARNINGS Indica los ingresos estimados del publicador de AdMob. La unidad de moneda (USD, EUR o cualquier otra) de las métricas de ingresos se determinan según la localización. de moneda. La cantidad es en micros. Por ejemplo, USD 6.50 serían representado como 6,500,000.

Los ingresos estimados por grupo de mediación y por nivel de instancia de fuente del anuncio son se admiten desde el 20 de octubre de 2019. Los ingresos estimados de terceros muestre 0 para las fechas anteriores al 20 de octubre de 2019.

Indica los ingresos estimados del publicador de AdMob. La unidad de moneda (USD, EUR o cualquier otra) de las métricas de ingresos se determinan según la localización. de moneda.
OBSERVED_ECPM eCPM promedio estimado de la red de publicidad de terceros. La unidad de moneda (USD, EUR o cualquier otra) de las métricas de ganancias se determinan según la métrica de moneda. La cantidad es en micros. Por ejemplo, USD 2.30 serían representado como 2300000.

El eCPM promedio estimado por grupo de mediación y por nivel de instancia de fuente de anuncios desde el 20 de octubre de 2019. Promedio estimado por terceros El eCPM mostrará 0 para las fechas anteriores al 20 de octubre de 2019.

Es el eCPM promedio de todos los anuncios. La unidad de moneda (USD, EUR o alguna otra) de Las métricas de ingresos se determinan según la configuración de localización de la moneda.

El eCPM promedio por grupo de mediación y por nivel de instancia de fuente del anuncio es de se admiten desde el 20 de octubre de 2019. OBSERVED_ECPM mostrará 0 para las fechas antes del 20 de octubre de 2019.

Escalares

Las siguientes dimensiones se actualizaron en la API del informe de actividad de los anuncios para que sean valores escalares en lugar de objetos. Esto simplificará la respuesta y reducirá y complejidad.

Dimensiones afectadas en la API de informes de mediación y la API de informes de red:

  • AD_UNIT
  • APP
  • AD_SOURCE
  • AD_SOURCE_INSTANCE
  • MEDIATION_GROUP
Datos de respuesta de un informe de muestra
Formato de dimensión API de Mediación / Red 
"AD_UNIT": {
   "value":"ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY",
   "displayLabel": "Test ad unit name"
   }
Formato de dimensión de la API de AAR 
"AD_UNIT_NAME": "Test ad unit name",
"AD_UNIT_ID": "ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY"

Informes por hora

Ahora puedes consultar el rendimiento por hora en la API de AdMob. Los informes por hora son disponible por hasta 28 días.

La dimensión DATE también debe especificarse en la solicitud para obtener datos de datos no estructurados. Se muestra un máximo de 28 días de datos cuando la dimensión HORA es especificada. El período de fechas de inicio es mayor que 28 días antes del la fecha actual muestran un error.

Tamaño del informe más grande

La API de Ads Activity Report te permite recuperar un total de 500,000 filas. Para para obtener información adicional, consulta la guía de cuotas.

Haz una solicitud

Sigue estos pasos para realizar una solicitud.

curl (línea de comandos)

Solicitudes que usan curl

  1. Carga el archivo de secretos del cliente y genera credenciales de autorización.

    La primera vez que realices este paso, se te pedirá que aceptes solicitud de autorización en el navegador. Antes de aceptar, asegúrate de estar haya accedido con una Cuenta de Google que tenga acceso a la API de AdMob. Tu aplicación estará autorizada para acceder a los datos en nombre de cualquier accedió a su cuenta.

    Para la autenticación y autorización, recomendamos usar oauth2l, una herramienta de línea de comandos simple para y funciona con Google OAuth 2.0. Instala oauth2l y ejecuta a continuación y reemplaza path_to_credentials_json por una ruta de acceso en un archivo credentials.json que puedes descargar cuando registras tu una aplicación en la nube. Para la primera ejecución, el comando te guiará a través de las Flujo de autorización de OAuth 2.0. Las ejecuciones posteriores actualizan el token automáticamente.

    ~/go/bin/oauth2l header --json path_to_credentials_json \
        https://www.googleapis.com/auth/admob.readonly

  2. Generar un informe de actividad de los anuncios

    curl -X POST https://admob.googleapis.com/v1alpha/accounts/pub-XXXXXXXXXXXXXXXX/adsActivityReport:generate \
     -H "Content-Type: application/json" \
     -H "$(~/go/bin/oauth2l header --json path_to_credentials_json https://www.googleapis.com/auth/admob.readonly)"  --data @- << EOF
      {
        "report_spec": {
        "date_range": {
          "start_date": {"year": 2023, "month": 1, "day": 1},
          "end_date": {"year": 2023, "month": 1, "day": 2}
        },
        "dimensions": ["DATE", "HOUR", "MEDIATION_AB_TEST", "VARIANT", "AD_SOURCE_ID", "AD_SOURCE_NAME"],
        "metrics": ["CLICKS", "BID_REQUEST","WINNING_BIDS", "IMPRESSIONS", "ESTIMATED_EARNINGS" ],
        "dimension_filters": [{"dimension": "COUNTRY", "matches_any": {"values": ["US"]}}],
        "sort_conditions": [{"metric":"CLICKS", "order": "DESCENDING"}],
        "localization_settings": {"currency_code": "USD", "language_code": "en-US"}
        }
      }
EOF

    Respuesta de muestra:

    {
"rows": [
  {
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant A"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 0
      },
      "BID_REQUEST": {
        "integerValue": "27"
      },
      "WINNING_BIDS": {
        "doubleValue": 0.1111111111111111
      },
      "IMPRESSIONS": {
        "integerValue": "2"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0
      }
    }
  },
{
    "dimensionValues": {
      "DATE": {
        "value": "20221102"
      },
      "HOUR": {
        "value": "23"
      },
      "MEDIATION_AB_TEST": {
        "value": "Mediation AB Test"
      },
      "VARIANT": {
        "value": "Variant B"
      },
      "AD_SOURCE_ID": {
        "value": "5450213213286189855"
      },
      "AD_SOURCE_NAME": {
        "value": "AdMob Network"
      }
    },
    "metricValues": {
      "CLICKS": {
        "doubleValue": 1
      },
      "BID_REQUEST": {
        "integerValue": "6"
      },
      "WINNING_BIDS": {
        "doubleValue": 1
      },
      "IMPRESSIONS": {
        "integerValue": "3"
      },
      "ESTIMATED_EARNINGS": {
        "doubleValue": 0.000427519
      }
    }
  }
]}