Method: reports.batchGet

Affiche les données Analytics.

Requête HTTP

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
Champs
reportRequests[]

object(ReportRequest)

Requêtes : chaque requête a une réponse distincte. Le nombre de requêtes est limité à 5. Toutes les requêtes doivent avoir les mêmes dateRanges, viewId, segments, samplingLevel et cohortGroup.

useResourceQuotas

boolean

Active les quotas basés sur les ressources (False par défaut). Si ce champ est défini sur True, les quotas par vue (profil) sont régis par le coût de calcul de la requête. Notez que l'utilisation de quotas basés sur le coût permet d'augmenter les taux d'échantillonnage. (10 millions pour SMALL, 100 M pour LARGE. Pour en savoir plus, consultez la documentation sur les limites et les quotas.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Classe de réponse principale qui contient les rapports de l'appel d'API batchGet Reporting.

Représentation JSON
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
Champs
reports[]

object(Report)

Réponses correspondant à chaque requête.

queryCost

number

Quantité de jetons de quota de ressources déduits pour exécuter la requête. Inclut toutes les réponses.

resourceQuotasRemaining

object(ResourceQuotasRemaining)

Quantité de ressources restantes pour la propriété.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ReportRequest

Classe principale de la requête qui spécifie la requête de l'API Reporting.

Représentation JSON
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
Champs
viewId

string

ID de la vue Analytics à partir de laquelle récupérer des données. Chaque ReportRequest d'une méthode batchGet doit contenir le même viewId.

dateRanges[]

object(DateRange)

Plages de dates dans la requête. La demande ne peut pas comporter plus de deux plages de dates. La réponse contient un ensemble de valeurs de métriques pour chaque combinaison de dimensions pour chaque plage de dates de la demande. Par conséquent, s'il existe deux plages de dates, il y a deux ensembles de valeurs de métriques, une pour la plage de dates initiale et une pour la deuxième. Le champ reportRequest.dateRanges ne doit pas être spécifié pour les cohortes ni pour les demandes de valeur vie client. Si aucune plage de dates n'est spécifiée, la plage de dates par défaut est (startDate: current date - 7 days, endDate: current date - 1 day). Chaque ReportRequest d'une méthode batchGet doit contenir la même définition dateRanges.

samplingLevel

enum(Sampling)

Taille de l'échantillon de rapport souhaité. Si le champ samplingLevel n'est pas spécifié, le niveau d'échantillonnage DEFAULT est utilisé. Chaque ReportRequest d'une méthode batchGet doit contenir la même définition samplingLevel. Pour en savoir plus, consultez le guide du développeur.

dimensions[]

object(Dimension)

Dimensions demandées. Les demandes peuvent inclure un total de neuf dimensions.

dimensionFilterClauses[]

object(DimensionFilterClause)

Les clauses de filtre de dimension pour filtrer les valeurs de dimension. Ils sont combinés de manière logique avec l'opérateur AND. Notez que le filtrage a lieu avant l'agrégation de toutes les dimensions, de sorte que les métriques renvoyées ne représentent le total que pour les dimensions pertinentes.

metrics[]

object(Metric)

Métriques demandées. Les requêtes doivent spécifier au moins une métrique. Les requêtes peuvent avoir un total de 10 métriques.

metricFilterClauses[]

object(MetricFilterClause)

Les clauses de filtre de métriques. Ils sont combinés de manière logique avec l'opérateur AND. Les filtres de métriques ne prennent en compte que la première plage de dates, et non la plage de dates de comparaison. Notez que le filtrage des métriques a lieu une fois les métriques agrégées.

filtersExpression

string

Filtres de dimensions ou de métriques qui restreignent les données renvoyées pour votre requête. Pour utiliser filtersExpression, indiquez une dimension ou une métrique à filtrer, suivie de l'expression de filtre. Par exemple, l'expression suivante sélectionne la dimension ga:browser qui commence par Firefox : ga:browser=~^Firefox. Pour en savoir plus sur les filtres de dimensions et de métriques, consultez la documentation de référence sur les filtres.

orderBys[]

object(OrderBy)

Ordre de tri sur les lignes de sortie. Pour comparer deux lignes, les éléments suivants sont appliqués dans l'ordre, jusqu'à ce qu'une différence soit trouvée. Toutes les plages de dates du résultat obtiennent le même ordre de ligne.

segments[]

object(Segment)

Segmentez les données renvoyées pour la requête. Une définition de segment permet d'examiner un sous-ensemble de la demande de segment. Une demande peut contenir jusqu'à quatre segments. Chaque ReportRequest d'une méthode batchGet doit contenir la même définition segments. Les requêtes avec segments doivent avoir la dimension ga:segment.

pivots[]

object(Pivot)

Définitions de tableaux croisés dynamiques. Les requêtes ne peuvent pas comporter plus de deux tableaux croisés dynamiques.

cohortGroup

object(CohortGroup)

