REST Resource: properties.reportTasks

Ressource : ReportTask

Configuration spécifique d'une tâche de rapport.

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

string

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

object (ReportDefinition)

Facultatif. Définition de rapport permettant d'extraire les données d'un rapport et décrivant la structure de ce rapport. Il inclut généralement les champs qui figureront 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 ressource du rapport, état du rapport, code temporel de création du rapport, etc.

ReportDefinition

Définition de la façon dont un rapport doit être exécuté.

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,
  "samplingLevel": enum (SamplingLevel)
}
Champs
dimensions[]

object (Dimension)

Facultatif. Les 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 pour les jours concernés sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une requête de cohorte, ce dateRanges doit être non 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, consultez Principes de base des filtres de dimension pour obtenir des exemples. Les métriques ne peuvent pas être utilisées dans ce filtre.
metricFilter

object (FilterExpression)

Facultatif. Clause de filtre des métriques. Appliqué après l'agrégation des lignes du rapport, comme la clause "having" de SQL. Vous ne pouvez pas utiliser de dimensions dans ce filtre.
offset

string (int64 format)

Facultatif. Nombre de lignes de la ligne de départ dans l'espace de stockage Google Analytics. La première ligne est considéré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 du stockage Google Analytics à inclure dans le rapport généré. Par exemple, si le stockage Google Analytics contient un total de 300 000 lignes, la tâche de rapport initiale peut comporter les 10 000 premières lignes avec une limite de 10 000 et un décalage de 0. Une autre tâche de rapport pourrait ensuite 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 à renvoyer 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é. 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. Par exemple, la dimension country ne peut pas prendre plus de 300 valeurs. Par conséquent, si vous générez des rapports uniquement sur country, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez limit sur une valeur plus élevée.
metricAggregations[]

enum (MetricAggregation)

Facultatif. Agrégation des métriques. Les valeurs agrégées des métriques s'affichent dans les lignes où dimensionValues est défini 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, par exemple "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, la dimension "cohort" (cohorte) doit être présente.
keepEmptyRows

boolean

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

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

Par exemple, si une propriété n'enregistre 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.
samplingLevel

enum (SamplingLevel)

Facultatif. Niveau d'échantillonnage du rapport.

Dimension

Les dimensions correspondent aux attributs de vos données. Par exemple, la dimension "Ville" indique la ville où un événement s'est déclenché. Les valeurs de dimension dans les réponses des rapports 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 méthodes de création de rapports de base telles que runReport et batchRunReports. Pour obtenir la liste des noms de dimensions compatibles avec la méthode runRealtimeReport, consultez Dimensions en temps réel. Pour obtenir la liste des noms de dimensions acceptés par la méthode runFunnelReport, consultez Dimensions de l'entonnoir.

Si dimensionExpression est spécifié, name peut être n'importe quelle chaîne de caractères de votre choix dans l'ensemble de caractères autorisés. Par exemple, si une dimensionExpression concatène country et city, vous pouvez appeler cette dimension countryAndCity. Les noms de 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 "pays, ville" : concatenate(pays, ", ", ville).

DimensionExpression

Utilisé pour exprimer une dimension qui est le résultat d'une formule de plusieurs dimensions. Exemples d'utilisation : 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, 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 en une seule dimension. Par exemple, dimension "pays, ville" : concatenate(pays, ", ", ville).

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 dans le champ "dimensions" de la requête.

ConcatenateExpression

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

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

string

Noms des dimensions. Les noms doivent faire référence à ceux du champ "dimensions" de la requête.
delimiter

string

Délimiteur placé entre les noms de dimensions.

Les délimiteurs sont souvent des caractères uniques tels que "|" ou ",", mais ils peuvent être des chaînes plus longues. Si une valeur de dimension contient le délimiteur, les deux seront présents dans la réponse sans distinction. Par exemple,si la valeur de la dimension 1 est "US,FR", celle de la dimension 2 est "JP" et le délimiteur est ",", 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. Les requêtes peuvent comporter jusqu'à 10 métriques.

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

