Rapports sur l'accès aux données

Vous pouvez créer des rapports sur l'accès aux données à l'aide de la méthode runAccessReport de l'API Admin v1. Ce rapport indique chaque fois qu'un utilisateur lit des données Google Analytics. Les enregistrements des accès aux données 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.

Demander un rapport sur l'accès aux données à l'aide de la bibliothèque cliente

Le moyen le plus rapide de commencer à utiliser les rapports Data Access consiste à utiliser les bibliothèques clientes.

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

Voici un exemple utilisant la bibliothèque cliente Python qui exécute une requête d'accès aux données et affiche 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

Fonctionnalités partagées avec les rapports Core

Les requêtes de rapport Data Access ont la même sémantique que les requêtes de rapport de base pour de nombreuses fonctionnalités courantes. Par exemple, la pagination, les filtres de dimension et les plages de dates se comportent de la même manière dans les deux types de rapports.

Familiarisez-vous avec la présentation des rapports principaux de la version 1 de l'API Data, puis revenez sur cette page pour en savoir plus sur les rapports sur l'accès aux données.

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

Utilisez la méthode runAccessReport pour demander un rapport sur l'accès aux données.

Sélectionnez une entité de reporting.

Comme pour la fonctionnalité de création de rapports de base de la version 1 de l'API Data, la méthode runAccessReport de la version 1 de l'API Google Analytics Admin nécessite que l'identifiant de la propriété Google Analytics soit spécifié dans un chemin de requête d'URL sous la forme properties/GA_PROPERTY_ID, par exemple:

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

Le rapport "Accès aux données" généré est basé sur les enregistrements d'accès aux données Google Analytics de la propriété Google Analytics spécifiée.

Si vous utilisez l'une des bibliothèques clientes de l'API Admin, vous n'avez pas besoin de manipuler manuellement le chemin d'URL de la requête. La plupart des clients d'API fournissent un paramètre property qui attend une chaîne au format properties/GA_PROPERTY_ID. Consultez l'extrait de code au début de cette page pour voir un exemple d'utilisation des bibliothèques clientes.

Choisir des dimensions et des métriques

Les dimensions décrivent et regroupent les données d'accès de votre propriété. Par exemple, la dimension userEmail indique l'adresse e-mail de l'utilisateur qui a accédé aux données de reporting. Les valeurs de dimension dans les réponses aux rapports 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 le schéma d'accès aux données pour obtenir la liste complète des noms de dimension et de métrique disponibles dans les requêtes de rapports d'accès aux données.

Demander le rapport

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

• 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 métriques 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 une liste des adresses e-mail des utilisateurs, la date et l'heure de leur dernier accès à 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/GA_PROPERTY_ID:runAccessReport
{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "mostRecentAccessEpochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    }
  ],
  "metrics": [
    {
      "metricName": "accessCount"
    }
  ]
}

Lire la réponse

La réponse du rapport sur l'accès aux données se compose principalement d'un en-tête et de lignes. L'en-tête se compose de AccessDimensionHeaders et de AccessMetricHeaders, qui listent les colonnes du rapport.

Chaque ligne du rapport sur l'accès se compose de AccessDimensionValues et de 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 aux 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 sur 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/GA_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étrique spécifiques correspondant 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é à la propriété spécifiée plus de 100 fois.

{
  "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 que vous pouvez essayer.

Dernier accès

Exemple de rapport sur l'accès pouvant ê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 l'heure du dernier accès (en microsecondes Unix depuis l'époque) pour chaque ligne.

Répartition de l'accès des utilisateurs

Un autre exemple de rapport utile est la répartition des accès des utilisateurs 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 et accessMechanism, ainsi que la métrique accessCount.

Le rapport contient une ligne par 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é.

Présentation de l'accès aux propriétés

Vous pouvez générer un rapport pour une propriété sans le répartir par utilisateur. Par exemple, le rapport suivant indique la fréquence d'accès à une propriété à l'aide de différents mécanismes d'accès:

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

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

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 un seul accès aux données.

Le rapport suivant contient des informations détaillées sur chaque fois qu'un utilisateur a accédé à 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.