Groupe de cohorte associé à cette demande. Si la requête contient un groupe de cohortes, la dimension ga:cohort doit être présente. Chaque ReportRequest d'une méthode batchGet doit contenir la même définition cohortGroup.

pageToken

string

Jeton de continuité pour obtenir la page de résultats suivante. Si vous l'ajoutez à la requête, les lignes sont renvoyées après "pageToken". pageToken doit être la valeur renvoyée dans le paramètre nextPageToken dans la réponse à la requête reports.batchGet.

pageSize

number

La taille de la page est destinée à la pagination et spécifie le nombre maximal de lignes renvoyées. La taille de la page doit être >= 0. Une requête renvoie la valeur par défaut de 1 000 lignes. L'API Core Reporting d'Analytics renvoie un maximum de 100 000 lignes par requête, quel que soit le nombre de lignes demandées. Elle peut également renvoyer moins de lignes que prévu si le nombre de segments de dimension ne correspond pas à vos attentes. Par exemple, il existe moins de 300 valeurs possibles pour ga:country. Par conséquent, si vous segmentez uniquement par pays, vous ne pouvez pas obtenir plus de 300 lignes, même si vous avez défini une valeur supérieure pour pageSize.

includeEmptyRows

boolean

Si la valeur est "false", la réponse n'inclut pas les lignes si toutes les métriques récupérées sont égales à zéro. La valeur par défaut est "false", ce qui exclut ces lignes.

hideTotals

boolean

Si la valeur est définie sur "true", cette option masque le total de toutes les métriques pour toutes les lignes correspondantes, pour chaque plage de dates. La valeur par défaut, "false", renvoie les totaux.

hideValueRanges

boolean

Si la valeur est définie sur "true", les valeurs minimale et maximale sont masquées sur toutes les lignes correspondantes. La valeur par défaut est "false", et les plages de valeurs sont renvoyées.

Échantillonnage

Valeurs du niveau d'échantillonnage.

Enums
SAMPLING_UNSPECIFIED Si le champ samplingLevel n'est pas spécifié, le niveau d'échantillonnage DEFAULT est utilisé.
DEFAULT Renvoie une réponse avec un échantillon qui allie vitesse et précision.
SMALL Il renvoie une réponse rapide avec une taille d'échantillonnage plus petite.
LARGE Renvoie une réponse plus précise avec une taille d'échantillonnage élevée. Toutefois, cela peut ralentir la réponse.

Dimension

