API Ads Activity Report (alpha)

Le rapport sur l'activité publicitaire une vue centralisée des performances de vos annonces. Il combine les données, les métriques de l'API de création de rapports sur le réseau et de l'API de rapport sur la médiation, ainsi que les données d'enchères dans un seul rapport unifié.

L'API Ads Activity Report offre des améliorations supplémentaires par rapport à la médiation API Report et API Network Report telles qu'elles apparaissent dans le tableau ci-dessous:

API Network Report API Mediation Report API Ads Activity Report
Performances du réseau
Performances des cascades d'annonces
Performances des enchères
Performances du test A/B de médiation
Rapports horaires
Taille du rapport 100 000 100 000 500 000

Métriques, dimensions et filtres de dimensions

Les métriques suivantes ont été ajoutées à l'API Ads Activity Report dans en plus des nombreuses métriques disponibles dans l'API Network Report et API Mediation Report.

Métrique Description
BID_REQUEST Nombre de demandes envoyées à la source d'annonces pour les enchères.
BIDS_IN_AUCTION Nombre d'enchères transmises par la source d'annonces qui ont participé aux mises aux enchères.
WINNING_BIDS Nombre d'enchères ayant remporté une mise aux enchères.

Les nouvelles dimensions suivantes sont incluses dans l'API Ads Activity Report.

Dimension Description
SEMAINE La date du premier jour de la semaine (selon la langue dans les paramètres de localisation) au format AAAAMMJJ (par Exemple : "20210701"). Les requêtes ne peuvent spécifier qu'une seule des valeurs suivantes : DATE, WEEK ou MONTH dimension temporelle.
HEURE Heure au format HH et heure PST. Exemple : "05" à 5h PST, "13" à 13h PST. La dimension DATE doit également être spécifiée dans la demande. A Un nombre maximal de 28 jours de données est renvoyé lorsque la dimension HEURE est spécifiée. Dates de début de plage de dates plus de 28 jours avant la date actuelle renvoie une erreur.
MEDIATION_AB_TEST (nom du test) Affichez les performances par test A/B de médiation. Il est obligatoire de spécifier si la dimension VARIANT est spécifiée.
MEDIATION_AB_TEST_VARIANT (Variante A, Variante B) Affichez les performances par variante du test A/B de médiation.
Nom de la dimension dans l'API Mediation Report Nom de la dimension dans l'API Ads Activity Report Description
BLOC_ANNONCES1 AD_UNIT_ID ID unique du bloc d'annonces (par exemple, "123456789").
AD_UNIT_NAME Nom du bloc d'annonces.
APPLICATION1 APP_ID Identifiant unique de l'application mobile (par exemple, "1234567890").
APP_NAME Nom de l'application.
AD_SOURCE1 AD_SOURCE_ID ID unique de la source d'annonces (par exemple, "1234567890123456789").
AD_SOURCE_NAME Nom de la source d'annonces (par exemple, "Réseau AdMob").
AD_SOURCE_INSTANCE1 AD_SOURCE_INSTANCE_ID ID unique de l'instance de source d'annonces (par exemple, "123456789012").
AD_SOURCE_INSTANCE_NAME Nom de l'instance de source d'annonces (par exemple, "AdMob (par défaut)").
MEDIATION_GROUP1 MEDIATION_GROUP_ID ID unique du groupe de médiation (par exemple, "1234567890").
MEDIATION_GROUP_NAME ID unique du groupe de médiation (par exemple, "AdMob (par défaut)").

1: consultez la section Scalars pour en savoir plus.

Le format des dimensions suivantes a été mis à jour.

