- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- CampaignReportSpec
- Dimensión
- Métrica
- Ejemplos
- Pruébala
Genera un informe 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 |
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 campañas. |
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 ( |
Campos | |
---|---|
rows[] |
Los datos del informe de campañas del publicador especificado. Se mostrarán un máximo de 100,000 filas de la API. |
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.
CampaignReportSpec
Es la especificación para generar un informe de campañas. Por ejemplo, la especificación para obtener IMPRESIONES y CLICS desglosados 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 ( |
Campos | |
---|---|
dateRange |
Es el período para el que se genera el informe. El rango máximo es de 30 días. |
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. |
languageCode |
Es el idioma utilizado para cualquier texto localizado, como ciertos valores de dimensión aplicables. La etiqueta de idioma se define en el 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 la campaña.
Enumeradores | |
---|---|
DIMENSION_UNSPECIFIED |
Valor predeterminado de una dimensión sin especificar. No lo utilices. |
DATE |
Una fecha en formato AAAAMMDD (por ejemplo, "20210701"). |
CAMPAIGN_ID |
El ID único de la campaña, por ejemplo, "123456789", que concuerda con el ID de campaña de la API de 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 |
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 coloca el anuncio. Por ejemplo, com.goog.bar para Android y 123456789 para apps de iOS. |
PLACEMENT_NAME |
Es el nombre de la aplicación en la que se publica 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"), una dimensión de publicación de anuncios. |
Métrica
Las métricas del informe de la campaña.
Enumeradores | |
---|---|
METRIC_UNSPECIFIED |
Valor predeterminado para un campo no establecido. No lo utilices. |
IMPRESSIONS |
Indica la cantidad de veces que se muestra un anuncio al usuario. |
CLICKS |
Indica 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 |
La cantidad de veces que se descargaron las apps en los dispositivos. |
ESTIMATED_COST |
Es el costo estimado de publicar un anuncio de la campaña en lugar de uno que genera ingresos. La moneda es la del informe de las campañas. |
AVERAGE_CPI |
Es el costo por instalación promedio. Es el importe promedio que se invirtió para adquirir un usuario nuevo. La moneda es la del informe de las campañas. |
INTERACTIONS |
Indica la cantidad de veces que un usuario interactúa con un anuncio. Se refiere a los clics y las participaciones. |