Les dimensions sont des attributs de vos données. Par exemple, la dimension ga:city indique la ville (par exemple, "Paris" ou "New York" d'où provient une session).

Représentation JSON
{
  "name": string,
  "histogramBuckets": [
    string
  ]
}
Champs
name

string

Nom de la dimension à récupérer, par exemple ga:browser.

histogramBuckets[]

string (int64 format)

Si ce n'est pas le cas, nous insérons les valeurs des dimensions dans des buckets après la chaîne en "int64". Les valeurs de dimension qui ne représentent pas la chaîne d'une valeur entière seront converties en zéro. Les valeurs du bucket doivent être dans un ordre croissant. Chaque bucket est fermé sur la partie inférieure et ouvert sur la partie supérieure. Le "premier" segment inclut toutes les valeurs inférieures à la première limite, tandis que le "dernier" inclut toutes les valeurs jusqu'à l'infini. Les valeurs de dimension qui se trouvent dans un bucket sont transformées en une nouvelle valeur de dimension. Par exemple, si l'une d'entre elles donne une liste de "0, 1, 3, 4, 7", nous renvoyons les buckets suivants:

  • bucket n°1: valeurs < 0, valeur de dimension &&t;0"
  • bucket #2: valeurs dans [0,1), valeur de la dimension "0"
  • bucket #3: valeurs dans [1,3), valeur de la dimension "1-2"
  • bucket #4: valeurs de [3,4), valeur de dimension "3"
  • bucket #5: valeurs dans [4,7), valeur de la dimension "4-6"
  • bucket #6: valeurs >= 7, valeur de dimension "7+

REMARQUE: Si vous appliquez une mutation d'histogramme sur n'importe quelle dimension et que vous l'utilisez pour le tri, vous devez utiliser le type de tri HISTOGRAM_BUCKET. Sans cela, les valeurs des dimensions seront triées en fonction de l'ordre du dictionnaire (lexicographique). Par exemple, l'ordre croissant du dictionnaire est:

"50-120" <1001+

Et l'ordre HISTOGRAM_BUCKET croissant est le suivant:

"50-120" et "121-1000", 1001+

Le client doit demander explicitement "orderType": "HISTOGRAM_BUCKET" pour une dimension transformée en histogramme.

Clause DimensionFilter

Groupe de filtres de dimensions. Définissez la valeur de l'opérateur pour spécifier la manière dont les filtres sont combinés logiquement.

Représentation JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
Champs
operator

enum(FilterLogicalOperator)

Opérateur permettant de combiner plusieurs filtres de dimensions. S'il n'est pas spécifié, il est traité comme un OR.

filters[]

object(DimensionFilter)

Ensemble répété de filtres. Ils sont combinés de façon logique en fonction de l'opérateur spécifié.

Opérateur de filtre de journal

Combinaison logique des filtres

Enums
OPERATOR_UNSPECIFIED Opérateur non spécifié. Il est traité comme un OR.
OR L'opérateur logique OR.
AND L'opérateur logique AND.

Filtre de dimension

Le filtre de dimension spécifie les options de filtrage d'une dimension.

Représentation JSON
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
Champs
dimensionName

string

Dimension sur laquelle filtrer. Un DimensionFilter doit contenir une dimension.

not

boolean

Opérateur logique NOT. Si cette valeur booléenne est définie sur "true", les valeurs de dimension correspondantes seront exclues du rapport. La valeur par défaut est "false" (inactif).

operator

enum(Operator)

Comment faire correspondre la dimension à l'expression ? La valeur par défaut est REGEXP.

expressions[]

string

Chaînes ou expression régulière à rechercher. Seule la première valeur de la liste est utilisée pour la comparaison, sauf si l'opérateur est IN_LIST. Si l'opérateur IN_LIST est utilisé, toute la liste est utilisée pour filtrer les dimensions, comme expliqué dans la description de l'opérateur IN_LIST.

caseSensitive

boolean

La correspondance doit-elle être sensible à la casse ? La valeur par défaut est "false".

Opérateur

Différents types de correspondance acceptés.

Enums
OPERATOR_UNSPECIFIED Si le type de correspondance n'est pas spécifié, il est traité comme un REGEXP.
REGEXP L'expression de correspondance est traitée comme une expression régulière. Tous les types de correspondance ne sont pas traités comme des expressions régulières.
BEGINS_WITH Correspond à la valeur commençant par l'expression de correspondance fournie.
ENDS_WITH Correspond aux valeurs qui se terminent par l'expression de correspondance fournie.
PARTIAL Correspondance de sous-chaîne.
EXACT La valeur doit correspondre entièrement à l'expression de correspondance.
NUMERIC_EQUAL

Filtres de comparaison d'entiers. La sensibilité à la casse est ignorée et l'expression est considérée comme une chaîne représentant un entier. Conditions d'échec:

  • Si l'expression n'est pas un entier int64 valide, le client doit s'attendre à une erreur.
  • Les dimensions d'entrée qui ne sont pas des valeurs int64 valides ne correspondront jamais au filtre.
NUMERIC_GREATER_THAN Vérifie si la dimension est numériquement supérieure à l'expression de correspondance. Lisez la description de NUMERIC_EQUALS pour connaître les restrictions.
NUMERIC_LESS_THAN Vérifie si la dimension est numériquement inférieure à l'expression de correspondance. Lisez la description de NUMERIC_EQUALS pour connaître les restrictions.
IN_LIST

Cette option permet de spécifier un filtre de dimension dont l'expression peut utiliser n'importe quelle valeur d'une liste de valeurs sélectionnée. Cela permet d'éviter d'évaluer plusieurs filtres de dimensions de mots clés exacts qui sont OU par une seule ligne de réponse. Exemple :

expressions: ["A", "B", "C"]

Toute ligne de réponse dont la dimension a cette valeur est A, B ou C, correspond à ce DimensionFilter.

Métrique

Les métriques sont les mesures quantitatives. Par exemple, la métrique ga:users indique le nombre total d'utilisateurs pour la période demandée.

Représentation JSON
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
Champs
expression

string

Expression de métrique dans la requête. Une expression est construite à partir d'un ou plusieurs chiffres et métriques. Les opérateurs acceptés sont les suivants: Plus (+), Moins (-), Négation (unaire -), Divisé par (/), Multiplié par (*), Parenthèse ; Nombres cardinaux positifs (0-9). Le nombre de chiffres après la virgule est limité à 1 024. Dans l'exemple ga:totalRefunds/ga:users, la plupart du temps, l'expression de métrique est un nom de métrique unique tel que ga:users. Ajout d'éléments MetricType mixtes (par exemple, CURRENCY + PERCENTAGE) entraînera des résultats inattendus.

alias

string

Un alias de l'expression de métrique est un autre nom de l'expression. L'alias peut être utilisé pour le filtrage et le tri. Ce champ est facultatif et utile si l'expression n'est pas une métrique unique, mais une expression complexe qui ne peut pas être utilisée pour le filtrage ni le tri. L'alias est également utilisé dans l'en-tête de la colonne de réponse.

formattingType

enum(MetricType)

Spécifie la mise en forme de l'expression métrique, par exemple INTEGER.

MetricType

Types de métriques.

Enums
METRIC_TYPE_UNSPECIFIED Le type de métrique n'est pas spécifié.
INTEGER Métrique entière.
FLOAT Métrique flottante.
CURRENCY Métrique de devise.
PERCENT Métrique en pourcentage.
TIME Métrique temporelle au format HH:MM:SS.

Clause MetricFilter

Représente un groupe de filtres de métriques. Définissez la valeur de l'opérateur pour spécifier la manière dont les filtres sont combinés logiquement.

Représentation JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
Champs
operator

enum(FilterLogicalOperator)

Opérateur permettant de combiner plusieurs filtres de métriques. S'il n'est pas spécifié, il est traité comme un OR.

filters[]

object(MetricFilter)

Ensemble répété de filtres. Ils sont combinés de façon logique en fonction de l'opérateur spécifié.

Filtre de métriques

MetricFilter spécifie le filtre sur une métrique.

Représentation JSON
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
Champs
metricName

string

Métrique qui sera filtrée. Un metricFilter doit contenir un nom de métrique. Un nom de métrique peut être un alias défini précédemment en tant que métrique ou une expression de métrique.

not

boolean

Opérateur logique NOT. Si cette valeur booléenne est définie sur "true", les valeurs des métriques correspondantes seront exclues du rapport. La valeur par défaut est "false" (inactif).

operator

enum(Operator)

Si la métrique EQUAL, LESS_THAN ou GREATER_THAN est la valeur de comparaison, la valeur par défaut est EQUAL. Si l'opérateur est IS_MISSING, vérifie s'il manque la métrique et ignore la valeur de comparaison.

comparisonValue

string

Valeur à comparer.

Opérateur

Différents types de comparaison

Enums
OPERATOR_UNSPECIFIED Si l'opérateur n'est pas spécifié, il est traité comme EQUAL.
EQUAL La valeur de la métrique doit-elle être exactement identique à la valeur de comparaison ?
LESS_THAN La valeur de la métrique doit être inférieure à la valeur de comparaison.
GREATER_THAN La valeur de la métrique doit être supérieure à la valeur de comparaison.
IS_MISSING Vérifie si la métrique est manquante. Ne compare pas la valeur value.

OrderBy

Spécifie les options de tri.

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

string

Champ selon lequel effectuer le tri. L'ordre de tri par défaut est croissant. Exemple : ga:browser Notez que vous ne pouvez spécifier qu'un seul champ pour le tri ici. Par exemple, ga:browser, ga:city n'est pas valide.

orderType

enum(OrderType)

Type de commande. Le type de commande par défaut est VALUE.

sortOrder

enum(SortOrder)

Ordre de tri du champ.

OrderType

OrderType contrôle la manière dont l'ordre de tri est déterminé.

Enums
ORDER_TYPE_UNSPECIFIED Le type de commande non spécifié sera traité comme un tri basé sur la valeur.
VALUE L'ordre de tri est basé sur la valeur de la colonne choisie. Il ne prend en compte que la première plage de dates.
DELTA L'ordre de tri est basé sur la différence des valeurs de la colonne choisie entre les deux premières plages de dates. Utilisable uniquement s'il existe exactement deux plages de dates.
SMART L'ordre de tri est basé sur la valeur pondérée de la colonne choisie. Si la colonne a un format "n/d", la valeur pondérée de ce ratio sera (n + totals.n)/(d + totals.d) utilisable uniquement pour les métriques qui représentent des ratios.
HISTOGRAM_BUCKET Le type d'ordre des histogrammes ne s'applique qu'aux colonnes de dimensions comportant des buckets d'histogrammes non vides.
DIMENSION_AS_INTEGER Si les dimensions correspondent à des nombres fixes de longueur fixe, le tri standard suffit. Vous pouvez utiliser DIMENSION_AS_INTEGER si les dimensions sont des nombres de longueur variable.

SortOrder

Ordre de tri du tri.

Enums
SORT_ORDER_UNSPECIFIED Si l'ordre de tri n'est pas spécifié, la valeur par défaut est croissante.
ASCENDING Tri croissant. Le champ est trié dans l'ordre croissant.
DESCENDING Tri décroissant. Le champ est trié de façon décroissante.

Segment

Définition du segment, si le rapport doit être segmenté. Un segment correspond à un sous-ensemble de données Analytics. Par exemple, parmi l'ensemble des utilisateurs, un segment peut inclure les utilisateurs d'un pays ou d'une ville spécifiques.

Représentation JSON
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
Champs
Champ d'union dynamicOrById. Vous pouvez définir ce segment de façon dynamique à l'aide d'un segment dynamique ou en utilisant l'ID d'un segment intégré ou personnalisé. dynamicOrById ne peut être qu'un des éléments suivants :
dynamicSegment

object(DynamicSegment)

Définition de segment dynamique dans la requête.

segmentId

string

ID d'un segment intégré ou personnalisé, par exemple gaid::-3.

Segment dynamique

Définition de segment dynamique pour définir le segment dans la requête. Un segment peut sélectionner des utilisateurs, des sessions ou les deux.

Représentation JSON
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  }
}
Champs
name

