Google Analytics Data API v1 की मदद से, फ़नल रिपोर्ट बनाई जा सकती हैं. फ़नल एक्सप्लोरेशन से उन चरणों को विज़ुअलाइज़ किया जा सकता है जिनकी मदद से आपके उपयोगकर्ता, और आसानी से देखा जा सकता है कि वे हर चरण को पूरा कर रहे हैं या नहीं.
मुख्य रिपोर्ट के साथ शेयर की गई सुविधाएं
फ़नल रिपोर्टिंग के अनुरोधों का सिमेंटिक, मुख्य रिपोर्ट अनुरोधों जैसा ही होता है शेयर किए गए कई फ़ीचर शामिल हैं. उदाहरण के लिए, पेज नंबर, डाइमेंशन फ़िल्टर, और उपयोगकर्ता फ़नल रिपोर्ट में प्रॉपर्टी, कोर रिपोर्ट की तरह ही काम करती हैं. यह गाइड में फ़नल रिपोर्टिंग की सुविधाओं पर फ़ोकस किया गया हो. इसके बारे में जानने के लिए Data API v1 की मुख्य रिपोर्टिंग सुविधाओं के बारे में जानने के लिए, रिपोर्टिंग की बुनियादी बातों वाली गाइड पढ़ें, साथ ही, इस्तेमाल के बेहतर उदाहरण गाइड भी पढ़ें.
फ़नल रिपोर्टिंग का तरीका
Data API v1, runFunnelReport में फ़नल रिपोर्टिंग की सुविधाओं के साथ काम करता है
तरीका. इस तरीके से, Google Analytics की कस्टम फ़नल रिपोर्ट मिलती है
इवेंट डेटा.
रिपोर्टिंग इकाई में चुनें
Data API v1 के सभी तरीकों के लिए, Google Analytics प्रॉपर्टी आइडेंटिफ़ायर का होना ज़रूरी है
URL अनुरोध पथ के अंदर इस रूप में दर्ज की जानी चाहिए:
properties/GA_PROPERTY_ID, जैसे:
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID:runFunnelReport
मिलने वाली रिपोर्ट, Google Analytics के इवेंट डेटा के आधार पर जनरेट की जाएगी को खास Google Analytics प्रॉपर्टी में इकट्ठा किया जाता है.
अगर किसी Data API क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो
अनुरोध यूआरएल पाथ में मैन्युअल तरीके से बदलाव करने की कोई ज़रूरत नहीं है. ज़्यादातर एपीआई क्लाइंट
ऐसा property पैरामीटर दें जिसके लिए स्ट्रिंग इस फ़ॉर्मैट में होनी चाहिए
properties/GA_PROPERTY_ID. आसानी से सिखाने वाली गाइड देखें
देखें.
फ़नल रिपोर्ट का अनुरोध
फ़नल रिपोर्ट का अनुरोध करने के लिए, RunFunnelReportRequest बनाया जा सकता है
ऑब्जेक्ट है. हमारा सुझाव है कि आप इन अनुरोध पैरामीटर से शुरू करें:
dateRangesमें मान्य एंट्री फ़ील्ड में डालें.funnelमें मान्य फ़नल स्पेसिफ़िकेशन फ़ील्ड में डालें.
फ़नल की खास बातें
funnel में फ़नल की खास बातें
RunFunnelReportRequest का फ़ील्ड
ऑब्जेक्ट, उपयोगकर्ता की उस गतिविधि के बारे में बताता है जिसे आपको मेज़र करना है. इसके लिए, steps की जानकारी दें
इस फ़नल के बारे में जानें.
फ़नल के चरणों में एक या उससे ज़्यादा ऐसी शर्तें होती हैं जिन्हें पूरा करने के बाद ही आपके उपयोगकर्ता
शामिल हैं. हर एक सर्वे में शामिल करने के लिए शर्तें
चरण की जानकारी यहां दी गई है
filterExpression
फ़ील्ड पर फ़िल्टर लागू करें.
हर फ़नल फ़िल्टर एक्सप्रेशन दो तरह के फ़िल्टर का कॉम्बिनेशन होता है:
funnelFieldFilterकिसी डाइमेंशन या मेट्रिक के लिए फ़िल्टर बनाता है.funnelEventFilterऐसा फ़िल्टर बनाता है जो किसी एक इवेंट नाम के इवेंट से मैच करता है. अगर ज़रूरी नहीं है, तोfunnelParameterFilterExpressionफ़ील्ड में, सिर्फ़ उन इवेंट के सबसेट को शामिल किया गया है जो एक ही इवेंट से मेल खाते हैं नाम और पैरामीटर फ़िल्टर एक्सप्रेशन इस इवेंट फ़िल्टर से मेल खाते हैं.
फ़िल्टर AND का इस्तेमाल करके जोड़े जा सकते हैं.
या
साथ ही, इन ग्रुप को हटाने के लिए, 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 है. |
फ़नल के चरण 1 (फ़र्स्ट ओपन/विज़िट) में अपनी पहली विज़िट के बाद के सभी उपयोगकर्ता शामिल होते हैं
किसी वेबसाइट या ऐप्लिकेशन के साथ इंटरैक्शन, जैसे कि ट्रिगर करने वाले उपयोगकर्ता
first_open या first_visit इवेंट.
इस व्यवहार को लागू करने के लिए, यह स्निपेट एक FunnelStep ऑब्जेक्ट के साथ
filterExpression फ़ील्ड.
फ़िल्टर एक्सप्रेशन फ़ील्ड एक FunnelFilterExpression ऑब्जेक्ट है
दो को जोड़कर बनाया गया
FunnelEventFilter
OR का इस्तेमाल करने वाली इकाइयां
Groups.
{
"name": "Purchase",
"filterExpression": {
"orGroup": {
"expressions": [
{
"funnelEventFilter": {
"eventName": "first_open"
}
},
{
"funnelEventFilter": {
"eventName": "first_visit"
}
}
]
}
}
}
फ़नल के दूसरा चरण (ऑर्गैनिक वेबसाइट पर आने वाले लोग) में वे उपयोगकर्ता शामिल होते हैं जिनका पहला मीडियम
जिसमें "ऑर्गैनिक" शब्द शामिल हो. नीचे दिए गए स्निपेट में, fieldName
FunnelFieldFilter का फ़ील्ड
फ़िल्टर को firstUserMedium डाइमेंशन से मैच करने का निर्देश देता है.
stringFilter
फ़ील्ड में केवल
जिसके डाइमेंशन में "ऑर्गैनिक" शब्द हो.
{
"name": "Organic visitors",
"filterExpression": {
"funnelFieldFilter": {
"fieldName": "firstUserMedium",
"stringFilter": {
"matchType": "CONTAINS",
"caseSensitive": false,
"value": "organic"
}
}
}
}
फ़नल के बाकी चरण भी इसी तरह से तय किए जा सकते हैं.
ब्रेकडाउन आयाम
वैकल्पिक ब्रेकडाउन डाइमेंशन (इस उदाहरण में deviceCategory) के लिए
FunnelBreakdown का इस्तेमाल करके तय किया गया
ऑब्जेक्ट:
"funnelBreakdown": {
"breakdownDimension": {
"name": "deviceCategory"
}
}
डिफ़ॉल्ट रूप से, ब्रेकडाउन डाइमेंशन की सिर्फ़ पहली पांच अलग-अलग वैल्यू
जो रिपोर्ट में शामिल हैं. आप limit का इस्तेमाल कर सकते हैं
इस व्यवहार को ओवरराइड करने के लिए FunnelBreakdown ऑब्जेक्ट का फ़ील्ड.
फ़नल रिपोर्ट की क्वेरी पूरी करें
फ़नल रिपोर्ट जनरेट करने वाली पूरी क्वेरी यहां दी गई है:
HTTP
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA_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());
}
}
}
PHP
use Google\Analytics\Data\V1alpha\Client\AlphaAnalyticsDataClient;
use Google\Analytics\Data\V1alpha\DateRange;
use Google\Analytics\Data\V1alpha\Dimension;
use Google\Analytics\Data\V1alpha\FunnelBreakdown;
use Google\Analytics\Data\V1alpha\FunnelEventFilter;
use Google\Analytics\Data\V1alpha\FunnelFieldFilter;
use Google\Analytics\Data\V1alpha\FunnelFilterExpression;
use Google\Analytics\Data\V1alpha\FunnelFilterExpressionList;
use Google\Analytics\Data\V1alpha\FunnelStep;
use Google\Analytics\Data\V1alpha\Funnel;
use Google\Analytics\Data\V1alpha\FunnelSubReport;
use Google\Analytics\Data\V1alpha\RunFunnelReportRequest;
use Google\Analytics\Data\V1alpha\RunFunnelReportResponse;
use Google\Analytics\Data\V1alpha\StringFilter;
use Google\Analytics\Data\V1alpha\StringFilter\MatchType;
/**
* 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
*
* @param string $propertyId Your GA-4 Property ID
*/
function run_funnel_report(string $propertyId)
{
// Create an instance of the Google Analytics Data API client library.
$client = new AlphaAnalyticsDataClient();
// Create the funnel report request.
$request = (new RunFunnelReportRequest())
->setProperty('properties/' . $propertyId)
->setDateRanges([
new DateRange([
'start_date' => '30daysAgo',
'end_date' => 'today',
]),
])
->setFunnelBreakdown(
new FunnelBreakdown([
'breakdown_dimension' =>
new Dimension([
'name' => 'deviceCategory'
])
])
)
->setFunnel(new Funnel());
// Add funnel steps to the funnel.
// 1. Add first open/visit step.
$request->getFunnel()->getSteps()[] = new FunnelStep([
'name' => 'First open/visit',
'filter_expression' => new FunnelFilterExpression([
'or_group' => new FunnelFilterExpressionList([
'expressions' => [
new FunnelFilterExpression([
'funnel_event_filter' => new FunnelEventFilter([
'event_name' => 'first_open',
])
]),
new FunnelFilterExpression([
'funnel_event_filter' => new FunnelEventFilter([
'event_name' => 'first_visit'
])
])
]
])
])
]);
// 2. Add organic visitors step.
$request->getFunnel()->getSteps()[] = new FunnelStep([
'name' => 'Organic visitors',
'filter_expression' => new FunnelFilterExpression([
'funnel_field_filter' => new FunnelFieldFilter([
'field_name' => 'firstUserMedium',
'string_filter' => new StringFilter([
'match_type' => MatchType::CONTAINS,
'case_sensitive' => false,
'value' => 'organic',
])
])
])
]);
// 3. Add session start step.
$request->getFunnel()->getSteps()[] = new FunnelStep([
'name' => 'Session start',
'filter_expression' => new FunnelFilterExpression([
'funnel_event_filter' => new FunnelEventFilter([
'event_name' => 'session_start',
])
])
]);
// 4. Add screen/page view step.
$request->getFunnel()->getSteps()[] = new FunnelStep([
'name' => 'Screen/Page view',
'filter_expression' => new FunnelFilterExpression([
'or_group' => new FunnelFilterExpressionList([
'expressions' => [
new FunnelFilterExpression([
'funnel_event_filter' => new FunnelEventFilter([
'event_name' => 'screen_view',
])
]),
new FunnelFilterExpression([
'funnel_event_filter' => new FunnelEventFilter([
'event_name' => 'page_view'
])
])
]
])
])
]);
// 5. Add purchase step.
$request->getFunnel()->getSteps()[] = new FunnelStep([
'name' => 'Purchase',
'filter_expression' => new FunnelFilterExpression([
'or_group' => new FunnelFilterExpressionList([
'expressions' => [
new FunnelFilterExpression([
'funnel_event_filter' => new FunnelEventFilter([
'event_name' => 'purchase',
])
]),
new FunnelFilterExpression([
'funnel_event_filter' => new FunnelEventFilter([
'event_name' => 'in_app_purchase'
])
])
]
])
])
]);
// Make an API call.
$response = $client->runFunnelReport($request);
printRunFunnelReportResponse($response);
}
/**
* Print results of a runFunnelReport call.
* @param RunFunnelReportResponse $response
*/
function printRunFunnelReportResponse(RunFunnelReportResponse $response)
{
print 'Report result: ' . PHP_EOL;
print '=== FUNNEL VISUALIZATION ===' . PHP_EOL;
printFunnelSubReport($response->getFunnelVisualization());
print '=== FUNNEL TABLE ===' . PHP_EOL;
printFunnelSubReport($response->getFunnelTable());
}
/**
* Print the contents of a FunnelSubReport object.
* @param FunnelSubReport $subReport
*/
function printFunnelSubReport(FunnelSubReport $subReport)
{
print 'Dimension headers:' . PHP_EOL;
foreach ($subReport->getDimensionHeaders() as $dimensionHeader) {
print $dimensionHeader->getName() . PHP_EOL;
}
print PHP_EOL . 'Metric headers:' . PHP_EOL;
foreach ($subReport->getMetricHeaders() as $metricHeader) {
print $metricHeader->getName() . PHP_EOL;
}
print PHP_EOL . 'Dimension and metric values for each row in the report:';
foreach ($subReport->getRows() as $rowIndex => $row) {
print PHP_EOL . 'Row #' . $rowIndex . PHP_EOL;
foreach ($row->getDimensionValues() as $dimIndex => $dimValue) {
$dimName = $subReport->getDimensionHeaders()[$dimIndex]->getName();
print $dimName . ": '" . $dimValue->getValue() . "'" . PHP_EOL;
}
foreach ($row->getMetricValues() as $metricIndex => $metricValue) {
$metricName = $subReport->getMetricHeaders()[$metricIndex]->getName();
print $metricName . ": '" . $metricValue->getValue() . "'" . PHP_EOL;
}
}
print PHP_EOL . 'Sampling metadata for each date range:' . PHP_EOL;
foreach($subReport->getMetadata()->getSamplingMetadatas() as $metadataIndex => $metadata) {
printf('Sampling metadata for date range #%d: samplesReadCount=%d' .
'samplingSpaceSize=%d%s',
$metadataIndex, $metadata->getSamplesReadCount(), $metadata->getSamplingSpaceSize(), PHP_EOL);
}
}
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)