Method: properties.reportTasks.query

Récupère le contenu d'une tâche de rapport. Une fois que vous avez demandé le reportTasks.create, vous pouvez récupérer le contenu du rapport une fois qu'il est ACTIF. Cette méthode renvoie une erreur si l'état de la tâche de rapport n'est pas ACTIVE. Une réponse à une requête renvoie les valeurs des lignes et des colonnes du tableau 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 ligne de début dans le rapport. La première ligne est considérée comme 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 le décalage sur 0. La première requête renvoie les limit premières lignes. La deuxième requête définit le décalage sur le limit de la première requête. La deuxième requête renvoie le deuxième limit de lignes.

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

string (int64 format)

Facultatif. Nombre de lignes à renvoyer à 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é. 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 également limité par la limite de la ReportTask associée. Une requête peut récupérer au maximum ReportTask.limit lignes. Par exemple, si ReportTask a une limite de 1 000, une requête reportTasks.query avec offset=900 et limit=500 renverra au maximum 100 lignes.

Pour en savoir plus sur ce paramètre de pagination, consultez 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 et l'ordre des DimensionHeaders correspondent aux dimensions présentes dans les lignes.
metricHeaders[]

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

Valeurs maximales des métriques, le cas échéant.
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