REST Resource: properties.reportTasks

Ressource: ReportTask

Une configuration de tâche de rapport spécifique.

Représentation JSON
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Champs
name

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}"

reportDefinition

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.

reportMetadata

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.

ReportDefinition

Définition de la manière dont un rapport doit être généré.

Représentation JSON
{
  "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
}
Champs
dimensions[]

object (Dimension)

Facultatif. Dimensions demandées et affichées.

metrics[]

object (Metric)

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

dateRanges[]

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é.

dimensionFilter

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.

metricFilter

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.

offset

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.

limit

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.

metricAggregations[]

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)".

orderBys[]

object (OrderBy)

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

currencyCode

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é.

cohortSpec

object (CohortSpec)

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

keepEmptyRows

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.

Dimension

Les dimensions correspondent aux attributs de vos données. Par exemple, la dimension "Ville" indique la ville d'où provient un événement. Les valeurs des dimensions dans les réponses au rapport sont des chaînes. Par exemple, la ville peut être "Paris". ou "New York".

Représentation JSON
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Champs
name

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.

dimensionExpression

object (DimensionExpression)

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

DimensionExpression

Permet d'exprimer une dimension résultant d'une formule à plusieurs dimensions. Exemples d'utilisation: 1) lowerCase(dimension) 2) concatenate(dimension1, symbole, dimension2).

Représentation JSON
{

  // 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.
}
Champs
Champ d'union one_expression. Spécifiez un type d'expression de dimension pour DimensionExpression. La one_expression ne peut être qu'un des éléments suivants :
lowerCase

object (CaseExpression)

Permet de convertir une valeur de dimension en minuscules.

upperCase

object (CaseExpression)

Permet de convertir une valeur de dimension en majuscules.

concatenate

object (ConcatenateExpression)

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

CaseExpression

Permet de convertir une valeur de dimension en une seule casse.

Représentation JSON
{
  "dimensionName": string
}
Champs
dimensionName

string

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

ConcatenateExpression

Permet de combiner des valeurs de dimension dans une seule dimension.

Représentation JSON
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Champs
dimensionNames[]

string

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

delimiter

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".

Métrique

Mesures quantitatives d'un rapport. Par exemple, la métrique eventCount correspond au nombre total d'événements. Vous pouvez envoyer jusqu'à 10 métriques par requête.

Représentation JSON
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Champs
name

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.

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.

invisible

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.

DateRange

Un ensemble de jours contigus: startDate, startDate + 1, ..., endDate. Les requêtes peuvent comporter jusqu'à quatre plages de dates.

Représentation JSON
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Champs
startDate

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é.

endDate

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é.

name

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.

FilterExpression

Pour exprimer des filtres de dimensions ou de métriques. Les champs d'une même "FilterExpression" doivent correspondre à toutes les dimensions ou à toutes les métriques.

Représentation JSON
{

  // 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.
}
Champs
Champ d'union expr. Spécifiez un type d'expression de filtre pour FilterExpression. La expr ne peut être qu'un des éléments suivants :
andGroup

object (FilterExpressionList)

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

orGroup

object (FilterExpressionList)

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

notExpression

object (FilterExpression)

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

filter

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.

FilterExpressionList

Liste d'expressions de filtre.

Représentation JSON
{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}
Champs
expressions[]

object (FilterExpression)

Liste d'expressions de filtre.

Filtre

Expression permettant de filtrer les valeurs des dimensions ou des métriques.

Représentation JSON
{
  "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.
}
Champs
fieldName

string

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

Champ d'union one_filter. Spécifiez un type de filtre pour Filter. La one_filter ne peut être qu'un des éléments suivants :
stringFilter

object (StringFilter)

Filtre lié aux chaînes.

inListFilter

object (InListFilter)

Filtre dans les valeurs de la liste.

numericFilter

object (NumericFilter)

Filtre pour les valeurs numériques ou de date.

betweenFilter

object (BetweenFilter)

Filtre entre deux valeurs.

StringFilter

Le filtre pour la chaîne

Représentation JSON
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Champs
matchType

enum (MatchType)

Type de correspondance de ce filtre.

value

string

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

caseSensitive

boolean

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

MatchType

Type de correspondance d'un filtre de chaîne

Enums
MATCH_TYPE_UNSPECIFIED Non spécifié
EXACT Correspondance exacte de la valeur de la chaîne.
BEGINS_WITH Commence par la valeur de la chaîne.
ENDS_WITH Se termine par la valeur de la chaîne.
CONTAINS Contient la valeur de la chaîne.
FULL_REGEXP Correspondance complète pour l'expression régulière avec la valeur de chaîne.
PARTIAL_REGEXP Correspondance partielle de l'expression régulière avec la valeur de chaîne.

InListFilter

Le résultat doit figurer dans une liste de valeurs de chaîne.

Représentation JSON
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Champs
values[]

string

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

caseSensitive

boolean

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

NumericFilter

Filtres pour les valeurs numériques ou de date.

Représentation JSON
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Champs
operation

enum (Operation)

Type d'opération pour ce filtre.

value

object (NumericValue)

Valeur numérique ou valeur de date.

Opération

Opération appliquée à un filtre numérique

Enums
OPERATION_UNSPECIFIED Non spécifié.
EQUAL Égal
LESS_THAN Inférieur à
LESS_THAN_OR_EQUAL Inférieur(e) ou égal(e) à
GREATER_THAN Supérieur(e) à
GREATER_THAN_OR_EQUAL Supérieur(e) ou égal(e) à

NumericValue

Pour représenter un nombre.

Représentation JSON
{

  // 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.
}
Champs
Champ d'union one_value. L'une des valeurs numériques one_value ne peut être que l'un des éléments suivants:
int64Value

