Method: properties.runAccessReport

Renvoie un rapport personnalisé sur les enregistrements d'accès aux données. Il fournit des enregistrements chaque fois qu'un utilisateur lit les données de rapports Google Analytics. Les enregistrements d'accès sont conservés jusqu'à deux ans.

Vous pouvez demander des rapports sur l'accès aux données pour une propriété. La propriété doit se trouver dans Google Analytics 360. Cette méthode est réservée aux administrateurs.

Ces enregistrements d'accès aux données incluent les rapports GA4 de l'UI, les Explorations de l'UI GA4, l'API GA4 et d'autres produits comme Firebase et AdMob, qui peuvent récupérer les 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 le fuseau horaire d'une propriété. Pour connaître l'historique des modifications de la configuration, consultez searchChangeHistoryEvents.

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

Les demandes de rapports sur l'accès aux données sont effectuées au niveau de la propriété ou du compte. Si elles sont demandées au niveau du compte, les rapports sur l'accès aux données incluent l'accès à toutes les propriétés de ce compte.

Pour effectuer une requête au niveau de la propriété, l'entité doit, par exemple, être "properties/123" si "123" est l'ID de votre propriété GA4. Pour effectuer une demande au niveau du compte, l'entité doit, par exemple, indiquer "accounts/1234" si "1234" correspond à 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
}
Champs
dimensions[]

object (AccessDimension)

Dimensions demandées et affichées dans la réponse. Les demandes peuvent contenir 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)

Plages de dates d'accès à lire. Si plusieurs plages de dates sont demandées, chaque ligne de la réponse contiendra un index basé sur zéro. Si deux plages de dates se chevauchent, les enregistrements d'accès des jours qui se chevauchent sont inclus dans les lignes de réponse pour les deux plages de dates. Les demandes peuvent être associées à deux plages de dates au maximum.

dimensionFilter

object (AccessFilterExpression)

Les filtres de dimensions vous permettent de limiter les réponses des rapports à des valeurs de dimension spécifiques correspondant au filtre. Par exemple, filtrer sur les enregistrements d'accès d'un seul utilisateur. Pour en savoir plus, consultez la section Principes de base des filtres de dimensions. 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 à 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, de la même manière que la clause "have" pour SQL. Impossible d'utiliser des dimensions dans ce filtre.

offset

string (int64 format)

Nombre de lignes sur la ligne de départ. La première ligne est comptabilisée comme ligne 0. Si le décalage n'est pas spécifié, il est traité comme une valeur de 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 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 de lignes demandées. limit doit être positif.

L'API peut renvoyer moins de lignes que la limit demandée, s'il ne reste pas plus de lignes que limit. Par exemple, la dimension country est inférieure à 300 valeurs. Par conséquent, lorsque vous générez un rapport seulement sur country, vous ne pouvez pas obtenir plus de 300 lignes, même si vous avez défini une valeur plus élevée pour limit.

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

timeZone

string

Fuseau horaire de cette requête, si spécifié. Si aucune valeur n'est spécifiée, le fuseau horaire de l'établissement est utilisé. Le fuseau horaire de la requête permet d'interpréter les dates de début et de fin du rapport.

Formaté en tant que chaînes provenant de la base de données du fuseau horaire de l'IANA (https://www.iana.org/time-zones), par exemple "America/New_York" ou "Asia/Tokyo".

orderBys[]

object (AccessOrderBy)

Spécifie l'ordre d'affichage 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 requêtes au niveau du compte, ce champ doit être défini sur "false".

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