Method: properties.runAccessReport

Renvoie un rapport personnalisé sur les enregistrements d'accès aux données. Le rapport enregistre chaque fois qu'un utilisateur lit des données de rapport Google Analytics. Les enregistrements d'accès sont conservés pendant deux ans maximum.

Vous pouvez demander des rapports sur l'accès aux données pour une propriété. Vous pouvez demander des rapports pour n'importe quelle propriété, mais les dimensions qui ne sont pas liées aux quotas ne peuvent être demandées que pour les propriétés Google Analytics 360. Cette méthode n'est disponible que pour les administrateurs.

Ces enregistrements d'accès aux données incluent les rapports de l'interface utilisateur GA, les explorations de l'interface utilisateur GA, l'API GA Data et d'autres produits tels que Firebase et AdMob, qui peuvent récupérer des données Google Analytics via une association. Ces enregistrements n'incluent pas les modifications de configuration de la propriété, comme l'ajout d'un flux ou la modification du fuseau horaire d'une propriété. Pour consulter l'historique des modifications de configuration, consultez searchChangeHistoryEvents.

Pour nous envoyer vos commentaires sur cette API, remplissez le formulaire de commentaires sur les rapports sur l'accès Google Analytics.

Requête HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
entity

string

Le rapport sur l'accès aux données permet de demander l'accès au niveau de la propriété ou du compte. Si vous les demandez au niveau du compte, les rapports sur l'accès aux données incluent tous les accès pour toutes les propriétés de ce compte.

Pour effectuer une requête au niveau de la propriété, l'entité doit être, par exemple, "properties/123" si "123" est l'ID de votre propriété Google Analytics. Pour effectuer une requête au niveau du compte, l'entité doit être, par exemple, "accounts/1234" si "1234" est l'ID de votre compte Google Analytics.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
Champs
dimensions[]

object (AccessDimension)

Dimensions demandées et affichées dans la réponse. Les requêtes sont autorisées jusqu'à neuf dimensions.

metrics[]

object (AccessMetric)

Métriques demandées et affichées dans la réponse. Les requêtes peuvent contenir jusqu'à 10 métriques.

dateRanges[]

object (AccessDateRange)

Intervalles de dates des enregistrements d'accès à lire. Si plusieurs périodes sont demandées, chaque ligne de réponse contient un indice de période basé sur zéro. Si deux périodes se chevauchent, les enregistrements d'accès pour les jours qui se chevauchent sont inclus dans les lignes de réponse pour les deux périodes. Vous pouvez demander jusqu'à deux plages de dates.

dimensionFilter

object (AccessFilterExpression)

Les filtres de dimension vous permettent de limiter la réponse du rapport à des valeurs de dimension spécifiques qui correspondent au filtre. Par exemple, filtrer les enregistrements d'accès d'un seul utilisateur. Pour en savoir plus, consultez Principes de base des filtres de dimension pour obtenir des exemples. Vous ne pouvez pas utiliser de métriques dans ce filtre.

metricFilter

object (AccessFilterExpression)

Les filtres de métriques vous permettent de limiter la réponse du rapport aux valeurs de métriques spécifiques qui correspondent au filtre. Les filtres de métriques sont appliqués après l'agrégation des lignes du rapport, comme la clause HAVING en SQL. Les dimensions ne peuvent pas être utilisées dans ce filtre.

offset

string (int64 format)

Nombre de lignes de la ligne de début. La première ligne est comptée comme la ligne 0. Si le décalage n'est pas spécifié, il est traité comme 0. Si le décalage est nul, cette méthode renvoie la première page de résultats avec des entrées limit.

Pour en savoir plus sur ce paramètre de pagination, consultez Pagination.

limit

string (int64 format)

Nombre de lignes à renvoyer. Si ce paramètre n'est pas spécifié, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 100 000 lignes par requête, quel que soit le nombre de lignes que vous demandez. limit doit être positif.

L'API peut renvoyer moins de lignes que l'limit demandée, si le nombre de lignes restantes n'est pas égal à celui de l'limit. Par exemple, il existe moins de 300 valeurs possibles pour la dimension country. Par conséquent, si vous n'utilisez que country dans vos rapports, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez limit sur une valeur plus élevée.

Pour en savoir plus sur ce paramètre de pagination, consultez Pagination.

timeZone

string

Fuseau horaire de cette requête, le cas échéant. Si aucune valeur n'est spécifiée, le fuseau horaire de la propriété est utilisé. Le fuseau horaire de la requête est utilisé pour interpréter les dates de début et de fin du rapport.

Formatées sous forme de chaînes issues de la base de données des fuseaux horaires IANA (https://www.iana.org/time-zones), par exemple "Amérique/New_York" ou "Asie/Tokyo".

orderBys[]

object (AccessOrderBy)

Spécifie l'ordre des lignes dans la réponse.

returnEntityQuota

boolean

Indique si l'état actuel du quota de cette propriété Analytics doit être renvoyé. Le quota est renvoyé dans AccessQuota. Pour les demandes au niveau du compte, ce champ doit être défini sur "false".

includeAllUsers

boolean

Facultatif. Indique si les utilisateurs qui n'ont jamais effectué d'appel d'API doivent être inclus dans la réponse. Si cette valeur est définie sur "True", tous les utilisateurs ayant accès à la propriété ou au compte spécifiés sont inclus dans la réponse, qu'ils aient effectué un appel d'API ou non. Si la valeur est "false", seuls les utilisateurs ayant effectué un appel d'API seront inclus.

expandGroups

boolean

Facultatif. Indique si les utilisateurs doivent être renvoyés dans des groupes d'utilisateurs. Ce champ ne fonctionne que lorsque "includeAllUsers" est défini sur "true". Si la valeur est "true", tous les utilisateurs ayant accès à la propriété ou au compte spécifiés sont renvoyés. Si la valeur est "false", seuls les utilisateurs disposant d'un accès direct sont renvoyés.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de RunAccessReportResponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit