- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- NetworkReportSpec
- Dimensión
- Métrica
- DimensionFilter
- SortCondition
- Ejemplos
- Pruébala
Genera un informe de la red de AdMob según la especificación de informes proporcionada. Muestra el resultado de una RPC de transmisión del servidor. El resultado se muestra en una secuencia de respuestas.
Solicitud HTTP
POST https://admob.googleapis.com/v1/{parent=accounts/*}/networkReport: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
Es la respuesta de transmisión del informe de la red de AdMob, en la que la primera respuesta contiene el encabezado del informe, un flujo de respuestas de la 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": {"microsValue": 6500000}
}
}
},
{
"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. |
Permisos 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.
NetworkReportSpec
Es la especificación para generar un informe de la red de AdMob. Por ejemplo, la especificación para obtener clics e ingresos estimados solo para los países "US" y "CN" puede verse como el siguiente ejemplo:
{
'dateRange': {
'startDate': {'year': 2021, 'month': 9, 'day': 1},
'endDate': {'year': 2021, 'month': 9, 'day': 30}
},
'dimensions': ['DATE', 'APP', 'COUNTRY'],
'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
'dimensionFilters': [
{
'dimension': 'COUNTRY',
'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
}
],
'sortConditions': [
{'dimension':'APP', order: 'ASCENDING'},
{'metric':'CLICKS', order: 'DESCENDING'}
],
'localizationSettings': {
'currencyCode': 'USD',
'languageCode': 'en-US'
}
}
Para una mejor comprensión, puedes tratar la especificación anterior como el siguiente seudoSQL:
SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
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 ordenación, el orden de las filas no está definido. |
localizationSettings |
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 establece el valor, la API muestra tantas filas como sea posible, hasta 100,000. Los valores aceptables son 1-100,000, inclusive. Los valores superiores a 100,000 mostrarán un error. |
timeZone |
La zona horaria del informe Acepta valores de nombre de TZ de IANA, como “America/Los_Angeles”. Si no se define una zona horaria, se aplica el valor predeterminado de la cuenta. Verifica el valor predeterminado mediante la acción get account. Advertencia: Por el momento, el único valor admitido es “America/Los_Angeles”. |
Dimensión
Las dimensiones del informe de red. 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 |
Una fecha en formato AAAAMMDD (por ejemplo, "20210701"). Las solicitudes pueden especificar como máximo una dimensión. |
MONTH |
Es un mes en formato AAAAMM (por ejemplo, “202107”). Las solicitudes pueden especificar como máximo una dimensión. |
WEEK |
Es la fecha del primer día de una semana en formato AAAAMMDD (por ejemplo, "20210701"). Las solicitudes pueden especificar como máximo una dimensión. |
AD_UNIT |
Es el ID único de la unidad de anuncios (por ejemplo, "ca-app-pub-1234/1234"). Si se especifica la dimensión AD_UNIT, se incluye APP automáticamente. |
APP |
Es el ID único de la aplicación para dispositivos móviles (por ejemplo, "ca-app-pub-1234~1234"). |
AD_TYPE |
Indica el tipo de anuncio (por ejemplo, "texto" o "imagen") y es una dimensión de publicación de anuncios. Advertencia: La dimensión no es compatible con las métricas AD_REQUESTS, MATCH_RATE y IMPRESSION_RPM. |
COUNTRY |
Es el código de país de CLDR del lugar donde se producen las vistas o los clics del anuncio (por ejemplo, "US" o "FR"). Esta es una dimensión de geografía. |
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 para dispositivos móviles de la aplicación (por ejemplo, "Android" o "iOS"). |
MOBILE_OS_VERSION |
Versión del sistema operativo para 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 |
Para Android, el nombre de la 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 |
Modo de restricción para la publicación de anuncios (p.ej., "Anuncios no personalizados"). |
Métrica
Las métricas del informe de red Las métricas son mediciones cuantitativas que indican el rendimiento de la empresa del publicador. Se agregan a partir de los eventos de anuncios individuales y se agrupan por las dimensiones del informe. El valor de la métrica puede ser un número entero o decimal (sin redondeo).
Enumeradores | |
---|---|
METRIC_UNSPECIFIED |
Valor predeterminado para un campo no establecido. No lo utilices. |
AD_REQUESTS |
Indica la cantidad de solicitudes de anuncios. El valor es un número entero. Advertencia: La métrica no es compatible con la dimensión AD_TYPE. |
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 configuración de localización de la moneda determina la unidad monetaria (USD, EUR o cualquier otra) de las métricas de ganancias. El importe está en micros. Por ejemplo, $6.50 se representaría como 6500000. |
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). |
IMPRESSION_RPM |
Son los ingresos estimados por cada mil impresiones de anuncios. El valor está en micros. Por ejemplo, $1.03 se representaría como 1030000. Equivale al eCPM en la IU de AdMob. Advertencia: La métrica no es compatible con la dimensión AD_TYPE. |
MATCHED_REQUESTS |
Indica 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). Advertencia: La métrica no es compatible con la dimensión AD_TYPE. |
SHOW_RATE |
Es la proporción de anuncios que se muestran sobre los que se muestran y se define como impresiones / solicitudes coincidentes. El valor es un valor decimal de doble precisión (aproximada). |
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 se encuentra en uno de los valores especificados en esta condición. |
SortCondition
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 qué valores se deben ordenar. Las direcciones (sort_on ) solo pueden ser una de las siguientes opciones: |
|
dimension |
Ordena los elementos por la dimensión especificada. |
metric |
Ordena por la métrica especificada. |