REST Resource: properties.reportTasks

Ressource: ReportTask

Configuration spécifique de la tâche de création de rapports.

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 création de rapports attribué lors de la création. Format: "properties/{property}/reportTasks/{reportTask}"

reportDefinition

object (ReportDefinition)

Facultatif. Définition de rapport pour extraire les données du rapport, qui décrit la structure d'un rapport. Il inclut 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 création de rapports spécifique, qui fournissent des informations sur un rapport. Il comprend généralement les informations suivantes: le nom de la ressource du rapport, son état, le code temporel de sa création, etc.

ReportDefinition

Définition de la manière 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. Plage de dates des données à lire. Si plusieurs périodes sont demandées, chaque ligne de réponse contient un indice de période basé sur zéro. Si deux plages de dates se chevauchent, les données d'événement pour les jours qui se chevauchent sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une requête de cohorte, ce dateRanges ne doit pas être spécifié.

dimensionFilter

object (FilterExpression)

Facultatif. Les filtres de dimension vous permettent de n'interroger que des valeurs de dimension spécifiques dans le rapport. Pour en savoir plus, consultez Principes de base des filtres de dimension pour obtenir des exemples. Vous ne pouvez pas utiliser de métriques 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 de Google Analytics Storage. La première ligne est comptée comme la ligne 0.

Lorsque vous créez une tâche de création 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 compte un total de 300 000 lignes, la tâche de rapport initiale peut inclure 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 création de rapports peut couvrir les 10 000 lignes suivantes avec une limite de 10 000 lignes et un décalage de 10 000.

limit

string (int64 format)

Facultatif. Nombre de lignes à afficher dans le 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. Par exemple, il existe moins de 300 valeurs possibles pour la dimension country. Par conséquent, si vous n'utilisez que country dans vos rapports, 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 de métrique agrégées s'affichent dans les lignes où les valeurs de dimension 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 ISO 4217, 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 cohorte associé à cette requête. Si un groupe de cohortes est présent dans la requête, la dimension "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 cette valeur est définie sur "true", ces lignes sont 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é ne consigne jamais d'événement purchase, une requête pour la dimension eventName et la métrique eventCount ne contiendra 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 d'où provient un événement. Les valeurs de dimension dans les réponses aux 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 la section Dimensions de l'API pour obtenir la liste des noms de dimension compatibles avec les méthodes de reporting de base telles que runReport et batchRunReports. Pour obtenir la liste des noms de dimension compatibles avec la méthode runRealtimeReport, consultez la section Dimensions en temps réel. Pour obtenir la liste des noms de dimension compatibles avec la méthode runFunnelReport, consultez la section Dimensions de l'entonnoir.

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

Permet d'exprimer une dimension qui est le résultat d'une formule de 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 en une seule dimension. Par exemple, dimension "pays, ville": concatenate(pays, ", ", ville).

CaseExpression

Permet de convertir une valeur de dimension en majuscule ou minuscule.

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

delimiter

string

Délimiteur placé entre les noms de dimension.

Les séparateurs sont souvent des caractères uniques tels que "|" ou ",", mais ils peuvent également être des chaînes plus longues. Si une valeur de dimension contient le délimiteur, les deux éléments 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 séparateur est ",", la réponse contient "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 contenir jusqu'à 10 métriques.

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

string

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

Si expression est spécifié, name peut être n'importe quelle chaîne dans l'ensemble de caractères autorisé. 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 produit pas de colonne dans la réponse, mais peut être utilisée dans metricFilter, orderBys ou une métrique expression.

DateRange

Ensemble de jours consécutifs: startDate, startDate + 1, ..., endDate. Vous pouvez demander jusqu'à quatre plages de dates.

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

string

Date de début inclusive de la requête, au format YYYY-MM-DD. ne peut pas être postérieure au endDate ; Le format NdaysAgo, yesterday ou today est également accepté. Dans ce cas, la date est déduite en fonction du fuseau horaire de l'établissement pour les rapports.

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 de l'établissement pour les rapports.