string

Nom de la métrique. Consultez la page Métriques de l'API pour obtenir la liste des noms de métriques compatibles avec les méthodes de création de rapports de base telles que runReport et batchRunReports. Pour obtenir la liste des noms de métriques compatibles avec la méthode runRealtimeReport, consultez Métriques en temps réel. Pour obtenir la liste des noms de métriques compatibles avec la méthode runFunnelReport, consultez Métriques de l'entonnoir.

Si expression est spécifié, name peut être n'importe quelle chaîne de caractères de votre choix dans l'ensemble de caractères autorisés. Par exemple, si expression est screenPageViews/sessions, vous pouvez appeler le nom de cette métrique viewsPerSession. Les noms de 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 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 peut être utilisée dans metricFilter, orderBys ou une métrique expression.

DateRange

Un ensemble contigu de jours : startDate, startDate + 1, ..., endDate. Vous pouvez inclure jusqu'à quatre plages de dates dans vos demandes.

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. Elle ne peut pas être postérieure au endDate. Les formats NdaysAgo, yesterday ou today sont également acceptés. Dans ce cas, la date est déduite en fonction du fuseau horaire de reporting de la propriété.
endDate

string

Date de fin (incluse) de la requête au format YYYY-MM-DD. Ne peut pas être antérieure au startDate. Les formats NdaysAgo, yesterday ou today sont également acceptés. Dans ce cas, la date est déduite en fonction du fuseau horaire de reporting de la propriété.
name

string

Attribue un nom à cette période. La dimension dateRange est associée à ce nom dans une réponse de rapport. Si elle est définie, elle ne peut pas commencer par date_range_ ni RESERVED_. Si elles ne sont pas définies, les plages de dates sont nommées en fonction de leur index 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 expression de filtre doivent être tous des dimensions ou tous des 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 de andGroup sont combinées dans une relation de type AND.
orGroup

object (FilterExpressionList)

Les FilterExpressions de orGroup sont combinées dans une relation OR.
notExpression

object (FilterExpression)

FilterExpression n'est PAS de notExpression.
filter

object (Filter)

Filtre primitif. Dans la même expression de filtre, tous les noms de champ du filtre doivent être des dimensions ou des métriques.

FilterExpressionList

Liste des expressions de filtre.

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

object (FilterExpression)

Liste des expressions de filtre.

Filtre

Expression permettant de filtrer les valeurs de dimension ou de métrique.

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)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // 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 pour les valeurs de la liste.
numericFilter

object (NumericFilter)

Filtre pour les valeurs numériques ou de date.
betweenFilter

object (BetweenFilter)

Filtre pour une plage de valeurs.
emptyFilter

object (EmptyFilter)

Filtre pour les valeurs vides telles que "(non défini)" et "".

StringFilter

Filtre pour la chaîne

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

enum (MatchType)

Type de correspondance pour 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 chaîne.
ENDS_WITH Se termine par la valeur de la chaîne.
CONTAINS Contient la valeur de chaîne.
FULL_REGEXP Correspondance exacte de 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 se présenter sous la forme d'une liste de valeurs de chaîne.

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

string

Liste des valeurs de chaîne. 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 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. one_value (valeur numérique) ne peut être qu'un des éléments suivants :
int64Value

string (int64 format)

Valeur entière
doubleValue

number

Valeur double

BetweenFilter

Pour indiquer 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 nombre.

EmptyFilter

Ce type ne comporte aucun champ.

Filtrer les valeurs vides.

MetricAggregation

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

Enums
METRIC_AGGREGATION_UNSPECIFIED Opérateur non spécifié.
TOTAL Opérateur SUM.
MINIMUM Opérateur minimum.
MAXIMUM Opérateur maximum.
COUNT Opérateur de comptage.

OrderBy

