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 aura une réponse distincte. Le nombre de requêtes est limité à 5. Toutes les requêtes doivent avoir les mêmes paramètres 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'activer les taux d'échantillonnage. (10 millions pour SMALL, 100 millions 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 :

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

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

object(Report)

Réponses correspondant à chacune des requêtes.

queryCost

number

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

resourceQuotasRemaining

object(ResourceQuotasRemaining)

Quota de ressources restant 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 de requête principale 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 les données. Chaque demande ReportRequest dans une méthode batchGet doit contenir le même viewId.

dateRanges[]

object(DateRange)

Plages de dates de la requête. La demande peut être associée à deux plages de dates au maximum. La réponse contiendra 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 y a deux plages de dates, il y aura deux jeux de valeurs de statistiques : l'un pour la plage de dates d'origine et l'autre pour la seconde. Le champ reportRequest.dateRanges ne doit pas être spécifié pour les cohortes ou les demandes de valeur vie. Si aucune plage de dates n'est indiquée, la plage de dates par défaut est (startDate: date du jour - 7 jours, endDate: date du jour - 1 jour). Chaque demande ReportRequest dans une méthode batchGet doit contenir la même définition dateRanges.

samplingLevel

enum(Sampling)

La taille d'échantillon de rapport souhaitée. Si le champ samplingLevel n'est pas spécifié, le niveau d'échantillonnage DEFAULT est utilisé. Chaque demande ReportRequest dans 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 requêtes peuvent comporter au total neuf dimensions.

dimensionFilterClauses[]

object(DimensionFilterClause)

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 s'effectue avant que les dimensions ne soient agrégées. Ainsi, les métriques renvoyées représentent le total des dimensions pertinentes.

metrics[]

object(Metric)

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

metricFilterClauses[]

object(MetricFilterClause)

Les clauses de filtre de métrique. Ils sont combinés de manière logique avec l'opérateur AND. Les filtres de métriques n'examinent que la première plage de dates, et non la période de comparaison. Notez que le filtrage des métriques s'effectue après leur agrégation.

filtersExpression

string

Filtres de dimensions ou de métriques qui limitent les données renvoyées pour votre requête. Pour utiliser l'filtersExpression, indiquez une dimension ou une métrique sur laquelle filtrer, suivi 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 présentent le même ordre des lignes.

segments[]

object(Segment)

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

pivots[]

object(Pivot)

Les définitions des 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 comporte un groupe de cohorte, la dimension ga:cohort doit être présente. Chaque demande ReportRequest dans une méthode batchGet doit contenir la même définition cohortGroup.

pageToken

string

Un jeton de continuation pour obtenir la page de résultats suivante. Si vous l'ajoutez à la requête, les lignes situées après "pageToken" seront renvoyées. "pageToken" doit correspondre à 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 supérieure ou égale à 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 demande, quel que soit le nombre demandé. Il peut également renvoyer moins de lignes que demandé, s'il n'y a pas autant de segments de dimensions que prévu. Par exemple, il y a moins de 300 valeurs possibles pour ga:country. Par conséquent, lorsque vous segmentez uniquement par pays, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez pageSize sur une valeur supérieure.

includeEmptyRows

boolean

Si la valeur est "false", la réponse n'inclut pas de 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 cette règle est définie sur "True", elle masque le total de toutes les métriques pour toutes les lignes correspondantes et pour chaque plage de dates. La valeur par défaut "false" et renvoie les totaux.

hideValueRanges

boolean

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

Échantillonnage

Valeurs pour le 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 une taille d'échantillon qui équilibre la vitesse et la précision.
SMALL Elle renvoie une réponse rapide avec une taille d'échantillon plus petite.
LARGE Renvoie une réponse plus précise en utilisant une taille d'échantillon importante. 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 champ n'est pas vide, les valeurs des dimensions sont placées dans des buckets après la chaîne, puis en int64. Les valeurs de dimension qui ne correspondent pas à la représentation sous forme de chaîne d'une valeur intégrale seront converties en zéro. Les valeurs du bucket doivent être dans un ordre croissant. Chaque bucket est fermé en bas et ouvert en haut. Le "premier" bucket inclut toutes les valeurs inférieures à la première limite, et le "dernier" bucket inclut toutes les valeurs jusqu'à l'infini. Les valeurs des dimensions appartenant à un bucket sont transformées en une nouvelle valeur de dimension. Par exemple, si l'on donne une liste de "0, 1, 3, 4, 7", nous renvoyons les buckets suivants:

  • Ensemble n° 1: valeurs < 0, valeur de la dimension "<0"
  • Ensemble n° 2: valeurs comprises entre [0,1), valeur de dimension "0"
  • Ensemble n° 3: valeurs comprises entre [1,3] et valeur de dimension "1-2"
  • Ensemble n° 4: valeurs comprises entre [3,4] et valeur de dimension "3"
  • Ensemble n° 5: valeurs entre [4,7), valeur de dimension "4-6"
  • Ensemble n° 6: valeurs >= 7, valeur de dimension "7+"

REMARQUE: Si vous appliquez une mutation d'histogramme à n'importe quelle dimension et que vous utilisez cette dimension pour trier, nous vous conseillons d'utiliser le type de tri HISTOGRAM_BUCKET à cette fin. Sinon, les valeurs des dimensions seront triées dans l'ordre (lexicographique) du dictionnaire. Par exemple, l'ordre croissant du dictionnaire est:

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

Et l'ordre croissant des HISTOGRAM_BUCKET est le suivant:

"<50", "50-120", "121-1000", "1001 et plus"

Le client doit demander explicitement à "orderType": "HISTOGRAM_BUCKET" une dimension dont l'histogramme a été modifié.

DimensionFilterClause

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 de manière logique.

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 manière logique en fonction de l'opérateur spécifié.

FilterLogicalOperator

Comment les filtres sont combinés de manière logique.

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

DimensionFilter

Le filtre de dimension spécifie les options de filtrage appliquées à une dimension.

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

string

Dimension à utiliser pour le filtrage. Un DimensionFilter doit contenir une dimension.

not

boolean

Opérateur NOT logique. 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".

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 à mettre en correspondance. 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é, la liste entière permet de 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 sont 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 se terminant 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 pour ces filtres, et l'expression est considérée comme une chaîne représentant un entier. Conditions d'échec:

  • Si l'expression n'est pas une valeur 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 dans une liste sélectionnée de valeurs. Cela permet d'éviter d'évaluer plusieurs filtres de dimensions de correspondance exacte associés à l'opérateur OU pour chaque ligne de réponse. Exemple :

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

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

Métrique

Les métriques sont des 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'une ou de plusieurs métriques et nombres. Les opérateurs acceptés incluent: Plus (+), Moins (-), Négation (Unaire -), Divisé par (/), Multiplié par (*), Parenthèse, Nombres cardinaux positifs (0-9). Ils peuvent inclure des nombres décimaux et sont limités à 1 024 caractères. Par exemple, ga:totalRefunds/ga:users : dans la plupart des cas, l'expression de métrique n'est qu'un seul nom de métrique, comme ga:users. Ajouter des MetricType mixtes (par exemple, CURRENCY + PERCENTAGE) produira des résultats inattendus.

alias

string

L'alias de l'expression de métrique est un nom alternatif de l'expression. L'alias peut être utilisé pour le filtrage et le tri. Ce champ est facultatif et est 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 et le tri. L'alias est également utilisé dans l'en-tête de la colonne de réponse.

formattingType

enum(MetricType)

Spécifie le format de l'expression de 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 de nombre entier.
FLOAT Métrique flottante.
CURRENCY Métrique de devise.
PERCENT Métrique en pourcentage.
TIME Métrique temporelle au format HH:MM:SS.

MetricFilterClause

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 de manière logique.

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 manière logique en fonction de l'opérateur spécifié.

MetricFilter

"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 paramètre 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 NOT logique. Si cette valeur booléenne est définie sur "true", les valeurs de métriques correspondantes seront exclues du rapport. La valeur par défaut est "false".

operator

enum(Operator)

Si la métrique est EQUAL, LESS_THAN ou GREATER_THAN, la valeur "compareValue" est-elle utilisée ? La valeur par défaut est EQUAL. Si l'opérateur est IS_MISSING, vérifie si la métrique est manquante 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 être exactement égale à 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 prend pas en compte comparaisonValue.

OrderBy

Spécifie les options de tri.

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

string

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

orderType

enum(OrderType)

Type de commande. La valeur par défaut "orderType" 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 Un type de commande non spécifié sera traité comme un tri en fonction de la valeur.
VALUE L'ordre de tri est basé sur la valeur de la colonne choisie. 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 le format "n/d", la valeur pondérée de ce ratio sera (n + totals.n)/(d + totals.d). Elle ne sera utilisable que pour les métriques qui représentent des ratios.
HISTOGRAM_BUCKET Le type d'ordre d'histogramme ne s'applique qu'aux colonnes de dimension comportant des buckets d'histogramme non vides.
DIMENSION_AS_INTEGER Si les dimensions sont des nombres de longueur fixe, le tri ordinaire fonctionne parfaitement. 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 par ordre croissant. Le champ sera trié par ordre croissant.
DESCENDING Tri par ordre décroissant. Le champ sera trié par ordre décroissant.

Segment

La définition du segment, si le rapport doit être segmenté Un segment est un sous-ensemble des données Analytics. Par exemple, un segment peut regrouper les utilisateurs d'un pays ou d'une ville spécifique.

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. Le segment peut être défini dynamiquement à l'aide de DynamicSegment ou à l'aide de l'ID d'un segment intégré ou personnalisé. dynamicOrById ne peut être qu'un des éléments suivants :
dynamicSegment

object(DynamicSegment)

Une définition de segment dynamique dans la requête.

segmentId

string

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

DynamicSegment

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 d'utilisateurs pour sélectionner les utilisateurs à inclure dans le segment.

sessionSegment

object(SegmentDefinition)

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

SegmentDefinition

SegmentDefinition définit le segment comme un ensemble de SegmentFilters associés à une opération AND logique.

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

object(SegmentFilter)

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

SegmentFilter

SegmentFilter définit ce segment comme étant 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. Vous pouvez utiliser une condition de segment de séquence pour sélectionner des utilisateurs ou des sessions en fonction de 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", correspond au complément d'un segment simple ou de séquence. Par exemple, pour prendre en compte 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 d'un segment de séquence ? simpleOrSequence ne peut être qu'un des éléments suivants :
simpleSegment

object(SimpleSegment)

Les conditions d'un segment simple sont constituées d'une ou de plusieurs conditions de dimension/statistique qui peuvent être combinées

sequenceSegment

object(SequenceSegment)

Les conditions de séquence sont composées d'une ou de plusieurs étapes, où chaque étape est définie par une ou plusieurs conditions de dimension/métrique. Plusieurs étapes peuvent être associées à des opérateurs séquentiels spéciaux.

SimpleSegment

Les conditions d'un segment simple sont constituées d'une ou de plusieurs conditions de dimension/statistique qui peuvent être combinées.

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

object(OrFiltersForSegment)

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

OrFiltersForSegment

Une liste de filtres de segments dans le groupe OR est combinée à l'opérateur logique OR.

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

object(SegmentFilterClause)

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

SegmentFilterClause

Clause de filtre à utiliser dans une définition de segment, peut être associée à un filtre de métrique ou 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. Filtre de dimension ou 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 de segment.

SegmentDimensionFilter

Le filtre de dimension spécifie les options de filtrage appliquées à 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 à laquelle le filtre est appliqué.

operator

enum(Operator)

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

caseSensitive

boolean

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

expressions[]

string

Liste d'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 de comparaison maximales pour le type de correspondance BETWEEN.

Opérateur

Différents types de correspondance sont acceptés.

Enums
OPERATOR_UNSPECIFIED Si le type de correspondance n'est pas spécifié, il est considéré comme du type REGEXP.
REGEXP L'expression de correspondance est traitée comme une expression régulière. Les autres types de correspondance ne sont pas traités comme des expressions régulières.
BEGINS_WITH Correspond aux valeurs commençant par l'expression de correspondance fournie.
ENDS_WITH Correspond aux valeurs se terminant 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 dans une liste sélectionnée de valeurs. Cela permet d'éviter d'évaluer plusieurs filtres de dimensions de correspondance exacte associés à l'opérateur OU pour chaque ligne de réponse. Exemple :

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

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

NUMERIC_LESS_THAN

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

  • Si l'expression n'est pas une valeur int64 valide, le client doit s'attendre à une erreur.
  • des 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 les valeurs minimale et maximale de l'expression de correspondance, limites exclues.

SegmentMetricFilter

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'une métrique définit son niveau. Le champ d'application des métriques 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 élément 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.

Champ d'application

Le champ d'application d'une métrique définit le niveau auquel elle est définie (PRODUCT, HIT, SESSION ou USER). Les valeurs des métriques peuvent également être enregistrées à des niveaux d'accès supérieurs à leur champ d'application principal. Exemple : ga:pageviews et ga:transactions peuvent être enregistrés au niveau des SESSION et USER en les additionnant simplement pour chaque appel enregistré au cours de ces sessions ou pour ces utilisateurs.

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

Opérateur

Différents types de comparaison.

Enums
UNSPECIFIED_OPERATOR Un 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 Opérateur est égal à.
BETWEEN Pour l'opérateur AND, les valeurs minimale et maximale sont exclusives. Nous utiliserons LT et GT à des fins de comparaison.

SequenceSegment

Les conditions de séquence sont composées d'une ou de plusieurs étapes, où chaque étape est définie par une ou plusieurs conditions de dimension/métrique. Plusieurs étapes peuvent être associées à des opérateurs séquentiels spéciaux.

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

object(SegmentSequenceStep)

Liste des étapes de la séquence.

firstStepShouldMatchFirstHit

boolean

Si la condition de la première étape est définie, elle doit correspondre au premier appel effectué par le visiteur (au cours de la période).

SegmentSequenceStep

Une 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 groupés "OU" qui sont associés à l'opérateur AND.

matchType

enum(MatchType)

Indique si l'étape précède immédiatement ou peut être n'importe quand avant la prochaine étape.

MatchType

Type de correspondance de la séquence.

Enums
UNSPECIFIED_MATCH_TYPE Un 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.

Ajouter un tableau croisé dynamique

Le tableau croisé dynamique décrit la section correspondante de la demande. Le tableau croisé dynamique permet de réorganiser les informations du tableau de certains rapports 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 de tableau croisé dynamique. Un tableau croisé dynamique ne peut pas comporter plus de quatre dimensions. Les dimensions pivot font partie de la restriction sur le nombre total de dimensions autorisées dans la demande.

dimensionFilterClauses[]

object(DimensionFilterClause)

Les DimensionFilterClauses sont combinées de manière logique avec un opérateur AND: seules les données incluses par l'ensemble de ces DimensionFilterClauses contribuent aux valeurs de cette région de tableau croisé dynamique. Les filtres de dimensions peuvent être utilisés pour limiter les colonnes affichées dans la région du tableau croisé dynamique. Par exemple, si vous avez ga:browser comme dimension demandée dans la région du tableau croisé dynamique et que vous spécifiez des filtres clés pour limiter ga:browser à "IE" ou à "Firefox", seuls ces deux navigateurs s'afficheront sous forme de colonnes.

metrics[]

object(Metric)

Les métriques croisées Les métriques croisées font partie de la restriction sur le nombre total de métriques autorisées dans la demande.

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. Par exemple, si vous utilisez la dimension ga:browser comme pivot, vous obtenez k colonnes pour "Firefox ", k colonnes pour"IE ", k colonnes 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 brisés par ordre lexicographique de la première dimension de tableau croisé dynamique, puis par ordre lexicographique de la deuxième dimension de tableau croisé dynamique, et ainsi de suite. Par exemple, si les totaux pour la première valeur pour Firefox, IE et Chrome étaient respectivement de 8, 2 et 8, l'ordre des colonnes sera Chrome, Firefox, IE.

La commande suivante vous permet de choisir quels groupes de k colonnes sont inclus dans la réponse.

maxGroupCount

number

Spécifie le nombre maximal de groupes à renvoyer. La valeur par défaut est 10, et la valeur maximale est 1 000.

CohortGroup

Définit un groupe de cohorte. 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 (LTV). La LTV mesure la valeur vie des utilisateurs acquis via différents canaux. Veuillez consulter les sections Analyse des cohortes et Valeur vie. Si la valeur de "lifeValue" est "false", procédez comme suit :

  • 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 être alignées sur la semaine et le mois calendaires. Par exemple, lorsque vous demandez ga:cohortNthWeek, le startDate dans la définition de la cohorte doit correspondre à un dimanche, et endDate doit correspondre au samedi suivant. Pour ga:cohortNthMonth, startDate doit correspondre au 1er du mois et endDate doit être le dernier jour du mois.

Lorsque la valeur "lifeValue" est définie sur "true" :

  • Les valeurs de la métrique correspondront aux valeurs du rapport "Valeur vie" de l'interface Web.
  • Le rapport sur la valeur vie indique l'évolution de la valeur (revenu) et de l'engagement (applications vues, objectifs réalisés, sessions et durée des sessions) au cours des 90 jours suivant l'acquisition d'un utilisateur.
  • Les métriques sont calculées en tant que moyenne cumulée par utilisateur par incrément de temps.
  • Les plages de dates de la définition de la cohorte ne doivent pas être alignées sur les limites de la semaine calendaire et du mois.
  • 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 avec la même date d'acquisition appartiennent à la même 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. À l'heure actuelle, le seul type accepté 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)

