Method: accounts.mediationReport.generate

Il génère un rapport sur la médiation AdMob en fonction des spécifications de rapport fournies. Renvoie le résultat d'un RPC en streaming côté serveur. Le résultat est renvoyé sous la forme d'une séquence de réponses.

Requête HTTP

POST https://admob.googleapis.com/v1/{parent=accounts/*}/mediationReport: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 (MediationReportSpec)
  }
}
Champs
reportSpec

object (MediationReportSpec)

Spécification du rapport "Réseau".

Corps de la réponse

Réponse en flux continu du rapport sur la médiation AdMob. La première réponse contient l'en-tête du rapport, puis un flux de réponses par ligne, et enfin un pied de page en tant que dernier message de réponse.

Exemple :

[{
  "header": {
    "dateRange": {
      "startDate": {"year": 2018, "month": 9, "day": 1},
      "endDate": {"year": 2018, "month": 9, "day": 1}
    },
    "localizationSettings": {
      "currencyCode": "USD",
      "languageCode": "en-US"
    }
  }
},
{
  "row": {
    "dimensionValues": {
      "DATE": {"value": "20180918"},
      "APP": {
        "value": "ca-app-pub-8123415297019784~1001342552",
         "displayLabel": "My app name!"
      }
    },
    "metricValues": {
      "ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

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

Représentation JSON 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
Champs
Champ d'union payload. Chaque message de réponse en flux continu contient un type de charge utile. payload ne peut être qu'un des éléments suivants :
header

object (ReportHeader)

Paramètres de génération de rapports décrivant son contenu, tels que la plage de dates et les paramètres de localisation.
row

object (ReportRow)

Données de rapport réelles.
footer

object (ReportFooter)

Informations supplémentaires sur le rapport généré, telles que des avertissements concernant les données.

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.

MediationReportSpec

Spécification permettant de générer un rapport sur la médiation AdMob. Par exemple, la spécification permettant d'obtenir l'ECPM observé, réparti par source d'annonce et application pour les pays "États-Unis" et "CN", peut se présenter comme suit:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 9, "day": 1},
    "endDate": {"year": 2021, "month": 9, "day": 30}
  },
  "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
  "metrics": ["OBSERVED_ECPM"],
  "dimensionFilters": [
    {
      "dimension": "COUNTRY",
      "matchesAny": {"values": [{"value": "US", "value": "CN"}]}
    }
  ],
  "sortConditions": [
    {"dimension":"APP", order: "ASCENDING"}
  ],
  "localizationSettings": {
    "currencyCode": "USD",
    "languageCode": "en-US"
  }
}

Pour mieux comprendre, vous pouvez traiter la spécification précédente comme le pseudo-SQL suivant:

SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
Représentation JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Champs
dateRange

object (DateRange)

Plage de dates pour laquelle le rapport est généré.
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 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.
dimensionFilters[]

object (DimensionFilter)

Décrit les lignes du rapport à mettre en correspondance en fonction des valeurs de leurs dimensions.
sortConditions[]

object (SortCondition)

Décrit le tri des lignes du rapport. L'ordre de la condition dans la liste définit sa priorité. Plus la condition est tôt, plus sa priorité est élevée. Si aucune condition de tri n'est spécifiée, l'ordre des lignes n'est pas défini.
localizationSettings

object (LocalizationSettings)

Paramètres de localisation du rapport.
maxReportRows

integer

Nombre maximal de lignes de données de rapport à renvoyer. Si la valeur n'est pas définie, l'API renvoie autant de lignes que possible, jusqu'à un maximum de 100 000. Les valeurs autorisées sont comprises entre 1 et 100 000 inclus. Les valeurs supérieures à 100 000 renvoient une erreur.
timeZone

string

Fuseau horaire du rapport. Accepte les valeurs de nom TZ de l'IANA, telles que "America/Los_Angeles". Si aucun fuseau horaire n'est défini, la valeur par défaut du compte est appliquée. Vérifiez la valeur par défaut à l'aide de l'action get account.

Avertissement : "America/Los_Angeles" est la seule valeur acceptée pour le moment.

Dimension

Dimensions du rapport sur la médiation. Les dimensions sont des attributs de données permettant de ventiler ou d'affiner les mesures quantitatives (métriques) en fonction de certains attributs, comme le format de l'annonce ou la plate-forme sur laquelle une annonce a été vue.

Enums
DIMENSION_UNSPECIFIED Valeur par défaut pour un champ non défini. Ne l'utilisez pas.
DATE Date au format AAAAMMJJ (par exemple, "20210701"). Les demandes ne peuvent spécifier qu'une seule dimension temporelle.
MONTH Mois au format AAAAMM (par exemple, "202107"). Les demandes ne peuvent spécifier qu'une seule dimension temporelle.
WEEK Date du premier jour du mois au format AAAAMMJJ (par exemple, "20210701"). Les demandes ne peuvent spécifier qu'une seule dimension temporelle.
AD_SOURCE ID unique de la source d'annonces (par exemple, "5450213213286189855" et "Réseau AdMob" comme valeur de libellé).
AD_SOURCE_INSTANCE ID unique de l'instance de source d'annonces (par exemple, "ca-app-pub-1234:asi:5678" et "AdMob (par défaut)" comme valeur de libellé).
AD_UNIT ID unique du bloc d'annonces (par exemple, "ca-app-pub-1234/8790"). Si la dimension AD_UNIT est spécifiée, APP est inclus automatiquement.
APP ID unique de l'application mobile (par exemple, "ca-app-pub-1234~1234").
MEDIATION_GROUP ID unique du groupe de médiation (par exemple, "ca-app-pub-1234:mg:1234" et "AdMob (par défaut)" comme valeur de libellé).
COUNTRY Code CLDR du pays où les impressions ou les clics sont enregistrés (par exemple, "US" ou "FR"). Il s'agit d'une dimension géographique.
FORMAT Format du bloc d'annonces (par exemple, "bannière" ou "native"), une dimension de diffusion de l'annonce.
PLATFORM Plate-forme du système d'exploitation pour mobile de l'application (par exemple, "Android" ou "iOS").
MOBILE_OS_VERSION Version du système d'exploitation mobile (par exemple, "iOS 13.5.1").
GMA_SDK_VERSION Version du SDK GMA, par exemple "iOS 7.62.0".
APP_VERSION_NAME Pour Android, le nom de la version de l'application se trouve dans versionName dans PackageInfo. Pour iOS, le nom de la version de l'application se trouve dans CFBundleShortVersionString.
SERVING_RESTRICTION Mode de restriction pour la diffusion d'annonces (par exemple, "Annonces non personnalisées").

Métrique

Métriques du rapport sur la médiation. Les métriques sont des mesures quantitatives qui indiquent les performances de l'entreprise d'un éditeur. Ils sont agrégés à partir des événements d'annonce individuels et regroupés en fonction des dimensions du rapport. La valeur de la métrique peut être un nombre entier ou un nombre décimal (sans arrondi).

Enums
METRIC_UNSPECIFIED Valeur par défaut pour un champ non défini. Ne l'utilisez pas.
AD_REQUESTS Nombre de requêtes. Cette valeur est un nombre entier.
CLICKS Nombre de fois qu'un utilisateur clique sur une annonce. Cette valeur est un nombre entier.
ESTIMATED_EARNINGS

Revenus estimés de l'éditeur AdMob. L'unité monétaire (USD, EUR ou autre) des métriques sur les revenus est déterminée par le paramètre de localisation de la devise. La quantité est exprimée en micros. Par exemple, 6,50 $ serait représenté par 6500000.

Les revenus estimés par groupe de médiation et par instance de source d'annonces sont disponibles depuis le 20 octobre 2019. Les revenus tiers estimés affichent 0 pour une période antérieure au 20 octobre 2019.
IMPRESSIONS Nombre total d'annonces diffusées auprès des utilisateurs. Cette valeur est un nombre entier.
IMPRESSION_CTR Rapport entre le nombre de clics et le nombre d'impressions. La valeur est une valeur décimale à double précision (approximative).
MATCHED_REQUESTS Nombre de fois où des annonces sont renvoyées en réponse à une demande. Cette valeur est un nombre entier.
MATCH_RATE Rapport entre les demandes d'annonces avec correspondance et le nombre total de demandes d'annonces. La valeur est une valeur décimale à double précision (approximative).
OBSERVED_ECPM

Il s'agit d'une estimation de l'eCPM moyen du réseau publicitaire tiers. L'unité monétaire (USD, EUR ou autre) des métriques sur les revenus est déterminée par le paramètre de localisation de la devise. La quantité est exprimée en micros. Par exemple, 2,30 $ serait représenté par 2300000.

L'estimation de l'eCPM moyen par groupe de médiation et par instance de source d'annonces est acceptée depuis le 20 octobre 2019. L'eCPM moyen estimé par un tiers indique 0 pour les dates antérieures au 20 octobre 2019.

DimensionFilter

Décrit les lignes du rapport à mettre en correspondance en fonction des valeurs de leurs dimensions.

Représentation JSON 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
Champs
dimension

enum (Dimension)

Applique le critère de filtre à la dimension spécifiée.
Champ d'union operator. Opérateur de filtre à appliquer. operator ne peut être qu'un des éléments suivants :
matchesAny

object (StringList)

Correspond à une ligne si la valeur de la dimension spécifiée figure dans l'une des valeurs spécifiées dans cette condition.

SortCondition

Sens de tri à appliquer à une dimension ou à une métrique.

Représentation JSON 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
Champs
order

enum (SortOrder)

Ordre de tri de la dimension ou de la métrique.
Champ d'union sort_on. Identifie les valeurs à trier. sort_on ne peut être qu'un des éléments suivants :
dimension

enum (Dimension)

Trier en fonction de la dimension spécifiée.
metric

enum (Metric)

Trier en fonction de la métrique spécifiée.