Method: accounts.campaignReport.generate

Génère un rapport sur la 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)

Spécifications du rapport sur les campagnes.

Corps de la réponse

Réponse de l'API Rapport sur les campagnes.

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)

Données du rapport sur la campagne provenant de l'éditeur spécifié. L'API renverra au maximum 100 000 lignes.

Champs d'application des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

CampaignReportSpec

Spécification pour générer un rapport sur les campagnes. Par exemple, la spécification permettant d'obtenir les IMPRESSIONS et les CLICS segmentés par CAMPAIGN_ID peut ressembler à l'exemple suivant :

{
  "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)

Période pour laquelle le rapport est généré. La période maximale est de 30 jours.
dimensions[]

enum (Dimension)

Liste des dimensions du rapport. La combinaison de valeurs de ces dimensions détermine la ligne du rapport. Si aucune dimension n'est spécifiée, le rapport renvoie 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 l'IETF BCP47. La valeur par défaut est "en-US" si elle n'est pas spécifiée ou 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 de l'API Campaign List.
CAMPAIGN_NAME Nom de la campagne.
AD_ID Identifiant unique de l'annonce, par exemple "123456789".
AD_NAME Nom de l'annonce (non unique).
PLACEMENT_ID Identifiant unique spécifique au fournisseur de l'application dans 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 diffusé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 d'annonces.

Métrique

Métriques du rapport sur la campagne.

Enums
METRIC_UNSPECIFIED Valeur par défaut pour un champ non défini. Ne pas utiliser.
IMPRESSIONS Nombre de fois qu'une annonce est présentée à l'utilisateur.
CLICKS Nombre de fois qu'un utilisateur a cliqué sur une annonce.
CLICK_THROUGH_RATE Nombre de clics sur une annonce divisé par le nombre de fois où elle s'est affiché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 de campagne au lieu d'une annonce qui génère des revenus. La devise est celle utilisée pour les rapports sur les campagnes.
AVERAGE_CPI Coût moyen par installation. Il s'agit du montant moyen qui a été dépensé afin d'acquérir un nouvel utilisateur. La devise est celle utilisée pour les rapports sur les campagnes.
INTERACTIONS Nombre de fois qu'un utilisateur interagit avec une annonce. Cela inclut les clics et les engagements.