Utilisé pour la cohorte FIRST_VISIT_DATE, celle-ci sélectionne les utilisateurs dont la première date de visite est comprise entre les dates de début et 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. Si elle est ga:cohortNthWeek, elle doit être alignée sur les limites de la semaine (du dimanche au samedi). Pour ga:cohortNthMonth, la plage de dates doit être alignée sur le mois (du premier jour au dernier jour du mois). Ces restrictions ne s'appliquent pas aux demandes LTV. Vous n'avez pas besoin d'indiquer de plage de dates pour le champ reportsRequest.dateRanges.

Type

Type de cohorte.

Enums
UNSPECIFIED_COHORT_TYPE Si aucune valeur n'est 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.

Incitez-le à faire un signalement

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 des réponses.

nextPageToken

string

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

ColumnHeader

En-têtes de colonne

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

string

Noms des dimensions dans la réponse.

metricHeader

object(MetricHeader)

En-têtes de métriques des métriques de 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 métrique (par exemple, INTEGER).

PivotHeader

En-têtes de chacune des sections de tableaux croisés dynamiques définies dans la demande.

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

object(PivotHeaderEntry)

Un en-tête de section de tableau croisé dynamique unique.

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 de tableaux croisés dynamiques 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 la métrique du tableau croisé dynamique.