string

Nom du segment dynamique.

userSegment

object(SegmentDefinition)

Segment utilisateur pour sélectionner les utilisateurs à inclure dans le segment.

sessionSegment

object(SegmentDefinition)

Segment de session pour sélectionner les sessions à inclure dans le segment.

Définition du segment

SegmentDefinition définit le segment comme un ensemble de filtres qui sont combinés avec une opération logique AND.

Représentation JSON
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ]
}
Champs
segmentFilters[]

object(SegmentFilter)

Un segment est défini par un ensemble de filtres de segments combinés à une opération logique AND.

Filtre de segments

SegmentFilter définit le segment comme un segment simple ou un segment de séquence. Une condition de segment simple contient des conditions de dimension et de métrique permettant de sélectionner les sessions ou les utilisateurs. Une condition de segment de séquence permet de sélectionner des utilisateurs ou des sessions selon des conditions séquentielles.

Représentation JSON
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
Champs
not

boolean

Si la valeur est "true", des annonces doivent être complémentaires du segment simple ou du segment de séquence. Par exemple, pour faire correspondre toutes les visites ne provenant pas de New York, nous pouvons définir le segment comme suit:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

Champ d'union simpleOrSequence. S'agit-il d'un segment simple ou d'une définition de segment de séquence ? simpleOrSequence ne peut être qu'un des éléments suivants :
simpleSegment

