Method: properties.reportTasks.query

Récupère le contenu d'une tâche de création 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 ACTIVE. Cette méthode renvoie une erreur si l'état de la tâche de création de rapports n'est pas ACTIVE. Une réponse de requête renvoie les valeurs de ligne et de colonne du rapport sous forme de tableau.

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 du rapport. La première ligne est comptée comme la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage, ou équivaut à définir le décalage sur 0. La première requête renvoie les premières limit de 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 la section Pagination.
limit

string (int64 format)

Facultatif. Nombre de lignes à renvoyer à partir du rapport. Si ce paramètre n'est pas spécifié, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 250 000 lignes par requête, quel que soit le nombre de lignes que vous demandez. limit doit être positif.

L'API peut également renvoyer moins de lignes que l'limit demandée, si le nombre de valeurs de dimension est inférieur à celui de l'limit. Le nombre de lignes disponibles pour une requête QueryReportTaskRequest est également limité par la limite de la tâche de rapport associée. Une requête ne peut pas récupérer plus de lignes que 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 ne renverra au maximum que 100 lignes.

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 création 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 et l'ordre des éléments "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 nécessaire, les valeurs totales des métriques.
maximums[]

object (Row)

Si demandé, les valeurs maximales des métriques.
minimums[]

object (Row)

Si nécessaire, 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,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "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 la ligne "(autre)". 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 requête contient un filtre sur sessionSource = google. Ce paramètre sera toujours renseigné si une 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 "(autre)" et de l'échantillonnage de données.
samplingMetadatas[]

object (SamplingMetadata)

Si les résultats de ce rapport sont échantillonnés, cela décrit le pourcentage d'événements utilisés dans ce rapport. Un samplingMetadatas est renseigné pour chaque période. Chaque samplingMetadatas correspond à une plage de dates, conformément aux plages de dates spécifiées dans la requête.

Toutefois, si les résultats ne sont pas échantillonnés, ce champ ne sera pas défini.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Décrit les restrictions de schéma 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 la devise utilisée dans ce rapport. Destiné à mettre en forme des métriques de devise telles que purchaseRevenue pour la visualisation. Si le paramètre "currencyCode" a été spécifié dans la requête, ce paramètre de réponse s'affichera en écho du paramètre de requête. Sinon, il s'agit du code de devise actuel de la propriété.

Les codes de devise sont des chaînes d'encodage des types de devises de la norme ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217), par exemple "USD", "EUR", "JPY". Pour en savoir plus, consultez https://support.google.com/analytics/answer/9796179.
timeZone

string

Fuseau horaire actuel de l'établissement. Destiné à interpréter les dimensions basées sur le temps, comme hour et minute. Formaté 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".
emptyReason

string

Si aucun motif n'est spécifié, le rapport est vide.
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 requête soit soumise à un seuil et qu'aucune donnée ne soit absente du rapport. Cela se produit lorsque toutes les données sont supérieures aux seuils. Pour en savoir plus, consultez les pages Seuils de données et À propos des données démographiques et des centres d'intérêt.

SchemaRestrictionResponse

Les restrictions de schéma 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 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 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 limitée.

RestrictedMetricType

Catégories de données que vous ne pouvez peut-être pas consulter dans certaines propriétés Google Analytics.

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.