Vue d'ensemble

L'API Admin de Google Analytics v1 vous permet de générer des rapports sur l'accès aux données à l'aide de la méthode runAccessReport. Le rapport enregistre chaque fois qu'un utilisateur lit les données de rapport Google Analytics. Les enregistrements d'accès sont conservés pendant deux ans maximum. Les rapports sur l'accès aux données ne sont disponibles que pour les utilisateurs disposant du rôle Administrateur.

Créer un rapport sur l'accès aux données

Les rapports sur l'accès aux données sont fournis via la méthode runAccessReport.

Fonctionnalités partagées avec les rapports principaux

Les requêtes de rapport sur l'accès aux données ont la même sémantique que les requêtes de rapport principales, pour de nombreuses fonctionnalités partagées. Par exemple, Pagination, Filtres de dimensions et Plages de dates se comportent de la même manière dans les rapports sur l'accès aux données que dans les rapports principaux.

Familiarisez-vous avec la présentation de la fonctionnalité principale de reporting de la version 1 de l'API Data. Le reste de ce document se concentrera sur les fonctionnalités spécifiques aux demandes de rapport sur l'accès aux données.

Sélection d'une entité à l'origine du signalement

Comme pour la fonctionnalité principale de reporting de la version 1 de l'API Data, la méthode runAccessReport de la version 1 de l'API Admin de Google Analytics exige que l'identifiant de propriété Google Analytics 4 soit spécifié dans un chemin de requête d'URL au format properties/GA4_PROPERTY_ID, par exemple:

  POST  https://analyticsadmin.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runAccessReport

Le rapport sur l'accès aux données généré sera généré en fonction des enregistrements d'accès aux données Google Analytics pour la propriété Google Analytics 4 spécifiée.

Si vous utilisez l'une des bibliothèques clientes de l'API Admin, il n'est pas nécessaire de manipuler manuellement le chemin de l'URL de la requête. La plupart des clients d'API fournissent un paramètre property qui attend une chaîne au format properties/GA4_PROPERTY_ID. Consultez l'extrait de code à la fin de ce guide pour découvrir un exemple d'utilisation des bibliothèques clientes.

Dimensions et statistiques

Les dimensions décrivent et regroupent les données d'accès à votre propriété. Par exemple, la dimension userEmail indique l'adresse e-mail de l'utilisateur qui a accédé aux données de rapport. Les valeurs des dimensions dans les réponses au rapport sont des chaînes.

Les métriques représentent les mesures quantitatives d'un rapport. La métrique accessCount renvoie le nombre total d'enregistrements d'accès aux données.

Consultez la page Schéma de l'accès aux données pour obtenir la liste complète des noms de dimensions et de métriques disponibles dans les demandes de rapport sur l'accès aux données.

Demande de rapport sur l'accès aux données

Pour demander des rapports sur l'accès aux données, créez un objet RunAccessReportRequest. Nous vous recommandons de commencer par les paramètres de requête suivants:

• Au moins une entrée valide dans le champ plages de dates.
• Au moins une entrée valide dans le champ dimensions.
• Si vous n'utilisez pas la dimension epochTimeMicros, au moins une entrée valide dans le champ des metrics pour recevoir des données quantitatives pour chaque combinaison de valeurs de dimension dans un rapport.

Voici un exemple de requête avec les champs recommandés. Cette requête génère la liste des adresses e-mail des utilisateurs, la date et l'heure auxquelles ils ont accédé pour la dernière fois à la propriété spécifiée au cours des sept derniers jours, ainsi que le nombre d'accès correspondant.

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runAccessReport
{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "mostRecentAccessEpochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    }
  ],
  "metrics": [
    {
      "metricName": "accessCount"
    }
  ]
}

Signaler la réponse

D'un point de vue conceptuel, la réponse du rapport sur l'accès aux données de la demande de rapport d'accès se compose principalement d'un en-tête et de lignes, comme la fonctionnalité principale de création de rapports de la version 1 de l'API Data. L'en-tête est composé de AccessDimensionHeaders et de AccessMetricHeaders, qui répertorient les colonnes du rapport.

