Method: accounts.networkReport.generate

Genera un informe de la red de AdMob según la especificación proporcionada. Devuelve el resultado de una RPC de transmisión del servidor. El resultado se devuelve 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

Parámetros
parent

string

Es el nombre del recurso de la cuenta para la que se generará 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 (NetworkReportSpec)
  }
}
Campos
reportSpec

object (NetworkReportSpec)

Es la especificación del informe de red.

Cuerpo de la respuesta

Es la respuesta de transmisión para el informe de la red de AdMob, en la que la primera respuesta contiene el encabezado del informe, luego un flujo de respuestas de filas 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 payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
Campos
Campo de unión payload. Cada mensaje de respuesta de transmisión contiene un tipo de carga útil. payload puede ser solo uno de los parámetros siguientes:
header

object (ReportHeader)

Es 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

object (ReportRow)

Son los datos reales del informe.
footer

object (ReportFooter)

Es información adicional sobre el informe generado, como advertencias sobre los datos.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

Para obtener más información, consulta OAuth 2.0 Overview.

NetworkReportSpec

Es la especificación para generar un informe de la red de AdMob. Por ejemplo, la especificación para obtener los clics y las ganancias estimadas 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 comprender mejor, puedes tratar la especificación anterior como el siguiente pseudo-SQL:

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 (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Campos
dateRange

object (DateRange)

Es el período para el que se genera el informe.
dimensions[]

enum (Dimension)

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 las métricas solicitadas para toda la cuenta.
metrics[]

enum (Metric)

Es la lista de métricas del informe. Un informe debe especificar al menos una métrica.
dimensionFilters[]

object (DimensionFilter)

Describe qué filas del informe deben coincidir según sus valores de dimensión.
sortConditions[]

object (SortCondition)

Describe la ordenación de las filas del informe. El orden de la condición en la lista define su precedencia: cuanto antes aparezca la condición, mayor será su precedencia. Si no se especifican condiciones de ordenamiento, no se define el orden de las filas.
localizationSettings

object (LocalizationSettings)

Es la configuración de localización del informe.
maxReportRows

integer

Es la cantidad máxima de filas de datos del informe que se devolverán. Si no se establece el valor, la API devuelve la mayor cantidad posible de filas, hasta 100,000. Los valores aceptables son del 1 al 100,000, inclusive. Los valores superiores a 100,000 devuelven un error.
timeZone

string

Es la zona horaria del informe. Acepta valores de nombres de IANA TZ, como "America/Los_Angeles". Si no se define una zona horaria, se aplica la predeterminada de la cuenta. Verifica el valor predeterminado con la acción get account.

Advertencia: Por el momento, "America/Los_Angeles" es el único valor admitido.

Dimensión

Son las dimensiones del informe de red. Las dimensiones son atributos de datos que permiten 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.

Enums
DIMENSION_UNSPECIFIED Es el valor predeterminado para un campo no establecido. No lo utilices.
DATE Es una fecha en formato AAAAMMDD (por ejemplo, "20210701"). Las solicitudes pueden especificar, como máximo, una dimensión temporal.
MONTH Es un mes en formato AAAAMM (por ejemplo, "202107"). Las solicitudes pueden especificar, como máximo, una dimensión temporal.
WEEK Fecha del primer día de una semana en formato AAAAMMDD (por ejemplo, "20210701"). Las solicitudes pueden especificar, como máximo, una dimensión temporal.
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

Es el tipo de anuncio (por ejemplo, "texto" o "imagen"), 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 CLDR del lugar donde se producen las vistas o los clics del 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", "nativa"), una dimensión de publicación de anuncios.
PLATFORM Plataforma del SO para dispositivos móviles de la app (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 En 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

Son las métricas del informe de red. Las métricas son mediciones cuantitativas que indican el rendimiento del negocio del publicador. 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 es un número entero o decimal (sin redondeo).

Enums
METRIC_UNSPECIFIED Es el valor predeterminado para un campo no establecido. No lo utilices.
AD_REQUESTS

Es 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 Es 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 de moneda (USD, EUR o cualquier otra) de las métricas de ingresos se determina según la configuración de localización de la moneda. El importe está en micros. Por ejemplo, USD 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 en relación con las impresiones. El valor es un valor decimal de doble precisión (aproximado).
IMPRESSION_RPM

Son las ganancias estimadas por cada mil impresiones de anuncios. El valor está en micros. Por ejemplo, USD 1.03 se representaría como 1030000. Equivalente al eCPM en la IU de AdMob.

Advertencia: La métrica no es compatible con la dimensión AD_TYPE.
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 relación con el total de solicitudes de anuncios. El valor es un valor decimal de doble precisión (aproximado).

Advertencia: La métrica no es compatible con la dimensión AD_TYPE.
SHOW_RATE Es la proporción de anuncios que se muestran en relación con los anuncios que se devuelven, y se define como impresiones / solicitudes coincidentes. El valor es un valor decimal de doble precisión (aproximado).

DimensionFilter

Describe qué filas del informe deben coincidir según sus valores de dimensión.

Representación JSON 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
Campos
dimension

enum (Dimension)

Aplica el criterio de filtro a la dimensión especificada.
Campo de unión operator. Es el operador de filtro que se aplicará. operator puede ser solo uno de los parámetros siguientes:
matchesAny

object (StringList)

Coincide con una fila si su valor para la dimensión especificada se encuentra entre los valores especificados en esta condición.

SortCondition

Es la dirección de ordenamiento que se aplicará a una dimensión o métrica.

Representación JSON 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
Campos
order

enum (SortOrder)

Es el orden de clasificación de la dimensión o la métrica.
Campo de unión sort_on. Identifica los valores según los que se ordenará. sort_on puede ser solo uno de los parámetros siguientes:
dimension

enum (Dimension)

Ordena los datos según la dimensión especificada.
metric

enum (Metric)

Ordena los resultados según la métrica especificada.