object(SimpleSegment)

Une condition de segment simple est composée d'une ou de plusieurs conditions de dimension/métrique pouvant être combinées

sequenceSegment

object(SequenceSegment)

Les conditions de la séquence comportent une ou plusieurs étapes, chacune étant définie par une ou plusieurs conditions de dimension/métrique. Vous pouvez combiner plusieurs étapes avec des opérateurs de séquence spéciaux.

Segment simple

Une condition de segment simple est composée d'une ou de plusieurs conditions de dimension/métrique pouvant être combinées.

Représentation JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ]
}
Champs
orFiltersForSegment[]

object(OrFiltersForSegment)

Liste de groupes de filtres de segment combinés à l'opérateur logique AND.

FiltresPourSegment

Une liste de filtres de segment du groupe OR est combinée avec l'opérateur logique "OU".

Représentation JSON
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ]
}
Champs
segmentFilterClauses[]

object(SegmentFilterClause)

Liste des filtres de segment à combiner avec un opérateur OR.

Clause SegmentFilter

Clause de filtre à utiliser dans une définition de segment, pouvant être une métrique ou un filtre de dimension.

Représentation JSON
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
Champs
not

boolean

Correspond au complément (!) du filtre.

Champ d'union dimensionOrMetricFilter. Une dimension ou un filtre de métrique. dimensionOrMetricFilter ne peut être qu'un des éléments suivants :
dimensionFilter

object(SegmentDimensionFilter)

Filtre de dimension pour la définition du segment.

metricFilter

object(SegmentMetricFilter)

Filtre de métriques pour la définition du segment.

Filtre de dimension de segment

Le filtre de dimension spécifie les options de filtrage d'une dimension.

Représentation JSON
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
Champs
dimensionName

string

Nom de la dimension pour laquelle le filtre est appliqué.

operator

enum(Operator)

Opérateur à utiliser pour faire correspondre la dimension avec les expressions.

caseSensitive

boolean

Si la correspondance est sensible à la casse, ignorée pour l'opérateur IN_LIST.

expressions[]

string

Liste des expressions. Seul le premier élément est utilisé pour tous les opérateurs.

minComparisonValue

string

Valeurs de comparaison minimales pour le type de correspondance BETWEEN.

maxComparisonValue

string

Valeurs maximales de comparaison pour le type de correspondance BETWEEN.

Opérateur

Différents types de correspondance acceptés.

Enums
OPERATOR_UNSPECIFIED Si le type de correspondance n'est pas spécifié, il est considéré comme une expression REGEXP.
REGEXP L'expression de correspondance est traitée comme une expression régulière. Tous les autres types de correspondance ne sont pas traités comme des expressions régulières.
BEGINS_WITH Correspond aux valeurs qui commencent par l'expression de correspondance fournie.
ENDS_WITH Correspond aux valeurs qui se terminent par l'expression de correspondance fournie.
PARTIAL Correspondance de sous-chaîne.
EXACT La valeur doit correspondre entièrement à l'expression de correspondance.
IN_LIST

Cette option permet de spécifier un filtre de dimension dont l'expression peut utiliser n'importe quelle valeur d'une liste de valeurs sélectionnée. Cela permet d'éviter d'évaluer plusieurs filtres de dimensions de mots clés exacts qui sont OU par une seule ligne de réponse. Exemple :

expressions: ["A", "B", "C"]

Toute ligne de réponse dont la dimension a cette valeur est A, B ou C, correspond à ce DimensionFilter.

NUMERIC_LESS_THAN