Chaque ligne du rapport d'accès comprend AccessDimensionValues et AccessMetricValues pour les colonnes du rapport. L'ordre des colonnes est cohérent dans la requête, l'en-tête et chaque ligne.

Voici un exemple de réponse à l'exemple de requête précédent:

{
  "dimensionHeaders": [
    {
      "dimensionName": "mostRecentAccessEpochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    }
  ],
  "metricHeaders": [
    {
      "metricName": "accessCount"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "1667591408427733"
        },
        {
          "value": "Bola@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "1238"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1667710959827161"
        },
        {
          "value": "Alex@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "475"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1667868650762743"
        },
        {
          "value": "Mahan@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "96"
        }
      ]
    }
  ],
  "rowCount": 3
}

Filtrer les enregistrements d'accès

Utilisez le champ dimensionFilter de l'objet RunAccessReportRequest pour limiter la réponse du rapport à des valeurs de dimension spécifiques qui correspondent au filtre.

L'exemple suivant génère un rapport basé sur des enregistrements d'accès aux données individuels, en filtrant les enregistrements d'accès d'un seul utilisateur avec l'adresse e-mail Alex@example.net. Le rapport contient l'heure de chaque enregistrement d'accès, l'adresse e-mail et l'adresse IP de l'utilisateur.

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runAccessReport
{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "epochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    },
    {
      "dimensionName": "userIP"
    }
  ],
  "dimensionFilter": {
    "accessFilter": {
      "fieldName": "userEmail",
      "stringFilter": {
        "matchType": "EXACT",
        "value": "Alex@example.net"
      }
    }
  }
}

De même, le champ metricFilter de l'objet RunAccessReportRequest peut être utilisé pour limiter la réponse du rapport à des valeurs de métriques spécifiques qui correspondent au filtre.

L'exemple suivant génère un rapport contenant les adresses e-mail et le nombre d'accès de tous les utilisateurs ayant accédé plus de 100 fois à la propriété spécifiée.

{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "userEmail"
    }
  ],
  "metricFilter": {
    "accessFilter": {
      "numericFilter": {
        "operation": "GREATER_THAN",
        "value": {
          "int64Value": 100
        }
      },
      "fieldName": "accessCount"
    }
  },
  "metrics": [
    {
      "metricName": "accessCount"
    }
  ]
}

Exemples de rapports

Voici quelques exemples de rapports à essayer.

Rapport sur les accès les plus récents par utilisateur

Voici un exemple de rapport d'accès qui peut être créé à l'aide de runAccessReport:

