- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Renvoie un rapport personnalisé sur les enregistrements d'accès aux données. 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.
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 au quota 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'UI GA4, les explorations de l'UI GA4, l'API Data de GA4, ainsi que d'autres produits comme Firebase et AdMob qui peuvent récupérer des données de Google Analytics via une association. Ces enregistrements n'incluent pas les modifications apportées à la configuration d'une 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 la configuration, consultez searchChangeHistoryEvents.
Requête HTTP
POST https://analyticsadmin.googleapis.com/v1beta/{entity=properties/*}:runAccessReport
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
entity |
Le rapport sur l'accès aux données permet d'effectuer des requêtes au niveau de la propriété ou du compte. Si cela est demandé au niveau du compte, les rapports sur l'accès aux données incluent tous les droits d'accès à 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, "propriétés/123" si "123" est votre ID de propriété GA4. Pour effectuer une requête 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 ( |
Champs | |
---|---|
dimensions[] |
Dimensions demandées et affichées dans la réponse. Les demandes sont autorisées jusqu'à neuf dimensions. |
metrics[] |
Métriques demandées et affichées dans la réponse. Les requêtes peuvent contenir jusqu'à 10 métriques. |
dateRanges[] |
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 sont inclus dans les lignes de réponse des deux plages de dates. Les demandes sont autorisées sur deux plages de dates maximum. |
dimensionFilter |
Les filtres de dimensions vous permettent de limiter la réponse d'un rapport à des valeurs de dimensions spécifiques correspondant au filtre. Par exemple, filtrer les enregistrements d'accès d'un seul utilisateur. Pour en savoir plus et obtenir des exemples, consultez l'article Principes de base des filtres de dimensions. Impossible d'utiliser des métriques dans ce filtre. |
metricFilter |
Les filtres de métriques vous permettent de limiter la réponse d'un rapport à des valeurs de métriques spécifiques correspondant au filtre. Les filtres de métriques sont appliqués après l'agrégation des lignes du rapport, comme avec la clause SQL "have-clause". Impossible d'utiliser des dimensions avec ce filtre. |
offset |
Nombre de lignes de la première ligne. La première ligne correspond à la ligne 0. Si le décalage n'est pas spécifié, il est considéré comme 0. Si le décalage est de zéro, cette méthode renvoie la première page de résultats avec des entrées Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
limit |
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é. L'API peut renvoyer moins de lignes que le Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
timeZone |
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 demande permet d'interpréter les dates de début et de fin du rapport. Sous la forme de chaînes issues de la base de données des fuseaux horaires de l'IANA (https://www.iana.org/time-zones) ; par exemple "America/New_York" ou "Asia/Tokyo". |
orderBys[] |
Spécifie l'ordre des lignes dans la réponse. |
returnEntityQuota |
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, la valeur de ce champ doit être "false". |
includeAllUsers |
Facultatif. Détermine si la réponse doit inclure les utilisateurs qui n'ont jamais effectué d'appel d'API. 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 |
Facultatif. Détermine si les utilisateurs inclus dans les groupes d'utilisateurs doivent être renvoyé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és sont affiché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