Filtres de comparaison d'entiers. La sensibilité à la casse est ignorée et l'expression est considérée comme une chaîne représentant un entier. Conditions d'échec:

  • Si l'expression n'est pas un entier int64 valide, le client doit s'attendre à une erreur.
  • Les dimensions d'entrée qui ne sont pas des valeurs int64 valides ne correspondront jamais au filtre.

Vérifie si la dimension est numériquement inférieure à l'expression de correspondance.

NUMERIC_GREATER_THAN Vérifie si la dimension est numériquement supérieure à l'expression de correspondance.
NUMERIC_BETWEEN Vérifie si la dimension est numériquement comprise entre le minimum et le maximum de l'expression de correspondance (les limites sont exclues).

Filtre de métrique de segment

Filtre de métrique à utiliser dans une clause de filtre de segment.

Représentation JSON
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
Champs
scope

enum(Scope)

La portée définie pour une métrique correspond au niveau auquel elle est définie. Le champ d'application de la métrique spécifié doit être supérieur ou égal à son champ d'application principal, tel que défini dans le modèle de données. Le champ d'application principal est défini selon que le segment sélectionne des utilisateurs ou des sessions.

metricName

string

Métrique qui sera filtrée. Un metricFilter doit contenir un nom de métrique.

operator

enum(Operator)

Spécifie l'opération à effectuer pour comparer la métrique. La valeur par défaut est EQUAL.

comparisonValue

string

Valeur à comparer. Si l'opérateur est BETWEEN, cette valeur est traitée comme une valeur de comparaison minimale.

maxComparisonValue

string

La valeur de comparaison maximale n'est utilisée que pour l'opérateur BETWEEN.

Portée

La portée définie pour une métrique correspond au niveau auquel elle est définie (PRODUCT, HIT, SESSION ou USER). Les valeurs de métriques peuvent également être enregistrées à des niveaux d'accès supérieurs à son champ d'application principal. Par exemple, Les rapports ga:pageviews et ga:transactions peuvent être rapportés au niveau de SESSION et du USER en les additionnant pour chaque appel survenu au cours de ces sessions ou pour ces utilisateurs.

Enums
UNSPECIFIED_SCOPE Si le champ d'application n'est pas spécifié, la portée est définie par défaut sur USER ou SESSION, selon que le segment tente de choisir des utilisateurs ou des sessions.
PRODUCT Portée du produit.
HIT Portée.
SESSION Portée de la session.
USER Portée définie au niveau de l'utilisateur.

Opérateur

Différents types de comparaison

Enums
UNSPECIFIED_OPERATOR L'opérateur non spécifié est traité comme un opérateur LESS_THAN.
LESS_THAN Vérifie si la valeur de la métrique est inférieure à la valeur de comparaison.
GREATER_THAN Vérifie si la valeur de la métrique est supérieure à la valeur de comparaison.
EQUAL Est égal à l'opérateur.
BETWEEN Pour les deux opérateurs, les valeurs minimale et maximale sont exclusives. Nous allons comparer LT et GT.

Segment de séquence

Les conditions de la séquence comportent une ou plusieurs étapes, chacune étant définie par une ou plusieurs conditions de dimension/métrique. Vous pouvez combiner plusieurs étapes avec des opérateurs de séquence spéciaux.

Représentation JSON
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
Champs
segmentSequenceSteps[]

object(SegmentSequenceStep)

Liste des étapes de la séquence.

firstStepShouldMatchFirstHit

boolean

Si elle est définie, la première condition de l'étape doit correspondre au premier appel du visiteur (dans la plage de dates).

Étape de la séquence du segment

Définition d'une séquence de segment.

Représentation JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
Champs
orFiltersForSegment[]

object(OrFiltersForSegment)

Une séquence est spécifiée avec une liste de filtres"OU groupés"associés à l'opérateur AND.

matchType

enum(MatchType)

Indique si l'étape précède immédiatement ou peut être n'importe quel moment avant l'étape suivante.

MatchType

Type de correspondance de la séquence.

Enums
UNSPECIFIED_MATCH_TYPE Le type de correspondance non spécifié est traité comme des précédents.
PRECEDES L'opérateur indique que l'étape précédente précède l'étape suivante.
IMMEDIATELY_PRECEDES L'opérateur indique que l'étape précédente précède immédiatement l'étape suivante.

Tableau croisé dynamique

Le tableau croisé dynamique décrit la section correspondante de la requête. Le tableau croisé dynamique permet de réorganiser les informations de certains rapports du tableau en appliquant une seconde dimension à vos données.

Représentation JSON
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
Champs
dimensions[]

object(Dimension)

Liste de dimensions à afficher sous forme de colonnes croisées. Un tableau croisé dynamique ne peut pas contenir plus de quatre dimensions. Les dimensions de tableau croisé dynamique font partie de la restriction sur le nombre total de dimensions autorisées dans la requête.

dimensionFilterClauses[]

object(DimensionFilterClause)

