- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- NetworkReportSpec
- Dimension
- Métrique
- DimensionFilter
- SortCondition
- Exemples
- Essayer
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 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/v1beta/{parent=accounts/*}/networkReport:generate
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
parent |
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 ( |
Champs | |
---|---|
reportSpec |
Spécification du rapport "Réseau". |
Corps de la réponse
Réponse en flux continu du rapport sur le réseau AdMob, dont la première 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": {"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 |
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 |
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 |
Données de rapport réelles. |
footer |
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 les clics et les revenus estimés pour les pays "US" et "CN" peut se présenter comme suit:
{
'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 ( |
Champs | |
---|---|
dateRange |
Plage de dates pour laquelle le rapport est généré. |
dimensions[] |
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[] |
Liste des métriques du rapport. Un rapport doit spécifier au moins une métrique. |
dimensionFilters[] |
Décrit les lignes du rapport à mettre en correspondance en fonction des valeurs de leurs dimensions. |
sortConditions[] |
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 |
Paramètres de localisation du rapport. |
maxReportRows |
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 |
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 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, 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_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 de l'annonce (par exemple, "texte" ou "image"), une 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 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 le réseau. 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 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. La quantité est exprimée 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 |
Rapport entre le nombre de clics et le nombre d'impressions. La valeur est une valeur décimale à double précision (approximative). |
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. Équivaut à l'eCPM dans l'interface utilisateur d'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 |
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). Avertissement:La métrique n'est pas compatible avec la dimension AD_TYPE. |
SHOW_RATE |
Ratio entre le nombre d'annonces affichées et les annonces renvoyées. Il correspond au 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 ( |
Champs | |
---|---|
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 |
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 ( |
Champs | |
---|---|
order |
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 |
Trier en fonction de la dimension spécifiée. |
metric |
Trier en fonction de la métrique spécifiée. |