Les "order by" définissent la façon dont les lignes seront triées dans la réponse. Par exemple, l'ordre des lignes peut être défini par le nombre d'événements (ordre décroissant) ou par la chaîne du nom de l'événement.

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", le tri s'effectue par ordre décroissant.
Champ d'union one_order_by. Spécifiez un type de tri pour OrderBy. La one_order_by ne peut être qu'un des éléments suivants :
metric

object (MetricOrderBy)

Trie les résultats par valeurs de métrique.
dimension

object (DimensionOrderBy)

Trie les résultats par valeurs de dimension.

MetricOrderBy

Trie les valeurs de métrique.

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

string

Nom d'une métrique dans la requête à trier.

DimensionOrderBy

Trie les données par valeurs de dimension.

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

string

Nom d'une dimension dans la requête à trier.
orderType

enum (OrderType)

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

OrderType

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

Enums
ORDER_TYPE_UNSPECIFIED Non spécifié.
ALPHANUMERIC Tri alphanumérique par point de code Unicode. Par exemple, "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Trier les valeurs alphanumériques non sensibles à la casse par point de code Unicode en minuscules. Par exemple, "2" < "A" < "b" < "X" < "z".
NUMERIC Les valeurs de dimension sont converties en nombres avant le tri. Par exemple, dans le tri NUMERIC, "25" < "100", et dans le tri ALPHANUMERIC, "100" < "25". Les valeurs de dimension non numériques ont toutes une valeur d'ordre égale, inférieure à 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 la rétention des utilisateurs pour la cohorte. Par exemple, vous pouvez sélectionner la cohorte d'utilisateurs acquis au cours de la première semaine de septembre et la suivre pendant les six semaines suivantes. La sélection des utilisateurs acquis au cours de la première semaine de septembre est spécifiée dans l'objet cohort. Le suivi de cette cohorte pendant les six semaines suivantes est spécifié dans l'objet cohortsRange.

Pour obtenir des exemples, consultez Exemples de rapports sur les cohortes.

La réponse du rapport peut afficher une série temporelle hebdomadaire indiquant, par exemple, que votre application a conservé 60 % de cette cohorte après trois semaines et 25 % après six semaines. Ces deux pourcentages peuvent être calculés à l'aide de la métrique cohortActiveUsers/cohortTotalUsers et figureront sur 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 dans des 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 identifiée dans le rapport par son nom.
cohortsRange

object (CohortsRange)

Les rapports sur les cohortes suivent les cohortes sur une plage de dates de rapport étendue. Cette plage spécifie une durée de décalage pour suivre les cohortes.
cohortReportSettings

object (CohortReportSettings)

Paramètres facultatifs pour un rapport sur une cohorte.

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 associés à la 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 est associée à ce nom dans une réponse de rapport. Si elle est définie, elle ne peut pas commencer par cohort_ ni RESERVED_. Si ce paramètre n'est pas défini, les cohortes sont nommées en fonction de leur index zéro (cohort_0, cohort_1, etc.).
dimension

string

Dimension utilisée par la cohorte. Obligatoire et compatible uniquement avec firstSessionDate.
dateRange

object (DateRange)

La cohorte sélectionne les utilisateurs dont la date du premier point de contact se situe entre la date de début et la date de fin définies dans dateRange. Ce dateRange ne spécifie pas la période complète des données d'événement présentes dans un rapport sur une cohorte. Dans un rapport sur une cohorte, ce dateRange est étendu par la précision et le décalage présents dans cohortsRange. Les données d'événement pour la plage de dates étendue du rapport sont présentes dans un rapport sur une cohorte.

Dans une requête de cohorte, ce dateRange est obligatoire et le dateRanges dans RunReportRequest ou RunPivotReportRequest doit être non spécifié.

Ce dateRange doit généralement être aligné sur la précision de la cohorte. Si CohortsRange utilise une précision quotidienne, dateRange peut correspondre à un seul jour. Si CohortsRange utilise une précision hebdomadaire, ce dateRange peut être aligné sur une limite de semaine, en commençant le dimanche et en se terminant le samedi. Si CohortsRange utilise une granularité mensuelle, cette dateRange peut être alignée sur un mois, en commençant le premier jour et en se terminant le dernier jour du mois.