Les dimensions DimensionFilter sont combinées de façon logique avec un opérateur AND: seules les données incluses dans toutes ces dimensions contribuent aux valeurs de cette région pivot. Les filtres de dimensions permettent de restreindre les colonnes affichées dans la zone pivot. Par exemple, si ga:browser est la dimension demandée dans la zone pivot et si vous spécifiez des filtres clés pour limiter ga:browser à"IE"ou"Firefox", seuls ces deux navigateurs s'affichent sous forme de colonnes.

metrics[]

object(Metric)

Métriques croisées. Les métriques de tableau croisé dynamique font partie de la restriction sur le nombre total de métriques autorisées dans la requête.

startGroup

number

Si k métriques ont été demandées, la réponse contiendra un multiple de k colonnes dépendant des données du rapport. Exemple : si vous avez pivoté sur la dimension ga:browser, vous obtenez k colonnes pour "Firefox", k colonnes pour "IE", "k" pour "Chrome", etc. L'ordre des groupes de colonnes est déterminé par ordre décroissant de "total" pour la première des k valeurs. Les liens sont rompus selon l'ordre lexicographique de la première dimension de tableau croisé dynamique, puis dans celui de la deuxième dimension, et ainsi de suite. Par exemple, si les totaux pour la première valeur de Firefox, IE et Chrome sont respectivement 8, 2 et 8, l'ordre des colonnes est Chrome, Firefox, IE.

La liste suivante vous permet de choisir le groupe de k colonnes à inclure dans la réponse.

maxGroupCount

number

Indique le nombre maximal de groupes à afficher. La valeur par défaut est 10 et la valeur maximale 1 000.

Groupe de cohortes

Définit un groupe de cohortes. Exemple :

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
Représentation JSON
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
Champs
cohorts[]

object(Cohort)

Définition de la cohorte.

lifetimeValue

boolean

Activez la valeur vie client. La LTV mesure la valeur vie des utilisateurs acquis via différents canaux. Veuillez consulter : Analyse des cohortes et Valeur vie Si la valeur vie est "false" :

  • Les valeurs des métriques sont semblables à celles du rapport sur les cohortes de l'interface Web.
  • Les plages de dates de la définition de la cohorte doivent correspondre à la semaine calendaire et au mois. Par exemple, si vous demandez ga:cohortNthWeek, startDate doit être défini un dimanche et endDate le samedi suivant. Pour ga:cohortNthMonth, startDate doit correspondre au 1er du mois et endDate doit correspondre au dernier jour du mois.

