Method: accounts.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 sans quota ne peuvent être demandées que sur 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 comme Firebase et AdMob peut récupérer des données de Google Analytics grâce à une association. Ces enregistrements n'incluent pas les modifications de configuration des propriétés (ajout d'un flux ou modification du fuseau horaire d'une propriété, par exemple). Pour en savoir plus sur l'historique des modifications de configuration, consultez searchChangeHistoryEvents.

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

Requête HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=accounts/*}: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 d'effectuer des demandes au niveau de la propriété ou du compte. S'ils sont demandés 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 correspondre à "properties/123". si "123" correspond à l'ID de votre propriété GA4. Pour effectuer une demande au niveau du compte, l'entité doit être, par exemple, "accounts/1234" si "1234" est votre ID de compte GA4.

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 demandes peuvent comporter jusqu'à neuf dimensions.
metrics[]

object (AccessMetric)

Métriques demandées et affichées dans la réponse. Vous pouvez envoyer jusqu'à 10 métriques par requête.
dateRanges[]

object (AccessDateRange)

Plages de dates des enregistrements d'accès à lire. Si plusieurs plages de dates sont demandées, chaque ligne de réponse contiendra un index de plage de dates basé sur zéro. Si deux plages de dates se chevauchent, les enregistrements d'accès correspondant aux jours concernés sont inclus dans les lignes de réponse correspondant aux deux plages de dates. Les requêtes peuvent comporter jusqu'à deux plages de dates.
dimensionFilter

object (AccessFilterExpression)

Les filtres de dimensions vous permettent de limiter la réponse du rapport à des valeurs de dimension spécifiques qui correspondent au filtre. Par exemple, le filtrage sur les enregistrements d'accès d'un seul utilisateur. Pour en savoir plus et voir des exemples, reportez-vous à la section Principes de base des filtres de dimensions. Impossible d'utiliser des métriques dans ce filtre.
metricFilter

object (AccessFilterExpression)

Les filtres de métriques vous permettent de limiter la réponse du rapport à des valeurs de métriques spécifiques qui correspondent au filtre. Les filtres de métriques sont appliqués après avoir agrégé les lignes du rapport, de la même manière que la clause SQL "have-clause". Impossible d'utiliser des dimensions dans ce filtre.
offset

string (int64 format)

Nombre de lignes de la première ligne. La première ligne est comptabilisée comme la ligne 0. Si le décalage n'est pas spécifié, il est traité comme 0. Si le décalage est égal à zéro, 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 la section Pagination.
limit

string (int64 format)

Nombre de lignes à afficher. Si aucune valeur n'est spécifiée, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 100 000 lignes par requête, quel que soit le nombre demandé. La valeur de limit doit être positive.

L'API peut renvoyer moins de lignes que la valeur limit demandée s'il ne reste pas autant de lignes que limit. Par exemple, il existe moins de 300 valeurs possibles pour la dimension "country". Ainsi, lorsque vous créez un rapport ne portant que sur la country, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez une valeur supérieure pour limit.

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

string

Fuseau horaire de cette requête, si spécifié. S'il n'est pas spécifié, le fuseau horaire de la propriété est utilisé. Le fuseau horaire de la requête permet d'interpréter les dates de début et de fin les dates de fin du rapport.

Mis en forme en tant que chaînes issues de la base de données des fuseaux horaires de l'IANA (https://www.iana.org/time-zones). Exemple : "Amérique/New_York" ou "Asia/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 affiché. Le quota est renvoyé dans AccessQuota. Pour les demandes au niveau du compte, ce champ doit être défini sur "false".
includeAllUsers

boolean

Facultatif. Détermine si les utilisateurs qui n'ont jamais effectué d'appel d'API doivent être inclus dans la réponse. Si la valeur est "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 ou non effectué un appel d'API. Si la valeur est "false", seuls les utilisateurs ayant effectué un appel d'API seront inclus.
expandGroups

boolean

Facultatif. Détermine si les utilisateurs figurant dans les groupes d'utilisateurs doivent être affichés. Ce champ ne fonctionne que si 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é sont renvoyés. Si la valeur est "false", seuls les utilisateurs bénéficiant 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