Method: accounts.campaignReport.generate

Genera informes de campañas según las especificaciones proporcionadas.

Solicitud HTTP

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Es el nombre de 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 (CampaignReportSpec)
  }
}
Campos
reportSpec

object (CampaignReportSpec)

Especificación del informe de campaña.

Cuerpo de la respuesta

Respuesta de la API de Campaign Report.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
Campos
rows[]

object (ReportRow)

Son los datos del informe de la campaña del publicador especificado. La API mostrará un máximo de 100,000 filas.

Alcances 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 la descripción general de OAuth 2.0.

CampaignReportSpec

Es la especificación para generar un informe de campaña. Por ejemplo, la especificación para obtener IMPRESIONES y CLICS desglosados por CAMPAIGN_ID puede ser similar al siguiente ejemplo:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
Representación JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
Campos
dateRange

object (DateRange)

Es el período para el que se genera el informe. El rango máximo es de 30 días.
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 mostrará una sola fila de métricas solicitadas para toda la cuenta.
metrics[]

enum (Metric)

Es la lista de métricas del informe. En el informe, se debe especificar, al menos, una métrica.
languageCode

string

Es el idioma que se usa para cualquier texto localizado, como ciertos valores de dimensión aplicables. La etiqueta de idioma se define en el código IETF BCP47. La configuración predeterminada es “en-US”. si no se especifica o no es válida.

Dimensión

Las dimensiones del informe de campaña

Enumeraciones
DIMENSION_UNSPECIFIED Valor predeterminado de una dimensión no especificada. No lo utilices.
DATE Una fecha en formato AAAAMMDD (por ejemplo, “20210701”).
CAMPAIGN_ID Es el ID único de la campaña (por ejemplo, "123456789", que concuerda con el ID de la campaña de la API de la lista de campañas).
CAMPAIGN_NAME El nombre de la campaña.
AD_ID Indica el ID único del anuncio; por ejemplo, "123456789".
AD_NAME Es el nombre del anuncio, que puede no ser único.
PLACEMENT_ID Es el ID único específico del proveedor de la aplicación en la que se publica el anuncio. Por ejemplo, com.goog.bar para Android y 123456789 para apps para iOS.
PLACEMENT_NAME Es el nombre de la aplicación en la que se coloca el anuncio.
PLACEMENT_PLATFORM Es la plataforma de la aplicación en la que se coloca el anuncio.
COUNTRY El nombre del país de segmentación.
FORMAT Es el formato de la unidad de anuncios (por ejemplo, "banner" o "nativo"), es una dimensión de publicación de anuncios.

Métrica

Las métricas del informe de la campaña

Enumeraciones
METRIC_UNSPECIFIED Valor predeterminado para un campo no establecido. No lo utilices.
IMPRESSIONS Indica la cantidad de veces que se muestra un anuncio a un usuario.
CLICKS Es la cantidad de veces que un usuario hace clic en un anuncio.
CLICK_THROUGH_RATE Es la cantidad de clics que recibe un anuncio dividida por la cantidad de veces que se muestra.
INSTALLS Es la cantidad de veces que se descargaron las apps en los dispositivos.
ESTIMATED_COST Es el costo estimado de publicar un anuncio de campaña en lugar de un anuncio que genera ingresos. La moneda es la moneda del informe de las campañas.
AVERAGE_CPI Es el costo por instalación promedio. Es el importe promedio invertido para adquirir un usuario nuevo. La moneda es la moneda del informe de las campañas.
INTERACTIONS Indica la cantidad de veces que un usuario interactúa con un anuncio. Esta categoría incluye los clics y las participaciones.