REST Resource: properties.reportTasks

{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}

string

Uniquement en sortie. Identifiant. Nom de la ressource de la tâche de rapport attribué lors de la création. Format : "properties/{property}/reportTasks/{reportTask}"

object (ReportDefinition)

Facultatif. Définition d'un rapport permettant d'extraire les données de rapport, qui décrivent la structure d'un rapport. Il comprend généralement les champs qui seront inclus dans le rapport et les critères qui seront utilisés pour filtrer les données.

object (ReportMetadata)

Uniquement en sortie. Métadonnées du rapport pour une tâche de rapport spécifique, qui fournissent des informations sur un rapport. Il inclut généralement les informations suivantes: nom de la ressource du rapport, état du rapport, code temporel de création du rapport, etc.

{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean
}

object (Dimension)

Facultatif. Dimensions demandées et affichées.

object (Metric)

Facultatif. Métriques demandées et affichées.

object (DateRange)

Facultatif. Plages de dates des données à lire. Si plusieurs plages de dates sont demandées, chaque ligne de réponse contiendra un index de plage de dates basé sur zéro. Si deux plages de dates se chevauchent, les données d'événement des jours concernés sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une demande de cohorte, ce dateRanges ne doit pas être spécifié.

object (FilterExpression)

Facultatif. Les filtres de dimensions vous permettent de demander uniquement des valeurs de dimensions spécifiques dans le rapport. Pour en savoir plus et voir des exemples, reportez-vous à la section Principes de base des filtres de dimensions. Impossible d'utiliser des métriques dans ce filtre.

object (FilterExpression)

Facultatif. Clause de filtre des métriques. Appliqué après avoir agrégé les lignes du rapport, de la même manière que la clause SQL "Hunter". Impossible d'utiliser les dimensions dans ce filtre.

string (int64 format)

Facultatif. Nombre de lignes de la première ligne de l'espace de stockage Google Analytics. La première ligne est comptabilisée comme la ligne 0.

Lorsque vous créez une tâche de rapport, les paramètres offset et limit définissent le sous-ensemble de lignes de données issues de l'espace de stockage Google Analytics à inclure dans le rapport généré. Par exemple, s'il existe un total de 300 000 lignes dans l'espace de stockage Google Analytics, la tâche de rapport initiale peut comporter les 10 000 premières lignes avec une limite de 10 000 lignes et un décalage de 0. Par la suite, une autre tâche de rapport pourrait couvrir les 10 000 lignes suivantes avec une limite de 10 000 et un décalage de 10 000.

string (int64 format)

Facultatif. Nombre de lignes à afficher dans le 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. Par exemple, il existe moins de 300 valeurs possibles pour la dimension "country". Ainsi, lorsque vous créez un rapport ne portant que sur la country, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez une valeur supérieure pour limit.

enum (MetricAggregation)

Facultatif. Agrégation des métriques Les valeurs des métriques agrégées seront affichées sur les lignes où les dimensionsValues sont définies sur "RESERVED_(MetricAggregation)".

object (OrderBy)

Facultatif. Spécifie l'ordre des lignes dans la réponse.

string

Facultatif. Code de devise au format ISO4217, tel que "AED", "USD" ou "JPY". Si le champ est vide, le rapport utilise la devise par défaut de la propriété.

object (CohortSpec)

Facultatif. Groupe de cohortes associé à cette demande. Si la requête contient un groupe de cohortes, doit être présente.

boolean

Facultatif. Si la valeur est "false" ou si aucune valeur n'est spécifiée, les lignes dont toutes les métriques sont égales à 0 ne sont pas renvoyées. Si la valeur est "true", ces lignes sont renvoyées si elles ne sont pas supprimées séparément par un filtre.

Quel que soit le paramètre keepEmptyRows, seules les données enregistrées par la propriété Google Analytics (GA4) peuvent être affichées dans un rapport.

Par exemple, si une propriété ne consigne jamais d'événement purchase, une requête pour la dimension eventName et la métrique eventCount ne comportera pas de ligne contenant eventName: "purchase". et eventCount: 0.

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

