Method: accounts.campaignReport.generate

Génère un rapport de campagne en fonction des spécifications fournies.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Nom de ressource du compte pour lequel générer le rapport. Exemple: accounts/pub-9876543210987654

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
Champs
reportSpec

object (CampaignReportSpec)

les spécifications des rapports sur les campagnes.

Corps de la réponse

Réponse de l'API Campaign Report.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
Champs
rows[]

object (ReportRow)

Les données du rapport sur la campagne de l'éditeur spécifié. L'API renverra un maximum de 100 000 lignes.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

CampaignReportSpec

Spécification pour la génération d'un rapport sur les campagnes. Par exemple, la spécification permettant d'obtenir les IMPRESSIONS et CLICKS segmentées par CAMPAIGN_ID peut se présenter comme suit:

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

object (DateRange)

Plage de dates pour laquelle le rapport est généré. La plage maximale est de 30 jours.
dimensions[]

enum (Dimension)

Liste des dimensions du rapport. La combinaison des valeurs de ces dimensions détermine la ligne du rapport. Si aucune dimension n'est spécifiée, le rapport affiche une seule ligne de métriques demandées pour l'ensemble du compte.
metrics[]

enum (Metric)

Liste des métriques du rapport. Un rapport doit spécifier au moins une métrique.
languageCode

string

Langue utilisée pour tout texte localisé, comme certaines valeurs de dimension applicables. Le tag de langue est défini dans la norme IETF BCP47. La valeur par défaut est "en-US". s'il n'est pas spécifié ou s'il n'est pas valide.

Dimension

Dimensions du rapport sur la campagne.

Enums
DIMENSION_UNSPECIFIED Valeur par défaut d'une dimension non spécifiée. Ne pas utiliser.
DATE Date au format AAAAMMJJ (par exemple, "20210701").
CAMPAIGN_ID Identifiant unique de la campagne (par exemple, "123456789"), qui correspond à l'ID de campagne indiqué dans l'API de la liste des campagnes.
CAMPAIGN_NAME Nom de la campagne.
AD_ID Identifiant unique de l'annonce (par exemple, "123456789").
AD_NAME Nom de l'annonce, qui ne peut pas être unique.
PLACEMENT_ID Identifiant unique du fournisseur associé à l'application sur laquelle l'annonce est diffusée. Par exemple, com.goog.bar pour les applications Android et 123456789 pour les applications iOS.
PLACEMENT_NAME Nom de l'application dans laquelle l'annonce est placée.
PLACEMENT_PLATFORM Plate-forme de l'application sur laquelle l'annonce est diffusée.
COUNTRY Nom du pays ciblé.
FORMAT Format du bloc d'annonces (par exemple, "bannière" ou "native"), une dimension de diffusion des annonces.

Métrique

Métriques du rapport sur la campagne.

Enums
METRIC_UNSPECIFIED Valeur par défaut d'un champ non défini. Ne pas utiliser.
IMPRESSIONS Nombre de fois qu'une annonce est diffusée auprès d'un utilisateur.
CLICKS Nombre de fois qu'un utilisateur clique sur une annonce.
CLICK_THROUGH_RATE Nombre de clics sur une annonce divisé par le nombre de fois où elle est diffusée.
INSTALLS Nombre de fois où des applications ont été téléchargées sur des appareils.
ESTIMATED_COST Estimation du coût de diffusion d'une annonce d'une campagne au lieu d'une annonce qui génère des revenus. La devise est la devise de référence des campagnes.
AVERAGE_CPI Coût moyen par installation. Il s'agit du montant moyen dépensé pour acquérir un nouvel utilisateur. La devise est la devise de référence des campagnes.
INTERACTIONS Nombre de fois qu'un utilisateur interagit avec une annonce. Il s'agit des clics et des engagements.