Google Analytics Data API v1 ช่วยให้คุณสร้างรายงาน Funnel ได้ การสำรวจ Funnel จะช่วยให้คุณได้เห็นภาพขั้นตอนต่างๆ ที่ผู้ใช้ใช้ในการดำเนินงาน และดูว่าจะประสบความสำเร็จหรือล้มเหลวในแต่ละขั้นตอนได้อย่างรวดเร็ว
ฟีเจอร์ที่แชร์กับรายงานหลัก
คำขอการรายงาน Funnel มีความหมายเหมือนกับคำขอรายงานหลักสำหรับฟีเจอร์ที่ใช้ร่วมกันหลายรายการ เช่น การแบ่งหน้า ตัวกรองมิติข้อมูล และพร็อพเพอร์ตี้ผู้ใช้ ทำงานเหมือนกับรายงานช่องทาง คู่มือนี้เน้นฟีเจอร์การรายงาน Funnel เพื่อทำความคุ้นเคยกับฟังก์ชันการรายงานหลักของ Data API เวอร์ชัน 1 โปรดอ่านคู่มือพื้นฐานการรายงานและคู่มือกรณีการใช้งานขั้นสูง
วิธีการรายงาน Funnel
Data API v1 รองรับฟังก์ชันการรายงาน Funnel ในเมธอด runFunnelReport วิธีนี้แสดงผลรายงาน Funnel ที่ปรับแต่งแล้วของข้อมูลเหตุการณ์ Google Analytics
การเลือกเอนทิตีการรายงาน
เมธอดทั้งหมดของ Data API v1 กำหนดให้ต้องระบุตัวระบุพร็อพเพอร์ตี้ Google Analytics 4
ภายในเส้นทางคำขอ URL ในรูปแบบ
properties/GA4_PROPERTY_ID เช่น
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA4_PROPERTY_ID:runFunnelReport
ระบบจะสร้างรายงานที่ได้ตามข้อมูลเหตุการณ์ Google Analytics ที่รวบรวมในพร็อพเพอร์ตี้ Google Analytics 4 ที่ระบุ
หากใช้ไลบรารีของไคลเอ็นต์ Data API อย่างใดอย่างหนึ่ง ก็ไม่จำเป็นต้องจัดการเส้นทาง URL คำขอด้วยตนเอง ไคลเอ็นต์ API ส่วนใหญ่จะมีพารามิเตอร์ property ที่คาดหวังสตริงในรูปแบบ properties/GA4_PROPERTY_ID โปรดดูตัวอย่างการใช้ไลบรารีของไคลเอ็นต์ได้ในคู่มือเริ่มใช้งานฉบับย่อ
คำขอรายงาน Funnel
หากต้องการขอรายงาน Funnel ให้สร้างออบเจ็กต์ RunFunnelReportRequest เราขอแนะนำให้เริ่มต้นด้วยพารามิเตอร์คำขอเหล่านี้
ข้อมูลที่ป้อนในช่อง
dateRangesข้อกำหนดของ Funnel ที่ถูกต้องในช่อง
funnel
ข้อกำหนดของ Funnel
ข้อกําหนดของ Funnel ในช่อง funnel ของออบเจ็กต์ RunFunnelReportRequest จะกําหนดเส้นทางของผู้ใช้ที่คุณต้องการวัดโดยอธิบาย steps ของ Funnel นี้
ขั้นตอนของ Funnel มีเงื่อนไขอย่างน้อย 1 รายการที่ผู้ใช้ต้องทำตามเพื่อให้อยู่ในขั้นตอนของเส้นทาง Funnel นั้น เงื่อนไขสำหรับการรวมในแต่ละขั้นตอนจะอธิบายได้ในช่อง filterExpression ของแต่ละขั้นตอน
นิพจน์ตัวกรอง Funnel แต่ละรายการเป็นชุดค่าผสมของตัวกรอง 2 ประเภท ดังนี้
funnelFieldFilterสร้างตัวกรองสำหรับมิติข้อมูลหรือเมตริกfunnelEventFilterสร้างตัวกรองที่ตรงกับเหตุการณ์ที่มีชื่อเหตุการณ์เดียว หากระบุช่องfunnelParameterFilterExpressionที่ไม่บังคับ จะมีเพียงชุดย่อยของเหตุการณ์ที่ตรงกับทั้งชื่อเหตุการณ์เดียวและนิพจน์ตัวกรองพารามิเตอร์ที่ตรงกับตัวกรองเหตุการณ์นี้
คุณรวมตัวกรองได้โดยใช้กลุ่ม AND, OR รวมถึงการยกเว้นโดยใช้นิพจน์ NOT
ผลลัพธ์ของรายงานสำหรับแต่ละขั้นตอนของ Funnel จะแจกแจงตามมิติข้อมูลและระบุไว้ในช่อง funnelBreakdown
ตัวอย่างรายงาน Funnel
มาใช้ Google Analytics Data API v1 เพื่อทำซ้ำรายงาน Funnel เริ่มต้นที่ให้ไว้ในเทมเพลตการสำรวจ Funnel ของ UI ของ Google Analytics กัน
ขั้นตอนของ Funnel
การกำหนดค่า Funnel ที่แสดงด้านบนมีขั้นตอนต่อไปนี้
| # | ชื่อขั้นตอน | เงื่อนไข |
|---|---|---|
| 1 | การเปิด/เข้าชมครั้งแรก | ชื่อเหตุการณ์คือ first_open หรือ first_visit |
| 2 | ผู้เข้าชมทั่วไป | มิติข้อมูล firstUserMedium มีคำว่า "ทั่วไป" |
| 3 | เริ่มต้นเซสชัน | ชื่อเหตุการณ์คือ session_start |
| 4 | การดูหน้าจอ/หน้าเว็บ | ชื่อเหตุการณ์คือ screen_view หรือ page_view |
| 5 | ซื้อ | ชื่อเหตุการณ์คือ purchase หรือ in_app_purchase |
ขั้นตอนที่ 1 (การเปิด/การเข้าชมครั้งแรก) ของ Funnel จะรวมผู้ใช้ทั้งหมดหลังจากการโต้ตอบครั้งแรกกับเว็บไซต์หรือแอปพลิเคชัน เช่น ผู้ใช้ที่ทริกเกอร์เหตุการณ์ first_open หรือ first_visit
หากต้องการใช้ลักษณะการทำงานนี้ ข้อมูลโค้ดด้านล่างจะระบุออบเจ็กต์ FunnelStep ที่มีช่อง filterExpression ช่องนิพจน์ตัวกรองเป็นออบเจ็กต์ FunnelFilterExpression ที่สร้างขึ้นโดยรวมเอนทิตี FunnelEventFilter 2 รายการโดยใช้กลุ่ม "หรือ"
{
"name": "Purchase",
"filterExpression": {
"orGroup": {
"expressions": [
{
"funnelEventFilter": {
"eventName": "first_open"
}
},
{
"funnelEventFilter": {
"eventName": "first_visit"
}
}
]
}
}
}
ขั้นตอนที่ 2 (ผู้เข้าชมทั่วไป) ของ Funnel จะรวมผู้ใช้ที่มีสื่อแรกซึ่งมีคำว่า "ทั่วไป" ในข้อมูลโค้ดด้านล่าง ช่อง fieldName ของ FunnelFieldFilter จะสั่งให้ตัวกรองจับคู่กับมิติข้อมูล firstUserMedium
ช่อง stringFilter มีเงื่อนไขให้รวมเฉพาะค่าของมิติข้อมูลที่มีคำว่า "ทั่วไป"
{
"name": "Organic visitors",
"filterExpression": {
"funnelFieldFilter": {
"fieldName": "firstUserMedium",
"stringFilter": {
"matchType": "CONTAINS",
"caseSensitive": false,
"value": "organic"
}
}
}
}
คุณระบุขั้นตอนที่เหลือของ Funnel ในลักษณะที่คล้ายกันได้
มิติข้อมูลแจกแจง
คุณระบุมิติข้อมูลรายละเอียดที่ไม่บังคับ (deviceCategory ในตัวอย่างนี้) ได้โดยใช้ออบเจ็กต์ FunnelBreakdown ดังนี้
"funnelBreakdown": {
"breakdownDimension": {
"name": "deviceCategory"
}
}
โดยค่าเริ่มต้น ค่าที่แตกต่างกัน 5 ค่าแรกของมิติข้อมูลรายละเอียดจะรวมอยู่ในรายงานเท่านั้น คุณใช้ช่อง limit ของออบเจ็กต์ FunnelBreakdown เพื่อลบล้างลักษณะการทำงานนี้ได้
ทำการค้นหารายงาน Funnel ที่เสร็จสมบูรณ์
ต่อไปนี้คือคำค้นหาที่สมบูรณ์ซึ่งสร้างรายงาน Funnel โดยใช้ขั้นตอนทั้งหมดที่อธิบายข้างต้น
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"
}
}
]
}
}
}
]
}
}
รายงานคำตอบ
การตอบกลับรายงาน Funnel
ของคำขอ API รายงาน Funnel ประกอบด้วย 2 ส่วนหลัก โดยทั้ง 2 ส่วนแสดงผลเป็นออบเจ็กต์ FunnelSubReport
ได้แก่ ภาพแสดงช่องทางและตาราง Funnel
การแสดงภาพ Funnel
ภาพแสดงช่องทาง ซึ่งแสดงผลในช่องfunnelVisualizationของการตอบกลับรายงาน Funnel มีภาพรวมระดับสูงของรายงาน Funnel ซึ่งจะเป็นประโยชน์ตามชื่อที่บอกคือ สำหรับการแสดงภาพรายงาน Funnel ที่สร้างขึ้นอย่างรวดเร็ว
แต่ละแถวของตารางภาพแสดงช่องทางมีช่องต่อไปนี้บางส่วนหรือทั้งหมด
ชื่อขั้นตอนของ Funnel (มิติข้อมูล
funnelStepName)จํานวนผู้ใช้ที่ใช้งานอยู่ (เมตริก
activeUsers)กลุ่ม (มิติข้อมูล
segmentรายการ) แสดงก็ต่อเมื่อระบุSegmentในการค้นหาของ Funnelวันที่ (มิติข้อมูล
date) แสดงเมื่อมีการระบุประเภทภาพTRENDED_FUNNELในการค้นหาเท่านั้นมิติข้อมูลการดำเนินการถัดไป (มิติข้อมูล
funnelStepNextActionรายการ) แสดงก็ต่อเมื่อมีการระบุFunnelNextActionในการค้นหาของ Funnel
UI ของ Google Analytics จะแสดงส่วนภาพแสดงช่องทางของรายงานตัวอย่างที่พูดถึงข้างต้น ดังนี้
ตาราง Funnel
ตาราง Funnel ซึ่งแสดงในช่อง funnelTable ของการตอบกลับรายงาน Funnel จะแสดงส่วนหลักของรายงาน แต่ละแถวของตารางจะมีช่องต่อไปนี้บางส่วนหรือทั้งหมด
ชื่อขั้นตอนของ Funnel (มิติข้อมูล
funnelStepName)มิติข้อมูลแจกแจง
จํานวนผู้ใช้ที่ใช้งานอยู่ (เมตริก
activeUsers)อัตราความสำเร็จขั้นตอน (เมตริก
funnelStepCompletionRate)จำนวนการละทิ้งขั้นตอน (เมตริก
funnelStepAbandonments)อัตราการหยุดกลางคัน (เมตริก
funnelStepAbandonmentRate)ชื่อกลุ่ม (มิติข้อมูล
segmentรายการ) แสดงก็ต่อเมื่อระบุSegmentในการค้นหาของ Funnel
ค่าทั้งหมดจะแสดงในแถวแยกต่างหากโดยมี RESERVED_TOTAL เป็นค่ามิติข้อมูลรายละเอียด เช่นเดียวกับฟังก์ชันการรายงานหลัก
ด้านล่างนี้คือตัวอย่างตาราง Funnel ที่แสดงใน UI ของ Google Analytics
คำตอบที่เป็นข้อมูลดิบ
ตัวอย่างข้อมูลด้านล่างแสดงตัวอย่างของข้อมูลดิบที่ตอบกลับการค้นหา runFunnelReport
รายงานตัวอย่างข้างต้นจะแสดงรายงานต่อไปนี้ที่แสดงจํานวนผู้ใช้ที่ใช้งานอยู่ซึ่งรวมอยู่ในแต่ละขั้นตอนของ Funnel ทั้งนี้ขึ้นอยู่กับข้อมูลที่พร็อพเพอร์ตี้ของคุณรวบรวม
{
"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"
}
ไลบรารีของไคลเอ็นต์
โปรดดูคู่มือเริ่มใช้งานฉบับย่อเพื่อดูคำอธิบายเกี่ยวกับวิธีติดตั้งและกำหนดค่าไลบรารีของไคลเอ็นต์
ด้านล่างนี้เป็นตัวอย่างการใช้ไลบรารีของไคลเอ็นต์ที่เรียกใช้การค้นหาของ Funnel และพิมพ์คำตอบ
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)