Method: properties.reportTasks.query

Récupère le contenu d'une tâche de rapport. Après avoir demandé reportTasks.create, vous pouvez récupérer le contenu du rapport une fois qu'il est à l'état ACTIF. Cette méthode renvoie une erreur si l'état de la tâche de rapport n'est pas ACTIVE. Une réponse à la requête renvoie les valeurs des lignes et colonnes tabulaires du rapport.

Requête HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de la source du rapport. Format : properties/{property}/reportTasks/{report}

Corps de la requête

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

Représentation JSON 
{
  "offset": string,
  "limit": string
}
Champs
offset

string (int64 format)

Facultatif. Nombre de lignes de la première ligne du rapport. La première ligne correspond à la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage ou, de manière équivalente, définit un décalage sur 0. La première requête renvoie les limit premières lignes. La deuxième requête définit un décalage sur le limit de la première requête, tandis que la deuxième renvoie le deuxième limit de lignes.

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

string (int64 format)

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

L'API peut également renvoyer moins de lignes que le limit demandé, s'il n'y a pas autant de valeurs de dimension que le limit. Le nombre de lignes disponibles pour une QueryReportTaskRequest est en outre limité par la limite de la ReportTask associée. Une requête peut extraire un maximum de lignes ReportTask.limit. Par exemple, si la limite de la tâche de rapport est de 1 000, une requête reportTasks.query avec offset=900 et limit=500 renvoie 100 lignes au maximum.

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

Corps de la réponse

Contenu du rapport correspondant à une tâche de rapport.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
Champs
dimensionHeaders[]

object (DimensionHeader)

Décrit les colonnes de dimension. Le nombre de "DimensionHeaders" et leur ordre correspondent aux dimensions présentes dans les lignes.
metricHeaders[]

object (MetricHeader)

Décrit les colonnes de métriques. Le nombre de "MetricHeaders" et leur ordre correspondent aux métriques présentes dans les lignes.
rows[]

object (Row)

Lignes de combinaisons de valeurs de dimension et de valeurs de métriques dans le rapport.
totals[]

object (Row)

Si nécessaire, il s'agit des valeurs totales des métriques.
maximums[]

object (Row)

Si nécessaire, il s'agit des valeurs maximales des métriques.
minimums[]

object (Row)

Si nécessaire, il s'agit des valeurs minimales des métriques.
rowCount

integer

Nombre total de lignes dans le résultat de la requête.
metadata

object (ResponseMetaData)

Métadonnées du rapport.

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

ResponseMetaData

Métadonnées de la réponse contenant des informations supplémentaires sur le contenu du rapport.

Représentation JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Champs
dataLossFromOtherRow

boolean

Si la valeur est "true", cela indique que certains ensembles de combinaisons de dimensions sont regroupés dans une ligne "(other)". Cela peut se produire pour les rapports à cardinalité élevée.

Le paramètre de métadonnées dataLossFromOtherRow est renseigné en fonction du tableau de données agrégées utilisé dans le rapport. Le paramètre sera renseigné avec précision, quels que soient les filtres et les limites du rapport.

Par exemple, la ligne "(other)" peut être supprimée du rapport, car la demande contient un filtre sur sessionSource = google. Ce paramètre sera renseigné si une perte de données sur une autre ligne était présente dans les données agrégées d'entrée utilisées pour générer ce rapport.

Pour en savoir plus, consultez À propos de la ligne "(other)" et de l'échantillonnage de données.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Décrit les restrictions de schéma activement appliquées lors de la création de ce rapport. Pour en savoir plus, consultez Gestion des accès et des restrictions de données.
currencyCode

string

Code de devise utilisé dans ce rapport. Elle est destinée à être utilisée pour mettre en forme des métriques monétaires telles que purchaseRevenue à des fins de visualisation. Si currencyCode a été spécifié dans la requête, ce paramètre de réponse renvoie le paramètre de requête. Sinon, il est le paramètre currencyCode actuel de la propriété.

Les codes de devise sont des encodages de chaîne correspondant à des types de devises conformes à la norme ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217). Par exemple : "USD", "EUR" ou "JPY". Pour en savoir plus, consultez https://support.google.com/analytics/answer/9796179.
timeZone

string

Fuseau horaire actuel de la propriété. Destiné à interpréter des dimensions temporelles telles que hour et minute. 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".
emptyReason

string

Si le motif est vide, le rapport ne l'est pas.
subjectToThresholding

boolean

Si subjectToThresholding est défini sur "true", ce rapport est soumis à un seuil et ne renvoie que les données qui atteignent les seuils minimaux d'agrégation. Il est possible qu'une demande soit soumise à un seuil et qu'aucune donnée ne soit absente du rapport, ce qui se produit lorsque toutes les données sont supérieures aux seuils. Pour en savoir plus, consultez Seuils de données et À propos des données démographiques et des centres d'intérêt.

SchemaRestrictionResponse

Restrictions de schéma appliquées de manière active lors de la création de ce rapport. Pour en savoir plus, consultez Gestion des accès et des restrictions de données.

Représentation JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Champs
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Toutes les restrictions activement appliquées lors de la création du rapport. Par exemple, purchaseRevenue a toujours le type de restriction REVENUE_DATA. Toutefois, cette restriction de réponse active n'est renseignée que si le rôle personnalisé de l'utilisateur interdit l'accès à REVENUE_DATA.

ActiveMetricRestriction

Métrique activement limitée à la création du rapport.

Représentation JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Champs
restrictedMetricTypes[]

enum (RestrictedMetricType)

Motif de la restriction de cette métrique.
metricName

string

Nom de la métrique faisant l'objet de restrictions.

RestrictedMetricType

Catégories de données qu'il est possible que vous ne puissiez pas consulter dans certaines propriétés GA4.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Type non spécifié.
COST_DATA Métriques sur les coûts telles que adCost
REVENUE_DATA Métriques sur les revenus telles que purchaseRevenue