Nom de la dimension. Consultez Dimensions de l'API pour obtenir la liste des noms de dimensions compatibles avec les principales méthodes de création de rapports telles que runReport et batchRunReports. Consultez Dimensions en temps réel pour obtenir la liste des noms de dimensions acceptés par la méthode runRealtimeReport. Consultez la section Dimensions de l'entonnoir pour obtenir la liste des noms de dimensions acceptés par la méthode runFunnelReport.

Si dimensionExpression est spécifié, name peut correspondre à n'importe quelle chaîne que vous souhaitez dans le jeu de caractères autorisé. Par exemple, si une dimensionExpression concatène country et city, vous pouvez appeler cette dimension countryAndCity. Les noms des dimensions que vous choisissez doivent correspondre à l'expression régulière ^[a-zA-Z0-9_]$.

Les dimensions sont référencées par name dans dimensionFilter, orderBys, dimensionExpression et pivots.

object (DimensionExpression)

Une dimension peut être le résultat d'une expression de plusieurs dimensions. Par exemple, dimension "country, city": concatenate(country, ", ", city).

{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}

object (CaseExpression)

Permet de convertir une valeur de dimension en minuscules.

object (CaseExpression)

Permet de convertir une valeur de dimension en majuscules.

object (ConcatenateExpression)

Permet de combiner des valeurs de dimension dans une seule dimension. Par exemple, dimension "country, city": concatenate(country, ", ", city).

{
  "dimensionName": string
}

string

Nom d'une dimension. Le nom doit faire référence à un nom figurant dans le champ "Dimensions" de la requête.

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

Noms des dimensions. Les noms doivent faire référence aux noms indiqués dans le champ "Dimensions" de la requête.

string

Délimiteur placé entre les noms de dimension.

Les délimiteurs sont souvent des caractères uniques tels que "|". ou "," mais il peut s'agir de chaînes plus longues. Si une valeur de dimension contient le délimiteur, les deux seront présents en réponse sans distinction. Par exemple, si la valeur de la dimension 1 = "US,FR", la valeur de la dimension 2 = "JP" et le séparateur = ", la réponse contiendra "US,FR,JP".

{
  "name": string,
  "expression": string,
  "invisible": boolean
}

string

Nom de la métrique. Consultez Métriques de l'API pour obtenir la liste des noms de métriques acceptés par les principales méthodes de création de rapports telles que runReport et batchRunReports. Consultez la section Métriques en temps réel pour obtenir la liste des noms de métriques acceptés par la méthode runRealtimeReport. Consultez Métriques sur les entonnoirs pour obtenir la liste des noms de métriques acceptés par la méthode runFunnelReport.

Si expression est spécifié, name peut correspondre à n'importe quelle chaîne que vous souhaitez dans le jeu de caractères autorisé. Par exemple, si expression correspond à screenPageViews/sessions, vous pouvez appeler cette métrique comme nom = viewsPerSession. Les noms des métriques que vous choisissez doivent correspondre à l'expression régulière ^[a-zA-Z0-9_]$.

Les métriques sont référencées par name dans metricFilter, orderBys et la métrique expression.

string

Expression mathématique utilisée pour les métriques dérivées. Par exemple, la métrique "Nombre d'événements par utilisateur" est eventCount/totalUsers.

boolean

Indique si une métrique est invisible dans la réponse du rapport. Si une métrique est invisible, elle ne génère pas de colonne dans la réponse, mais elle peut être utilisée dans metricFilter, orderBys ou une métrique expression.

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

Date de début (incluse) de la requête au format YYYY-MM-DD. Ne peut pas être postérieure à endDate. Le format NdaysAgo, yesterday ou today est également accepté. Dans ce cas, la date est déduite en fonction du fuseau horaire des rapports de la propriété.

string

Date de fin inclusive de la requête au format YYYY-MM-DD. Ne peut pas être antérieure au startDate. Le format NdaysAgo, yesterday ou today est également accepté. Dans ce cas, la date est déduite en fonction du fuseau horaire des rapports de la propriété.

string

