-
Notifications
You must be signed in to change notification settings - Fork 1
/
run_report_with_dimension_and_metric_filters.js
139 lines (125 loc) · 4.34 KB
/
run_report_with_dimension_and_metric_filters.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
'use strict';
/** Google Analytics Data API sample application demonstrating the usage of
dimension and metric filters in a report.
See https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport#body.request_body.FIELDS.dimension_filter
for more information.
Before you start the application, please review the comments starting with
"TODO(developer)" and update the code to use correct values.
Usage:
npm install
node runReportWithDimensionAndMetricFilters.js
*/
function main(propertyId = 'YOUR-GA4-PROPERTY-ID') {
// [START analyticsdata_run_report_with_dimension_and_metric_filters]
// TODO(developer): Uncomment this variable and replace with your
// Google Analytics 4 property ID before running the sample.
// propertyId = 'YOUR-GA4-PROPERTY-ID';
// Imports the Google Analytics Data API client library.
const {BetaAnalyticsDataClient} = require('@google-analytics/data');
// Initialize client that will be used to send requests. This client only
// needs to be created once, and can be reused for multiple requests.
const analyticsDataClient = new BetaAnalyticsDataClient();
// Runs a report using both metric and dimension filters. A dimension filter
// limits the report to include only users who made an in-app purchase using
// Android platform. A metric filter specifies that only users with session
// counts larger than 1,000 should be included.
async function runReportWithDimensionAndMetricFilters() {
const [response] = await analyticsDataClient.runReport({
property: `properties/${propertyId}`,
dimensions: [
{
name: 'city',
},
],
metrics: [
{
name: 'activeUsers',
},
],
dateRanges: [
{
startDate: '2020-03-31',
endDate: 'today',
},
],
metricFilter: {
filter: {
fieldName: 'sessions',
numericFilter: {
operation: 'GREATER_THAN',
value: {
int64Value: 1000,
},
},
},
},
dimensionFilter: {
andGroup: {
expressions: [
{
filter: {
fieldName: 'platform',
stringFilter: {
matchType: 'EXACT',
value: 'Android',
},
},
},
{
filter: {
fieldName: 'eventName',
stringFilter: {
matchType: 'EXACT',
value: 'in_app_purchase',
},
},
},
],
},
},
});
printRunReportResponse(response);
}
runReportWithDimensionAndMetricFilters();
// Prints results of a runReport call.
function printRunReportResponse(response) {
//[START analyticsdata_print_run_report_response_header]
console.log(`${response.rowCount} rows received`);
response.dimensionHeaders.forEach(dimensionHeader => {
console.log(`Dimension header name: ${dimensionHeader.name}`);
});
response.metricHeaders.forEach(metricHeader => {
console.log(
`Metric header name: ${metricHeader.name} (${metricHeader.type})`
);
});
//[END analyticsdata_print_run_report_response_header]
// [START analyticsdata_print_run_report_response_rows]
console.log('Report result:');
response.rows.forEach(row => {
console.log(
`${row.dimensionValues[0].value}, ${row.metricValues[0].value}`
);
});
// [END analyticsdata_print_run_report_response_rows]
}
// [END analyticsdata_run_report_with_dimension_and_metric_filters]
}
process.on('unhandledRejection', err => {
console.error(err.message);
process.exitCode = 1;
});
main(...process.argv.slice(2));