- Ressource: ReportTask
- ReportDefinition
- Dimension
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Métrique
- DateRange
- FilterExpression
- FilterExpressionList
- Filtre
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Opération
- NumericValue
- BetweenFilter
- EmptyFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Cohorte
- CohortsRange
- Précision
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- État
- Méthodes
Ressource: ReportTask
Configuration spécifique de la tâche de création de rapports.
Représentation JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Champs | |
---|---|
name |
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}" |
report |
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. |
report |
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 ( |
Champs | |
---|---|
dimensions[] |
Facultatif. Les dimensions demandées et affichées. |
metrics[] |
Facultatif. Métriques demandées et affichées |
date |
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 |
dimension |
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. |
metric |
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 |
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 |
limit |
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. L'API peut également renvoyer moins de lignes que l' |
metric |
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)". |
order |
Facultatif. Spécifie l'ordre des lignes dans la réponse. |
currency |
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é. |
cohort |
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. |
keep |
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 Par exemple, si une propriété ne consigne jamais d'événement |
sampling |
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 ( |
Champs | |
---|---|
name |
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 Si Les dimensions sont référencées par |
dimension |
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 |
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 : |
|
lower |
Permet de convertir une valeur de dimension en minuscules. |
upper |
Permet de convertir une valeur de dimension en majuscules. |
concatenate |
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 | |
---|---|
dimension |
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 | |
---|---|
dimension |
Noms des dimensions. Les noms doivent faire référence aux noms figurant dans le champ "dimensions" de la requête. |
delimiter |
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 |
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 Si Les métriques sont référencées par |
expression |
Expression mathématique pour les métriques dérivées. Par exemple, la métrique "Nombre d'événements par utilisateur" est |
invisible |
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 |
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 | |
---|---|
start |
Date de début inclusive de la requête, au format |
end |
Date de fin inclusive de la requête au format |
name |
Attribue un nom à cette plage de dates. La valeur de la dimension |
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 |
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 : |
|
and |
Les FilterExpressions dans andGroup ont une relation AND. |
or |
Les expressions de filtre de l'élément "orGroup" sont associées dans une relation OR. |
not |
L'expression de filtre n'est PAS de type notExpression. |
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 ( |
Champs | |
---|---|
expressions[] |
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 |
Champs | |
---|---|
field |
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 : |
|
string |
Filtre lié aux chaînes. |
in |
Filtre pour les valeurs de la liste. |
numeric |
Filtre pour les valeurs numériques ou de date. |
between |
Filtre entre deux valeurs. |
empty |
Filtre pour les valeurs vides telles que "(non défini)" et "". |
StringFilter
Filtre de chaîne
Représentation JSON |
---|
{
"matchType": enum ( |
Champs | |
---|---|
match |
Type de correspondance de ce filtre. |
value |
Valeur de chaîne utilisée pour la mise en correspondance. |
case |
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[] |
Liste des valeurs de chaîne. Ne doit pas être vide. |
case |
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 ( |
Champs | |
---|---|
operation |
Type d'opération pour ce filtre. |
value |
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 |
Champs | |
---|---|
Champ d'union one_value . La valeur numérique one_value ne peut être qu'une des valeurs suivantes: |
|
int64 |
Valeur entière |
double |
Valeur double |
BetweenFilter
Pour indiquer que le résultat doit être compris entre deux nombres (inclus).
Représentation JSON |
---|
{ "fromValue": { object ( |
Champs | |
---|---|
from |
Commence par ce nombre. |
to |
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 |
Champs | |
---|---|
desc |
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 |
Trie les résultats en fonction des valeurs d'une métrique. |
dimension |
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 | |
---|---|
metric |
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 ( |
Champs | |
---|---|
dimension |
Nom de la dimension à trier dans la requête. |
order |
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 ( |
Champs | |
---|---|
cohorts[] |
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. |
cohorts |
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. |
cohort |
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 ( |
Champs | |
---|---|
name |
Attribue un nom à cette cohorte. La valeur de la dimension |
dimension |
Dimension utilisée par la cohorte. Obligatoire et compatible uniquement avec |
date |
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 Dans une requête de cohorte, cet élément En règle générale, cette |
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 ( |
Champs | |
---|---|
granularity |
Obligatoire. Précision utilisée pour interpréter les |
start |
Si Si Si |
end |
Obligatoire. Si Si Si |
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 |
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 : |
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 ( |
Champs | |
---|---|
creation |
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 |
state |
Uniquement en sortie. État actuel de cette tâche de création de rapports. |
begin |
Uniquement en sortie. Heure à laquelle Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
task |
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 |
error |
Uniquement en sortie. Un message d'erreur s'affiche si une tâche de création de rapport échoue. |
total |
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
Par exemple, supposons que la valeur |
É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 |
|
---|---|
|
Lance la création d'une tâche de création de rapports. |
|
Récupère les métadonnées de rapport sur une tâche de création de rapports spécifique. |
|
Répertorie toutes les tâches de création de rapports pour une propriété. |
|
Récupère le contenu d'une tâche de création de rapport. |