- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- RunPivotReportRequest
- Essayer
Renvoie plusieurs rapports croisés dynamiques à la fois. Tous les rapports doivent concerner la même propriété GA4.
Requête HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
property |
Un identifiant de propriété Google Analytics GA4 dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, découvrez où trouver votre ID de propriété. Cette propriété doit être spécifiée pour le lot. La propriété dans RunPivotReportRequest peut ne pas être spécifiée ou correspondre à cette propriété. Exemple: propriétés/1234 |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{
"requests": [
{
object ( |
Champs | |
---|---|
requests[] |
Requêtes individuelles Chaque demande est associée à une réponse de rapport croisé dynamique. Chaque requête par lot est autorisée jusqu'à cinq requêtes. |
Corps de la réponse
Réponse par lot contenant plusieurs rapports de tableaux croisés dynamiques.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"pivotReports": [
{
object ( |
Champs | |
---|---|
pivotReports[] |
Réponses individuelles. Chaque réponse est associée à une demande de rapport croisé dynamique. |
kind |
Identifie le type de ressource de ce message. Cet élément |
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
RunPivotReportRequest
Demande de génération d'un rapport croisé dynamique.
Représentation JSON |
---|
{ "property": string, "dimensions": [ { object ( |
Champs | |
---|---|
property |
Un identifiant de propriété Google Analytics GA4 dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, découvrez où trouver votre ID de propriété. Dans une requête par lot, cette propriété ne doit pas être spécifiée ou correspondre à la propriété au niveau du lot. Exemple: propriétés/1234 |
dimensions[] |
Dimensions demandées. Toutes les dimensions définies doivent être utilisées par l'un des éléments suivants: dimensionExpression, dimensionFilter, pivots, orderBys. |
metrics[] |
Métriques demandées. Vous devez en spécifier au moins une. Toutes les métriques définies doivent être utilisées par l'une des options suivantes: metric_expression, metricFilter ou orderBys. |
dateRanges[] |
Plage de dates pour laquelle récupérer les données d'événement pour le rapport. Si plusieurs plages de dates sont spécifiées, les données d'événement de chacune d'elles sont utilisées dans le rapport. Vous pouvez inclure une dimension spéciale portant le nom de champ "dateRange" dans les noms des champs d'un tableau croisé dynamique. Le cas échéant, le rapport compare les données entre les plages de dates. Dans une demande de cohorte, cet élément |
pivots[] |
Décrit le format visuel des dimensions du rapport en colonnes ou en lignes. L'union des noms de champ (fieldNames) dans tous les tableaux croisés dynamiques doit être un sous-ensemble de noms de dimensions définis dans "Dimensions". Deux tableaux croisés dynamiques ne peuvent pas avoir la même dimension. Une dimension n'est visible que si elle apparaît dans un tableau croisé dynamique. |
dimensionFilter |
Clause de filtre des dimensions. Vous devez demander des dimensions pour ce filtre. Impossible d'utiliser des métriques dans ce filtre. |
metricFilter |
Clause de filtre des métriques. Appliquée lors de la phase post-agrégation, de la même manière que la clause SQL existante. Des métriques doivent être demandées pour être utilisées dans ce filtre. Impossible d'utiliser des dimensions avec ce filtre. |
currencyCode |
Code de devise au format ISO 4217, tel que "AED", "USD" ou "JPY". Si le champ est vide, le rapport utilise la devise par défaut de la propriété. |
cohortSpec |
Groupe de cohorte associé à cette demande. Si la requête comporte un groupe de cohorte, la dimension "cohorte" doit être présente. |
keepEmptyRows |
Si la valeur est "false" ou n'est pas spécifiée, aucune ligne dont toutes les métriques sont égales à 0 ne sera pas renvoyée. Si la valeur est "true", ces lignes sont renvoyées si un filtre ne les a pas supprimées séparément. Quel que soit le paramètre Par exemple, si une propriété ne consigne jamais d'événement |
returnPropertyQuota |
Indique si l'état actuel du quota de cette propriété Analytics doit être affiché. Le quota est renvoyé dans PropertyQuota. |
comparisons[] |
Facultatif. Configuration des comparaisons demandées et affichées. La requête nécessite à la fois un champ de comparaison et une dimension de comparaison pour recevoir une colonne de comparaison dans la réponse. |