Method: properties.reportTasks.query

Récupère le contenu d'une tâche de rapport. Après avoir demandé l'reportTasks.create, vous pouvez récupérer le contenu du rapport une fois que celui-ci est 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 la ligne tabulaire & les valeurs des colonnes 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 est comptabilisée comme la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage ; ou une valeur équivalente, définit le 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 par rapport à la valeur limit de la première requête. la deuxième requête renvoie la deuxième valeur 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 à afficher à partir du rapport. 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é. La valeur de limit doit être positive.

L'API peut également renvoyer moins de lignes que la valeur limit demandée s'il n'y a pas autant de valeurs de dimension que 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 récupérer au maximum lignes ReportTask.limit. Par exemple, si la tâche ReportTask a une limite de 1 000, une requête reportTasks.query avec offset=900 et limit=500 renverra 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 dimensions. Le nombre de DimensionHeaders et l'ordre de ces DimensionHeaders correspondent aux dimensions présentes dans les lignes.
metricHeaders[]

object (MetricHeader)

Décrit les colonnes de métriques. Le nombre d'en-têtes de métriques et leur ordre correspondent aux métriques présentes dans les lignes.
rows[]

object (Row)

Lignes des combinaisons de valeurs des dimensions et des valeurs des métriques dans le rapport
totals[]

object (Row)

Si demandé, les valeurs totales des métriques.
maximums[]

object (Row)

Valeurs maximales des métriques (si demandé).
minimums[]

object (Row)

Si demandé, les 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 signifie que certains ensembles de combinaisons de dimensions sont regroupés dans "(other)". ligne. 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 globales utilisé dans le rapport. Le paramètre sera inséré correctement, 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 basé sur sessionSource = google. Ce paramètre sera quand même renseigné si la perte de données d'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. Destiné à être utilisé pour mettre en forme les métriques monétaires comme purchaseRevenue à des fins de visualisation. Si currencyCode a été spécifié dans la requête, ce paramètre de réponse renvoie l'écho du paramètre de requête. Sinon, ce paramètre de réponse correspond au paramètre currencyCode actuel de la propriété.

Les codes de devise sont des encodages de type de devise sous la forme de chaînes conformes à la norme ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217). Exemple : "USD", "EUR", "JPY". Pour en savoir plus, consultez https://support.google.com/analytics/answer/9796179.
timeZone

string

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

string

Si le motif est vide, le rapport est vide pour cette raison.
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, auquel cas aucune donnée n'est absente du rapport. Cela se produit lorsque toutes les données dépassent les 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 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.

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 est toujours associé au 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

Il s'agit d'une métrique faisant l'objet d'une restriction active lors de la création du rapport.

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

enum (RestrictedMetricType)

Raison 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 que vous ne pouvez peut-être pas consulter sur 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.