- Ressource: ReportTask
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ReportDefinition
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Dimension
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- DimensionExpression
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CaseExpression
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ConcatenateExpression
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Métrique
- DateRange
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- FilterExpression
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- FilterExpressionList
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Filtre
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StringFilter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MatchType
- InListFilter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- NumericFilter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Opération
- NumericValue
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- BetweenFilter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MetricAggregation
- OrderBy
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MetricOrderBy
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- DimensionOrderBy
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- OrderType
- CohortSpec
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Cohorte
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CohortsRange
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Précision
- CohortReportSettings
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ReportMetadata
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- É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 la tâche de rapport attribué lors de la création. Format : "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
Facultatif. Définition d'un rapport permettant d'extraire les données de rapport, qui décrivent la structure d'un rapport. Il comprend 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 du rapport pour une tâche de rapport spécifique, qui fournissent des informations sur un rapport. Il inclut généralement les informations suivantes: nom de la ressource du rapport, état du rapport, code temporel de création du rapport, etc. |
ReportDefinition
Définition de la manière dont un rapport doit être généré.
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 des 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, ce |
dimensionFilter |
Facultatif. Les filtres de dimensions vous permettent de demander uniquement des valeurs de dimensions spécifiques dans le rapport. Pour en savoir plus et voir des exemples, reportez-vous à la section 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 avoir agrégé les lignes du rapport, de la même manière que la clause SQL "Hunter". Impossible d'utiliser les dimensions dans ce filtre. |
offset |
Facultatif. Nombre de lignes de la première ligne de l'espace de stockage Google Analytics. La première ligne est comptabilisée comme 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é. La valeur de L'API peut également renvoyer moins de lignes que la valeur |
metricAggregations[] |
Facultatif. Agrégation des métriques Les valeurs des métriques agrégées seront affichées sur les lignes où les dimensionsValues 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 ISO4217, 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 cohortes associé à cette demande. Si la requête contient un groupe de cohortes, doit être présente. |
keepEmptyRows |
Facultatif. Si la valeur est "false" ou si aucune valeur n'est spécifiée, les lignes dont toutes les métriques sont égales à 0 ne sont pas renvoyées. Si la valeur est "true", ces lignes sont renvoyées si elles ne sont pas supprimées séparément par un filtre. 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'où provient un événement. Les valeurs des dimensions dans les réponses au rapport 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 Dimensions de l'API pour obtenir la liste des noms de dimensions compatibles avec 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 d'une expression de plusieurs dimensions. Par exemple, dimension "country, city": concatenate(country, ", ", city). |
DimensionExpression
Permet d'exprimer une dimension résultant d'une formule à plusieurs dimensions. Exemples d'utilisation: 1) lowerCase(dimension) 2) concatenate(dimension1, symbole, dimension2).
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union one_expression . Spécifiez un type d'expression de dimension pour DimensionExpression . La one_expression ne peut être qu'un des éléments suivants : |
|
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 dans une seule dimension. Par exemple, dimension "country, city": concatenate(country, ", ", city). |
CaseExpression
Permet de convertir une valeur de dimension en une seule casse.
Représentation JSON |
---|
{ "dimensionName": string } |
Champs | |
---|---|
dimensionName |
Nom d'une dimension. Le nom doit faire référence à un nom figurant dans le champ "Dimensions" de la requête. |
ConcatenateExpression
Permet de combiner des valeurs de dimension dans une seule dimension.
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 "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 il peut s'agir de chaînes plus longues. Si une valeur de dimension contient le délimiteur, les deux seront présents en réponse sans distinction. Par exemple, si la valeur de la dimension 1 = "US,FR", la valeur de 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. Vous pouvez envoyer jusqu'à 10 métriques par requête.
Représentation JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Champs | |
---|---|
name |
Nom de la métrique. Consultez 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 utilisée pour les métriques dérivées. Par exemple, la métrique "Nombre d'événements par utilisateur" est |
invisible |
Indique si une métrique est invisible dans la réponse du rapport. Si une métrique est invisible, elle ne génère pas de colonne dans la réponse, mais elle peut être utilisée dans |
DateRange
Un ensemble de jours contigus: startDate
, startDate + 1
, ..., endDate
. Les requêtes peuvent comporter jusqu'à quatre plages de dates.
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 correspondre à toutes les dimensions ou à toutes les 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 filterExpressions dans andGroup sont liés par une relation AND. |
orGroup |
Les filtres "FilterExpressions" dans orGroup ont une relation OR. |
notExpression |
La valeur "FilterExpression" n'est PAS "notExpression". |
filter |
Un filtre primitif. Dans une 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. Doit être un nom défini 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 dans les valeurs de la liste. |
numericFilter |
Filtre pour les valeurs numériques ou de date. |
betweenFilter |
Filtre entre deux valeurs. |
StringFilter
Le filtre pour la 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 chaîne. |
PARTIAL_REGEXP |
Correspondance partielle de l'expression régulière avec la valeur de chaîne. |
InListFilter
Le résultat doit figurer 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 de date.
Représentation JSON |
---|
{ "operation": enum ( |
Champs | |
---|---|
operation |
Type d'opération pour ce filtre. |
value |
Valeur numérique ou valeur de date. |
Opération
Opération appliquée à un filtre numérique
Enums | |
---|---|
OPERATION_UNSPECIFIED |
Non spécifié. |
EQUAL |
Égal |
LESS_THAN |
Inférieur à |
LESS_THAN_OR_EQUAL |
Inférieur(e) ou égal(e) à |
GREATER_THAN |
Supérieur(e) à |
GREATER_THAN_OR_EQUAL |
Supérieur(e) ou égal(e) à |
NumericValue
Pour 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 que l'un des éléments suivants: |
|
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 minimal. |
MAXIMUM |
Opérateur maximum. |
COUNT |
Opérateur nombre. |
OrderBy
Les options "Order by" définissent la façon dont les lignes sont triées dans la réponse. Par exemple, le tri des lignes par nombre décroissant d'événements correspond à un ordre de tri, et le tri des lignes par chaîne de nom d'événement dans un ordre différent.
Représentation JSON |
---|
{ "desc": boolean, // Union field |
Champs | |
---|---|
desc |
Si la valeur est "true", effectue le tri dans l'ordre décroissant. |
Champ d'union one_order_by . Spécifiez un type de commande par 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 pour trier les données. |
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 permettant de classer les valeurs de dimension de chaîne.
Enums | |
---|---|
ORDER_TYPE_UNSPECIFIED |
Non spécifié. |
ALPHANUMERIC |
Tri alphanumérique par point de code Unicode. Exemple : "2" < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Tri des caractères alphanumériques non sensibles à la casse par point de code Unicode minuscule. Exemple : "2" < "A" < "b" < "X" < "z". |
NUMERIC |
Les valeurs des dimensions sont converties en nombres avant le tri. Par exemple, pour 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 en dessous de 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 qui ont été acquis au cours de la première semaine de septembre et suivre cette cohorte pendant les six semaines suivantes. La sélection des utilisateurs acquis au cours de la première semaine de cohorte de septembre est spécifiée dans l'objet cohort
. Cette dernière est indiquée dans l'objet cohortsRange
pour les six prochaines semaines.
Pour obtenir des exemples, reportez-vous à la section Exemples de rapports sur les cohortes.
La réponse au rapport peut indiquer une série temporelle hebdomadaire dans laquelle votre application a retenu 60% de cette cohorte après trois semaines et 25% de cette cohorte après six semaines. Ces deux pourcentages peuvent être calculés à l'aide de la métrique cohortActiveUsers/cohortTotalUsers
et constitueront des lignes distinctes dans le rapport.
Représentation JSON |
---|
{ "cohorts": [ { object ( |
Champs | |
---|---|
cohorts[] |
Définit les critères de sélection pour regrouper les utilisateurs en cohortes. La plupart des rapports sur les cohortes ne définissent qu'une seule cohorte. Si plusieurs cohortes sont spécifiées, chacune d'elles peut être reconnue dans le rapport par son 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 sur laquelle suivre les cohortes. |
cohortReportSettings |
Paramètres facultatifs d'un rapport sur les cohortes. |
Cohorte
Définit un critère de sélection de cohorte. 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 n'est compatible qu'avec |
dateRange |
La cohorte sélectionne les utilisateurs dont la première date de contact est comprise entre la date de début et la date de fin définies dans les Dans une demande de cohorte, cet élément Ce |
CohortsRange
Configure la période étendue d'un rapport sur une cohorte. Spécifie une durée de décalage pour le suivi des cohortes.
Représentation JSON |
---|
{
"granularity": enum ( |
Champs | |
---|---|
granularity |
Obligatoire. Niveau de précision utilisé pour interpréter les valeurs |
startOffset |
Si Si Si |
endOffset |
Obligatoire. Si Si Si |
Précision
Niveau de précision utilisé pour interpréter les valeurs startOffset
et endOffset
pour la période étendue d'un rapport sur une cohorte.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Ne doit jamais être spécifié. |
DAILY |
Précision quotidienne. Ce paramètre est fréquemment utilisé si le dateRange de la cohorte correspond à un seul jour et que la requête contient cohortNthDay . |
WEEKLY |
Précision hebdomadaire. Il est généralement utilisé si le dateRange de la cohorte dure une semaine (du dimanche au samedi) et que la requête contient cohortNthWeek . |
MONTHLY |
Précision mensuelle. Ce paramètre est fréquemment utilisé si le 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 entre le premier jour de contact et le jour de la fin. Non disponible dans ce pays : |
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. Quota total de jetons facturés lors de la création du rapport. Étant donné que ce nombre de jetons est basé sur l'activité à partir de l'état |
state |
Uniquement en sortie. État actuel de cette tâche de rapport. |
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 sa création. |
totalRowCount |
Uniquement en sortie. Nombre total de lignes dans l'espace de stockage Google Analytics. Si vous souhaitez interroger des lignes de données supplémentaires au-delà du rapport actuel, il peut lancer une nouvelle tâche de rapport en fonction de l'
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 ultérieurement. La création s'effectue 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 concernant une tâche spécifique. |
|
Répertorie toutes les tâches de rapport pour une propriété. |
|
Récupère le contenu d'une tâche de rapport. |