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 de l'API Admin v1 runAccessReport. Ce rapport indique chaque fois qu'un utilisateur lit des données Google Analytics. Les enregistrements d'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 sur l'accès aux données 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 d'utilisation de la bibliothèque cliente Python qui exécute une requête d'accès aux données et affiche la réponse.

Python

google-analytics-admin/properties_run_access_report.py
Ouvrir dans Cloud Shell Afficher sur GitHub 
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}")

Fonctionnalités partagées avec les rapports principaux

Les requêtes de rapports sur l'accès aux données ont la même sémantique que les requêtes de rapports principaux pour de nombreuses fonctionnalités courantes. Par exemple la pagination, les filtres de dimension et les périodes se comportent de la même manière dans les deux types de rapports.

Familiarisez-vous avec la présentation des rapports principaux dans l'API Data v1, puis revenez à 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 runAccessReport pour demander un rapport sur l'accès aux données.

Sélectionner une entité de rapport

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

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

Le rapport sur l'accès aux données obtenu est généré en fonction des enregistrements d'accès aux données Google Analytics pour la propriété Google Analytics 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 API fournissent un paramètre property qui attend une chaîne au format properties/GA_PROPERTY_ID. Consultez l'extrait de code snippet au début de cette page pour obtenir 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 à 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 de dimension dans les réponses de 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 le schéma d'accès aux données pour obtenir la liste complète des noms de dimensions et de métriques disponibles dans les requêtes de rapports sur l'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 les paramètres de requête suivants :

  • Au moins une entrée valide dans le champ des date périodes.
  • Au moins une entrée valide dans le champ des dimensions.
  • Si vous n'utilisez pas la dimension epochTimeMicros, au moins une entrée valide dans le champ des 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 d'adresses e-mail d'utilisateurs, la dernière fois qu'ils ont accédé à la propriété spécifiée au cours des sept derniers jours et le nombre d'accès correspondant.

HTTP

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 est principalement constituée d'un en-tête et de lignes. L'en-tête se compose de AccessDimensionHeaders et AccessMetricHeaders , qui listent les colonnes du rapport.

Chaque ligne du rapport d'accès se compose de 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 à la requête précédente :

{
  "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 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.

HTTP

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 metricFilter champ de l' RunAccessReportRequest objet peut être utilisé pour limiter la réponse du rapport à des valeurs de métrique 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 qui ont accédé à la propriété spécifiée plus de 100 fois.

HTTP

{
  "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

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

Heure (epoch) du dernier accès (en microsecondes) Adresse e-mail de l'utilisateur Nombre d'accès
1525220215025371 Bola@example.net 5
1525220215028361 Alex@example.net 36
1525220215027671 Charlie@example.net 1153
1525220215027341 Mahan@example.net 1

Ce rapport peut être généré en interrogeant les dimensions mostRecentAccessEpochTimeMicros, userEmail et la accessCount métrique. Le rapport contient une ligne par utilisateur : mostRecentAccessEpochTimeMicros la dimension 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' epoch) pour chaque ligne.

Répartition des accès utilisateur

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

Heure (epoch) du dernier accès (en microsecondes) Adresse e-mail de l'utilisateur Mécanisme d'accès Nombre d'accès
1525220215028367 Alex@example.net Firebase 31
1525220215555778 Alex@example.net Interface utilisateur Google Analytics 1
1525220215022378 Bola@example.net Interface utilisateur Google Analytics 65
1525220215026389 Bola@example.net API Google Analytics 894
1525220215025631 Charlie@example.net API Google Analytics 67
1525220215068325 Mahan@example.net Google Ads 3

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

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 à la propriété

Il est possible de générer un rapport pour une propriété sans le décomposer 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 :

ID de propriété avec accès Nom de la propriété avec accès Mécanisme d'accès Nombre d'accès
12345678 DemoApp Firebase 31
12345678 DemoApp Interface utilisateur Google Analytics 624
12345678 DemoApp Google Ads 83
12345678 DemoApp API Google Analytics 1744

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

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

Accès individuel aux données

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 fois qu'un utilisateur a accédé à la propriété spécifiée.

Epoch Unix en microsecondes Adresse e-mail de l'utilisateur ID de propriété avec accès Nom de la propriété avec accès Adresse IP de l'utilisateur Mécanisme d'accès Données de coût renvoyées Données sur les revenus renvoyées
1525220215025371 Bola@example.net 12345678 DemoApp 1.2.3.1 Interface utilisateur Google Analytics true true
1525220645645645 Mahan@example.net 12345678 DemoApp 1.2.3.5 Interface utilisateur Google Analytics faux faux
1525220211312322 Bola@example.net 12345678 DemoApp 11.22.33.11 Google Ads true faux
1525220210234221 Alex@example.net 12345678 DemoApp 11.22.33.22 Firebase faux faux
1525220215028368 Alex@example.net 12345678 DemoApp 1.2.3.2 Google Ads faux faux
1525220214234231 Mahan@example.net 12345678 DemoApp 11.22.33.55 Google Ads true true
1525220423423452 Charlie@example.net 12345678 DemoApp 1.2.3.3 API Google Analytics true faux
1525220132312333 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Ads true true

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