- 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 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 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 GA4 UI Reporting, GA4 UI Explorations, GA4 Data API et 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 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.
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 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 demande au niveau de la propriété, l'entité doit être par exemple "properties/123" si "123" est 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 l'ID de votre 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 peuvent comporter 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[] |
Plage 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 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 |
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, le filtrage sur 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 |
Les filtres de métriques vous permettent de limiter la réponse du rapport à des valeurs de métrique spécifiques correspondant 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 dans la clause SQL Hunter. Vous ne pouvez pas utiliser de dimensions dans ce filtre. |
offset |
Nombre de lignes de la première ligne. 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 Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
limit |
Nombre de lignes à renvoyer. 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 de lignes que vous demandez. L'API peut renvoyer moins de lignes que l' Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
timeZone |
Fuseau horaire de cette requête, le cas échéant. 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 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 du Nord/New_York" ou "Asie/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 renvoyé. Le quota est renvoyé dans AccessQuota. Pour les requêtes au niveau du compte, ce champ doit être défini sur "false". |
includeAllUsers |
Facultatif. Indique 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 effectué un appel d'API ou non. Si la valeur est "false", seuls les utilisateurs ayant effectué un appel d'API seront inclus. |
expandGroups |
Facultatif. Indique si les utilisateurs doivent être renvoyés dans des groupes d'utilisateurs. 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 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