CohortsRange

Configure la plage de dates étendue pour un rapport sur les cohortes. Spécifie une durée de décalage pour suivre les cohortes.

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

enum (Granularity)

Obligatoire. Niveau de précision utilisé pour interpréter startOffset et endOffset pour la plage de dates étendue d'un rapport sur une cohorte.
startOffset

integer

startOffset spécifie la date de début de la période de reporting étendue pour un rapport sur une cohorte. startOffset est généralement défini sur 0 pour que les rapports contiennent des données à partir de l'acquisition de la cohorte.

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

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

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

integer

Obligatoire. endOffset spécifie la date de fin de la période de référence étendue pour un rapport sur une cohorte. endOffset peut être n'importe quel entier positif, mais il est généralement défini sur 5 à 10 afin que les rapports contiennent des données sur la cohorte pour les prochaines périodes de granularité.

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

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

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

Précision

Niveau de précision utilisé pour interpréter startOffset et endOffset pour la plage de dates étendue d'un rapport sur une cohorte.

Enums
GRANULARITY_UNSPECIFIED Ne doit jamais être spécifié.
DAILY Granularité quotidienne. Couramment utilisé si le dateRange de la cohorte correspond à un seul jour et que la requête contient cohortNthDay.
WEEKLY Granularité hebdomadaire. Couramment 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. Couramment 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 une cohorte.

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

boolean

Si la valeur est "true", le résultat est cumulé du jour du premier contact à la date de fin. Non compatible avec RunReportRequest.

SamplingLevel

Catégories de niveaux d'échantillonnage pour les demandes.

Enums
SAMPLING_LEVEL_UNSPECIFIED Type non spécifié.
LOW Applique un niveau d'échantillonnage de 10 millions aux propriétés standards et de 100 millions aux propriétés Google Analytics 360.
MEDIUM Exclusivement disponible pour les propriétés Google Analytics 360 avec un niveau d'échantillonnage d'un milliard.
UNSAMPLED Exclusivement disponible pour les propriétés Google Analytics 360. Les explorations non échantillonnées sont plus précises et peuvent révéler des insights qui ne sont pas visibles dans les explorations standards. Pour en savoir plus, consultez https://support.google.com/analytics/answer/10896953.

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. Nombre total de jetons de quota facturés lors de la création du rapport. Étant donné que ce nombre de jetons est basé sur l'activité de l'état CREATING, les frais de jetons seront fixes une fois 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 à laquelle le rapport est passé à l'état CREATING.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
taskRowCount

integer

Uniquement en sortie. Nombre total de lignes dans les résultats du rapport. Ce champ est rempli lorsque l'état est actif. Vous pouvez utiliser taskRowCount pour la pagination dans les limites de leur rapport existant.
errorMessage

string

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

integer

Uniquement en sortie. Nombre total de lignes dans le stockage Google Analytics. Si vous souhaitez interroger des lignes de données supplémentaires au-delà du rapport actuel, vous pouvez lancer une nouvelle tâche de rapport basée sur totalRowCount.

taskRowCount représente le nombre de lignes spécifiques au rapport actuel, tandis que totalRowCount englobe le nombre total de lignes pour toutes les données récupérées à partir du stockage Google Analytics.

Par exemple, supposons que la valeur taskRowCount du rapport actuel soit de 20, ce qui signifie que les données des 20 premières lignes sont affichées. Simultanément, la valeur totalRowCount est de 30, ce qui indique la présence de données pour les 30 lignes. taskRowCount peut être utilisé pour parcourir 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 afin d'accéder à l'ensemble des données des 30 lignes.

É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 a lieu immédiatement après l'appel CreateReport.
ACTIVE Le rapport est entièrement créé et prêt à être interrogé.
FAILED La création du rapport a échoué.

Méthodes

create

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

get

 Obtient les métadonnées d'un rapport concernant une tâche de rapport spécifique.

list

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

query

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