Attribue un nom à cette plage de dates. La dimension "dateRange" prend ce nom sous ce nom dans une réponse de rapport. S'il est défini, il ne peut pas commencer par date_range_ ni par RESERVED_. Si cette règle n'est pas configurée, les plages de dates sont nommées d'après leur index basé sur zéro dans la requête: date_range_0, date_range_1, etc.

{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}

object (FilterExpressionList)

Les filterExpressions dans andGroup sont liés par une relation AND.

object (FilterExpressionList)

Les filtres "FilterExpressions" dans orGroup ont une relation OR.

object (FilterExpression)

La valeur "FilterExpression" n'est PAS "notExpression".

object (Filter)

Un filtre primitif. Dans une même "FilterExpression", tous les noms de champs du filtre doivent correspondre à toutes les dimensions ou à toutes les métriques.

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

Liste d'expressions de filtre.

{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}

string

Nom de la dimension ou de la métrique. Doit être un nom défini dans les dimensions ou les métriques.

object (StringFilter)

Filtre lié aux chaînes.

object (InListFilter)

Filtre dans les valeurs de la liste.

object (NumericFilter)

Filtre pour les valeurs numériques ou de date.

object (BetweenFilter)

Filtre entre deux valeurs.

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

Type de correspondance de ce filtre.

string

Valeur de chaîne utilisée pour la mise en correspondance.

boolean

Si la valeur est "true", la valeur de la chaîne est sensible à la casse.

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

Liste des valeurs de chaîne. Ce champ ne doit pas être vide.

boolean

Si la valeur est "true", la valeur de la chaîne est sensible à la casse.

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

Type d'opération pour ce filtre.

object (NumericValue)

Valeur numérique ou valeur de date.

{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}

string (int64 format)

Valeur entière

number

Valeur double

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

Commence par ce nombre.

object (NumericValue)

Se termine par ce numéro.

{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}

boolean

Si la valeur est "true", effectue le tri dans l'ordre décroissant.

object (MetricOrderBy)

Trie les résultats en fonction des valeurs d'une métrique.

object (DimensionOrderBy)

Trie les résultats en fonction des valeurs d'une dimension.

{
  "metricName": string
}

string

Nom de métrique dans la requête pour trier les données.

{
  "dimensionName": string,
  "orderType": enum (OrderType)
}

string

Nom de dimension dans la demande de tri.

enum (OrderType)

Contrôle la règle d'ordre des valeurs de dimension.

{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}

object (Cohort)

Définit les critères de sélection pour regrouper les utilisateurs en cohortes.

La plupart des rapports sur les cohortes ne définissent qu'une seule cohorte. Si plusieurs cohortes sont spécifiées, chacune d'elles peut être reconnue dans le rapport par son nom.

object (CohortsRange)

Les rapports sur les cohortes suivent les cohortes sur une période étendue. Cette plage spécifie une durée de décalage sur laquelle suivre les cohortes.

object (CohortReportSettings)

Paramètres facultatifs d'un rapport sur les cohortes.

{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}

string

Attribue un nom à cette cohorte. La dimension "cohort" prend ce nom sous ce nom dans une réponse de rapport. S'il est défini, il ne peut pas commencer par cohort_ ni par RESERVED_. Si cette règle n'est pas configurée, les cohortes sont nommées d'après leur index basé sur zéro (cohort_0, cohort_1, etc.).

string

Dimension utilisée par la cohorte. Obligatoire et n'est compatible qu'avec firstSessionDate.

object (DateRange)

La cohorte sélectionne les utilisateurs dont la première date de contact est comprise entre la date de début et la date de fin définies dans les dateRange. Cet élément dateRange ne spécifie pas la plage de dates complète des données d'événement qui figurent dans un rapport sur les cohortes. Dans un rapport sur les cohortes, ce dateRange est étendu par la précision et le décalage présents dans cohortsRange. les données d'événement correspondant à la période étendue sont présentes dans le rapport sur les cohortes.

Dans une demande de cohorte, cet élément dateRange est obligatoire, et l'élément dateRanges de l'élément RunReportRequest ou RunPivotReportRequest ne doit pas être spécifié.

