Package com.google.analytics.data.v1alpha (0.32.0)

A client to Google Analytics Data API

The interfaces provided are listed below, along with usage samples.

AlphaAnalyticsDataClient

Service Description: Google Analytics reporting data service.

Sample for AlphaAnalyticsDataClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RunFunnelReportRequest request =
       RunFunnelReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDateRanges(new ArrayList<DateRange>())
           .setFunnel(Funnel.newBuilder().build())
           .setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
           .setFunnelNextAction(FunnelNextAction.newBuilder().build())
           .addAllSegments(new ArrayList<Segment>())
           .setLimit(102976443)
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setReturnPropertyQuota(true)
           .build();
   RunFunnelReportResponse response = alphaAnalyticsDataClient.runFunnelReport(request);
 }

Classes

AlphaAnalyticsDataClient

Service Description: Google Analytics reporting data service.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
   RunFunnelReportRequest request =
       RunFunnelReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDateRanges(new ArrayList<DateRange>())
           .setFunnel(Funnel.newBuilder().build())
           .setFunnelBreakdown(FunnelBreakdown.newBuilder().build())
           .setFunnelNextAction(FunnelNextAction.newBuilder().build())
           .addAllSegments(new ArrayList<Segment>())
           .setLimit(102976443)
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setReturnPropertyQuota(true)
           .build();
   RunFunnelReportResponse response = alphaAnalyticsDataClient.runFunnelReport(request);
 }