Lorsque "lifeValue" est "true" :

  • Les valeurs des métriques correspondent aux valeurs du rapport sur la valeur LifeTime de l'interface Web.
  • Le rapport sur la valeur vie indique l'évolution de la valeur des utilisateurs (revenus) et de l'engagement (vues d'application, objectifs réalisés, sessions et durée de la session) au cours des 90 jours suivant l'acquisition d'un utilisateur.
  • Elles sont calculées sous la forme d'une moyenne cumulée par utilisateur et par incrément de temps.
  • Les plages de dates de la définition de la cohorte ne doivent pas correspondre aux limites de la semaine et du mois calendaires.
  • viewId doit être un ID de vue d'application

Cohort

Définit une cohorte. Une cohorte est un groupe d'utilisateurs qui partagent une caractéristique commune. Par exemple, tous les utilisateurs ayant la même date d'acquisition forment une cohorte.

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

string

Nom unique de la cohorte. S'il n'est pas défini, le nom sera généré automatiquement avec les valeurs cohort_[1234...].

type

enum(Type)

Type de cohorte. Pour le moment, le seul type compatible est FIRST_VISIT_DATE. Si ce champ n'est pas spécifié, la cohorte est traitée comme une cohorte de type FIRST_VISIT_DATE.

dateRange

object(DateRange)

Cette valeur est utilisée pour la cohorte FIRST_VISIT_DATE, qui sélectionne les utilisateurs dont la première date de visite se situe entre la date de début et la date de fin définies dans la plage de dates. Les plages de dates doivent être alignées pour les demandes de cohortes. Si la requête contient ga:cohortNthDay, elle doit durer exactement un jour. Dans le cas de ga:cohortNthWeek, elle doit correspondre à la limite de la semaine (qui commence le dimanche et se termine le samedi). Pour ga:cohortNthMonth, la plage de dates doit correspondre au mois (qui commence le premier et se termine le dernier jour du mois). Pour les requêtes LTV, il n'existe aucune restriction de ce type. Il n'est pas nécessaire de fournir une plage de dates pour le champ reportsRequest.dateRanges.

Type

Type de cohorte.

Enums
UNSPECIFIED_COHORT_TYPE Si elle n'est pas spécifiée, elle est traitée comme FIRST_VISIT_DATE.
FIRST_VISIT_DATE Cohortes sélectionnées en fonction de la date de la première visite.

Rapport

Réponse de données correspondant à la requête.

Représentation JSON
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
Champs
columnHeader

object(ColumnHeader)

En-têtes de colonne.

data

object(ReportData)

Données de réponse.

nextPageToken

string

Jeton de page pour récupérer la page de résultats suivante dans la liste.

En-tête de colonne

En-têtes de colonnes.

Représentation JSON
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
Champs
dimensions[]

string

Noms des dimensions dans la réponse.

metricHeader

object(MetricHeader)

En-têtes pour les métriques dans la réponse.

MetricHeader

En-têtes des métriques.

Représentation JSON
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
Champs
metricHeaderEntries[]

object(MetricHeaderEntry)

En-têtes des métriques dans la réponse.

pivotHeaders[]

object(PivotHeader)

En-têtes des tableaux croisés dynamiques dans la réponse.

MetricHeaderEntry

En-tête des métriques.

Représentation JSON
{
  "name": string,
  "type": enum(MetricType)
}
Champs
name

string

Nom de l'en-tête.

type

enum(MetricType)

Type de la métrique, par exemple INTEGER.

PivotHeader

En-têtes de chacune des sections pivots définies dans la requête.

Représentation JSON
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
Champs
pivotHeaderEntries[]

object(PivotHeaderEntry)

En-tête de section croisé dynamique.

totalPivotGroupsCount

number

Nombre total de groupes pour ce tableau croisé dynamique.

PivotHeaderEntry

En-têtes de chaque colonne de métrique correspondant aux métriques demandées dans la section "Pivots" de la réponse.

Représentation JSON
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
Champs
dimensionNames[]

string

Nom des dimensions dans la réponse du tableau croisé dynamique.

dimensionValues[]

string

Valeurs des dimensions du tableau croisé dynamique.

metric

object(MetricHeaderEntry)

En-tête de métrique dans le tableau croisé dynamique.

Données du rapport

Partie des données du rapport.

Représentation JSON
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
Champs
rows[]

object(ReportRow)

Il existe une ligne ReportReport pour chaque combinaison unique de dimensions.

totals[]

object(DateRangeValues)

Pour chaque plage de dates demandée, pour l'ensemble des lignes correspondant à la requête, chaque format de valeur demandé obtient un total. Le total d'un format de valeur est calculé en additionnant d'abord les métriques mentionnées dans le format de valeur, puis en évaluant le format de valeur en tant qu'expression scalaire. Par exemple, &Total pour 3 / (ga:sessions + 2), nous calculons 3 / ((sum of all relevant ga:sessions) + 2). Les totaux sont calculés avant la pagination.

rowCount

number

Nombre total de lignes correspondantes pour cette requête.

minimums[]

object(DateRangeValues)

Valeurs minimale et maximale affichées sur toutes les lignes correspondantes. Elles sont toutes les deux vides lorsque hideValueRanges dans la requête est faux ou lorsque le nombre de lignes est égal à zéro.

maximums[]

object(DateRangeValues)

Valeurs minimale et maximale affichées sur toutes les lignes correspondantes. Elles sont toutes les deux vides lorsque hideValueRanges dans la requête est faux ou lorsque le nombre de lignes est égal à zéro.

samplesReadCounts[]

string (int64 format)

Si les résultats sont échantillonnés, cette fonction renvoie le nombre total d'échantillons lus, soit une entrée par plage de dates. Si les résultats ne sont pas échantillonnés, ce champ ne sera pas défini. Pour en savoir plus, consultez le guide du développeur.

samplingSpaceSizes[]

string (int64 format)

Si les résultats sont échantillonnés, cette fonction renvoie le nombre total d'échantillons présents (une entrée par plage de dates). Si les résultats ne sont pas échantillonnés, ce champ ne sera pas défini. Pour en savoir plus, consultez le guide du développeur.

isDataGolden

boolean

Indique si la réponse à cette requête est en or ou non. Les données sont dorées lorsque la même requête ne génère aucun nouveau résultat si vous la demandez plus tard.

dataLastRefreshed

string (Timestamp format)

Dernière actualisation des données du rapport. Tous les appels reçus avant cet horodatage sont inclus dans le calcul du rapport.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z"

Ligne du rapport

Une ligne dans le rapport

Représentation JSON
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
Champs
dimensions[]

string

Liste des dimensions demandées.

metrics[]

object(DateRangeValues)

Liste des métriques pour chaque plage de dates demandée.

Valeurs de plage de dates

Utilisé pour renvoyer une liste de métriques pour une seule combinaison DateRange / Dimension

Représentation JSON
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
Champs
values[]

string

Chaque valeur correspond à chaque métrique de la requête.

pivotValueRegions[]

object(PivotValueRegion)

Valeurs de chaque région pivot.

PivotValueRegion

Valeurs de métriques dans la région pivot.

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

string

Valeurs des métriques dans chacune des régions pivots.

Quotas de ressources restants

Jetons de quota de ressources restants pour la propriété une fois la requête terminée.

Représentation JSON
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
Champs
dailyQuotaTokensRemaining

number

Quota de ressources quotidiennes restantes.

hourlyQuotaTokensRemaining

number

Jetons de quota de ressources horaires restants.

Essayer