Ce dateRange doit généralement être aligné sur la précision de la cohorte. Si CohortsRange utilise une précision quotidienne, cette dateRange ne peut correspondre qu'à un seul jour. Si CohortsRange utilise une précision hebdomadaire, cette dateRange peut être alignée sur une limite de semaine, du dimanche au samedi. Si CohortsRange utilise une précision mensuelle, cette dateRange peut être alignée sur un mois, du premier au dernier jour du mois.

{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}

enum (Granularity)

Obligatoire. Niveau de précision utilisé pour interpréter les valeurs startOffset et endOffset pour la période étendue d'un rapport sur une cohorte.

integer

startOffset indique la date de début de la période étendue d'un rapport sur une cohorte. La valeur startOffset est généralement définie sur 0 afin que les rapports contiennent les données issues de l'acquisition de la cohorte.

Si granularity correspond à DAILY, la valeur startDate de la plage de dates étendue du rapport correspond à startDate de la cohorte plus startOffset jours.

Si granularity correspond à WEEKLY, la valeur startDate de la plage de dates étendue du rapport correspond à startDate de la cohorte plus startOffset * 7 jours.

Si granularity correspond à MONTHLY, la valeur startDate de la plage de dates étendue du rapport correspond à startDate de la cohorte plus startOffset * 30 jours.

integer

Obligatoire. endOffset indique la date de fin de la période étendue d'un rapport sur une cohorte. endOffset peut correspondre à n'importe quel entier positif, mais sa valeur est généralement comprise entre 5 et 10 afin que les rapports contiennent des données sur la cohorte pour les périodes de précision suivantes.

Si granularity correspond à DAILY, la valeur endDate de la plage de dates étendue du rapport correspond à endDate de la cohorte plus endOffset jours.

Si granularity correspond à WEEKLY, la valeur endDate de la plage de dates étendue du rapport correspond à endDate de la cohorte plus endOffset * 7 jours.

Si granularity correspond à MONTHLY, la valeur endDate de la plage de dates étendue du rapport correspond à endDate de la cohorte plus endOffset * 30 jours.

{
  "accumulate": boolean
}

boolean

Si la valeur est "true", le résultat s'accumule entre le premier jour de contact et le jour de la fin. Non disponible dans ce pays : RunReportRequest.

{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}

integer

Uniquement en sortie. Quota total de jetons facturés lors de la création du rapport. Étant donné que ce nombre de jetons est basé sur l'activité à partir de l'état CREATING, cette facturation de jetons sera corrigée dès qu'une tâche de rapport passera à l'état ACTIVE ou FAILED.

enum (State)

Uniquement en sortie. État actuel de cette tâche de rapport.

string (Timestamp format)

Uniquement en sortie. Heure à laquelle reportTasks.create a été appelé et où le rapport a commencé à l'état CREATING.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

integer

Uniquement en sortie. Nombre total de lignes dans le résultat du rapport. Ce champ sera renseigné lorsque l'état sera actif. Vous pouvez utiliser taskRowCount pour la pagination dans les limites du rapport existant.

string

Uniquement en sortie. Un message d'erreur s'affiche si une tâche de rapport échoue lors de sa création.

integer

Uniquement en sortie. Nombre total de lignes dans l'espace de stockage Google Analytics. Si vous souhaitez interroger des lignes de données supplémentaires au-delà du rapport actuel, il peut lancer une nouvelle tâche de rapport en fonction de l'totalRowCount.

taskRowCount représente le nombre de lignes spécifiques au rapport actuel, tandis que totalRowCount englobe le nombre total de lignes pour l'ensemble des données extraites de l'espace de stockage Google Analytics.

Par exemple, supposons que la valeur taskRowCount du rapport actuel soit égale à 20, ce qui affiche les données des 20 premières lignes. Simultanément, la valeur de totalRowCount est de 30, ce qui indique la présence de données pour les 30 lignes. taskRowCount peut être utilisé pour paginer les 20 premières lignes. Pour développer le rapport et inclure les données des 30 lignes, vous pouvez créer une tâche de rapport à l'aide de totalRowCount pour accéder à l'ensemble complet des 30 lignes. de données.