name

string

Attribue un nom à cette plage de dates. La valeur de la dimension dateRange est définie sur ce nom dans une réponse de rapport. Si défini, ne peut pas commencer par date_range_ ou RESERVED_. Si cet attribut n'est pas défini, les plages de dates sont nommées en fonction de leur index à partir de zéro dans la requête: date_range_0, date_range_1, etc.

FilterExpression

Pour exprimer des filtres de dimension ou de métrique. Les champs d'une même expression de filtre doivent être tous des dimensions ou toutes 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 dans andGroup ont une relation AND.

orGroup

object (FilterExpressionList)

Les expressions de filtre de l'élément "orGroup" sont associées dans une relation OR.

notExpression

object (FilterExpression)

L'expression de filtre n'est PAS de type notExpression.

filter

object (Filter)

Filtre primitif. Dans la même expression de filtre, tous les noms de champ du filtre doivent correspondre à 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 des dimensions ou des 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 entre deux valeurs.

emptyFilter

object (EmptyFilter)

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

StringFilter

Filtre de 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 définie sur "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 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 trouver dans 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 définie sur "true", la valeur de la chaîne est sensible à la casse.

NumericFilter

Filtres pour les valeurs numériques ou les dates

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

enum (Operation)

Type d'opération pour ce filtre.

value

object (NumericValue)

Une valeur numérique ou une 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

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. La valeur numérique one_value ne peut être qu'une des valeurs suivantes:
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 chiffre ;

EmptyFilter

Ce type ne comporte aucun champ.

Filtrez sur 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 ordres de tri définissent le mode de tri des lignes dans la réponse. Par exemple, trier les lignes par nombre d'événements décroissant est une chose, et trier les lignes par chaîne de nom d'événement en est une autre.

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 défini sur "true", trie 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 en fonction des valeurs d'une métrique.

dimension

object (DimensionOrderBy)

Trie les résultats par valeurs d'une dimension.

MetricOrderBy

Trie les données en fonction des 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 de la dimension à trier dans la requête.

orderType

enum (OrderType)

Contrôle la règle de tri des valeurs de dimension.

OrderType

Règle permettant d'organiser 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 Tri alphanumérique insensible à la casse par point de code Unicode minuscule. Par exemple, "2" < "A" < "b" < "X" < "z".
NUMERIC Les valeurs des dimensions 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 sous 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 acquise au cours de la première semaine de septembre et la suivre pendant les six semaines suivantes. La sélection des utilisateurs acquis dans la cohorte de la première semaine de septembre est spécifiée dans l'objet cohort. Le suivi de cette cohorte pendant les six prochaines semaines 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 au bout de trois semaines et 25% au bout de six semaines. Ces deux pourcentages peuvent être calculés à l'aide de la métrique cohortActiveUsers/cohortTotalUsers et apparaîtront 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 en cohortes.

La plupart des rapports sur les cohortes ne définissent qu'une seule cohorte. Si vous spécifiez plusieurs cohortes, vous pouvez les reconnaître dans le rapport par leur nom.

cohortsRange

object (CohortsRange)

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

cohortReportSettings

object (CohortReportSettings)

Paramètres facultatifs pour un rapport sur les cohortes.

Cohorte

Définit des critères de sélection de cohorte. Une cohorte est un groupe d'utilisateurs qui partagent une caractéristique commune. Par exemple, les utilisateurs ayant 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 valeur de la dimension cohort est définie sur ce nom dans une réponse de rapport. Si défini, ne peut pas commencer par cohort_ ou RESERVED_. Si cet attribut n'est pas défini, les cohortes sont nommées en fonction de leur index à partir de 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 de premier contact se situe entre la date de début et la date de fin définies dans dateRange. Cette dateRange ne spécifie pas la plage de dates complète des données d'événement présentes dans un rapport sur les cohortes. Dans un rapport sur les cohortes, cette dateRange est étendue par la granularité et le décalage présents dans la cohortsRange. Les données d'événement pour la plage de dates de reporting étendue sont présentes dans un rapport sur les cohortes.

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