Ce rapport peut être généré en interrogeant les dimensions mostRecentAccessEpochTimeMicros, userEmail et la métrique accessCount. Le rapport contient une ligne par utilisateur: la dimension mostRecentAccessEpochTimeMicros agrège les enregistrements d'accès aux données pour chaque utilisateur accédant à la propriété et renvoie la date et l'heure du dernier accès (en microsecondes Unix depuis l'epoch) pour chaque ligne.

Rapport détaillé des accès utilisateur

Un autre exemple utile de rapport est la répartition des accès utilisateur par mécanisme d'accès (interface utilisateur Google Analytics, API, etc.).

Ce rapport peut être généré en interrogeant les dimensions mostRecentAccessEpochTimeMicros, userEmail, accessMechanism et la statistique accessCount.

Le rapport contient une ligne pour chaque combinaison utilisateur/mécanisme d'accès. La dimension mostRecentAccessEpochTimeMicros contient la dernière fois qu'un utilisateur a accédé à la propriété à l'aide du mécanisme d'accès spécifié.

Rapport "Vue d'ensemble des accès à la propriété"

Il est possible de générer un rapport pour une propriété sans détailler chaque utilisateur. Par exemple, le rapport suivant indique la fréquence à laquelle une propriété est accessible à l'aide de différents mécanismes d'accès:

Ce rapport peut être généré en interrogeant les dimensions accessedPropertyId, accessedPropertyName, accessMechanism et la métrique accessCount.

Le rapport contient une ligne pour chaque combinaison ID de propriété/mécanisme d'accès.

Rapport sur les accès aux données individuelles

Pour générer un rapport dans lequel chaque ligne est basée sur un enregistrement d'accès aux données individuel, omettez la dimension mostRecentAccessEpochTimeMicros d'une requête et utilisez plutôt la dimension epochTimeMicros. Il n'est pas nécessaire d'interroger la métrique accessCount, car chaque ligne du rapport contient des informations sur une seule occurrence d'accès aux données.

Le rapport suivant contient des informations détaillées sur chaque accès d'un utilisateur à la propriété spécifiée.

Ce rapport peut être généré en interrogeant les dimensions epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned et revenueDataReturned.

Bibliothèques clientes

Consultez le guide de démarrage rapide pour découvrir comment installer et configurer les bibliothèques clientes.

Voici un exemple utilisant la bibliothèque cliente Python, qui exécute une requête d'accès aux données et imprime la réponse.

from datetime import datetime

from google.analytics.admin import AnalyticsAdminServiceClient
from google.analytics.admin_v1alpha.types import (
    AccessDateRange,
    AccessDimension,
    AccessMetric,
    RunAccessReportRequest,
)


def run_sample():
    """Runs the sample."""
    # TODO(developer): Replace this variable with your Google Analytics 4
    #  property ID (e.g. "123456") before running the sample.
    property_id = "YOUR-GA4-PROPERTY-ID"
    run_access_report(property_id)


def run_access_report(property_id: str, transport: str = None):
    """
    Runs an access report for a Google Analytics property. The report will
    aggregate over dimensions `userEmail`, `accessedPropertyId`,
    `reportType`, `revenueDataReturned`, `costDataReturned`,
    `userIP`, and return the access count, as well as the most recent access
    time for each combination.
    See https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema
    for the description of each field used in a data access report query.
    Args:
        property_id(str): The Google Analytics Property ID.
        transport(str): The transport to use. For example, "grpc"
            or "rest". If set to None, a transport is chosen automatically.
    """
    client = AnalyticsAdminServiceClient(transport=transport)
    request = RunAccessReportRequest(
        entity=f"properties/{property_id}",
        dimensions=[
            AccessDimension(dimension_name="userEmail"),
            AccessDimension(dimension_name="accessedPropertyId"),
            AccessDimension(dimension_name="reportType"),
            AccessDimension(dimension_name="revenueDataReturned"),
            AccessDimension(dimension_name="costDataReturned"),
            AccessDimension(dimension_name="userIP"),
            AccessDimension(dimension_name="mostRecentAccessEpochTimeMicros"),
        ],
        metrics=[AccessMetric(metric_name="accessCount")],
        date_ranges=[AccessDateRange(start_date="yesterday", end_date="today")],
    )

    access_report = client.run_access_report(request)

    print("Result:")
    print_access_report(access_report)


def print_access_report(response):
    """Prints the access report."""
    print(f"{response.row_count} rows received")
    for dimensionHeader in response.dimension_headers:
        print(f"Dimension header name: {dimensionHeader.dimension_name}")
    for metricHeader in response.metric_headers:
        print(f"Metric header name: {metricHeader.metric_name})")

    for rowIdx, row in enumerate(response.rows):
        print(f"\nRow {rowIdx}")
        for i, dimension_value in enumerate(row.dimension_values):
            dimension_name = response.dimension_headers[i].dimension_name
            if dimension_name.endswith("Micros"):
                # Convert microseconds since Unix Epoch to datetime object.
                dimension_value_formatted = datetime.utcfromtimestamp(
                    int(dimension_value.value) / 1000000
                )
            else:
                dimension_value_formatted = dimension_value.value
            print(f"{dimension_name}: {dimension_value_formatted}")

        for i, metric_value in enumerate(row.metric_values):
            metric_name = response.metric_headers[i].metric_name
            print(f"{metric_name}: {metric_value.value}")

properties_run_access_report.py