Method: accounts.campaignReport.generate

Genera un informe de la campaña 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

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 (CampaignReportSpec)
  }
}
Campos
reportSpec

object (CampaignReportSpec)

Es la especificación del informe de la campaña.

Cuerpo de la respuesta

Es la 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 devolverá un máximo de 100,000 filas.

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.

CampaignReportSpec

Es la especificación para generar un informe de campaña. Por ejemplo, la especificación para obtener las IMPRESIONES y los CLICS segmentados por CAMPAIGN_ID puede verse como el 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 intervalo 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 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.

languageCode

string

Es el idioma que se usa para cualquier texto localizado, como ciertos valores de dimensiones aplicables. La etiqueta de idioma se define en el estándar BCP47 del IETF. Si no se especifica o es no válido, el valor predeterminado es "en-US".

Dimensión

Son las dimensiones del informe de la campaña.

Enums
DIMENSION_UNSPECIFIED Es el valor predeterminado de una dimensión no especificada. No lo utilices.
DATE Es una fecha en formato AAAAMMDD (por ejemplo, "20210701").
CAMPAIGN_ID Es el ID único de la campaña, por ejemplo, "123456789", que coincide 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 Es 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 app en la que se coloca el anuncio. Por ejemplo, com.goog.bar para Android y 123456789 para apps para iOS.
PLACEMENT_NAME Es el nombre de la app en la que se coloca el anuncio.
PLACEMENT_PLATFORM Es la plataforma de la app en la que se coloca el anuncio.
COUNTRY Es el nombre del país objetivo.
FORMAT Es el formato de la unidad de anuncios (por ejemplo, "banner", "nativa"), una dimensión de publicación de anuncios.

Métrica

Son las métricas del informe de la campaña.

Enums
METRIC_UNSPECIFIED Es el valor predeterminado para un campo no establecido. No lo utilices.
IMPRESSIONS Es la cantidad de veces que se muestra un anuncio al 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 el anuncio.
INSTALLS Cantidad de veces que se descargaron apps en dispositivos.
ESTIMATED_COST Es el costo estimado de publicar un anuncio de la campaña en lugar de un anuncio que genera ingresos. La moneda es la moneda de informes de las campañas.
AVERAGE_CPI Es el costo promedio por instalación. Esto significa la cantidad promedio que se gastó para adquirir un usuario nuevo. La moneda es la moneda de informes de las campañas.
INTERACTIONS Es la cantidad de veces que un usuario interactúa con un anuncio. Esto incluye los clics y las participaciones.