Method: accounts.networkReport.generate

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

Requête HTTP

POST https://admob.googleapis.com/v1/{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 en flux continu pour le rapport sur le réseau AdMob, où la première réponse contient l'en-tête du rapport, un flux de réponses sous forme de lignes 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": {"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 de 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 (par exemple, sa plage de dates et ses 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.

NetworkReportSpec

Spécification permettant de générer un rapport sur le réseau AdMob. Par exemple, la spécification permettant d'obtenir le nombre de clics et les revenus estimés uniquement pour la région "États-Unis" et "CN" pays 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 traiter 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)

Plage de dates pour laquelle le rapport est généré.
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.
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 des conditions dans la liste définit leur 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 cette valeur n'est pas définie, l'API renvoie autant de lignes que possible, jusqu'à 100 000. Les valeurs autorisées vont de 1 à 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" (Récupérer le compte).

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

Dimension

Dimensions du rapport "Réseau". Les dimensions sont des attributs de données qui permettent 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 d'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 de temps.
MONTH Mois au format AAAAMM (par exemple, "202107"). Les requêtes ne peuvent spécifier qu'une seule dimension de temps.
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 de temps.
AD_UNIT ID unique du bloc d'annonces (par exemple, "ca-app-pub-1234/1234"). Si la dimension AD_UNIT est spécifiée, l'application APP est incluse automatiquement.
APP ID unique de l'application mobile (par exemple, "ca-app-pub-1234~1234").
AD_TYPE

Type de l'annonce (par exemple, "texte" ou "image"), et dimension de diffusion de l'annonce.

Avertissement:La dimension n'est pas compatible avec les métriques AD_REQUESTS, MATCH_RATE et IMPRESSION_RPM.
COUNTRY Code pays CLDR du lieu où les visionnages de l'annonce ou les clics sont effectué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 des annonces.
PLATFORM La 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 pour mobile (ex. : "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 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 individuelles et regroupées selon les dimensions du rapport. La valeur de la métrique peut être un nombre entier ou décimal (sans arrondi).

Enums
METRIC_UNSPECIFIED Valeur par défaut d'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 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. Le montant est exprimé en micros. Par exemple, 6,50 $ est représenté par 6500000.
IMPRESSIONS Nombre total d'annonces diffusées auprès des utilisateurs. Cette valeur est un nombre entier.
IMPRESSION_CTR Le rapport entre le nombre de clics et le nombre d'impressions La valeur est une valeur décimale à double précision (approximative).
IMPRESSION_RPM

Il s'agit des revenus estimés pour mille impressions d'annonces. La valeur est exprimée en micros. Par exemple, 1,03 $ est représenté par 1030000. Équivaut à l'eCPM dans l'interface utilisateur AdMob.

Avertissement:La métrique n'est pas compatible avec la dimension AD_TYPE.
MATCHED_REQUESTS Nombre de fois où 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 une valeur décimale à double précision (approximative).

Avertissement:La métrique n'est pas compatible avec la dimension AD_TYPE.
SHOW_RATE Ratio entre le nombre d'annonces diffusées et le nombre d'annonces renvoyées (nombre d'impressions divisé par le nombre de demandes avec correspondance) La valeur est une valeur décimale à double précision (approximative).

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)

Trouve une correspondance avec une ligne si sa valeur de la dimension spécifiée se trouve 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 à utiliser pour le tri. sort_on ne peut être qu'un des éléments suivants :
dimension

enum (Dimension)

Trier selon la dimension spécifiée.
metric

enum (Metric)

Trier selon la métrique spécifiée.