string (int64 format)

Valeur entière

doubleValue

number

Valeur double

BetweenFilter

Pour exprimer que le résultat doit être compris entre deux nombres (inclus).

Représentation JSON
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Champs
fromValue

object (NumericValue)

Commence par ce nombre.

toValue

object (NumericValue)

Se termine par ce numéro.

MetricAggregation

Représente l'agrégation de métriques.

Enums
METRIC_AGGREGATION_UNSPECIFIED Opérateur non spécifié.
TOTAL SOMME.
MINIMUM Opérateur minimal.
MAXIMUM Opérateur maximum.
COUNT Opérateur nombre.

OrderBy

Les options "Order by" définissent la façon dont les lignes sont triées dans la réponse. Par exemple, le tri des lignes par nombre décroissant d'événements correspond à un ordre de tri, et le tri des lignes par chaîne de nom d'événement dans un ordre différent.

Représentation JSON
{
  "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.
}
Champs
desc

boolean

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

Champ d'union one_order_by. Spécifiez un type de commande par pour OrderBy. La one_order_by ne peut être qu'un des éléments suivants :
metric

object (MetricOrderBy)

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

dimension

object (DimensionOrderBy)

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

MetricOrderBy

Trie par valeurs de métriques.

Représentation JSON
{
  "metricName": string
}
Champs
metricName

string

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

DimensionOrderBy

Trie par valeurs de dimension.

Représentation JSON
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Champs
dimensionName

string

Nom de dimension dans la demande de tri.

orderType

enum (OrderType)

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

OrderType

Règle permettant de classer les valeurs de dimension de chaîne.

Enums
ORDER_TYPE_UNSPECIFIED Non spécifié.
ALPHANUMERIC Tri alphanumérique par point de code Unicode. Exemple : "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Tri des caractères alphanumériques non sensibles à la casse par point de code Unicode minuscule. Exemple : "2" < "A" < "b" < "X" < "z".
NUMERIC Les valeurs des dimensions sont converties en nombres avant le tri. Par exemple, pour le tri NUMERIC, "25" < "100" et, dans le tri ALPHANUMERIC, "100" < "25". Les valeurs de dimension non numériques ont toutes une valeur de tri égale en dessous de toutes les valeurs numériques.

CohortSpec

Spécification des cohortes pour un rapport sur les cohortes.

Les rapports sur les cohortes créent une série temporelle de fidélisation des utilisateurs pour la cohorte. Par exemple, vous pouvez sélectionner la cohorte d'utilisateurs qui ont été acquis au cours de la première semaine de septembre et suivre cette cohorte pendant les six semaines suivantes. La sélection des utilisateurs acquis au cours de la première semaine de cohorte de septembre est spécifiée dans l'objet cohort. Cette dernière est indiquée dans l'objet cohortsRange pour les six prochaines semaines.

Pour obtenir des exemples, reportez-vous à la section Exemples de rapports sur les cohortes.

La réponse au rapport peut indiquer une série temporelle hebdomadaire dans laquelle votre application a retenu 60% de cette cohorte après trois semaines et 25% de cette cohorte après six semaines. Ces deux pourcentages peuvent être calculés à l'aide de la métrique cohortActiveUsers/cohortTotalUsers et constitueront des lignes distinctes dans le rapport.

Représentation JSON
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Champs
cohorts[]

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.

cohortsRange

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.

cohortReportSettings

object (CohortReportSettings)

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

Cohorte

Définit un critère de sélection de cohorte. Une cohorte est un groupe d'utilisateurs qui partagent une caractéristique commune. Par exemple, les utilisateurs ayant le même firstSessionDate appartiennent à la même cohorte.

Représentation JSON
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Champs
name

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.).

dimension

string

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

dateRange

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.

CohortsRange

Configure la période étendue d'un rapport sur une cohorte. Spécifie une durée de décalage pour le suivi des cohortes.

Représentation JSON
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Champs
granularity

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.

startOffset

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.

endOffset

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.

Précision

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

Enums
GRANULARITY_UNSPECIFIED Ne doit jamais être spécifié.
DAILY Précision quotidienne. Ce paramètre est fréquemment utilisé si le dateRange de la cohorte correspond à un seul jour et que la requête contient cohortNthDay.
WEEKLY Précision hebdomadaire. Il est généralement utilisé si le dateRange de la cohorte dure une semaine (du dimanche au samedi) et que la requête contient cohortNthWeek.
MONTHLY Précision mensuelle. Ce paramètre est fréquemment utilisé si le dateRange de la cohorte dure un mois et que la requête contient cohortNthMonth.

CohortReportSettings

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

Représentation JSON
{
  "accumulate": boolean
}
Champs
accumulate

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.

ReportMetadata

Métadonnées du rapport pour une tâche de rapport spécifique.

Représentation JSON
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Champs
creationQuotaTokensCharged

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.

state

enum (State)

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

beginCreatingTime

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".

taskRowCount

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.

errorMessage

string

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

totalRowCount

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.

État

État du traitement.

Enums
STATE_UNSPECIFIED L'état non spécifié ne sera jamais utilisé.
CREATING Le rapport est en cours de création et sera disponible ultérieurement. La création s'effectue immédiatement après l'appel CreateReport.
ACTIVE Le rapport est entièrement créé et prêt à être interrogé.
FAILED Échec de la création du rapport.

Méthodes

create

Lance la création d'une tâche de rapport.

get

Récupère les métadonnées du rapport concernant une tâche spécifique.

list

Répertorie toutes les tâches de rapport pour une propriété.

query

Récupère le contenu d'une tâche de rapport.