Note: close() needs to be called on the AlphaAnalyticsDataClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AlphaAnalyticsDataSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
     AlphaAnalyticsDataSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AlphaAnalyticsDataClient alphaAnalyticsDataClient =
     AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
     AlphaAnalyticsDataSettings.newBuilder().setEndpoint(myEndpoint).build();
 AlphaAnalyticsDataClient alphaAnalyticsDataClient =
     AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
     AlphaAnalyticsDataSettings.newHttpJsonBuilder().build();
 AlphaAnalyticsDataClient alphaAnalyticsDataClient =
     AlphaAnalyticsDataClient.create(alphaAnalyticsDataSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

AlphaAnalyticsDataClient.ListAudienceListsFixedSizeCollection

AlphaAnalyticsDataClient.ListAudienceListsPage

AlphaAnalyticsDataClient.ListAudienceListsPagedResponse

AlphaAnalyticsDataGrpc

Google Analytics reporting data service.

AlphaAnalyticsDataGrpc.AlphaAnalyticsDataBlockingStub

A stub to allow clients to do synchronous rpc calls to service AlphaAnalyticsData.

Google Analytics reporting data service.

AlphaAnalyticsDataGrpc.AlphaAnalyticsDataFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service AlphaAnalyticsData.

Google Analytics reporting data service.

AlphaAnalyticsDataGrpc.AlphaAnalyticsDataImplBase

Base class for the server implementation of the service AlphaAnalyticsData.

Google Analytics reporting data service.

AlphaAnalyticsDataGrpc.AlphaAnalyticsDataStub

A stub to allow clients to do asynchronous rpc calls to service AlphaAnalyticsData.

Google Analytics reporting data service.

AlphaAnalyticsDataSettings

Settings class to configure an instance of AlphaAnalyticsDataClient.

The default instance has everything set to sensible defaults:

The default service address (analyticsdata.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of runFunnelReport to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AlphaAnalyticsDataSettings.Builder alphaAnalyticsDataSettingsBuilder =
     AlphaAnalyticsDataSettings.newBuilder();
 alphaAnalyticsDataSettingsBuilder
     .runFunnelReportSettings()
     .setRetrySettings(
         alphaAnalyticsDataSettingsBuilder
             .runFunnelReportSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
     alphaAnalyticsDataSettingsBuilder.build();

AlphaAnalyticsDataSettings.Builder

Builder for AlphaAnalyticsDataSettings.

AnalyticsDataApiProto

AudienceDimension

An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the QueryAudienceListResponse.

Protobuf type google.analytics.data.v1alpha.AudienceDimension

AudienceDimension.Builder

An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the QueryAudienceListResponse.

Protobuf type google.analytics.data.v1alpha.AudienceDimension

AudienceDimensionValue

The value of a dimension.

Protobuf type google.analytics.data.v1alpha.AudienceDimensionValue

AudienceDimensionValue.Builder

The value of a dimension.

Protobuf type google.analytics.data.v1alpha.AudienceDimensionValue

AudienceList

An audience list is a list of users in an audience at the time of the list's creation. One audience may have multiple audience lists created for different days.

Protobuf type google.analytics.data.v1alpha.AudienceList

AudienceList.Builder

An audience list is a list of users in an audience at the time of the list's creation. One audience may have multiple audience lists created for different days.

Protobuf type google.analytics.data.v1alpha.AudienceList

AudienceListMetadata

This metadata is currently blank.

Protobuf type google.analytics.data.v1alpha.AudienceListMetadata

AudienceListMetadata.Builder

This metadata is currently blank.

Protobuf type google.analytics.data.v1alpha.AudienceListMetadata

AudienceListName

AudienceListName.Builder

Builder for properties/{propertyId}/audienceLists/{audienceListId}.

AudienceRow

Dimension value attributes for the audience user row.

Protobuf type google.analytics.data.v1alpha.AudienceRow

AudienceRow.Builder

Dimension value attributes for the audience user row.

Protobuf type google.analytics.data.v1alpha.AudienceRow

BetweenFilter

To express that the result needs to be between two numbers (inclusive).

Protobuf type google.analytics.data.v1alpha.BetweenFilter

BetweenFilter.Builder

To express that the result needs to be between two numbers (inclusive).

Protobuf type google.analytics.data.v1alpha.BetweenFilter

CreateAudienceListRequest

A request to create a new audience list.

Protobuf type google.analytics.data.v1alpha.CreateAudienceListRequest

CreateAudienceListRequest.Builder

A request to create a new audience list.

Protobuf type google.analytics.data.v1alpha.CreateAudienceListRequest

DateRange

A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

Protobuf type google.analytics.data.v1alpha.DateRange

DateRange.Builder

A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

Protobuf type google.analytics.data.v1alpha.DateRange

Dimension

Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York".

Protobuf type google.analytics.data.v1alpha.Dimension

Dimension.Builder

Protobuf type google.analytics.data.v1alpha.Dimension

DimensionExpression

Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).

Protobuf type google.analytics.data.v1alpha.DimensionExpression

DimensionExpression.Builder

Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).

Protobuf type google.analytics.data.v1alpha.DimensionExpression

DimensionExpression.CaseExpression

Used to convert a dimension value to a single case.

Protobuf type google.analytics.data.v1alpha.DimensionExpression.CaseExpression

DimensionExpression.CaseExpression.Builder

Used to convert a dimension value to a single case.

Protobuf type google.analytics.data.v1alpha.DimensionExpression.CaseExpression

DimensionExpression.ConcatenateExpression

Used to combine dimension values to a single dimension.

Protobuf type google.analytics.data.v1alpha.DimensionExpression.ConcatenateExpression

DimensionExpression.ConcatenateExpression.Builder

Used to combine dimension values to a single dimension.

Protobuf type google.analytics.data.v1alpha.DimensionExpression.ConcatenateExpression

DimensionHeader

Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.

Protobuf type google.analytics.data.v1alpha.DimensionHeader

DimensionHeader.Builder

Protobuf type google.analytics.data.v1alpha.DimensionHeader

DimensionValue

The value of a dimension.

Protobuf type google.analytics.data.v1alpha.DimensionValue

DimensionValue.Builder

The value of a dimension.

Protobuf type google.analytics.data.v1alpha.DimensionValue

EventSegment

Event segments are subsets of events that were triggered on your site or app. for example, all purchase events made in a particular location; app_exception events that occurred on a specific operating system.

Protobuf type google.analytics.data.v1alpha.EventSegment

EventSegment.Builder

Protobuf type google.analytics.data.v1alpha.EventSegment

EventSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

Protobuf type google.analytics.data.v1alpha.EventSegmentConditionGroup

EventSegmentConditionGroup.Builder

Conditions tell Analytics what data to include in or exclude from the segment.

Protobuf type google.analytics.data.v1alpha.EventSegmentConditionGroup

EventSegmentCriteria

An event matches a criteria if the event meet the conditions in the criteria.

Protobuf type google.analytics.data.v1alpha.EventSegmentCriteria

EventSegmentCriteria.Builder

An event matches a criteria if the event meet the conditions in the criteria.

Protobuf type google.analytics.data.v1alpha.EventSegmentCriteria

EventSegmentExclusion

Specifies which events are excluded in this segment.

Protobuf type google.analytics.data.v1alpha.EventSegmentExclusion

EventSegmentExclusion.Builder

Specifies which events are excluded in this segment.

Protobuf type google.analytics.data.v1alpha.EventSegmentExclusion

Filter

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1alpha.Filter

Filter.Builder

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1alpha.Filter

FilterExpression

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.

Protobuf type google.analytics.data.v1alpha.FilterExpression

FilterExpression.Builder

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.

Protobuf type google.analytics.data.v1alpha.FilterExpression

FilterExpressionList

A list of filter expressions.

Protobuf type google.analytics.data.v1alpha.FilterExpressionList

FilterExpressionList.Builder

A list of filter expressions.

Protobuf type google.analytics.data.v1alpha.FilterExpressionList

Funnel

Configures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps.

Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys.

Protobuf type google.analytics.data.v1alpha.Funnel

Funnel.Builder

Configures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps.

Protobuf type google.analytics.data.v1alpha.Funnel

FunnelBreakdown

Breakdowns add a dimension to the funnel table sub report response.

Protobuf type google.analytics.data.v1alpha.FunnelBreakdown

FunnelBreakdown.Builder

Breakdowns add a dimension to the funnel table sub report response.

Protobuf type google.analytics.data.v1alpha.FunnelBreakdown

FunnelEventFilter

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

Protobuf type google.analytics.data.v1alpha.FunnelEventFilter

FunnelEventFilter.Builder

Protobuf type google.analytics.data.v1alpha.FunnelEventFilter

FunnelFieldFilter

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1alpha.FunnelFieldFilter

FunnelFieldFilter.Builder

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1alpha.FunnelFieldFilter

FunnelFilterExpression

Expresses combinations of funnel filters.

Protobuf type google.analytics.data.v1alpha.FunnelFilterExpression

FunnelFilterExpression.Builder

Expresses combinations of funnel filters.

Protobuf type google.analytics.data.v1alpha.FunnelFilterExpression

FunnelFilterExpressionList

A list of funnel filter expressions.

Protobuf type google.analytics.data.v1alpha.FunnelFilterExpressionList

FunnelFilterExpressionList.Builder

A list of funnel filter expressions.

Protobuf type google.analytics.data.v1alpha.FunnelFilterExpressionList

FunnelNextAction

Next actions state the value for a dimension after the user has achieved a step but before the same user has achieved the next step. For example if the nextActionDimension is eventName, then nextActionDimension in the ith funnel step row will return first event after the event that qualified the user into the ith funnel step but before the user achieved the i+1th funnel step.

Protobuf type google.analytics.data.v1alpha.FunnelNextAction

FunnelNextAction.Builder

Protobuf type google.analytics.data.v1alpha.FunnelNextAction

FunnelParameterFilter

An expression to filter parameter values in a funnel.

Protobuf type google.analytics.data.v1alpha.FunnelParameterFilter

FunnelParameterFilter.Builder

An expression to filter parameter values in a funnel.

Protobuf type google.analytics.data.v1alpha.FunnelParameterFilter

FunnelParameterFilterExpression

Expresses combinations of funnel filters on parameters.

Protobuf type google.analytics.data.v1alpha.FunnelParameterFilterExpression

FunnelParameterFilterExpression.Builder

Expresses combinations of funnel filters on parameters.

Protobuf type google.analytics.data.v1alpha.FunnelParameterFilterExpression

FunnelParameterFilterExpressionList

A list of funnel parameter filter expressions.

Protobuf type google.analytics.data.v1alpha.FunnelParameterFilterExpressionList

FunnelParameterFilterExpressionList.Builder

A list of funnel parameter filter expressions.

Protobuf type google.analytics.data.v1alpha.FunnelParameterFilterExpressionList

FunnelResponseMetadata

The funnel report's response metadata carries additional information about the funnel report.

Protobuf type google.analytics.data.v1alpha.FunnelResponseMetadata

FunnelResponseMetadata.Builder

The funnel report's response metadata carries additional information about the funnel report.

Protobuf type google.analytics.data.v1alpha.FunnelResponseMetadata

FunnelStep

Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey.

Protobuf type google.analytics.data.v1alpha.FunnelStep

FunnelStep.Builder

Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey.

Protobuf type google.analytics.data.v1alpha.FunnelStep

FunnelSubReport

Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.

Protobuf type google.analytics.data.v1alpha.FunnelSubReport

FunnelSubReport.Builder

Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.

Protobuf type google.analytics.data.v1alpha.FunnelSubReport

GetAudienceListRequest

A request to retrieve configuration metadata about a specific audience list.

Protobuf type google.analytics.data.v1alpha.GetAudienceListRequest

GetAudienceListRequest.Builder

A request to retrieve configuration metadata about a specific audience list.

Protobuf type google.analytics.data.v1alpha.GetAudienceListRequest

InListFilter

The result needs to be in a list of string values.

Protobuf type google.analytics.data.v1alpha.InListFilter

InListFilter.Builder

The result needs to be in a list of string values.

Protobuf type google.analytics.data.v1alpha.InListFilter

ListAudienceListsRequest

A request to list all audience lists for a property.

Protobuf type google.analytics.data.v1alpha.ListAudienceListsRequest

ListAudienceListsRequest.Builder

A request to list all audience lists for a property.

Protobuf type google.analytics.data.v1alpha.ListAudienceListsRequest

ListAudienceListsResponse

A list of all audience lists for a property.

Protobuf type google.analytics.data.v1alpha.ListAudienceListsResponse

ListAudienceListsResponse.Builder

A list of all audience lists for a property.

Protobuf type google.analytics.data.v1alpha.ListAudienceListsResponse

MetricHeader

Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.

Protobuf type google.analytics.data.v1alpha.MetricHeader

MetricHeader.Builder

Protobuf type google.analytics.data.v1alpha.MetricHeader

MetricValue

The value of a metric.

Protobuf type google.analytics.data.v1alpha.MetricValue

MetricValue.Builder

The value of a metric.

Protobuf type google.analytics.data.v1alpha.MetricValue

NumericFilter

Filters for numeric or date values.

Protobuf type google.analytics.data.v1alpha.NumericFilter

NumericFilter.Builder

Filters for numeric or date values.

Protobuf type google.analytics.data.v1alpha.NumericFilter

NumericValue

To represent a number.

Protobuf type google.analytics.data.v1alpha.NumericValue

NumericValue.Builder

To represent a number.

Protobuf type google.analytics.data.v1alpha.NumericValue

PropertyName

PropertyName.Builder

Builder for properties/{propertyId}.

PropertyQuota

Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.

Protobuf type google.analytics.data.v1alpha.PropertyQuota

PropertyQuota.Builder

Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.

Protobuf type google.analytics.data.v1alpha.PropertyQuota

QueryAudienceListRequest

A request to list users in an audience list.

Protobuf type google.analytics.data.v1alpha.QueryAudienceListRequest

QueryAudienceListRequest.Builder

A request to list users in an audience list.

Protobuf type google.analytics.data.v1alpha.QueryAudienceListRequest

QueryAudienceListResponse

A list of users in an audience list.

Protobuf type google.analytics.data.v1alpha.QueryAudienceListResponse

QueryAudienceListResponse.Builder

A list of users in an audience list.

Protobuf type google.analytics.data.v1alpha.QueryAudienceListResponse

QuotaStatus

Current state for a particular quota group.

Protobuf type google.analytics.data.v1alpha.QuotaStatus

QuotaStatus.Builder

Current state for a particular quota group.

Protobuf type google.analytics.data.v1alpha.QuotaStatus

ReportingApiProto

Row

Report data for each row. For example if RunReportRequest contains:

`none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ]

One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be:

none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ]`

Protobuf type google.analytics.data.v1alpha.Row

Row.Builder

Report data for each row. For example if RunReportRequest contains:

`none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ]

One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be:

none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ]`

Protobuf type google.analytics.data.v1alpha.Row

RunFunnelReportRequest

The request for a funnel report.

Protobuf type google.analytics.data.v1alpha.RunFunnelReportRequest

RunFunnelReportRequest.Builder

The request for a funnel report.

Protobuf type google.analytics.data.v1alpha.RunFunnelReportRequest

RunFunnelReportResponse

The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.

Protobuf type google.analytics.data.v1alpha.RunFunnelReportResponse

RunFunnelReportResponse.Builder

The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.

Protobuf type google.analytics.data.v1alpha.RunFunnelReportResponse

SamplingMetadata

If funnel report results are sampled, this metadata describes what percentage of events were used in this funnel report for a date range. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.

Protobuf type google.analytics.data.v1alpha.SamplingMetadata

SamplingMetadata.Builder

Protobuf type google.analytics.data.v1alpha.SamplingMetadata

Segment

A segment is a subset of your Analytics data. For example, of your entire set of users, one segment might be users from a particular country or city. Another segment might be users who purchase a particular line of products or who visit a specific part of your site or trigger certain events in your app.

To learn more, see GA4 Segment Builder.

Protobuf type google.analytics.data.v1alpha.Segment

Segment.Builder

To learn more, see GA4 Segment Builder.

Protobuf type google.analytics.data.v1alpha.Segment

SegmentEventFilter

Protobuf type google.analytics.data.v1alpha.SegmentEventFilter

SegmentEventFilter.Builder

Protobuf type google.analytics.data.v1alpha.SegmentEventFilter

SegmentFilter

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1alpha.SegmentFilter

SegmentFilter.Builder

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1alpha.SegmentFilter

SegmentFilterExpression

Expresses combinations of segment filters.

Protobuf type google.analytics.data.v1alpha.SegmentFilterExpression

SegmentFilterExpression.Builder

Expresses combinations of segment filters.

Protobuf type google.analytics.data.v1alpha.SegmentFilterExpression

SegmentFilterExpressionList

A list of segment filter expressions.

Protobuf type google.analytics.data.v1alpha.SegmentFilterExpressionList

SegmentFilterExpressionList.Builder

A list of segment filter expressions.

Protobuf type google.analytics.data.v1alpha.SegmentFilterExpressionList

SegmentFilterScoping

Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.

Protobuf type google.analytics.data.v1alpha.SegmentFilterScoping

SegmentFilterScoping.Builder

Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.

Protobuf type google.analytics.data.v1alpha.SegmentFilterScoping

SegmentParameterFilter

An expression to filter parameter values in a segment.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilter

SegmentParameterFilter.Builder

An expression to filter parameter values in a segment.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilter

SegmentParameterFilterExpression

Expresses combinations of segment filter on parameters.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterExpression

SegmentParameterFilterExpression.Builder

Expresses combinations of segment filter on parameters.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterExpression

SegmentParameterFilterExpressionList

A list of segment parameter filter expressions.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterExpressionList

SegmentParameterFilterExpressionList.Builder

A list of segment parameter filter expressions.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterExpressionList

SegmentParameterFilterScoping

Scopings specify how multiple events should be considered when evaluating a segment parameter filter.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterScoping

SegmentParameterFilterScoping.Builder

Scopings specify how multiple events should be considered when evaluating a segment parameter filter.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterScoping

SessionSegment

Session segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising campaign.

Protobuf type google.analytics.data.v1alpha.SessionSegment

SessionSegment.Builder

Session segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising campaign.

Protobuf type google.analytics.data.v1alpha.SessionSegment

SessionSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

Protobuf type google.analytics.data.v1alpha.SessionSegmentConditionGroup

SessionSegmentConditionGroup.Builder

Conditions tell Analytics what data to include in or exclude from the segment.

Protobuf type google.analytics.data.v1alpha.SessionSegmentConditionGroup

SessionSegmentCriteria

A session matches a criteria if the session's events meet the conditions in the criteria.

Protobuf type google.analytics.data.v1alpha.SessionSegmentCriteria

SessionSegmentCriteria.Builder

A session matches a criteria if the session's events meet the conditions in the criteria.

Protobuf type google.analytics.data.v1alpha.SessionSegmentCriteria

SessionSegmentExclusion

Specifies which sessions are excluded in this segment.

Protobuf type google.analytics.data.v1alpha.SessionSegmentExclusion

SessionSegmentExclusion.Builder

Specifies which sessions are excluded in this segment.

Protobuf type google.analytics.data.v1alpha.SessionSegmentExclusion

StringFilter

The filter for string

Protobuf type google.analytics.data.v1alpha.StringFilter

StringFilter.Builder

The filter for string

Protobuf type google.analytics.data.v1alpha.StringFilter

UserSegment

User segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping carts, but didn’t complete a purchase.

Protobuf type google.analytics.data.v1alpha.UserSegment

UserSegment.Builder

Protobuf type google.analytics.data.v1alpha.UserSegment

UserSegmentConditionGroup

Conditions tell Analytics what data to include in or exclude from the segment.

Protobuf type google.analytics.data.v1alpha.UserSegmentConditionGroup

UserSegmentConditionGroup.Builder

Conditions tell Analytics what data to include in or exclude from the segment.

Protobuf type google.analytics.data.v1alpha.UserSegmentConditionGroup

UserSegmentCriteria

A user matches a criteria if the user's events meet the conditions in the criteria.

Protobuf type google.analytics.data.v1alpha.UserSegmentCriteria

UserSegmentCriteria.Builder

A user matches a criteria if the user's events meet the conditions in the criteria.

Protobuf type google.analytics.data.v1alpha.UserSegmentCriteria

UserSegmentExclusion

Specifies which users are excluded in this segment.

Protobuf type google.analytics.data.v1alpha.UserSegmentExclusion

UserSegmentExclusion.Builder

Specifies which users are excluded in this segment.

Protobuf type google.analytics.data.v1alpha.UserSegmentExclusion

UserSegmentSequenceGroup

Define conditions that must occur in a specific order for the user to be a member of the segment.

Protobuf type google.analytics.data.v1alpha.UserSegmentSequenceGroup

UserSegmentSequenceGroup.Builder

Define conditions that must occur in a specific order for the user to be a member of the segment.

Protobuf type google.analytics.data.v1alpha.UserSegmentSequenceGroup

UserSequenceStep

A condition that must occur in the specified step order for this user to match the sequence.

Protobuf type google.analytics.data.v1alpha.UserSequenceStep

UserSequenceStep.Builder

A condition that must occur in the specified step order for this user to match the sequence.

Protobuf type google.analytics.data.v1alpha.UserSequenceStep

Interfaces

AlphaAnalyticsDataGrpc.AsyncService

Google Analytics reporting data service.