Google Analytics Data API v1 की मदद से, फ़नल रिपोर्ट जनरेट की जा सकती हैं. फ़नल एक्सप्लोरेशन से उन चरणों को विज़ुअलाइज़ किया जा सकता है जिनका इस्तेमाल करके, आपके उपयोगकर्ता टास्क पूरा करते हैं. साथ ही, यह भी तुरंत देखा जा सकता है कि वे हर चरण को पूरा कर रहे हैं या नहीं.
मुख्य रिपोर्ट के साथ शेयर की गई सुविधाएं
फ़नल रिपोर्टिंग के अनुरोधों का मतलब, कई शेयर की गई सुविधाओं के लिए मुख्य रिपोर्ट अनुरोधों से मिलते-जुलते होते हैं. उदाहरण के लिए, पेज पर नंबर डालना, डाइमेंशन फ़िल्टर, और उपयोगकर्ता प्रॉपर्टी फ़नल रिपोर्ट में, कोर रिपोर्ट की तरह ही काम करती हैं. यह गाइड, फ़नल रिपोर्टिंग की सुविधाओं पर फ़ोकस करती है. Data API v1 के मुख्य रिपोर्टिंग फ़ंक्शन के बारे में जानने के लिए, रिपोर्टिंग की बुनियादी जानकारी वाली गाइड और बेहतर इस्तेमाल के उदाहरण वाली गाइड पढ़ें.
फ़नल रिपोर्टिंग का तरीका
Data API v1, runFunnelReport के तरीके में, फ़नल रिपोर्टिंग की सुविधा के साथ काम करता है. यह तरीका आपके Google Analytics इवेंट डेटा की कस्टमाइज़ की गई फ़नल रिपोर्ट दिखाता है.
रिपोर्टिंग इकाई चुनना
Data API v1 के सभी तरीकों के लिए, यूआरएल अनुरोध पाथ में Google Analytics 4 प्रॉपर्टी आइडेंटिफ़ायर की जानकारी, properties/GA4_PROPERTY_ID के तौर पर देनी होगी. जैसे:
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA4_PROPERTY_ID:runFunnelReport
जनरेट की गई रिपोर्ट, आपकी तय की गई Google Analytics 4 प्रॉपर्टी में इकट्ठा किए गए Google Analytics के इवेंट डेटा के आधार पर जनरेट होगी.
अगर Data API क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो अनुरोध के यूआरएल पाथ में मैन्युअल तरीके से बदलाव करने की ज़रूरत नहीं है. ज़्यादातर एपीआई क्लाइंट
ऐसा property पैरामीटर देते हैं जो properties/GA4_PROPERTY_ID के तौर पर स्ट्रिंग होना चाहिए. क्लाइंट लाइब्रेरी को इस्तेमाल करने के उदाहरणों के लिए, आसानी से सिखाने वाली गाइड देखें.
फ़नल रिपोर्ट का अनुरोध
फ़नल रिपोर्ट का अनुरोध करने के लिए, RunFunnelReportRequest ऑब्जेक्ट बनाया जा सकता है. हम इन अनुरोध पैरामीटर से शुरू करने का सुझाव देते हैं:
dateRangesफ़ील्ड में मान्य एंट्री होनी चाहिए.funnelफ़ील्ड में फ़नल की सही जानकारी.
फ़नल की जानकारी
RunFunnelReportRequest ऑब्जेक्ट के funnel फ़ील्ड में मौजूद फ़नल स्पेसिफ़िकेशन, उस उपयोगकर्ता की गतिविधि के बारे में बताता है जिसे आपको मेज़र करना है. इसके लिए, steps को इस फ़नल के बारे में जानकारी दें.
फ़नल चरणों में एक या ज़्यादा शर्तें होती हैं, जिन्हें आपके उपयोगकर्ताओं को पूरा करना होगा, ताकि उन्हें फ़नल के सफ़र के उस चरण में शामिल किया जा सके. हर चरण में शामिल करने की शर्तों के बारे में, हर चरण के filterExpression फ़ील्ड में बताया जा सकता है.
हर फ़नल फ़िल्टर एक्सप्रेशन दो तरह के फ़िल्टर से मिलकर बनता है:
funnelFieldFilterकिसी डाइमेंशन या मेट्रिक के लिए एक फ़िल्टर बनाता है.funnelEventFilterएक ऐसा फ़िल्टर बनाता है जो किसी एक इवेंट के नाम से मैच करता है. अगर आपनेfunnelParameterFilterExpressionफ़ील्ड का इस्तेमाल किया है, तो सिर्फ़ इवेंट के उस सबसेट का इस्तेमाल किया जा सकता है जो एक इवेंट के नाम और पैरामीटर फ़िल्टर एक्सप्रेशन, दोनों से मैच करता हो.
फ़िल्टर को और, या ग्रुप का इस्तेमाल करके मिलाया जा सकता है. साथ ही, NOT एक्सप्रेशन का इस्तेमाल करके, फ़िल्टर को हटाया जा सकता है.
हर फ़नल चरण के लिए रिपोर्ट के नतीजों को डाइमेंशन के आधार पर बांटा जाएगा.
ये नतीजे funnelBreakdown फ़ील्ड में दिए गए होते हैं.
फ़नल रिपोर्ट का उदाहरण
आइए, Google Analytics Data API v1 का इस्तेमाल करके, Google Analytics यूज़र इंटरफ़ेस (यूआई) के फ़नल एक्सप्लोरेशन टेंप्लेट में दी गई डिफ़ॉल्ट फ़नल रिपोर्ट को फिर से जनरेट करें:
फ़नल चरण
ऊपर दिखाए गए फ़नल कॉन्फ़िगरेशन में नीचे दिए गए चरण हैं:
| # | कदम का नाम | शर्त |
|---|---|---|
| 1 | पहली बार खोला/विज़िट किया | इवेंट का नाम first_open या first_visit है. |
| 2 | ऑर्गेनिक विज़िटर | firstUserMedium डाइमेंशन में "ऑर्गैनिक" शब्द शामिल है. |
| 3 | सेशन की शुरुआत | इवेंट का नाम session_start है. |
| 4 | स्क्रीन/पेज व्यू | इवेंट का नाम screen_view या page_view है. |
| 5 | खरीदारी करना | इवेंट का नाम purchase या in_app_purchase है. |
फ़नल के पहला चरण (पहली बार खुलने/विज़िट करने पर) में वे सभी उपयोगकर्ता शामिल होते हैं जिन्होंने किसी वेबसाइट या ऐप्लिकेशन के साथ
पहली बार इंटरैक्शन किया. जैसे, वे उपयोगकर्ता जिन्होंने first_open या first_visit इवेंट ट्रिगर किए.
इस व्यवहार को लागू करने के लिए, नीचे दिया गया स्निपेट, filterExpression फ़ील्ड वाले FunnelStep ऑब्जेक्ट के बारे में बताता है. फ़िल्टर एक्सप्रेशन फ़ील्ड, एक FunnelFilterExpression ऑब्जेक्ट है. इसे OR ग्रुप का इस्तेमाल करके, दो FunnelEventFilter इकाइयों को मिलाकर बनाया जाता है.
{
"name": "Purchase",
"filterExpression": {
"orGroup": {
"expressions": [
{
"funnelEventFilter": {
"eventName": "first_open"
}
},
{
"funnelEventFilter": {
"eventName": "first_visit"
}
}
]
}
}
}
फ़नल के दूसरे चरण (ऑर्गैनिक विज़िटर) में वे उपयोगकर्ता शामिल होते हैं जिनके पहले मीडियम में "ऑर्गैनिक" शब्द शामिल है. नीचे दिए गए स्निपेट में, FunnelFieldFilter के fieldName फ़ील्ड से, फ़िल्टर को firstUserMedium डाइमेंशन से मैच करने का निर्देश मिलता है.
stringFilter फ़ील्ड में सिर्फ़ "ऑर्गैनिक" शब्द वाले डाइमेंशन की वैल्यू शामिल करने के लिए शर्त होती है.
{
"name": "Organic visitors",
"filterExpression": {
"funnelFieldFilter": {
"fieldName": "firstUserMedium",
"stringFilter": {
"matchType": "CONTAINS",
"caseSensitive": false,
"value": "organic"
}
}
}
}
बाकी फ़नल के चरणों को इसी तरह से बताया जा सकता है.
ब्रेकडाउन आयाम
ब्रेकडाउन के वैकल्पिक डाइमेंशन (इस उदाहरण में deviceCategory) को FunnelBreakdown ऑब्जेक्ट का इस्तेमाल करके तय किया जा सकता है:
"funnelBreakdown": {
"breakdownDimension": {
"name": "deviceCategory"
}
}
डिफ़ॉल्ट रूप से, ब्रेकडाउन डाइमेंशन की सिर्फ़ पहली पांच अलग-अलग वैल्यू को रिपोर्ट में शामिल किया जाता है. इस व्यवहार को बदलने के लिए, FunnelBreakdown ऑब्जेक्ट के limit फ़ील्ड का इस्तेमाल किया जा सकता है.
फ़नल रिपोर्ट क्वेरी पूरी करें
यहां एक पूरी क्वेरी दी गई है, जो ऊपर बताए गए सभी चरणों का इस्तेमाल करके फ़नल रिपोर्ट जनरेट करती है:
HTTP
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA4_PROPERTY_ID:runFunnelReport
{
"dateRanges": [
{
"startDate": "30daysAgo",
"endDate": "today"
}
],
"funnelBreakdown": {
"breakdownDimension": {
"name": "deviceCategory"
}
},
"funnel": {
"steps": [
{
"name": "First open/visit",
"filterExpression": {
"orGroup": {
"expressions": [
{
"funnelEventFilter": {
"eventName": "first_open"
}
},
{
"funnelEventFilter": {
"eventName": "first_visit"
}
}
]
}
}
},
{
"name": "Organic visitors",
"filterExpression": {
"funnelFieldFilter": {
"fieldName": "firstUserMedium",
"stringFilter": {
"matchType": "CONTAINS",
"caseSensitive": false,
"value": "organic"
}
}
}
},
{
"name": "Session start",
"filterExpression": {
"funnelEventFilter": {
"eventName": "session_start"
}
}
},
{
"name": "Screen/Page view",
"filterExpression": {
"orGroup": {
"expressions": [
{
"funnelEventFilter": {
"eventName": "screen_view"
}
},
{
"funnelEventFilter": {
"eventName": "page_view"
}
}
]
}
}
},
{
"name": "Purchase",
"filterExpression": {
"orGroup": {
"expressions": [
{
"funnelEventFilter": {
"eventName": "purchase"
}
},
{
"funnelEventFilter": {
"eventName": "in_app_purchase"
}
}
]
}
}
}
]
}
}
जवाब की शिकायत करें
फ़नल रिपोर्ट के एपीआई अनुरोध के फ़नल रिपोर्ट रिस्पॉन्स में, दो मुख्य हिस्से होते हैं. दोनों हिस्से, FunnelSubReport ऑब्जेक्ट के तौर पर दिखाए जाते हैं: फ़नल विज़ुअलाइज़ेशन और फ़नल टेबल.
फ़नल विज़ुअलाइज़ेशन
फ़नल रिपोर्ट रिस्पॉन्स के funnelVisualization फ़ील्ड में दिखने वाले फ़नल विज़ुअलाइज़ेशन में, फ़नल रिपोर्ट की खास जानकारी मिलती है. जैसा कि नाम से ज़ाहिर है, यह जनरेट की गई फ़नल रिपोर्ट को तुरंत विज़ुअलाइज़ करने के लिए फ़ायदेमंद है.
फ़नल विज़ुअलाइज़ेशन टेबल की हर लाइन में, नीचे दिए गए कुछ या सभी फ़ील्ड होते हैं:
फ़नल चरण का नाम (
funnelStepNameडाइमेंशन).सक्रिय उपयोगकर्ताओं की संख्या (
activeUsersमेट्रिक).सेगमेंट (
segmentडाइमेंशन). सिर्फ़ तब दिखता है, जब फ़नल क्वेरी मेंSegmentकी जानकारी दी गई हो.तारीख (
dateडाइमेंशन). सिर्फ़ तब प्रज़ेंट करें, जब क्वेरी मेंTRENDED_FUNNELविज़ुअलाइज़ेशन का टाइप बताया गया हो.अगली कार्रवाई का डाइमेंशन (
funnelStepNextActionडाइमेंशन). सिर्फ़ तब दिखाएं, जब फ़नल क्वेरी मेंFunnelNextActionके बारे में बताया गया हो.
ऊपर बताए गए उदाहरण रिपोर्ट का फ़नल विज़ुअलाइज़ेशन सेक्शन Google Analytics यूज़र इंटरफ़ेस (यूआई) में इस तरह दिखेगा:
फ़नल टेबल
फ़नल रिपोर्ट रिस्पॉन्स के funnelTable फ़ील्ड में मौजूद फ़नल टेबल, रिपोर्ट का मुख्य हिस्सा दिखाती है. टेबल की हर लाइन में
इनमें से कुछ या सभी फ़ील्ड होते हैं:
फ़नल चरण का नाम (
funnelStepNameडाइमेंशन).ब्रेकडाउन डाइमेंशन.
सक्रिय उपयोगकर्ताओं की संख्या (
activeUsersमेट्रिक).चरण पूरा करने की दर (
funnelStepCompletionRateमेट्रिक).चरण छोड़ने वालों की संख्या (
funnelStepAbandonmentsमेट्रिक).चरण छोड़ने की दर (
funnelStepAbandonmentRateमेट्रिक).सेगमेंट का नाम (
segmentडाइमेंशन). सिर्फ़ तब दिखता है, जब फ़नल क्वेरी मेंSegmentकी जानकारी दी गई हो.
मुख्य रिपोर्टिंग की सुविधा की तरह ही, कुल वैल्यू एक अलग पंक्ति में दिखाई जाती हैं, जिसमें ब्रेकडाउन डाइमेंशन वैल्यू के तौर पर RESERVED_TOTAL मौजूद होती है.
Google Analytics के यूज़र इंटरफ़ेस (यूआई) में दिखाए गए फ़नल टेबल का एक उदाहरण नीचे दिया गया है:
रॉ रिस्पॉन्स
नीचे दिया गया स्निपेट, runFunnelReport क्वेरी के जवाब में मिले रॉ डेटा का उदाहरण दिखाता है.
आपकी प्रॉपर्टी से इकट्ठा किए गए डेटा के आधार पर, उदाहरण के तौर पर ऊपर दी गई रिपोर्ट में नीचे दी गई रिपोर्ट दिखेगी. इसमें हर फ़नल चरण में शामिल सक्रिय उपयोगकर्ताओं की संख्या दिखेगी.
{
"funnelTable": {
"dimensionHeaders": [
{
"name": "funnelStepName"
},
{
"name": "deviceCategory"
}
],
"metricHeaders": [
{
"name": "activeUsers",
"type": "TYPE_INTEGER"
},
{
"name": "funnelStepCompletionRate",
"type": "TYPE_INTEGER"
},
{
"name": "funnelStepAbandonments",
"type": "TYPE_INTEGER"
},
{
"name": "funnelStepAbandonmentRate",
"type": "TYPE_INTEGER"
}
],
"rows": [
{
"dimensionValues": [
{
"value": "1. First open/visit"
},
{
"value": "RESERVED_TOTAL"
}
],
"metricValues": [
{
"value": "4621565"
},
{
"value": "0.27780178359495106"
},
{
"value": "3337686"
},
{
"value": "0.72219821640504889"
}
]
},
{
"dimensionValues": [
{
"value": "1. First open/visit"
},
{
"value": "desktop"
}
],
"metricValues": [
{
"value": "4015959"
},
{
"value": "0.27425279989163237"
},
{
"value": "2914571"
},
{
"value": "0.72574720010836768"
}
]
},
{
"dimensionValues": [
{
"value": "1. First open/visit"
},
{
"value": "mobile"
}
],
"metricValues": [
{
"value": "595760"
},
{
"value": "0.29156035987646034"
},
{
"value": "422060"
},
{
"value": "0.70843964012353966"
}
]
},
{
"dimensionValues": [
{
"value": "1. First open/visit"
},
{
"value": "tablet"
}
],
"metricValues": [
{
"value": "33638"
},
{
"value": "0.205571080325822"
},
{
"value": "26723"
},
{
"value": "0.79442891967417806"
}
]
},
...
],
"metadata": {
"samplingMetadatas": [
{
"samplesReadCount": "9917254",
"samplingSpaceSize": "1162365416"
}
]
}
},
"funnelVisualization": {
"dimensionHeaders": [
{
"name": "funnelStepName"
}
],
"metricHeaders": [
{
"name": "activeUsers",
"type": "TYPE_INTEGER"
}
],
"rows": [
{
"dimensionValues": [
{
"value": "1. First open/visit"
}
],
"metricValues": [
{
"value": "4621565"
}
]
},
...
],
"metadata": {
"samplingMetadatas": [
{
"samplesReadCount": "9917254",
"samplingSpaceSize": "1162365416"
}
]
}
},
"kind": "analyticsData#runFunnelReport"
}
क्लाइंट लाइब्रेरी
क्लाइंट लाइब्रेरी को इंस्टॉल और कॉन्फ़िगर करने के तरीके के बारे में जानने के लिए, क्विक स्टार्ट गाइड देखें.
नीचे क्लाइंट लाइब्रेरी का इस्तेमाल करने वाले उदाहरण दिए गए हैं, जो फ़नल क्वेरी चलाते हैं और जवाब को प्रिंट करते हैं.
Java
import com.google.analytics.data.v1alpha.AlphaAnalyticsDataClient;
import com.google.analytics.data.v1alpha.DateRange;
import com.google.analytics.data.v1alpha.Dimension;
import com.google.analytics.data.v1alpha.DimensionHeader;
import com.google.analytics.data.v1alpha.FunnelBreakdown;
import com.google.analytics.data.v1alpha.FunnelEventFilter;
import com.google.analytics.data.v1alpha.FunnelFieldFilter;
import com.google.analytics.data.v1alpha.FunnelFilterExpression;
import com.google.analytics.data.v1alpha.FunnelFilterExpressionList;
import com.google.analytics.data.v1alpha.FunnelStep;
import com.google.analytics.data.v1alpha.FunnelSubReport;
import com.google.analytics.data.v1alpha.MetricHeader;
import com.google.analytics.data.v1alpha.Row;
import com.google.analytics.data.v1alpha.RunFunnelReportRequest;
import com.google.analytics.data.v1alpha.RunFunnelReportResponse;
import com.google.analytics.data.v1alpha.SamplingMetadata;
import com.google.analytics.data.v1alpha.StringFilter;
import com.google.analytics.data.v1alpha.StringFilter.MatchType;
/**
* Google Analytics Data API sample application demonstrating the creation of a funnel report.
*
* <p>See
* https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1alpha/properties/runFunnelReport
* for more information.
*
* <p>Before you start the application, please review the comments starting with "TODO(developer)"
* and update the code to use correct values.
*
* <p>To run this sample using Maven:
*
* <pre>{@code
* cd google-analytics-data
* mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.RunFunnelReportSample"
* }</pre>
*/
public class RunFunnelReportSample {
public static void main(String... args) throws Exception {
/**
* TODO(developer): Replace this variable with your Google Analytics 4 property ID before
* running the sample.
*/
String propertyId = "YOUR-GA4-PROPERTY-ID";
sampleRunFunnelReport(propertyId);
}
/**
* Runs a funnel query to build a report with 5 funnel steps.
*
* <ol>
* <li>First open/visit (event name is `first_open` or `first_visit`).
* <li>Organic visitors (`firstUserMedium` dimension contains the term "organic").
* <li>Session start (event name is `session_start`).
* <li>Screen/Page view (event name is `screen_view` or `page_view`).
* <li>Purchase (event name is `purchase` or `in_app_purchase`).
* </ol>
*
* The report configuration reproduces the default funnel report provided in the Funnel
* Exploration template of the Google Analytics UI. See more at
* https://support.google.com/analytics/answer/9327974
*/
static void sampleRunFunnelReport(String propertyId) throws Exception {
// Using a default constructor instructs the client to use the credentials
// specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
try (AlphaAnalyticsDataClient analyticsData = AlphaAnalyticsDataClient.create()) {
RunFunnelReportRequest.Builder requestBuilder =
RunFunnelReportRequest.newBuilder()
.setProperty("properties/" + propertyId)
.addDateRanges(DateRange.newBuilder().setStartDate("30daysAgo").setEndDate("today"))
.setFunnelBreakdown(
FunnelBreakdown.newBuilder()
.setBreakdownDimension(Dimension.newBuilder().setName("deviceCategory")));
// Adds each step of the funnel.
requestBuilder
.getFunnelBuilder()
.addSteps(
FunnelStep.newBuilder()
.setName("First open/visit")
.setFilterExpression(
FunnelFilterExpression.newBuilder()
.setOrGroup(
FunnelFilterExpressionList.newBuilder()
.addExpressions(
FunnelFilterExpression.newBuilder()
.setFunnelEventFilter(
FunnelEventFilter.newBuilder()
.setEventName("first_open")))
.addExpressions(
FunnelFilterExpression.newBuilder()
.setFunnelEventFilter(
FunnelEventFilter.newBuilder()
.setEventName("first_visit"))))));
requestBuilder
.getFunnelBuilder()
.addSteps(
FunnelStep.newBuilder()
.setName("Organic visitors")
.setFilterExpression(
FunnelFilterExpression.newBuilder()
.setFunnelFieldFilter(
FunnelFieldFilter.newBuilder()
.setFieldName("firstUserMedium")
.setStringFilter(
StringFilter.newBuilder()
.setMatchType(MatchType.CONTAINS)
.setCaseSensitive(false)
.setValue("organic")))));
requestBuilder
.getFunnelBuilder()
.addSteps(
FunnelStep.newBuilder()
.setName("Session start")
.setFilterExpression(
FunnelFilterExpression.newBuilder()
.setFunnelEventFilter(
FunnelEventFilter.newBuilder().setEventName("session_start"))));
requestBuilder
.getFunnelBuilder()
.addSteps(
FunnelStep.newBuilder()
.setName("Screen/Page view")
.setFilterExpression(
FunnelFilterExpression.newBuilder()
.setOrGroup(
FunnelFilterExpressionList.newBuilder()
.addExpressions(
FunnelFilterExpression.newBuilder()
.setFunnelEventFilter(
FunnelEventFilter.newBuilder()
.setEventName("screen_view")))
.addExpressions(
FunnelFilterExpression.newBuilder()
.setFunnelEventFilter(
FunnelEventFilter.newBuilder()
.setEventName("page_view"))))));
requestBuilder
.getFunnelBuilder()
.addSteps(
FunnelStep.newBuilder()
.setName("Purchase")
.setFilterExpression(
FunnelFilterExpression.newBuilder()
.setOrGroup(
FunnelFilterExpressionList.newBuilder()
.addExpressions(
FunnelFilterExpression.newBuilder()
.setFunnelEventFilter(
FunnelEventFilter.newBuilder()
.setEventName("purchase")))
.addExpressions(
FunnelFilterExpression.newBuilder()
.setFunnelEventFilter(
FunnelEventFilter.newBuilder()
.setEventName("in_app_purchase"))))));
// Make the request.
RunFunnelReportResponse response = analyticsData.runFunnelReport(requestBuilder.build());
printRunFunnelReportResponse(response);
}
}
/** Prints results of a runFunnelReport call. */
static void printRunFunnelReportResponse(RunFunnelReportResponse response) {
System.out.println("Report result:");
System.out.println("=== FUNNEL VISUALIZATION ===");
printFunnelSubReport(response.getFunnelVisualization());
System.out.println("=== FUNNEL TABLE ===");
printFunnelSubReport(response.getFunnelTable());
}
/** Prints the contents of a FunnelSubReport object. */
private static void printFunnelSubReport(FunnelSubReport funnelSubReport) {
System.out.println("Dimension headers:");
for (DimensionHeader dimensionHeader : funnelSubReport.getDimensionHeadersList()) {
System.out.println(dimensionHeader.getName());
}
System.out.println();
System.out.println("Metric headers:");
for (MetricHeader metricHeader : funnelSubReport.getMetricHeadersList()) {
System.out.println(metricHeader.getName());
}
System.out.println();
System.out.println("Dimension and metric values for each row in the report:");
for (int rowIndex = 0; rowIndex < funnelSubReport.getRowsCount(); rowIndex++) {
Row row = funnelSubReport.getRows(rowIndex);
for (int fieldIndex = 0; fieldIndex < row.getDimensionValuesCount(); fieldIndex++) {
System.out.printf(
"%s: '%s'%n",
funnelSubReport.getDimensionHeaders(fieldIndex).getName(),
row.getDimensionValues(fieldIndex).getValue());
}
for (int fieldIndex = 0; fieldIndex < row.getMetricValuesCount(); fieldIndex++) {
System.out.printf(
"%s: '%s'%n",
funnelSubReport.getMetricHeaders(fieldIndex).getName(),
row.getMetricValues(fieldIndex).getValue());
}
}
System.out.println();
System.out.println("Sampling metadata for each date range:");
for (int metadataIndex = 0;
metadataIndex < funnelSubReport.getMetadata().getSamplingMetadatasCount();
metadataIndex++) {
SamplingMetadata samplingMetadata =
funnelSubReport.getMetadata().getSamplingMetadatas(metadataIndex);
System.out.printf(
"Sampling metadata for date range #%d: samplesReadCount=%d, samplingSpaceSize=%d%n",
metadataIndex,
samplingMetadata.getSamplesReadCount(),
samplingMetadata.getSamplingSpaceSize());
}
}
}
Python
from google.analytics.data_v1alpha import AlphaAnalyticsDataClient
from google.analytics.data_v1alpha.types import (
DateRange,
Dimension,
Funnel,
FunnelBreakdown,
FunnelEventFilter,
FunnelFieldFilter,
FunnelFilterExpression,
FunnelFilterExpressionList,
FunnelStep,
RunFunnelReportRequest,
StringFilter,
)
def run_sample():
"""Runs the sample."""
# TODO(developer): Replace this variable with your Google Analytics 4
# property ID before running the sample.
property_id = "YOUR-GA4-PROPERTY-ID"
run_funnel_report(property_id)
def run_funnel_report(property_id="YOUR-GA4-PROPERTY-ID"):
"""Runs a funnel query to build a report with 5 funnel steps.
Step 1: First open/visit (event name is `first_open` or `first_visit`).
Step 2: Organic visitors (`firstUserMedium` dimension contains the term
"organic").
Step 3: Session start (event name is `session_start`).
Step 4: Screen/Page view (event name is `screen_view` or `page_view`).
Step 5: Purchase (event name is `purchase` or `in_app_purchase`).
The report configuration reproduces the default funnel report provided in
the Funnel Exploration template of the Google Analytics UI.
See more at https://support.google.com/analytics/answer/9327974
"""
client = AlphaAnalyticsDataClient()
request = RunFunnelReportRequest(
property=f"properties/{property_id}",
date_ranges=[DateRange(start_date="30daysAgo", end_date="today")],
funnel_breakdown=FunnelBreakdown(
breakdown_dimension=Dimension(name="deviceCategory")
),
funnel=Funnel(
steps=[
FunnelStep(
name="First open/visit",
filter_expression=FunnelFilterExpression(
or_group=FunnelFilterExpressionList(
expressions=[
FunnelFilterExpression(
funnel_event_filter=FunnelEventFilter(
event_name="first_open"
)
),
FunnelFilterExpression(
funnel_event_filter=FunnelEventFilter(
event_name="first_visit"
)
),
]
)
),
),
FunnelStep(
name="Organic visitors",
filter_expression=FunnelFilterExpression(
funnel_field_filter=FunnelFieldFilter(
field_name="firstUserMedium",
string_filter=StringFilter(
match_type=StringFilter.MatchType.CONTAINS,
case_sensitive=False,
value="organic",
),
)
),
),
FunnelStep(
name="Session start",
filter_expression=FunnelFilterExpression(
funnel_event_filter=FunnelEventFilter(
event_name="session_start"
)
),
),
FunnelStep(
name="Screen/Page view",
filter_expression=FunnelFilterExpression(
or_group=FunnelFilterExpressionList(
expressions=[
FunnelFilterExpression(
funnel_event_filter=FunnelEventFilter(
event_name="screen_view"
)
),
FunnelFilterExpression(
funnel_event_filter=FunnelEventFilter(
event_name="page_view"
)
),
]
)
),
),
FunnelStep(
name="Purchase",
filter_expression=FunnelFilterExpression(
or_group=FunnelFilterExpressionList(
expressions=[
FunnelFilterExpression(
funnel_event_filter=FunnelEventFilter(
event_name="purchase"
)
),
FunnelFilterExpression(
funnel_event_filter=FunnelEventFilter(
event_name="in_app_purchase"
)
),
]
)
),
),
]
),
)
response = client.run_funnel_report(request)
print_run_funnel_report_response(response)
def print_funnel_sub_report(funnel_sub_report):
"""Prints the contents of a FunnelSubReport object."""
print("Dimension headers:")
for dimension_header in funnel_sub_report.dimension_headers:
print(dimension_header.name)
print("\nMetric headers:")
for metric_header in funnel_sub_report.metric_headers:
print(metric_header.name)
print("\nDimensions and metric values for each row in the report:")
for row_idx, row in enumerate(funnel_sub_report.rows):
print("\nRow #{}".format(row_idx))
for field_idx, dimension_value in enumerate(row.dimension_values):
dimension_name = funnel_sub_report.dimension_headers[field_idx].name
print("{}: '{}'".format(dimension_name, dimension_value.value))
for field_idx, metric_value in enumerate(row.metric_values):
metric_name = funnel_sub_report.metric_headers[field_idx].name
print("{}: '{}'".format(metric_name, metric_value.value))
print("\nSampling metadata for each date range:")
for metadata_idx, metadata in enumerate(
funnel_sub_report.metadata.sampling_metadatas
):
print(
"Sampling metadata for date range #{}: samplesReadCount={}, "
"samplingSpaceSize={}".format(
metadata_idx, metadata.samples_read_count, metadata.sampling_space_size
)
)
def print_run_funnel_report_response(response):
"""Prints results of a runFunnelReport call."""
print("Report result:")
print("=== FUNNEL VISUALIZATION ===")
print_funnel_sub_report(response.funnel_visualization)
print("=== FUNNEL TABLE ===")
print_funnel_sub_report(response.funnel_table)