Method: accounts.networkReport.generate

Génère un rapport sur le réseau AdMob en fonction des spécifications fournies. Renvoie le résultat d'un RPC de streaming côté serveur. Le résultat est renvoyé dans une séquence de réponses.

Requête HTTP

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

object (NetworkReportSpec)

Spécification du rapport sur le réseau.

Corps de la réponse

Réponse de flux pour le rapport sur le réseau AdMob, où la première réponse contient l'en-tête du rapport, puis un flux de réponses de ligne et enfin un pied de page comme 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": {"microsValue": 6500000}
    }
  }
},
{
  "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 du flux 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 le contenu du rapport, tels que la plage de dates et les paramètres de localisation.
row

object (ReportRow)

Données réelles du rapport.
footer

object (ReportFooter)

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

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.

NetworkReportSpec

Spécification pour générer un rapport sur le réseau AdMob. Par exemple, la spécification permettant d'obtenir les clics et les revenus estimés uniquement pour les pays "US" et "CN" peut ressembler à l'exemple suivant :

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

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

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
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)

Période 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 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.
dimensionFilters[]

object (DimensionFilter)

Décrit les lignes du rapport à faire correspondre en fonction de leurs valeurs de dimension.
sortConditions[]

object (SortCondition)

Décrit le tri des lignes du rapport. L'ordre des conditions dans la liste définit leur priorité : plus la condition est placée en haut de la liste, 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'à 100 000. Les valeurs acceptables 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 IANA, telles que "America/Los_Angeles". Si aucun fuseau horaire n'est défini, celui par défaut du compte est appliqué. Vérifiez la valeur par défaut à l'aide de l'action "Obtenir le compte".

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

Dimension

Dimensions du rapport sur le réseau. Les dimensions sont des attributs de données permettant de ventiler ou d'affiner les mesures quantitatives (métriques) en fonction de certains attributs, tels que le format des annonces ou la plate-forme sur laquelle elles ont été vues.

Enums
DIMENSION_UNSPECIFIED Valeur par défaut pour un champ non défini. Ne pas utiliser.
DATE Date au format AAAAMMJJ (par exemple, "20210701"). Les requêtes ne peuvent spécifier qu'une seule dimension temporelle.
MONTH Mois au format AAAAMM (par exemple, "202107"). Les requêtes ne peuvent spécifier qu'une seule dimension temporelle.
WEEK Date du premier jour d'une semaine au format AAAAMMJJ (par exemple, "20210701"). Les requêtes ne peuvent spécifier qu'une seule dimension temporelle.
AD_UNIT ID unique du bloc d'annonces (par exemple, "ca-app-pub-1234/1234"). 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").
AD_TYPE

Type d'annonce (par exemple, "textuelle" ou "illustrée"), une dimension de diffusion d'annonce.

Avertissement : Cette dimension n'est pas compatible avec les métriques AD_REQUESTS, MATCH_RATE et IMPRESSION_RPM.
COUNTRY Code pays CLDR du lieu où les vues/clics sur l'annonce se produisent (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 d'annonces.
PLATFORM Plate-forme de l'OS 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 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 le réseau. Les métriques sont des mesures quantitatives qui indiquent les performances de l'activité de l'éditeur. Elles sont agrégées à partir des événements d'annonces individuels et regroupées par dimensions du rapport. La valeur de la métrique est un nombre entier ou décimal (sans arrondi).

Enums
METRIC_UNSPECIFIED Valeur par défaut pour un champ non défini. Ne pas utiliser.
AD_REQUESTS

Nombre de demandes d'annonces. Cette valeur est un nombre entier.

Avertissement : La métrique n'est pas compatible avec la dimension AD_TYPE.
CLICKS Nombre de fois qu'un utilisateur a cliqué 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 pour la devise. Le montant est exprimé en micros. Par exemple, 6,50 $ serait représenté par 6500000.
IMPRESSIONS Nombre total d'annonces diffusées auprès des utilisateurs. Cette valeur est un nombre entier.
IMPRESSION_CTR Il s'agit du rapport entre le nombre de clics et le nombre d'impressions. La valeur est un nombre décimal à double précision (approximatif).
IMPRESSION_RPM

Estimation des revenus pour mille impressions d'annonces. La valeur est exprimée en micros. Par exemple, 1,03 $ serait représenté par 1030000. Équivalent à l'eCPM dans l'UI AdMob.

Avertissement : La métrique n'est pas compatible avec la dimension AD_TYPE.
MATCHED_REQUESTS Nombre de fois que des annonces sont renvoyées en réponse à une demande. Cette valeur est un nombre entier.
MATCH_RATE

Ratio entre le nombre de demandes d'annonces avec correspondance et le nombre total de demandes d'annonces. La valeur est un nombre décimal à double précision (approximatif).

Avertissement : La métrique n'est pas compatible avec la dimension AD_TYPE.
SHOW_RATE Il s'agit du rapport entre les annonces diffusées et les annonces renvoyées, défini comme suit : impressions / demandes avec correspondance. La valeur est un nombre décimal à double précision (approximatif).

DimensionFilter

Décrit les lignes du rapport à faire correspondre en fonction de leurs valeurs de dimension.

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)

Établit une correspondance avec une ligne si sa valeur pour la dimension spécifiée correspond à l'une des valeurs spécifiées dans cette condition.

SortCondition

Sens du 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 sur lesquelles trier. sort_on ne peut être qu'un des éléments suivants :
dimension

enum (Dimension)

Trie les résultats selon la dimension spécifiée.
metric

enum (Metric)

Triez les résultats selon la métrique spécifiée.