- 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
- CampaignReportSpec
- Dimension
- Métrique
- Exemples
- Essayer
Génère un rapport sur les campagnes 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 |
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écifications des rapports sur les campagnes |
Corps de la réponse
Réponse de l'API Campaign Report.
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 ( |
Champs | |
---|---|
rows[] |
Données du rapport sur la campagne de l'éditeur spécifié. 100 000 lignes au maximum seront renvoyées par l'API. |
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.
CampaignReportSpec
Spécification pour la génération d'un rapport sur les campagnes. Par exemple, la spécification permettant de générer les IMPRESSIONS et les clics sur les clics, segmentés par CAMPAIGN_ID, peut se présenter comme suit:
{
"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 ( |
Champs | |
---|---|
dateRange |
Plage de dates pour laquelle le rapport est généré. La plage maximale est de 30 jours. |
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. |
languageCode |
Langue utilisée pour le texte localisé, comme certaines valeurs de dimensions applicables. Le tag de langue est défini dans l'IETF BCP47. La valeur par défaut est "en-US" si aucune valeur n'est spécifiée ou si elle n'est pas valide. |
Dimension
Dimensions du rapport sur les campagnes
Enums | |
---|---|
DIMENSION_UNSPECIFIED |
Valeur par défaut d'une dimension non spécifiée. Ne l'utilisez pas. |
DATE |
Date au format AAAAMMJJ (par exemple, "20210701"). |
CAMPAIGN_ID |
ID 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, qui peut ne pas être unique. |
PLACEMENT_ID |
ID unique spécifique au fournisseur de l'application dans laquelle l'annonce est diffusée. Par exemple, com.goog.bar pour 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 de l'annonce. |
Métrique
Métriques du rapport sur la campagne.
Enums | |
---|---|
METRIC_UNSPECIFIED |
Valeur par défaut pour un champ non défini. Ne l'utilisez pas. |
IMPRESSIONS |
Nombre de fois où une annonce est présentée à l'utilisateur. |
CLICKS |
Nombre de fois qu'un utilisateur clique sur une annonce. |
CLICK_THROUGH_RATE |
Nombre de clics sur une annonce divisé par le nombre de fois où elle est diffusée. |
INSTALLS |
Nombre de fois où des applications ont été téléchargées sur des appareils. |
ESTIMATED_COST |
Coût estimé de la diffusion d'une annonce d'une campagne plutôt que d'une annonce générant des revenus. La devise est la devise de référence pour les campagnes. |
AVERAGE_CPI |
Coût par installation moyen Il s'agit du montant moyen qui a été dépensé pour acquérir un nouvel utilisateur. La devise est la devise de référence pour les campagnes. |
INTERACTIONS |
Nombre de fois qu'un utilisateur interagit avec une annonce. Il s'agit des clics et des engagements. |