Nom de la dimension dans l'API Mediation Report Description dans l'API Mediation Report Description dans l'API Ads Activity Report
ESTIMATED_EARNINGS Revenus estimés de l'éditeur AdMob. L'unité monétaire (USD, (en euros ou autre) des métriques sur les revenus sont déterminées par la localisation pour la devise. Le montant est exprimé en micros. Par exemple, 6,50 $ correspond à représentée par 6500000.

Les revenus estimés par groupe de médiation et par instance de source d'annonces sont depuis le 20 octobre 2019. Les revenus estimés tiers afficher 0 pour les dates antérieures au 20 octobre 2019.

Revenus estimés de l'éditeur AdMob. L'unité monétaire (USD, (en euros ou autre) des métriques sur les revenus sont déterminées par la localisation pour la devise.
OBSERVED_ECPM Estimation de l'eCPM moyen du réseau publicitaire tiers. Unité monétaire (USD, EUR ou autre) les métriques sur les revenus sont déterminées par la localisation pour la devise. Le montant est exprimé en micros. Par exemple, 2,30 $ correspond à représentée par 2300000.

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

eCPM moyen pour toutes les annonces. L'unité monétaire (USD, EUR ou autre) de la valeur les métriques sur les revenus sont déterminées par le paramètre de localisation de la devise.

L'eCPM moyen par groupe de médiation et par instance de source d'annonces est de depuis le 20 octobre 2019. OBSERVED_ECPM affichera 0 pour les dates. avant le 20 octobre 2019.

Scalaires

Les dimensions ci-dessous ont été mises à jour dans l'API Ads Activity Report pour être des valeurs scalaires plutôt que des objets. Cela simplifiera la réponse et réduira la complexité.

Dimensions concernées dans l'API Mediation Report et l'API Network Report:

  • AD_UNIT
  • APP
  • AD_SOURCE
  • AD_SOURCE_INSTANCE
  • MEDIATION_GROUP
Exemple de données de réponse à un rapport
Format de dimension de l'API de médiation / réseau
"AD_UNIT": {
   "value":"ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY",
   "displayLabel": "Test ad unit name"
   }
Format des dimensions de l'API AAR
"AD_UNIT_NAME": "Test ad unit name",
"AD_UNIT_ID": "ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY"

Rapports horaires

Vous pouvez désormais afficher les performances par heure dans l'API AdMob. Les rapports horaires sont disponibles pendant 28 jours.

La dimension DATE doit également être spécifiée dans la requête pour récupérer toutes les données par heure données. Un maximum de 28 jours de données est renvoyé lorsque la dimension HEURE est spécifié. Les dates de début de période antérieures à la période de 28 jours la date actuelle renvoie une erreur.

Rapport plus volumineux

L'API Ads Activity Report vous permet d'extraire 500 000 lignes au total. Pour consultez le guide des quotas.

Envoyer une requête

Pour envoyer une demande, procédez comme suit :

curl (ligne de commande)

Requêtes utilisant curl

  1. Chargez le fichier de secrets client et générez des identifiants d'autorisation.

    La première fois que vous effectuez cette étape, vous êtes invité à accepter un dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté à l'aide d'un compte Google ayant accès à l'API AdMob ; Votre application est autorisée à accéder aux données au nom est actuellement connecté.

    Pour l'authentification et l'autorisation, nous vous recommandons d'utiliser oauth2l, un outil de ligne de commande simple pour avec Google OAuth 2.0. Installez oauth2l et exécutez la ci-dessous, en remplaçant path_to_credentials_json par un chemin d'accès vers un fichier credentials.json que vous téléchargez lors de l'enregistrement de votre de votre application cloud. Lors de la première exécution, la commande vous guide à travers Flux d'autorisation OAuth 2.0. Les exécutions suivantes actualisent le jeton automatiquement.

    ~/go/bin/oauth2l header --json path_to_credentials_json \
            https://www.googleapis.com/auth/admob.readonly
    
  2. Générer un rapport sur l'activité publicitaire

    curl -X POST https://admob.googleapis.com/v1alpha/accounts/pub-XXXXXXXXXXXXXXXX/adsActivityReport:generate \
         -H "Content-Type: application/json" \
         -H "$(~/go/bin/oauth2l header --json path_to_credentials_json https://www.googleapis.com/auth/admob.readonly)"  --data @- << EOF
          {
            "report_spec": {
            "date_range": {
              "start_date": {"year": 2023, "month": 1, "day": 1},
              "end_date": {"year": 2023, "month": 1, "day": 2}
            },
            "dimensions": ["DATE", "HOUR", "MEDIATION_AB_TEST", "VARIANT", "AD_SOURCE_ID", "AD_SOURCE_NAME"],
            "metrics": ["CLICKS", "BID_REQUEST","WINNING_BIDS", "IMPRESSIONS", "ESTIMATED_EARNINGS" ],
            "dimension_filters": [{"dimension": "COUNTRY", "matches_any": {"values": ["US"]}}],
            "sort_conditions": [{"metric":"CLICKS", "order": "DESCENDING"}],
            "localization_settings": {"currency_code": "USD", "language_code": "en-US"}
            }
          }
    EOF
    

    Exemple de réponse :

    {
    "rows": [
      {
        "dimensionValues": {
          "DATE": {
            "value": "20221102"
          },
          "HOUR": {
            "value": "23"
          },
          "MEDIATION_AB_TEST": {
            "value": "Mediation AB Test"
          },
          "VARIANT": {
            "value": "Variant A"
          },
          "AD_SOURCE_ID": {
            "value": "5450213213286189855"
          },
          "AD_SOURCE_NAME": {
            "value": "AdMob Network"
          }
        },
        "metricValues": {
          "CLICKS": {
            "doubleValue": 0
          },
          "BID_REQUEST": {
            "integerValue": "27"
          },
          "WINNING_BIDS": {
            "doubleValue": 0.1111111111111111
          },
          "IMPRESSIONS": {
            "integerValue": "2"
          },
          "ESTIMATED_EARNINGS": {
            "doubleValue": 0
          }
        }
      },
    {
        "dimensionValues": {
          "DATE": {
            "value": "20221102"
          },
          "HOUR": {
            "value": "23"
          },
          "MEDIATION_AB_TEST": {
            "value": "Mediation AB Test"
          },
          "VARIANT": {
            "value": "Variant B"
          },
          "AD_SOURCE_ID": {
            "value": "5450213213286189855"
          },
          "AD_SOURCE_NAME": {
            "value": "AdMob Network"
          }
        },
        "metricValues": {
          "CLICKS": {
            "doubleValue": 1
          },
          "BID_REQUEST": {
            "integerValue": "6"
          },
          "WINNING_BIDS": {
            "doubleValue": 1
          },
          "IMPRESSIONS": {
            "integerValue": "3"
          },
          "ESTIMATED_EARNINGS": {
            "doubleValue": 0.000427519
          }
        }
      }
    ]}