- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- MediationReportSpec
- Dimensión
- Métrica
- DimensionFilter
- SortCondition
- Ejemplos
- Pruébala
Genera un informe de mediación de AdMob basado en la especificación del informe. Muestra el resultado de una RPC de transmisión del lado del servidor. El resultado se muestra en una secuencia de respuestas.
Solicitud HTTP
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/mediationReport:generate
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
parent |
Nombre del recurso de la cuenta para la que se genera el informe. Ejemplo: accounts/pub-9876543210987654 |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"reportSpec": {
object ( |
Campos | |
---|---|
reportSpec |
Especificación de informes de red. |
Cuerpo de la respuesta
La respuesta de transmisión del informe de mediación de AdMob, en la que la primera respuesta contiene el encabezado del informe, un flujo de respuestas de fila y, por último, un pie de página como el último mensaje de respuesta.
Por ejemplo:
[{
"header": {
"dateRange": {
"startDate": {"year": 2018, "month": 9, "day": 1},
"endDate": {"year": 2018, "month": 9, "day": 1}
},
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
},
{
"row": {
"dimensionValues": {
"DATE": {"value": "20180918"},
"APP": {
"value": "ca-app-pub-8123415297019784~1001342552",
"displayLabel": "My app name!"
}
},
"metricValues": {
"ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
}
}
},
{
"footer": {"matchingRowCount": 1}
}]
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión payload . Cada mensaje de respuesta de transmisión contiene un tipo de carga útil. Las direcciones (payload ) solo pueden ser una de las siguientes opciones: |
|
header |
La configuración de generación de informes que describe el contenido del informe, como el período y la configuración de localización. |
row |
Datos de informes reales. |
footer |
Información adicional sobre el informe generado, como advertencias sobre los datos. |
Alcances de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
Para obtener más información, consulta la Descripción general de OAuth 2.0.
MediationReportSpec
Es la especificación para generar un informe de mediación de AdMob. Por ejemplo, la especificación para obtener el eCPM observado dividido por fuente del anuncio y aplicación para los países de "EE.UU." y "CN" puede parecerse al siguiente ejemplo:
{
"dateRange": {
"startDate": {"year": 2021, "month": 9, "day": 1},
"endDate": {"year": 2021, "month": 9, "day": 30}
},
"dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
"metrics": ["OBSERVED_ECPM"],
"dimensionFilters": [
{
"dimension": "COUNTRY",
"matchesAny": {"values": [{"value": "US", "value": "CN"}]}
}
],
"sortConditions": [
{"dimension":"APP", order: "ASCENDING"}
],
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
Para una mejor comprensión, puedes tratar la especificación anterior como la siguiente seudoSQL:
SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
Representación JSON |
---|
{ "dateRange": { object ( |
Campos | |
---|---|
dateRange |
Es el período para el que se genera el informe. |
dimensions[] |
Es la lista de dimensiones del informe. La combinación de valores de estas dimensiones determina la fila del informe. Si no se especifican dimensiones, el informe muestra una sola fila de métricas solicitadas para toda la cuenta. |
metrics[] |
Es la lista de métricas del informe. Un informe debe especificar al menos una métrica. |
dimensionFilters[] |
Describe qué filas del informe deben coincidir según sus valores de dimensión. |
sortConditions[] |
Describe el orden de las filas del informe. El orden de la condición en la lista define su precedencia; cuanto antes sea la condición, mayor será su precedencia. Si no se especifican condiciones de orden, el orden de la fila no está definido. |
localizationSettings |
Es la configuración de localización del informe. |
maxReportRows |
Cantidad máxima de filas de datos del informe que se mostrarán. Si no se configura el valor, la API muestra tantas filas como sea posible, hasta 100,000. Los valores aceptables son 1-100000, ambos inclusive. Los valores superiores a 100,000 mostrarán un error. |
timeZone |
Es la zona horaria del informe. Acepta valores de nombre de la TZ de IANA, como “America/Los_Angeles”. Si no se define una zona horaria, se aplicará la configuración predeterminada de la cuenta. Verifica el valor predeterminado mediante la acción get account. Advertencia: “America/Los_Angeles” es el único valor admitido por el momento. |
Dimensión
Las dimensiones del informe de mediación. Las dimensiones son atributos de datos para desglosar o definir mejor las mediciones cuantitativas (métricas) según ciertos atributos, como el formato del anuncio o la plataforma en la que se vio.
Enumeradores | |
---|---|
DIMENSION_UNSPECIFIED |
Valor predeterminado para un campo no establecido. No lo utilices. |
DATE |
Es una fecha en el formato AAAAMMDD (por ejemplo, “20210701”). Las solicitudes pueden especificar como máximo una dimensión de tiempo. |
MONTH |
Es un mes en el formato AAAAMM (por ejemplo, “202107”). Las solicitudes pueden especificar como máximo una dimensión de tiempo. |
WEEK |
Es la fecha del primer día de una semana en el formato AAAAMMDD (por ejemplo, “20210701”). Las solicitudes pueden especificar como máximo una dimensión de tiempo. |
AD_SOURCE |
Es el ID único de la fuente del anuncio (por ejemplo, "5450213213286189855" y "Red de AdMob" como valor de la etiqueta). |
AD_SOURCE_INSTANCE |
Es el ID único de la instancia de la fuente del anuncio (por ejemplo, "ca-app-pub-1234:asi:5678" y "AdMob (predeterminado)" como valor de etiqueta). |
AD_UNIT |
Es el ID único de la unidad de anuncios (por ejemplo, "ca-app-pub-1234/8790"). Si se especifica la dimensión AD_UNIT, se incluirá APP automáticamente. |
APP |
Es el ID único de la aplicación para dispositivos móviles (por ejemplo, "ca-app-pub-1234~1234"). |
MEDIATION_GROUP |
Es el ID único del grupo de mediación (por ejemplo, "ca-app-pub-1234:mg:1234" y "AdMob (predeterminado)" como valor de etiqueta). |
COUNTRY |
Es el código de país de CLDR del lugar donde se producen las vistas o los clics en el anuncio (por ejemplo, “US” o “FR”). Esta es una dimensión geográfica. |
FORMAT |
Es el formato de la unidad de anuncios (por ejemplo, "banner" o "nativo"), una dimensión de publicación de anuncios. |
PLATFORM |
Indica la plataforma del SO de la aplicación para dispositivos móviles (por ejemplo, "Android" o "iOS"). |
MOBILE_OS_VERSION |
Versión del sistema operativo de dispositivos móviles, p.ej., "iOS 13.5.1". |
GMA_SDK_VERSION |
Versión del SDK de GMA, p.ej., "iOS 7.62.0". |
APP_VERSION_NAME |
En Android, el nombre de versión de la app se puede encontrar en versionName en PackageInfo. En iOS, el nombre de la versión de la app se puede encontrar en CFBundleShortVersionString. |
SERVING_RESTRICTION |
Es el modo de restricción para la publicación de anuncios (p.ej., "Anuncios no personalizados"). |
Métrica
Las métricas del informe de mediación. Las métricas son mediciones cuantitativas que indican el rendimiento del negocio de los publicadores. Se agregan a partir de los eventos de anuncios individuales y se agrupan según las dimensiones del informe. El valor de la métrica puede ser un número entero o un decimal (sin redondeo).
Enumeradores | |
---|---|
METRIC_UNSPECIFIED |
Valor predeterminado para un campo no establecido. No lo utilices. |
AD_REQUESTS |
La cantidad de solicitudes. El valor es un número entero. |
CLICKS |
Indica la cantidad de veces que un usuario hace clic en un anuncio. El valor es un número entero. |
ESTIMATED_EARNINGS |
Son los ingresos estimados del publicador de AdMob. La unidad monetaria (USD, EUR o cualquier otra moneda) de las métricas de ganancias se determina mediante la configuración de localización de la moneda. El importe está en micros. Por ejemplo, $6.50 se representaría como 6500000. Se admiten los ingresos estimados por grupo de mediación y por instancia de fuente del anuncio desde el 20 de octubre de 2019. Los ingresos estimados de terceros mostrarán 0 para las fechas anteriores al 20 de octubre de 2019. |
IMPRESSIONS |
Es la cantidad total de anuncios que se muestran a los usuarios. El valor es un número entero. |
IMPRESSION_CTR |
Es la proporción de clics sobre las impresiones. El valor es un valor decimal de doble precisión (aproximada). |
MATCHED_REQUESTS |
Es la cantidad de veces que se muestran anuncios en respuesta a una solicitud. El valor es un número entero. |
MATCH_RATE |
Es la proporción de solicitudes de anuncios coincidentes en comparación con el total de solicitudes de anuncios. El valor es un valor decimal de doble precisión (aproximada). |
OBSERVED_ECPM |
Es el eCPM promedio estimado de la red de publicidad de terceros. La unidad monetaria (USD, EUR o cualquier otra moneda) de las métricas de ganancias se determina mediante la configuración de localización de la moneda. El importe está en micros. Por ejemplo, $2.30 se representaría como 2300000. Se admite el eCPM promedio estimado por grupo de mediación y por nivel de instancia de la fuente del anuncio desde el 20 de octubre de 2019. El eCPM promedio estimado por terceros mostrará 0 para las fechas anteriores al 20 de octubre de 2019. |
DimensionFilter
Describe qué filas del informe deben coincidir según sus valores de dimensión.
Representación JSON |
---|
{ "dimension": enum ( |
Campos | |
---|---|
dimension |
Aplica el criterio de filtro a la dimensión especificada. |
Campo de unión operator . Operador de filtro que se aplicará. Las direcciones (operator ) solo pueden ser una de las siguientes opciones: |
|
matchesAny |
Coincide con una fila si su valor para la dimensión especificada está en uno de los valores especificados en esta condición. |
SortCondition
Indica la dirección de orden que se aplicará a una dimensión o métrica.
Representación JSON |
---|
{ "order": enum ( |
Campos | |
---|---|
order |
Orden de clasificación de la dimensión o métrica. |
Campo de unión sort_on . Identifica los valores según los cuales se debe ordenar. Las direcciones (sort_on ) solo pueden ser una de las siguientes opciones: |
|
dimension |
Ordena por la dimensión especificada. |
metric |
Ordena por la métrica especificada. |