Google Analytics Data API v1을 사용하여 유입경로 보고서를 생성할 수 있습니다. 유입경로 탐색 분석을 사용하면 사용자가 각 단계에서 성공 또는 실패 여부를 신속하게 확인할 수 있습니다.
핵심 보고서와 공유 기능
유입경로 보고 요청은 다음에 대한 핵심 보고서 요청과 의미가 동일합니다. 많은 공유 기능을 제공합니다 예: 페이지로 나누기, 측정기준 필터, 사용자 유입경로 보고서에서 속성은 핵심 보고서와 동일하게 작동합니다. 이 유입경로 보고 기능을 중점적으로 다룹니다. Data API v1의 핵심 보고 기능에 대해 알아보려면 보고 기본사항 가이드를 읽어보세요. 고급 사용 사례 가이드를 참조하세요
유입경로 보고 방법
Data API v1은 runFunnelReport에서 유입경로 보고 기능을 지원합니다. 메서드를 사용하여 축소하도록 요청합니다. 이 메서드는 Google 애널리틱스의 맞춤 유입경로 보고서를 반환합니다. 이벤트 데이터입니다.
보고 항목 선택
Data API v1의 모든 메서드에는 Google 애널리틱스 4 속성 식별자가 필요합니다.
는
properties/GA4_PROPERTY_ID. 예:
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA4_PROPERTY_ID:runFunnelReport
Google 애널리틱스 이벤트 데이터를 기반으로 결과 보고서가 생성됩니다. 수집된 데이터를 바탕으로 합니다.
Data API 클라이언트 라이브러리 중 하나를 사용하는 경우 요청 URL 경로를 수동으로 조작할 필요가 없습니다. 대부분의 API 클라이언트는 properties/GA4_PROPERTY_ID 형식의 문자열을 예상하는 property 매개변수를 제공합니다. 클라이언트 라이브러리 사용 예는 빠른 시작 가이드를 참고하세요.
유입경로 보고서 요청
유입경로 보고서를 요청하려면 RunFunnelReportRequest를 구성하세요.
객체를 지정합니다. 다음 요청 매개변수로 시작하는 것이 좋습니다.
dateRanges의 유효한 항목 필드를 확인합니다.funnel의 유효한 유입경로 사양 필드를 확인합니다.
유입경로 사양
funnel의 유입경로 사양
RunFunnelReportRequest의 필드
객체는 steps를 설명하여 측정하려는 사용자 여정을 정의합니다.
확인할 수 있습니다
유입경로 단계에는 사용자가 충족해야 하는 조건이 하나 이상 포함됩니다.
포함되어 있습니다. 각 단계에 포함되기 위한 조건은
filterExpression에 설명되어 있어야 합니다.
필드를 확인하시기 바랍니다.
각 유입경로 필터 표현식은 다음 두 가지 유형의 필터 조합입니다.
funnelFieldFilter드림 측정기준 또는 측정항목에 대한 필터를 만듭니다.funnelEventFilter드림 이벤트 이름의 이벤트와 일치하는 필터를 만듭니다. 선택사항인funnelParameterFilterExpression드림 필드가 지정되면 단일 이벤트 이름 두 개와 일치하는 이벤트의 하위 집합만 매개변수 필터 표현식이 이 이벤트 필터와 일치합니다.
각 유입경로 단계에 대한 보고서 결과는 측정기준에 따라 분류됩니다.
funnelBreakdown 필드에 지정됩니다.
유입경로 보고서 예
Google 애널리틱스 Data API v1을 사용하여 기본 유입경로 보고서를 재현해 보겠습니다. 유입경로 탐색 분석에서 제공되는 Google 애널리틱스 UI의 템플릿인
유입경로 단계
위에 표시된 유입경로 구성에는 다음 단계가 포함됩니다.
| # | 단계 이름 | 조건 |
|---|---|---|
| 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 그룹을 사용하여 항목을 찾을 수 있습니다.
{
"name": "Purchase",
"filterExpression": {
"orGroup": {
"expressions": [
{
"funnelEventFilter": {
"eventName": "first_open"
}
},
{
"funnelEventFilter": {
"eventName": "first_visit"
}
}
]
}
}
}
유입경로의 2단계 (자연 방문자)에는 첫 매체를 가진 사용자가 포함됩니다.
'자연'이라는 용어가 포함됩니다. 아래 스니펫에서 fieldName
FunnelFieldFilter의 필드
는 필터가 firstUserMedium 측정기준과 일치하도록 지시합니다.
stringFilter
필드에는
'자연 검색'이 포함된 측정기준입니다.
{
"name": "Organic visitors",
"filterExpression": {
"funnelFieldFilter": {
"fieldName": "firstUserMedium",
"stringFilter": {
"matchType": "CONTAINS",
"caseSensitive": false,
"value": "organic"
}
}
}
}
나머지 유입경로 단계는 비슷한 방식으로 지정할 수 있습니다.
세부 측정기준
선택사항인 세부 측정기준 (이 예에서는 deviceCategory)은
FunnelBreakdown를 사용하여 지정됨
객체:
"funnelBreakdown": {
"breakdownDimension": {
"name": "deviceCategory"
}
}
기본적으로 세부 측정기준의 처음 5개 고유 값만
확인할 수 있습니다 limit
필드를 설정하여 이 동작을 재정의합니다.FunnelBreakdown
전체 유입경로 보고서 쿼리
다음은 모든 단계를 사용하여 유입경로 보고서를 생성하는 완전한 쿼리입니다. 설명:
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측정기준) Present only if theFunnelNextAction드림 지정할 수 있습니다
Google 애널리틱스 UI에 유입경로 시각화가 표시되는 방식입니다. 섹션의 내용은 다음과 같습니다.
유입경로 표
funnelTable에서 반환된 유입경로 표
유입경로 보고서 응답 입력란에
보고서의 주요 부분을 나타냅니다. 표의 각 행에
다음 필드의 일부 또는 전부를 포함합니다.
유입경로 단계 이름 (
funnelStepName측정기준)세부 측정기준입니다.
활성 사용자 수 (
activeUsers측정항목)단계 완료율 (
funnelStepCompletionRate측정항목)단계 이탈 횟수 (측정항목
funnelStepAbandonments개)입니다.단계 이탈률 (측정항목
funnelStepAbandonmentRate개)세그먼트 이름 (측정기준
segment개)Segment인 경우에만 표시 지정할 수 있습니다
핵심 보고 기능과 마찬가지로 전체 값은
세부 측정기준 값으로 RESERVED_TOTAL이 있는 별도의 행
다음은 Google 애널리틱스 UI에 표시되는 유입경로 표의 예입니다.
원시 응답
아래 스니펫은
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"
}
클라이언트 라이브러리
다음에 대한 설명은 빠른 시작 가이드를 참조하세요. 클라이언트 라이브러리를 설치하고 구성하는 방법을 알아보세요.
다음은 유입경로 쿼리를 실행하고 있습니다.
자바
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)