ReportData

Partie "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 un élément ReportRow 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 pour 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. Exemple : Les "totaux" de 3 / (ga:sessions + 2) sont calculés comme suit : 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 visibles sur toutes les lignes correspondantes. Ils sont tous les deux vides si la valeur de hideValueRanges dans la requête est "false" ou si le nombre de lignes (rowCount) est égal à zéro.

maximums[]

object(DateRangeValues)

Valeurs minimale et maximale visibles sur toutes les lignes correspondantes. Ils sont tous les deux vides si la valeur de hideValueRanges dans la requête est "false" ou si le nombre de lignes (rowCount) est égal à zéro.

samplesReadCounts[]

string (int64 format)

Si les résultats sont échantillonnés, la fonction renvoie le nombre total d'échantillons lus, à raison d'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 option affiche le nombre total d'échantillons présents, à raison d'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 demande est correcte ou non. Les données sont essentielles lorsque la même demande ne produira pas de nouveaux résultats si vous la demandez ultérieurement.

dataLastRefreshed

string (Timestamp format)

Date et heure de la dernière actualisation des données du rapport. Tous les appels reçus avant ce code temporel 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"

ReportRow

Une ligne du 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.

DateRangeValues

Permet de 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 demande.

pivotValueRegions[]

object(PivotValueRegion)

Valeurs de chaque région pivot.

PivotValueRegion

Valeurs des 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.

ResourceQuotasRemaining

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

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

number

Quota de ressources quotidien restant.

hourlyQuotaTokensRemaining

number

Jetons de quota horaires restants.

Essayer