- Ressource: ReportTask
- ReportDefinition
- Dimension
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Métrique
- DateRange
- FilterExpression
- FilterExpressionList
- Filtre
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Opération
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Cohorte
- CohortsRange
- Précision
- CohortReportSettings
- ReportMetadata
- État
- Méthodes
Ressource: ReportTask
Une configuration de tâche de rapport spécifique.
Représentation JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Champs | |
---|---|
name |
Uniquement en sortie. Identifiant. Nom de la ressource de tâche de rapport attribué lors de la création. Format: "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
Facultatif. Définition de rapport permettant d'extraire les données d'un 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 |
Uniquement en sortie. Métadonnées d'un rapport pour une tâche spécifique, qui fournissent des informations sur un rapport. Il comprend généralement les informations suivantes: le nom de la ressource du rapport, l'état du rapport, la date et l'heure de création du rapport, etc. |
ReportDefinition
Définition du mode d'exécution d'un rapport.
Représentation JSON |
---|
{ "dimensions": [ { object ( |
Champs | |
---|---|
dimensions[] |
Facultatif. Dimensions demandées et affichées. |
metrics[] |
Facultatif. Métriques demandées et affichées. |
dateRanges[] |
Facultatif. Plages de dates correspondant aux 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, cet élément |
dimensionFilter |
Facultatif. Les filtres de dimensions vous permettent de ne demander que des valeurs de dimensions spécifiques dans le rapport. Pour en savoir plus et obtenir des exemples, consultez l'article Principes de base des filtres de dimensions. Impossible d'utiliser des métriques dans ce filtre. |
metricFilter |
Facultatif. Clause de filtre des métriques. Appliqué après l'agrégation des lignes du rapport, semblable à la clause SQL existante. Impossible d'utiliser des dimensions avec ce filtre. |
offset |
Facultatif. Nombre de lignes de la première ligne provenant de l'espace de stockage Google Analytics. La première ligne correspond à la ligne 0. Lorsque vous créez une tâche de rapport, les paramètres |
limit |
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é. L'API peut également renvoyer moins de lignes que le |
metricAggregations[] |
Facultatif. Agrégation de métriques. Les valeurs de métriques agrégées s'affichent dans les lignes où les valeurs de dimension sont définies sur "RESERVED_(MetricAggregation)". |
orderBys[] |
Facultatif. Spécifie l'ordre des lignes dans la réponse. |
currencyCode |
Facultatif. Code de devise au format ISO 4217, tel que "AED", "USD" ou "JPY". Si le champ est vide, le rapport utilise la devise par défaut de la propriété. |
cohortSpec |
Facultatif. Groupe de cohorte associé à cette demande. Si la requête comporte un groupe de cohorte, la dimension "cohorte" doit être présente. |
keepEmptyRows |
Facultatif. Si la valeur est "false" ou n'est pas spécifiée, aucune ligne dont toutes les métriques sont égales à 0 ne sera pas renvoyée. Si la valeur est "true", ces lignes sont renvoyées si un filtre ne les a pas supprimées séparément. Quel que soit le paramètre Par exemple, si une propriété ne consigne jamais d'événement |
Dimension
Les dimensions correspondent aux attributs de vos données. Par exemple, la dimension "ville" indique la ville d'origine d'un événement. Dans les réponses aux rapports, les valeurs des dimensions 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 les dimensions de l'API pour obtenir la liste des noms de dimensions acceptés par les principales méthodes de création de rapports, telles que Si Les dimensions sont référencées par |
dimensionExpression |
Une dimension peut être le résultat de l'expression de plusieurs dimensions. Par exemple, dimension "pays, ville": concatenate(country, ", ", city). |
DimensionExpression
Permet d'exprimer une dimension résultant d'une formule de plusieurs dimensions. Exemples d'utilisation: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, 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 : |
|
lowerCase |
Permet de convertir une valeur de dimension en minuscules. |
upperCase |
Permet de convertir une valeur de dimension en majuscules. |
concatenate |
Permet de combiner des valeurs de dimension en une seule. Par exemple, dimension "pays, ville": concatenate(country, ", ", city). |
CaseExpression
Permet de convertir une valeur de dimension en une casse.
Représentation JSON |
---|
{ "dimensionName": string } |
Champs | |
---|---|
dimensionName |
Nom d'une dimension. Le nom doit faire référence à un nom indiqué dans le champ de dimensions de la requête. |
ConcatenateExpression
Permet de combiner des valeurs de dimension en une seule.
Représentation JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Champs | |
---|---|
dimensionNames[] |
Noms des dimensions. Les noms doivent faire référence aux noms indiqués dans le champ de dimensions de la requête. |
delimiter |
Délimiteur placé entre les noms de dimension. Les délimiteurs sont souvent des caractères uniques tels que "|" ou ", mais peuvent être des chaînes plus longues. Si une valeur de dimension contient le délimiteur, les deux seront présentes dans la réponse sans distinction. Par exemple, si la valeur de la dimension 1 = "US,FR", 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. 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 page 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 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 de |
invisible |
Indique si une métrique est invisible dans la réponse du rapport. Si une métrique n'est pas visible, elle ne génère pas de colonne dans la réponse, mais peut être utilisée dans |
DateRange
Un ensemble de jours contigu: startDate
, startDate + 1
, ..., endDate
. Jusqu'à quatre plages de dates sont autorisées pour les demandes.
Représentation JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Champs | |
---|---|
startDate |
Date de début (incluse) de la requête au format |
endDate |
Date de fin inclusive de la requête au format |
name |
Attribue un nom à cette plage de dates. La dimension |
FilterExpression
Pour exprimer des filtres de dimensions ou de métriques. Les champs d'une même FilterExpression 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 : |
|
andGroup |
Les objets FilterExpressions dans andGroup ont une relation AND. |
orGroup |
Les FilterExpressions dans orGroup ont une relation OR. |
notExpression |
FilterExpression n'est PAS notExpression. |
filter |
Un filtre primitif. Dans la 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 ( |
Champs | |
---|---|
expressions[] |
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 |
Champs | |
---|---|
fieldName |
Nom de la dimension ou de la métrique. Vous devez définir un nom 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 |
Filtre lié aux chaînes. |
inListFilter |
Filtre pour les valeurs dans la liste. |
numericFilter |
Filtre pour les valeurs numériques ou les dates. |
betweenFilter |
Filtre entre deux valeurs. |
StringFilter
Filtre de chaîne
Représentation JSON |
---|
{
"matchType": enum ( |
Champs | |
---|---|
matchType |
Type de correspondance de ce filtre. |
value |
Valeur de chaîne utilisée pour la mise en correspondance. |
caseSensitive |
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 la chaîne. |
PARTIAL_REGEXP |
Correspondance partielle pour l'expression régulière avec la valeur de la 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. Ce champ ne doit pas être vide. |
caseSensitive |
Si la valeur est "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 |
Valeur numérique ou date. |
Opération
Opération appliquée à un filtre numérique
Enums | |
---|---|
OPERATION_UNSPECIFIED |
URL indéterminée. |
EQUAL |
Égal à |
LESS_THAN |
Moins de |
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 . L'une des valeurs numériques one_value ne peut être qu'une seule des valeurs suivantes: |
|
int64Value |
Valeur entière |
doubleValue |
Valeur double |
BetweenFilter
Pour exprimer que le résultat doit être compris entre deux nombres (inclus)
Représentation JSON |
---|
{ "fromValue": { object ( |
Champs | |
---|---|
fromValue |
Commence par ce nombre. |
toValue |
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 minimum. |
MAXIMUM |
Opérateur maximum. |
COUNT |
Opérateur "count". |
OrderBy
La fonction "Order by" définit la manière dont les lignes seront triées dans la réponse. Par exemple, le tri des lignes par nombre d'événements décroissant est un ordre de tri, tandis que celui par chaîne de nom d'événement est différent.
Représentation JSON |
---|
{ "desc": boolean, // Union field |
Champs | |
---|---|
desc |
Si la valeur est "true", les résultats sont triés 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 en fonction des valeurs d'une dimension. |
MetricOrderBy
Trie par valeurs de métriques.
Représentation JSON |
---|
{ "metricName": string } |
Champs | |
---|---|
metricName |
Nom de métrique dans la requête de tri. |
DimensionOrderBy
Trie par valeurs de dimension.
Représentation JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Champs | |
---|---|
dimensionName |
Nom de dimension dans la demande de tri. |
orderType |
Contrôle la règle d'ordre des valeurs de dimension. |
OrderType
Règle selon laquelle classer les valeurs de dimension de chaîne.
Enums | |
---|---|
ORDER_TYPE_UNSPECIFIED |
URL indéterminée. |
ALPHANUMERIC |
Tri alphanumérique par point de code Unicode. Par exemple, "2" < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Tri par point de code Unicode en minuscules/majuscules non sensibles à la casse 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 de tri é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 fidélisation 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 la cohorte de septembre est spécifiée dans l'objet cohort
. Ensuite, la cohorte pour les six prochaines semaines est spécifiée dans l'objet cohortsRange
.
Vous trouverez des exemples dans l'article Exemples de rapports sur les cohortes.
La réponse du rapport peut afficher une série temporelle hebdomadaire dans laquelle votre application a conservé 60% de cette cohorte après trois semaines et 25% de cette cohorte après six semaines. Ces deux pourcentages peuvent être calculés par la métrique cohortActiveUsers/cohortTotalUsers
et figureront 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 dans des cohortes. La plupart des rapports sur les cohortes ne définissent qu'une seule cohorte. Si vous spécifiez plusieurs cohortes, vous pourrez les reconnaître dans le rapport grâce à leur nom. |
cohortsRange |
Les rapports sur les cohortes suivent les cohortes sur une période étendue. Cette plage spécifie une durée de décalage à suivre pour suivre les cohortes. |
cohortReportSettings |
Paramètres facultatifs pour un rapport sur les cohortes. |
Cohort
Définit les critères de sélection des cohortes. 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 ( |
Champs | |
---|---|
name |
Attribue un nom à cette cohorte. La dimension |
dimension |
Dimension utilisée par la cohorte. Obligatoire et compatible uniquement avec |
dateRange |
La cohorte sélectionne les utilisateurs dont la date de premier contact est comprise entre les dates de début et de fin définies dans l' Dans une demande de cohorte, ce Cet élément |
CohortsRange
Permet de configurer la plage de dates étendue pour un rapport sur les cohortes. Spécifie la durée de décalage à suivre pour suivre les cohortes.
Représentation JSON |
---|
{
"granularity": enum ( |
Champs | |
---|---|
granularity |
Obligatoire. Précision utilisée pour interpréter les valeurs |
startOffset |
Si Si Si |
endOffset |
Obligatoire. Si Si Si |
Précision
Précision utilisée pour interpréter les valeurs startOffset
et endOffset
pour la période étendue d'un rapport sur les cohortes.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Ne doit jamais être spécifié. |
DAILY |
Précision quotidienne Généralement utilisé si l'dateRange de la cohorte correspond à une seule journée et que la requête contient cohortNthDay . |
WEEKLY |
Précision hebdomadaire Généralement utilisé si l'dateRange de la cohorte est d'une semaine (du dimanche au samedi) et que la requête contient cohortNthWeek . |
MONTHLY |
Précision mensuelle Généralement utilisé si l'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 |
Si la valeur est "true", le résultat s'accumule du premier jour de contact jusqu'au jour de fin. Non disponible dans |
ReportMetadata
Métadonnées du rapport pour une tâche de rapport spécifique.
Représentation JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Champs | |
---|---|
creationQuotaTokensCharged |
Uniquement en sortie. Le quota total de jetons facturés lors de la création du rapport. Étant donné que le nombre de jetons est basé sur l'activité à l'état |
state |
Uniquement en sortie. État actuel de cette tâche de création de rapports. |
beginCreatingTime |
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 : |
taskRowCount |
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 |
errorMessage |
Uniquement en sortie. Un message d'erreur s'affiche si une tâche de rapport échoue lors de la création. |
totalRowCount |
Uniquement en sortie. Nombre total de lignes dans l'espace de stockage Google Analytics. Si vous souhaitez interroger d'autres lignes de données que celles du rapport actuel, l'utilisateur peut lancer une nouvelle tâche de rapport en fonction du La valeur Par exemple, supposons que la valeur |
É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 prochainement. La création est effectuée 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 rapport. |
|
Récupère les métadonnées du rapport sur une tâche de rapport 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 rapport. |