En règle générale, cette dateRange doit être alignée sur la granularité de la cohorte. Si CohortsRange utilise une précision quotidienne, dateRange peut correspondre à une seule journée. Si CohortsRange utilise une granularité hebdomadaire, ce dateRange peut être aligné sur une limite de semaine, commençant le dimanche et se terminant le samedi. Si CohortsRange utilise une granularité mensuelle, ce dateRange peut être aligné sur un mois, du premier au dernier jour.

CohortsRange

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

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

enum (Granularity)

Obligatoire. Précision utilisée pour interpréter les startOffset et endOffset pour la plage de dates de reporting étendue d'un rapport sur les cohortes.

startOffset

integer

startOffset spécifie la date de début de la plage de dates de rapport étendue pour un rapport sur les cohortes. startOffset est généralement défini sur 0 afin que les rapports contiennent les données à partir de l'acquisition de la cohorte.

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

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

Si granularity est MONTHLY, la startDate de la plage de dates de reporting étendue 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 les cohortes. 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 de reporting étendue correspond à la endDate de la cohorte plus endOffset jours.

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

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

Précision

Précision utilisée pour interpréter les startOffset et endOffset pour la plage de dates de reporting étendue d'un rapport sur les cohortes.

Enums
GRANULARITY_UNSPECIFIED Ne doit jamais être spécifié.
DAILY Granularité quotidienne. Couramment utilisé si la dateRange de la cohorte correspond à un seul jour et que la requête contient cohortNthDay.
WEEKLY Précision hebdomadaire. Couramment utilisé si la durée de la dateRange de la cohorte est d'une semaine (du dimanche au samedi) et que la requête contient cohortNthWeek.
MONTHLY Précision mensuelle. Utilisé couramment si la durée de la dateRange de la cohorte est d'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 est cumulé du jour de la première interaction au jour de fin. Non compatible avec le ou les niveaux de sortie suivants : RunReportRequest.

SamplingLevel

Catégories de niveaux d'échantillonnage pour les requêtes.

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 Disponible uniquement pour les propriétés Google Analytics 360 avec un niveau d'échantillonnage de 1 milliard.
UNSAMPLED Disponible uniquement 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 création de rapports 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, cette facturation de jetons sera corrigée une fois qu'une tâche de création de rapports passera à l'état ACTIVE ou FAILED.

state

enum (State)

Uniquement en sortie. État actuel de cette tâche de création de rapports.

beginCreatingTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle reportTasks.create a été appelé et à laquelle 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 est renseigné lorsque l'état est actif. Vous pouvez utiliser taskRowCount pour la pagination dans les limites de votre rapport existant.

errorMessage

string

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

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, vous pouvez lancer une nouvelle tâche de création de rapports basée sur totalRowCount.

taskRowCount représente le nombre de lignes spécifiquement liées au rapport en cours, tandis que totalRowCount englobe le nombre total de lignes pour toutes les données récupérées à partir de l'espace de stockage Google Analytics.

Par exemple, supposons que la valeur taskRowCount du rapport actuel soit 20, ce qui affiche les données des 20 premières lignes. Simultanément, totalRowCount est égal à 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 de toutes les 30 lignes, vous pouvez créer une tâche de rapport à l'aide de totalRowCount pour accéder à l'ensemble complet de données de 30 lignes.

État

État du traitement.

Enums
STATE_UNSPECIFIED L'état non spécifié n'est 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 Échec de la création du rapport.

Méthodes

create

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

get

Récupère les métadonnées de rapport sur une tâche de création de rapports spécifique.

list

Répertorie toutes les tâches de création de rapports pour une propriété.

query

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