data

package
v0.0.0-...-a8a6208 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 10, 2024 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	RunFunnelReportRequest_FunnelVisualizationType_name = map[int32]string{
		0: "FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED",
		1: "STANDARD_FUNNEL",
		2: "TRENDED_FUNNEL",
	}
	RunFunnelReportRequest_FunnelVisualizationType_value = map[string]int32{
		"FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED": 0,
		"STANDARD_FUNNEL":                       1,
		"TRENDED_FUNNEL":                        2,
	}
)

Enum value maps for RunFunnelReportRequest_FunnelVisualizationType.

View Source
var (
	UserCriteriaScoping_name = map[int32]string{
		0: "USER_CRITERIA_SCOPING_UNSPECIFIED",
		1: "USER_CRITERIA_WITHIN_SAME_EVENT",
		2: "USER_CRITERIA_WITHIN_SAME_SESSION",
		3: "USER_CRITERIA_ACROSS_ALL_SESSIONS",
	}
	UserCriteriaScoping_value = map[string]int32{
		"USER_CRITERIA_SCOPING_UNSPECIFIED": 0,
		"USER_CRITERIA_WITHIN_SAME_EVENT":   1,
		"USER_CRITERIA_WITHIN_SAME_SESSION": 2,
		"USER_CRITERIA_ACROSS_ALL_SESSIONS": 3,
	}
)

Enum value maps for UserCriteriaScoping.

View Source
var (
	UserExclusionDuration_name = map[int32]string{
		0: "USER_EXCLUSION_DURATION_UNSPECIFIED",
		1: "USER_EXCLUSION_TEMPORARY",
		2: "USER_EXCLUSION_PERMANENT",
	}
	UserExclusionDuration_value = map[string]int32{
		"USER_EXCLUSION_DURATION_UNSPECIFIED": 0,
		"USER_EXCLUSION_TEMPORARY":            1,
		"USER_EXCLUSION_PERMANENT":            2,
	}
)

Enum value maps for UserExclusionDuration.

View Source
var (
	SessionCriteriaScoping_name = map[int32]string{
		0: "SESSION_CRITERIA_SCOPING_UNSPECIFIED",
		1: "SESSION_CRITERIA_WITHIN_SAME_EVENT",
		2: "SESSION_CRITERIA_WITHIN_SAME_SESSION",
	}
	SessionCriteriaScoping_value = map[string]int32{
		"SESSION_CRITERIA_SCOPING_UNSPECIFIED": 0,
		"SESSION_CRITERIA_WITHIN_SAME_EVENT":   1,
		"SESSION_CRITERIA_WITHIN_SAME_SESSION": 2,
	}
)

Enum value maps for SessionCriteriaScoping.

View Source
var (
	SessionExclusionDuration_name = map[int32]string{
		0: "SESSION_EXCLUSION_DURATION_UNSPECIFIED",
		1: "SESSION_EXCLUSION_TEMPORARY",
		2: "SESSION_EXCLUSION_PERMANENT",
	}
	SessionExclusionDuration_value = map[string]int32{
		"SESSION_EXCLUSION_DURATION_UNSPECIFIED": 0,
		"SESSION_EXCLUSION_TEMPORARY":            1,
		"SESSION_EXCLUSION_PERMANENT":            2,
	}
)

Enum value maps for SessionExclusionDuration.

View Source
var (
	EventCriteriaScoping_name = map[int32]string{
		0: "EVENT_CRITERIA_SCOPING_UNSPECIFIED",
		1: "EVENT_CRITERIA_WITHIN_SAME_EVENT",
	}
	EventCriteriaScoping_value = map[string]int32{
		"EVENT_CRITERIA_SCOPING_UNSPECIFIED": 0,
		"EVENT_CRITERIA_WITHIN_SAME_EVENT":   1,
	}
)

Enum value maps for EventCriteriaScoping.

View Source
var (
	EventExclusionDuration_name = map[int32]string{
		0: "EVENT_EXCLUSION_DURATION_UNSPECIFIED",
		1: "EVENT_EXCLUSION_PERMANENT",
	}
	EventExclusionDuration_value = map[string]int32{
		"EVENT_EXCLUSION_DURATION_UNSPECIFIED": 0,
		"EVENT_EXCLUSION_PERMANENT":            1,
	}
)

Enum value maps for EventExclusionDuration.

View Source
var (
	MetricType_name = map[int32]string{
		0:  "METRIC_TYPE_UNSPECIFIED",
		1:  "TYPE_INTEGER",
		2:  "TYPE_FLOAT",
		4:  "TYPE_SECONDS",
		5:  "TYPE_MILLISECONDS",
		6:  "TYPE_MINUTES",
		7:  "TYPE_HOURS",
		8:  "TYPE_STANDARD",
		9:  "TYPE_CURRENCY",
		10: "TYPE_FEET",
		11: "TYPE_MILES",
		12: "TYPE_METERS",
		13: "TYPE_KILOMETERS",
	}
	MetricType_value = map[string]int32{
		"METRIC_TYPE_UNSPECIFIED": 0,
		"TYPE_INTEGER":            1,
		"TYPE_FLOAT":              2,
		"TYPE_SECONDS":            4,
		"TYPE_MILLISECONDS":       5,
		"TYPE_MINUTES":            6,
		"TYPE_HOURS":              7,
		"TYPE_STANDARD":           8,
		"TYPE_CURRENCY":           9,
		"TYPE_FEET":               10,
		"TYPE_MILES":              11,
		"TYPE_METERS":             12,
		"TYPE_KILOMETERS":         13,
	}
)

Enum value maps for MetricType.

View Source
var (
	StringFilter_MatchType_name = map[int32]string{
		0: "MATCH_TYPE_UNSPECIFIED",
		1: "EXACT",
		2: "BEGINS_WITH",
		3: "ENDS_WITH",
		4: "CONTAINS",
		5: "FULL_REGEXP",
		6: "PARTIAL_REGEXP",
	}
	StringFilter_MatchType_value = map[string]int32{
		"MATCH_TYPE_UNSPECIFIED": 0,
		"EXACT":                  1,
		"BEGINS_WITH":            2,
		"ENDS_WITH":              3,
		"CONTAINS":               4,
		"FULL_REGEXP":            5,
		"PARTIAL_REGEXP":         6,
	}
)

Enum value maps for StringFilter_MatchType.

View Source
var (
	NumericFilter_Operation_name = map[int32]string{
		0: "OPERATION_UNSPECIFIED",
		1: "EQUAL",
		2: "LESS_THAN",
		3: "LESS_THAN_OR_EQUAL",
		4: "GREATER_THAN",
		5: "GREATER_THAN_OR_EQUAL",
	}
	NumericFilter_Operation_value = map[string]int32{
		"OPERATION_UNSPECIFIED": 0,
		"EQUAL":                 1,
		"LESS_THAN":             2,
		"LESS_THAN_OR_EQUAL":    3,
		"GREATER_THAN":          4,
		"GREATER_THAN_OR_EQUAL": 5,
	}
)

Enum value maps for NumericFilter_Operation.

View Source
var File_google_analytics_data_v1alpha_analytics_data_api_proto protoreflect.FileDescriptor
View Source
var File_google_analytics_data_v1alpha_data_proto protoreflect.FileDescriptor

Functions

func RegisterAlphaAnalyticsDataServer

func RegisterAlphaAnalyticsDataServer(s *grpc.Server, srv AlphaAnalyticsDataServer)

Types

type AlphaAnalyticsDataClient

type AlphaAnalyticsDataClient interface {
	// Returns a customized funnel report of your Google Analytics event data. The
	// data returned from the API is as a table with columns for the requested
	// dimensions and metrics.
	//
	// 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. To learn more, see [GA4
	// Funnel Explorations](https://support.google.com/analytics/answer/9327974).
	RunFunnelReport(ctx context.Context, in *RunFunnelReportRequest, opts ...grpc.CallOption) (*RunFunnelReportResponse, error)
}

AlphaAnalyticsDataClient is the client API for AlphaAnalyticsData service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type AlphaAnalyticsDataServer

type AlphaAnalyticsDataServer interface {
	// Returns a customized funnel report of your Google Analytics event data. The
	// data returned from the API is as a table with columns for the requested
	// dimensions and metrics.
	//
	// 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. To learn more, see [GA4
	// Funnel Explorations](https://support.google.com/analytics/answer/9327974).
	RunFunnelReport(context.Context, *RunFunnelReportRequest) (*RunFunnelReportResponse, error)
}

AlphaAnalyticsDataServer is the server API for AlphaAnalyticsData service.

type BetweenFilter

type BetweenFilter struct {

	// Begins with this number.
	FromValue *NumericValue `protobuf:"bytes,1,opt,name=from_value,json=fromValue,proto3" json:"from_value,omitempty"`
	// Ends with this number.
	ToValue *NumericValue `protobuf:"bytes,2,opt,name=to_value,json=toValue,proto3" json:"to_value,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BetweenFilter) Descriptor deprecated

func (*BetweenFilter) Descriptor() ([]byte, []int)

Deprecated: Use BetweenFilter.ProtoReflect.Descriptor instead.

func (*BetweenFilter) GetFromValue

func (x *BetweenFilter) GetFromValue() *NumericValue

func (*BetweenFilter) GetToValue

func (x *BetweenFilter) GetToValue() *NumericValue

func (*BetweenFilter) ProtoMessage

func (*BetweenFilter) ProtoMessage()

func (*BetweenFilter) ProtoReflect

func (x *BetweenFilter) ProtoReflect() protoreflect.Message

func (*BetweenFilter) Reset

func (x *BetweenFilter) Reset()

func (*BetweenFilter) String

func (x *BetweenFilter) String() string

type DateRange

type DateRange struct {

	// The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
	// be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
	// accepted, and in that case, the date is inferred based on the property's
	// reporting time zone.
	StartDate string `protobuf:"bytes,1,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot
	// be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is
	// also accepted, and in that case, the date is inferred based on the
	// property's reporting time zone.
	EndDate string `protobuf:"bytes,2,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// Assigns a name to this date range. The dimension `dateRange` is valued to
	// this name in a report response. If set, cannot begin with `date_range_` or
	// `RESERVED_`. If not set, date ranges are named by their zero based index in
	// the request: `date_range_0`, `date_range_1`, etc.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*DateRange) Descriptor deprecated

func (*DateRange) Descriptor() ([]byte, []int)

Deprecated: Use DateRange.ProtoReflect.Descriptor instead.

func (*DateRange) GetEndDate

func (x *DateRange) GetEndDate() string

func (*DateRange) GetName

func (x *DateRange) GetName() string

func (*DateRange) GetStartDate

func (x *DateRange) GetStartDate() string

func (*DateRange) ProtoMessage

func (*DateRange) ProtoMessage()

func (*DateRange) ProtoReflect

func (x *DateRange) ProtoReflect() protoreflect.Message

func (*DateRange) Reset

func (x *DateRange) Reset()

func (*DateRange) String

func (x *DateRange) String() string

type Dimension

type Dimension struct {

	// The name of the dimension. See the [API
	// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
	// for the list of dimension names.
	//
	// If `dimensionExpression` is specified, `name` can be any string that you
	// would like within the allowed character set. For example if a
	// `dimensionExpression` concatenates `country` and `city`, you could call
	// that dimension `countryAndCity`. Dimension names that you choose must match
	// the regular expression `^[a-zA-Z0-9_]$`.
	//
	// Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
	// `dimensionExpression`, and `pivots`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// One dimension can be the result of an expression of multiple dimensions.
	// For example, dimension "country, city": concatenate(country, ", ", city).
	DimensionExpression *DimensionExpression `protobuf:"bytes,2,opt,name=dimension_expression,json=dimensionExpression,proto3" json:"dimension_expression,omitempty"`
	// contains filtered or unexported fields
}

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".

func (*Dimension) Descriptor deprecated

func (*Dimension) Descriptor() ([]byte, []int)

Deprecated: Use Dimension.ProtoReflect.Descriptor instead.

func (*Dimension) GetDimensionExpression

func (x *Dimension) GetDimensionExpression() *DimensionExpression

func (*Dimension) GetName

func (x *Dimension) GetName() string

func (*Dimension) ProtoMessage

func (*Dimension) ProtoMessage()

func (*Dimension) ProtoReflect

func (x *Dimension) ProtoReflect() protoreflect.Message

func (*Dimension) Reset

func (x *Dimension) Reset()

func (*Dimension) String

func (x *Dimension) String() string

type DimensionExpression

type DimensionExpression struct {

	// Specify one type of dimension expression for `DimensionExpression`.
	//
	// Types that are assignable to OneExpression:
	//	*DimensionExpression_LowerCase
	//	*DimensionExpression_UpperCase
	//	*DimensionExpression_Concatenate
	OneExpression isDimensionExpression_OneExpression `protobuf_oneof:"one_expression"`
	// contains filtered or unexported fields
}

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).

func (*DimensionExpression) Descriptor deprecated

func (*DimensionExpression) Descriptor() ([]byte, []int)

Deprecated: Use DimensionExpression.ProtoReflect.Descriptor instead.

func (*DimensionExpression) GetConcatenate

func (*DimensionExpression) GetLowerCase

func (*DimensionExpression) GetOneExpression

func (m *DimensionExpression) GetOneExpression() isDimensionExpression_OneExpression

func (*DimensionExpression) GetUpperCase

func (*DimensionExpression) ProtoMessage

func (*DimensionExpression) ProtoMessage()

func (*DimensionExpression) ProtoReflect

func (x *DimensionExpression) ProtoReflect() protoreflect.Message

func (*DimensionExpression) Reset

func (x *DimensionExpression) Reset()

func (*DimensionExpression) String

func (x *DimensionExpression) String() string

type DimensionExpression_CaseExpression

type DimensionExpression_CaseExpression struct {

	// Name of a dimension. The name must refer back to a name in dimensions
	// field of the request.
	DimensionName string `protobuf:"bytes,1,opt,name=dimension_name,json=dimensionName,proto3" json:"dimension_name,omitempty"`
	// contains filtered or unexported fields
}

Used to convert a dimension value to a single case.

func (*DimensionExpression_CaseExpression) Descriptor deprecated

func (*DimensionExpression_CaseExpression) Descriptor() ([]byte, []int)

Deprecated: Use DimensionExpression_CaseExpression.ProtoReflect.Descriptor instead.

func (*DimensionExpression_CaseExpression) GetDimensionName

func (x *DimensionExpression_CaseExpression) GetDimensionName() string

func (*DimensionExpression_CaseExpression) ProtoMessage

func (*DimensionExpression_CaseExpression) ProtoMessage()

func (*DimensionExpression_CaseExpression) ProtoReflect

func (*DimensionExpression_CaseExpression) Reset

func (*DimensionExpression_CaseExpression) String

type DimensionExpression_Concatenate

type DimensionExpression_Concatenate struct {
	// Used to combine dimension values to a single dimension.
	// For example, dimension "country, city": concatenate(country, ", ", city).
	Concatenate *DimensionExpression_ConcatenateExpression `protobuf:"bytes,6,opt,name=concatenate,proto3,oneof"`
}

type DimensionExpression_ConcatenateExpression

type DimensionExpression_ConcatenateExpression struct {

	// Names of dimensions. The names must refer back to names in the dimensions
	// field of the request.
	DimensionNames []string `protobuf:"bytes,1,rep,name=dimension_names,json=dimensionNames,proto3" json:"dimension_names,omitempty"`
	// The delimiter placed between dimension names.
	//
	// Delimiters are often single characters such as "|" or "," but can be
	// longer strings. If a dimension value contains the delimiter, both will be
	// present in response with no distinction. For example if dimension 1 value
	// = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the
	// response will contain "US,FR,JP".
	Delimiter string `protobuf:"bytes,2,opt,name=delimiter,proto3" json:"delimiter,omitempty"`
	// contains filtered or unexported fields
}

Used to combine dimension values to a single dimension.

func (*DimensionExpression_ConcatenateExpression) Descriptor deprecated

func (*DimensionExpression_ConcatenateExpression) Descriptor() ([]byte, []int)

Deprecated: Use DimensionExpression_ConcatenateExpression.ProtoReflect.Descriptor instead.

func (*DimensionExpression_ConcatenateExpression) GetDelimiter

func (*DimensionExpression_ConcatenateExpression) GetDimensionNames

func (x *DimensionExpression_ConcatenateExpression) GetDimensionNames() []string

func (*DimensionExpression_ConcatenateExpression) ProtoMessage

func (*DimensionExpression_ConcatenateExpression) ProtoReflect

func (*DimensionExpression_ConcatenateExpression) Reset

func (*DimensionExpression_ConcatenateExpression) String

type DimensionExpression_LowerCase

type DimensionExpression_LowerCase struct {
	// Used to convert a dimension value to lower case.
	LowerCase *DimensionExpression_CaseExpression `protobuf:"bytes,4,opt,name=lower_case,json=lowerCase,proto3,oneof"`
}

type DimensionExpression_UpperCase

type DimensionExpression_UpperCase struct {
	// Used to convert a dimension value to upper case.
	UpperCase *DimensionExpression_CaseExpression `protobuf:"bytes,5,opt,name=upper_case,json=upperCase,proto3,oneof"`
}

type DimensionHeader

type DimensionHeader struct {

	// The dimension's name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*DimensionHeader) Descriptor deprecated

func (*DimensionHeader) Descriptor() ([]byte, []int)

Deprecated: Use DimensionHeader.ProtoReflect.Descriptor instead.

func (*DimensionHeader) GetName

func (x *DimensionHeader) GetName() string

func (*DimensionHeader) ProtoMessage

func (*DimensionHeader) ProtoMessage()

func (*DimensionHeader) ProtoReflect

func (x *DimensionHeader) ProtoReflect() protoreflect.Message

func (*DimensionHeader) Reset

func (x *DimensionHeader) Reset()

func (*DimensionHeader) String

func (x *DimensionHeader) String() string

type DimensionValue

type DimensionValue struct {

	// One kind of dimension value
	//
	// Types that are assignable to OneValue:
	//	*DimensionValue_Value
	OneValue isDimensionValue_OneValue `protobuf_oneof:"one_value"`
	// contains filtered or unexported fields
}

The value of a dimension.

func (*DimensionValue) Descriptor deprecated

func (*DimensionValue) Descriptor() ([]byte, []int)

Deprecated: Use DimensionValue.ProtoReflect.Descriptor instead.

func (*DimensionValue) GetOneValue

func (m *DimensionValue) GetOneValue() isDimensionValue_OneValue

func (*DimensionValue) GetValue

func (x *DimensionValue) GetValue() string

func (*DimensionValue) ProtoMessage

func (*DimensionValue) ProtoMessage()

func (*DimensionValue) ProtoReflect

func (x *DimensionValue) ProtoReflect() protoreflect.Message

func (*DimensionValue) Reset

func (x *DimensionValue) Reset()

func (*DimensionValue) String

func (x *DimensionValue) String() string

type DimensionValue_Value

type DimensionValue_Value struct {
	// Value as a string if the dimension type is a string.
	Value string `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}

type EventCriteriaScoping

type EventCriteriaScoping int32

Scoping specifies which events are considered when evaluating if an event meets a criteria.

const (
	// Unspecified criteria scoping. Do not specify.
	EventCriteriaScoping_EVENT_CRITERIA_SCOPING_UNSPECIFIED EventCriteriaScoping = 0
	// If the criteria is satisfied within one event, the event matches the
	// criteria.
	EventCriteriaScoping_EVENT_CRITERIA_WITHIN_SAME_EVENT EventCriteriaScoping = 1
)

func (EventCriteriaScoping) Descriptor

func (EventCriteriaScoping) Enum

func (EventCriteriaScoping) EnumDescriptor deprecated

func (EventCriteriaScoping) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventCriteriaScoping.Descriptor instead.

func (EventCriteriaScoping) Number

func (EventCriteriaScoping) String

func (x EventCriteriaScoping) String() string

func (EventCriteriaScoping) Type

type EventExclusionDuration

type EventExclusionDuration int32

Enumerates options for how long an exclusion will last if an event matches the `eventExclusionCriteria`.

const (
	// Unspecified exclusion duration. Do not specify.
	EventExclusionDuration_EVENT_EXCLUSION_DURATION_UNSPECIFIED EventExclusionDuration = 0
	// Permanently exclude events from the segment if the event ever meets
	// the `eventExclusionCriteria` condition.
	EventExclusionDuration_EVENT_EXCLUSION_PERMANENT EventExclusionDuration = 1
)

func (EventExclusionDuration) Descriptor

func (EventExclusionDuration) Enum

func (EventExclusionDuration) EnumDescriptor deprecated

func (EventExclusionDuration) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventExclusionDuration.Descriptor instead.

func (EventExclusionDuration) Number

func (EventExclusionDuration) String

func (x EventExclusionDuration) String() string

func (EventExclusionDuration) Type

type EventSegment

type EventSegment struct {

	// Defines which events are included in this segment. Optional.
	EventInclusionCriteria *EventSegmentCriteria `` /* 129-byte string literal not displayed */
	// Defines which events are excluded in this segment. Optional.
	Exclusion *EventSegmentExclusion `protobuf:"bytes,2,opt,name=exclusion,proto3" json:"exclusion,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*EventSegment) Descriptor deprecated

func (*EventSegment) Descriptor() ([]byte, []int)

Deprecated: Use EventSegment.ProtoReflect.Descriptor instead.

func (*EventSegment) GetEventInclusionCriteria

func (x *EventSegment) GetEventInclusionCriteria() *EventSegmentCriteria

func (*EventSegment) GetExclusion

func (x *EventSegment) GetExclusion() *EventSegmentExclusion

func (*EventSegment) ProtoMessage

func (*EventSegment) ProtoMessage()

func (*EventSegment) ProtoReflect

func (x *EventSegment) ProtoReflect() protoreflect.Message

func (*EventSegment) Reset

func (x *EventSegment) Reset()

func (*EventSegment) String

func (x *EventSegment) String() string

type EventSegmentConditionGroup

type EventSegmentConditionGroup struct {

	// `conditionScoping` should always be `EVENT_CRITERIA_WITHIN_SAME_EVENT`.
	//
	// Optional. If unspecified, a `conditionScoping` of
	// `EVENT_CRITERIA_WITHIN_SAME_EVENT` is used.
	ConditionScoping EventCriteriaScoping `` /* 166-byte string literal not displayed */
	// Data is included or excluded from the segment based on if it matches
	// this expression. Expressions express criteria on dimension, metrics,
	// and/or parameters.
	SegmentFilterExpression *SegmentFilterExpression `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*EventSegmentConditionGroup) Descriptor deprecated

func (*EventSegmentConditionGroup) Descriptor() ([]byte, []int)

Deprecated: Use EventSegmentConditionGroup.ProtoReflect.Descriptor instead.

func (*EventSegmentConditionGroup) GetConditionScoping

func (x *EventSegmentConditionGroup) GetConditionScoping() EventCriteriaScoping

func (*EventSegmentConditionGroup) GetSegmentFilterExpression

func (x *EventSegmentConditionGroup) GetSegmentFilterExpression() *SegmentFilterExpression

func (*EventSegmentConditionGroup) ProtoMessage

func (*EventSegmentConditionGroup) ProtoMessage()

func (*EventSegmentConditionGroup) ProtoReflect

func (*EventSegmentConditionGroup) Reset

func (x *EventSegmentConditionGroup) Reset()

func (*EventSegmentConditionGroup) String

func (x *EventSegmentConditionGroup) String() string

type EventSegmentCriteria

type EventSegmentCriteria struct {

	// An event matches this criteria if the event matches each of these
	// `andConditionGroups`.
	AndConditionGroups []*EventSegmentConditionGroup `protobuf:"bytes,1,rep,name=and_condition_groups,json=andConditionGroups,proto3" json:"and_condition_groups,omitempty"`
	// contains filtered or unexported fields
}

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

func (*EventSegmentCriteria) Descriptor deprecated

func (*EventSegmentCriteria) Descriptor() ([]byte, []int)

Deprecated: Use EventSegmentCriteria.ProtoReflect.Descriptor instead.

func (*EventSegmentCriteria) GetAndConditionGroups

func (x *EventSegmentCriteria) GetAndConditionGroups() []*EventSegmentConditionGroup

func (*EventSegmentCriteria) ProtoMessage

func (*EventSegmentCriteria) ProtoMessage()

func (*EventSegmentCriteria) ProtoReflect

func (x *EventSegmentCriteria) ProtoReflect() protoreflect.Message

func (*EventSegmentCriteria) Reset

func (x *EventSegmentCriteria) Reset()

func (*EventSegmentCriteria) String

func (x *EventSegmentCriteria) String() string

type EventSegmentExclusion

type EventSegmentExclusion struct {

	// `eventExclusionDuration` should always be `PERMANENTLY_EXCLUDE`.
	//
	// Optional. If unspecified, an `eventExclusionDuration` of
	// `EVENT_EXCLUSION_PERMANENT` is used.
	EventExclusionDuration EventExclusionDuration `` /* 188-byte string literal not displayed */
	// If an event meets this condition, the event is excluded from membership
	// in the segment for the `eventExclusionDuration`.
	EventExclusionCriteria *EventSegmentCriteria `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies which events are excluded in this segment.

func (*EventSegmentExclusion) Descriptor deprecated

func (*EventSegmentExclusion) Descriptor() ([]byte, []int)

Deprecated: Use EventSegmentExclusion.ProtoReflect.Descriptor instead.

func (*EventSegmentExclusion) GetEventExclusionCriteria

func (x *EventSegmentExclusion) GetEventExclusionCriteria() *EventSegmentCriteria

func (*EventSegmentExclusion) GetEventExclusionDuration

func (x *EventSegmentExclusion) GetEventExclusionDuration() EventExclusionDuration

func (*EventSegmentExclusion) ProtoMessage

func (*EventSegmentExclusion) ProtoMessage()

func (*EventSegmentExclusion) ProtoReflect

func (x *EventSegmentExclusion) ProtoReflect() protoreflect.Message

func (*EventSegmentExclusion) Reset

func (x *EventSegmentExclusion) Reset()

func (*EventSegmentExclusion) String

func (x *EventSegmentExclusion) String() string

type Filter

type Filter struct {

	// The dimension name or metric name. Must be a name defined in dimensions
	// or metrics.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// Specify one type of filter for `Filter`.
	//
	// Types that are assignable to OneFilter:
	//	*Filter_StringFilter
	//	*Filter_InListFilter
	//	*Filter_NumericFilter
	//	*Filter_BetweenFilter
	OneFilter isFilter_OneFilter `protobuf_oneof:"one_filter"`
	// contains filtered or unexported fields
}

An expression to filter dimension or metric values.

func (*Filter) Descriptor deprecated

func (*Filter) Descriptor() ([]byte, []int)

Deprecated: Use Filter.ProtoReflect.Descriptor instead.

func (*Filter) GetBetweenFilter

func (x *Filter) GetBetweenFilter() *BetweenFilter

func (*Filter) GetFieldName

func (x *Filter) GetFieldName() string

func (*Filter) GetInListFilter

func (x *Filter) GetInListFilter() *InListFilter

func (*Filter) GetNumericFilter

func (x *Filter) GetNumericFilter() *NumericFilter

func (*Filter) GetOneFilter

func (m *Filter) GetOneFilter() isFilter_OneFilter

func (*Filter) GetStringFilter

func (x *Filter) GetStringFilter() *StringFilter

func (*Filter) ProtoMessage

func (*Filter) ProtoMessage()

func (*Filter) ProtoReflect

func (x *Filter) ProtoReflect() protoreflect.Message

func (*Filter) Reset

func (x *Filter) Reset()

func (*Filter) String

func (x *Filter) String() string

type FilterExpression

type FilterExpression struct {

	// Specify one type of filter expression for `FilterExpression`.
	//
	// Types that are assignable to Expr:
	//	*FilterExpression_AndGroup
	//	*FilterExpression_OrGroup
	//	*FilterExpression_NotExpression
	//	*FilterExpression_Filter
	Expr isFilterExpression_Expr `protobuf_oneof:"expr"`
	// contains filtered or unexported fields
}

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

func (*FilterExpression) Descriptor deprecated

func (*FilterExpression) Descriptor() ([]byte, []int)

Deprecated: Use FilterExpression.ProtoReflect.Descriptor instead.

func (*FilterExpression) GetAndGroup

func (x *FilterExpression) GetAndGroup() *FilterExpressionList

func (*FilterExpression) GetExpr

func (m *FilterExpression) GetExpr() isFilterExpression_Expr

func (*FilterExpression) GetFilter

func (x *FilterExpression) GetFilter() *Filter

func (*FilterExpression) GetNotExpression

func (x *FilterExpression) GetNotExpression() *FilterExpression

func (*FilterExpression) GetOrGroup

func (x *FilterExpression) GetOrGroup() *FilterExpressionList

func (*FilterExpression) ProtoMessage

func (*FilterExpression) ProtoMessage()

func (*FilterExpression) ProtoReflect

func (x *FilterExpression) ProtoReflect() protoreflect.Message

func (*FilterExpression) Reset

func (x *FilterExpression) Reset()

func (*FilterExpression) String

func (x *FilterExpression) String() string

type FilterExpressionList

type FilterExpressionList struct {

	// A list of filter expressions.
	Expressions []*FilterExpression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// contains filtered or unexported fields
}

A list of filter expressions.

func (*FilterExpressionList) Descriptor deprecated

func (*FilterExpressionList) Descriptor() ([]byte, []int)

Deprecated: Use FilterExpressionList.ProtoReflect.Descriptor instead.

func (*FilterExpressionList) GetExpressions

func (x *FilterExpressionList) GetExpressions() []*FilterExpression

func (*FilterExpressionList) ProtoMessage

func (*FilterExpressionList) ProtoMessage()

func (*FilterExpressionList) ProtoReflect

func (x *FilterExpressionList) ProtoReflect() protoreflect.Message

func (*FilterExpressionList) Reset

func (x *FilterExpressionList) Reset()

func (*FilterExpressionList) String

func (x *FilterExpressionList) String() string

type FilterExpression_AndGroup

type FilterExpression_AndGroup struct {
	// The FilterExpressions in and_group have an AND relationship.
	AndGroup *FilterExpressionList `protobuf:"bytes,1,opt,name=and_group,json=andGroup,proto3,oneof"`
}

type FilterExpression_Filter

type FilterExpression_Filter struct {
	// A primitive filter. In the same FilterExpression, all of the filter's
	// field names need to be either all dimensions or all metrics.
	Filter *Filter `protobuf:"bytes,4,opt,name=filter,proto3,oneof"`
}

type FilterExpression_NotExpression

type FilterExpression_NotExpression struct {
	// The FilterExpression is NOT of not_expression.
	NotExpression *FilterExpression `protobuf:"bytes,3,opt,name=not_expression,json=notExpression,proto3,oneof"`
}

type FilterExpression_OrGroup

type FilterExpression_OrGroup struct {
	// The FilterExpressions in or_group have an OR relationship.
	OrGroup *FilterExpressionList `protobuf:"bytes,2,opt,name=or_group,json=orGroup,proto3,oneof"`
}

type Filter_BetweenFilter

type Filter_BetweenFilter struct {
	// A filter for between two values.
	BetweenFilter *BetweenFilter `protobuf:"bytes,5,opt,name=between_filter,json=betweenFilter,proto3,oneof"`
}

type Filter_InListFilter

type Filter_InListFilter struct {
	// A filter for in list values.
	InListFilter *InListFilter `protobuf:"bytes,3,opt,name=in_list_filter,json=inListFilter,proto3,oneof"`
}

type Filter_NumericFilter

type Filter_NumericFilter struct {
	// A filter for numeric or date values.
	NumericFilter *NumericFilter `protobuf:"bytes,4,opt,name=numeric_filter,json=numericFilter,proto3,oneof"`
}

type Filter_StringFilter

type Filter_StringFilter struct {
	// Strings related filter.
	StringFilter *StringFilter `protobuf:"bytes,2,opt,name=string_filter,json=stringFilter,proto3,oneof"`
}

type Funnel

type Funnel struct {

	// In an open funnel, users can enter the funnel in any step, and in a closed
	// funnel, users must enter the funnel in the first step. Optional. If
	// unspecified, a closed funnel is used.
	IsOpenFunnel bool `protobuf:"varint,1,opt,name=is_open_funnel,json=isOpenFunnel,proto3" json:"is_open_funnel,omitempty"`
	// The sequential steps of this funnel.
	Steps []*FunnelStep `protobuf:"bytes,2,rep,name=steps,proto3" json:"steps,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Funnel) Descriptor deprecated

func (*Funnel) Descriptor() ([]byte, []int)

Deprecated: Use Funnel.ProtoReflect.Descriptor instead.

func (*Funnel) GetIsOpenFunnel

func (x *Funnel) GetIsOpenFunnel() bool

func (*Funnel) GetSteps

func (x *Funnel) GetSteps() []*FunnelStep

func (*Funnel) ProtoMessage

func (*Funnel) ProtoMessage()

func (*Funnel) ProtoReflect

func (x *Funnel) ProtoReflect() protoreflect.Message

func (*Funnel) Reset

func (x *Funnel) Reset()

func (*Funnel) String

func (x *Funnel) String() string

type FunnelBreakdown

type FunnelBreakdown struct {

	// The dimension column added to the funnel table sub report response. The
	// breakdown dimension breaks down each funnel step. A valid
	// `breakdownDimension` is required if `funnelBreakdown` is specified.
	BreakdownDimension *Dimension `protobuf:"bytes,1,opt,name=breakdown_dimension,json=breakdownDimension,proto3" json:"breakdown_dimension,omitempty"`
	// The maximum number of distinct values of the breakdown dimension to return
	// in the response. A `limit` of `5` is used if limit is not specified. Limit
	// must exceed zero and cannot exceed 15.
	Limit *int64 `protobuf:"varint,2,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

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

func (*FunnelBreakdown) Descriptor deprecated

func (*FunnelBreakdown) Descriptor() ([]byte, []int)

Deprecated: Use FunnelBreakdown.ProtoReflect.Descriptor instead.

func (*FunnelBreakdown) GetBreakdownDimension

func (x *FunnelBreakdown) GetBreakdownDimension() *Dimension

func (*FunnelBreakdown) GetLimit

func (x *FunnelBreakdown) GetLimit() int64

func (*FunnelBreakdown) ProtoMessage

func (*FunnelBreakdown) ProtoMessage()

func (*FunnelBreakdown) ProtoReflect

func (x *FunnelBreakdown) ProtoReflect() protoreflect.Message

func (*FunnelBreakdown) Reset

func (x *FunnelBreakdown) Reset()

func (*FunnelBreakdown) String

func (x *FunnelBreakdown) String() string

type FunnelEventFilter

type FunnelEventFilter struct {

	// This filter matches events of this single event name. Event name is
	// required.
	EventName *string `protobuf:"bytes,1,opt,name=event_name,json=eventName,proto3,oneof" json:"event_name,omitempty"`
	// If specified, this filter matches events that match both the single event
	// name and the parameter filter expressions.
	//
	// Inside the parameter filter expression, only parameter filters are
	// available.
	FunnelParameterFilterExpression *FunnelParameterFilterExpression `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*FunnelEventFilter) Descriptor deprecated

func (*FunnelEventFilter) Descriptor() ([]byte, []int)

Deprecated: Use FunnelEventFilter.ProtoReflect.Descriptor instead.

func (*FunnelEventFilter) GetEventName

func (x *FunnelEventFilter) GetEventName() string

func (*FunnelEventFilter) GetFunnelParameterFilterExpression

func (x *FunnelEventFilter) GetFunnelParameterFilterExpression() *FunnelParameterFilterExpression

func (*FunnelEventFilter) ProtoMessage

func (*FunnelEventFilter) ProtoMessage()

func (*FunnelEventFilter) ProtoReflect

func (x *FunnelEventFilter) ProtoReflect() protoreflect.Message

func (*FunnelEventFilter) Reset

func (x *FunnelEventFilter) Reset()

func (*FunnelEventFilter) String

func (x *FunnelEventFilter) String() string

type FunnelFieldFilter

type FunnelFieldFilter struct {

	// The dimension name or metric name.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// Specify one type of filter.
	//
	// Types that are assignable to OneFilter:
	//	*FunnelFieldFilter_StringFilter
	//	*FunnelFieldFilter_InListFilter
	//	*FunnelFieldFilter_NumericFilter
	//	*FunnelFieldFilter_BetweenFilter
	OneFilter isFunnelFieldFilter_OneFilter `protobuf_oneof:"one_filter"`
	// contains filtered or unexported fields
}

An expression to filter dimension or metric values.

func (*FunnelFieldFilter) Descriptor deprecated

func (*FunnelFieldFilter) Descriptor() ([]byte, []int)

Deprecated: Use FunnelFieldFilter.ProtoReflect.Descriptor instead.

func (*FunnelFieldFilter) GetBetweenFilter

func (x *FunnelFieldFilter) GetBetweenFilter() *BetweenFilter

func (*FunnelFieldFilter) GetFieldName

func (x *FunnelFieldFilter) GetFieldName() string

func (*FunnelFieldFilter) GetInListFilter

func (x *FunnelFieldFilter) GetInListFilter() *InListFilter

func (*FunnelFieldFilter) GetNumericFilter

func (x *FunnelFieldFilter) GetNumericFilter() *NumericFilter

func (*FunnelFieldFilter) GetOneFilter

func (m *FunnelFieldFilter) GetOneFilter() isFunnelFieldFilter_OneFilter

func (*FunnelFieldFilter) GetStringFilter

func (x *FunnelFieldFilter) GetStringFilter() *StringFilter

func (*FunnelFieldFilter) ProtoMessage

func (*FunnelFieldFilter) ProtoMessage()

func (*FunnelFieldFilter) ProtoReflect

func (x *FunnelFieldFilter) ProtoReflect() protoreflect.Message

func (*FunnelFieldFilter) Reset

func (x *FunnelFieldFilter) Reset()

func (*FunnelFieldFilter) String

func (x *FunnelFieldFilter) String() string

type FunnelFieldFilter_BetweenFilter

type FunnelFieldFilter_BetweenFilter struct {
	// A filter for between two values.
	BetweenFilter *BetweenFilter `protobuf:"bytes,7,opt,name=between_filter,json=betweenFilter,proto3,oneof"`
}

type FunnelFieldFilter_InListFilter

type FunnelFieldFilter_InListFilter struct {
	// A filter for in list values.
	InListFilter *InListFilter `protobuf:"bytes,5,opt,name=in_list_filter,json=inListFilter,proto3,oneof"`
}

type FunnelFieldFilter_NumericFilter

type FunnelFieldFilter_NumericFilter struct {
	// A filter for numeric or date values.
	NumericFilter *NumericFilter `protobuf:"bytes,6,opt,name=numeric_filter,json=numericFilter,proto3,oneof"`
}

type FunnelFieldFilter_StringFilter

type FunnelFieldFilter_StringFilter struct {
	// Strings related filter.
	StringFilter *StringFilter `protobuf:"bytes,4,opt,name=string_filter,json=stringFilter,proto3,oneof"`
}

type FunnelFilterExpression

type FunnelFilterExpression struct {

	// Specify one type of filter for `FunnelFilterExpression`.
	//
	// Types that are assignable to Expr:
	//	*FunnelFilterExpression_AndGroup
	//	*FunnelFilterExpression_OrGroup
	//	*FunnelFilterExpression_NotExpression
	//	*FunnelFilterExpression_FunnelFieldFilter
	//	*FunnelFilterExpression_FunnelEventFilter
	Expr isFunnelFilterExpression_Expr `protobuf_oneof:"expr"`
	// contains filtered or unexported fields
}

Expresses combinations of funnel filters.

func (*FunnelFilterExpression) Descriptor deprecated

func (*FunnelFilterExpression) Descriptor() ([]byte, []int)

Deprecated: Use FunnelFilterExpression.ProtoReflect.Descriptor instead.

func (*FunnelFilterExpression) GetAndGroup

func (*FunnelFilterExpression) GetExpr

func (m *FunnelFilterExpression) GetExpr() isFunnelFilterExpression_Expr

func (*FunnelFilterExpression) GetFunnelEventFilter

func (x *FunnelFilterExpression) GetFunnelEventFilter() *FunnelEventFilter

func (*FunnelFilterExpression) GetFunnelFieldFilter

func (x *FunnelFilterExpression) GetFunnelFieldFilter() *FunnelFieldFilter

func (*FunnelFilterExpression) GetNotExpression

func (x *FunnelFilterExpression) GetNotExpression() *FunnelFilterExpression

func (*FunnelFilterExpression) GetOrGroup

func (*FunnelFilterExpression) ProtoMessage

func (*FunnelFilterExpression) ProtoMessage()

func (*FunnelFilterExpression) ProtoReflect

func (x *FunnelFilterExpression) ProtoReflect() protoreflect.Message

func (*FunnelFilterExpression) Reset

func (x *FunnelFilterExpression) Reset()

func (*FunnelFilterExpression) String

func (x *FunnelFilterExpression) String() string

type FunnelFilterExpressionList

type FunnelFilterExpressionList struct {

	// The list of funnel filter expressions.
	Expressions []*FunnelFilterExpression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// contains filtered or unexported fields
}

A list of funnel filter expressions.

func (*FunnelFilterExpressionList) Descriptor deprecated

func (*FunnelFilterExpressionList) Descriptor() ([]byte, []int)

Deprecated: Use FunnelFilterExpressionList.ProtoReflect.Descriptor instead.

func (*FunnelFilterExpressionList) GetExpressions

func (x *FunnelFilterExpressionList) GetExpressions() []*FunnelFilterExpression

func (*FunnelFilterExpressionList) ProtoMessage

func (*FunnelFilterExpressionList) ProtoMessage()

func (*FunnelFilterExpressionList) ProtoReflect

func (*FunnelFilterExpressionList) Reset

func (x *FunnelFilterExpressionList) Reset()

func (*FunnelFilterExpressionList) String

func (x *FunnelFilterExpressionList) String() string

type FunnelFilterExpression_AndGroup

type FunnelFilterExpression_AndGroup struct {
	// The FunnelFilterExpression in `andGroup` have an AND relationship.
	AndGroup *FunnelFilterExpressionList `protobuf:"bytes,1,opt,name=and_group,json=andGroup,proto3,oneof"`
}

type FunnelFilterExpression_FunnelEventFilter

type FunnelFilterExpression_FunnelEventFilter struct {
	// 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.
	FunnelEventFilter *FunnelEventFilter `protobuf:"bytes,5,opt,name=funnel_event_filter,json=funnelEventFilter,proto3,oneof"`
}

type FunnelFilterExpression_FunnelFieldFilter

type FunnelFilterExpression_FunnelFieldFilter struct {
	// A funnel filter for a dimension or metric.
	FunnelFieldFilter *FunnelFieldFilter `protobuf:"bytes,4,opt,name=funnel_field_filter,json=funnelFieldFilter,proto3,oneof"`
}

type FunnelFilterExpression_NotExpression

type FunnelFilterExpression_NotExpression struct {
	// The FunnelFilterExpression is NOT of `notExpression`.
	NotExpression *FunnelFilterExpression `protobuf:"bytes,3,opt,name=not_expression,json=notExpression,proto3,oneof"`
}

type FunnelFilterExpression_OrGroup

type FunnelFilterExpression_OrGroup struct {
	// The FunnelFilterExpression in `orGroup` have an OR relationship.
	OrGroup *FunnelFilterExpressionList `protobuf:"bytes,2,opt,name=or_group,json=orGroup,proto3,oneof"`
}

type FunnelNextAction

type FunnelNextAction struct {

	// The dimension column added to the funnel visualization sub report response.
	// The next action dimension returns the next dimension value of this
	// dimension after the user has attained the `i`th funnel step.
	//
	// `nextActionDimension` currently only supports `eventName` and most Page /
	// Screen dimensions like `pageTitle` and `pagePath`. `nextActionDimension`
	// cannot be a dimension expression.
	NextActionDimension *Dimension `protobuf:"bytes,1,opt,name=next_action_dimension,json=nextActionDimension,proto3" json:"next_action_dimension,omitempty"`
	// The maximum number of distinct values of the breakdown dimension to return
	// in the response. A `limit` of `5` is used if limit is not specified. Limit
	// must exceed zero and cannot exceed 5.
	Limit *int64 `protobuf:"varint,2,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

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 `i`th funnel step row will return first event after the event that qualified the user into the `i`th funnel step but before the user achieved the `i+1`th funnel step.

func (*FunnelNextAction) Descriptor deprecated

func (*FunnelNextAction) Descriptor() ([]byte, []int)

Deprecated: Use FunnelNextAction.ProtoReflect.Descriptor instead.

func (*FunnelNextAction) GetLimit

func (x *FunnelNextAction) GetLimit() int64

func (*FunnelNextAction) GetNextActionDimension

func (x *FunnelNextAction) GetNextActionDimension() *Dimension

func (*FunnelNextAction) ProtoMessage

func (*FunnelNextAction) ProtoMessage()

func (*FunnelNextAction) ProtoReflect

func (x *FunnelNextAction) ProtoReflect() protoreflect.Message

func (*FunnelNextAction) Reset

func (x *FunnelNextAction) Reset()

func (*FunnelNextAction) String

func (x *FunnelNextAction) String() string

type FunnelParameterFilter

type FunnelParameterFilter struct {

	// The field that is being filtered.
	//
	// Types that are assignable to OneParameter:
	//	*FunnelParameterFilter_EventParameterName
	//	*FunnelParameterFilter_ItemParameterName
	OneParameter isFunnelParameterFilter_OneParameter `protobuf_oneof:"one_parameter"`
	// Specify one type of filter.
	//
	// Types that are assignable to OneFilter:
	//	*FunnelParameterFilter_StringFilter
	//	*FunnelParameterFilter_InListFilter
	//	*FunnelParameterFilter_NumericFilter
	//	*FunnelParameterFilter_BetweenFilter
	OneFilter isFunnelParameterFilter_OneFilter `protobuf_oneof:"one_filter"`
	// contains filtered or unexported fields
}

An expression to filter parameter values in a funnel.

func (*FunnelParameterFilter) Descriptor deprecated

func (*FunnelParameterFilter) Descriptor() ([]byte, []int)

Deprecated: Use FunnelParameterFilter.ProtoReflect.Descriptor instead.

func (*FunnelParameterFilter) GetBetweenFilter

func (x *FunnelParameterFilter) GetBetweenFilter() *BetweenFilter

func (*FunnelParameterFilter) GetEventParameterName

func (x *FunnelParameterFilter) GetEventParameterName() string

func (*FunnelParameterFilter) GetInListFilter

func (x *FunnelParameterFilter) GetInListFilter() *InListFilter

func (*FunnelParameterFilter) GetItemParameterName

func (x *FunnelParameterFilter) GetItemParameterName() string

func (*FunnelParameterFilter) GetNumericFilter

func (x *FunnelParameterFilter) GetNumericFilter() *NumericFilter

func (*FunnelParameterFilter) GetOneFilter

func (m *FunnelParameterFilter) GetOneFilter() isFunnelParameterFilter_OneFilter

func (*FunnelParameterFilter) GetOneParameter

func (m *FunnelParameterFilter) GetOneParameter() isFunnelParameterFilter_OneParameter

func (*FunnelParameterFilter) GetStringFilter

func (x *FunnelParameterFilter) GetStringFilter() *StringFilter

func (*FunnelParameterFilter) ProtoMessage

func (*FunnelParameterFilter) ProtoMessage()

func (*FunnelParameterFilter) ProtoReflect

func (x *FunnelParameterFilter) ProtoReflect() protoreflect.Message

func (*FunnelParameterFilter) Reset

func (x *FunnelParameterFilter) Reset()

func (*FunnelParameterFilter) String

func (x *FunnelParameterFilter) String() string

type FunnelParameterFilterExpression

type FunnelParameterFilterExpression struct {

	// Specify one type of filter for `FunnelParameterFilterExpression`.
	//
	// Types that are assignable to Expr:
	//	*FunnelParameterFilterExpression_AndGroup
	//	*FunnelParameterFilterExpression_OrGroup
	//	*FunnelParameterFilterExpression_NotExpression
	//	*FunnelParameterFilterExpression_FunnelParameterFilter
	Expr isFunnelParameterFilterExpression_Expr `protobuf_oneof:"expr"`
	// contains filtered or unexported fields
}

Expresses combinations of funnel filters on parameters.

func (*FunnelParameterFilterExpression) Descriptor deprecated

func (*FunnelParameterFilterExpression) Descriptor() ([]byte, []int)

Deprecated: Use FunnelParameterFilterExpression.ProtoReflect.Descriptor instead.

func (*FunnelParameterFilterExpression) GetAndGroup

func (*FunnelParameterFilterExpression) GetExpr

func (m *FunnelParameterFilterExpression) GetExpr() isFunnelParameterFilterExpression_Expr

func (*FunnelParameterFilterExpression) GetFunnelParameterFilter

func (x *FunnelParameterFilterExpression) GetFunnelParameterFilter() *FunnelParameterFilter

func (*FunnelParameterFilterExpression) GetNotExpression

func (*FunnelParameterFilterExpression) GetOrGroup

func (*FunnelParameterFilterExpression) ProtoMessage

func (*FunnelParameterFilterExpression) ProtoMessage()

func (*FunnelParameterFilterExpression) ProtoReflect

func (*FunnelParameterFilterExpression) Reset

func (*FunnelParameterFilterExpression) String

type FunnelParameterFilterExpressionList

type FunnelParameterFilterExpressionList struct {

	// The list of funnel parameter filter expressions.
	Expressions []*FunnelParameterFilterExpression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// contains filtered or unexported fields
}

A list of funnel parameter filter expressions.

func (*FunnelParameterFilterExpressionList) Descriptor deprecated

func (*FunnelParameterFilterExpressionList) Descriptor() ([]byte, []int)

Deprecated: Use FunnelParameterFilterExpressionList.ProtoReflect.Descriptor instead.

func (*FunnelParameterFilterExpressionList) GetExpressions

func (*FunnelParameterFilterExpressionList) ProtoMessage

func (*FunnelParameterFilterExpressionList) ProtoMessage()

func (*FunnelParameterFilterExpressionList) ProtoReflect

func (*FunnelParameterFilterExpressionList) Reset

func (*FunnelParameterFilterExpressionList) String

type FunnelParameterFilterExpression_AndGroup

type FunnelParameterFilterExpression_AndGroup struct {
	// The FunnelParameterFilterExpression in `andGroup` have an AND
	// relationship.
	AndGroup *FunnelParameterFilterExpressionList `protobuf:"bytes,1,opt,name=and_group,json=andGroup,proto3,oneof"`
}

type FunnelParameterFilterExpression_FunnelParameterFilter

type FunnelParameterFilterExpression_FunnelParameterFilter struct {
	// A primitive funnel parameter filter.
	FunnelParameterFilter *FunnelParameterFilter `protobuf:"bytes,4,opt,name=funnel_parameter_filter,json=funnelParameterFilter,proto3,oneof"`
}

type FunnelParameterFilterExpression_NotExpression

type FunnelParameterFilterExpression_NotExpression struct {
	// The FunnelParameterFilterExpression is NOT of `notExpression`.
	NotExpression *FunnelParameterFilterExpression `protobuf:"bytes,3,opt,name=not_expression,json=notExpression,proto3,oneof"`
}

type FunnelParameterFilterExpression_OrGroup

type FunnelParameterFilterExpression_OrGroup struct {
	// The FunnelParameterFilterExpression in `orGroup` have an OR
	// relationship.
	OrGroup *FunnelParameterFilterExpressionList `protobuf:"bytes,2,opt,name=or_group,json=orGroup,proto3,oneof"`
}

type FunnelParameterFilter_BetweenFilter

type FunnelParameterFilter_BetweenFilter struct {
	// A filter for between two values.
	BetweenFilter *BetweenFilter `protobuf:"bytes,7,opt,name=between_filter,json=betweenFilter,proto3,oneof"`
}

type FunnelParameterFilter_EventParameterName

type FunnelParameterFilter_EventParameterName struct {
	// This filter will be evaluated on the specified event parameter. Event
	// parameters are logged as parameters of the event. Event parameters
	// include fields like "firebase_screen" & "currency".
	//
	// Event parameters can only be used in segments & funnels and can only be
	// used in a descendent filter from an EventFilter. In a descendent filter
	// from an EventFilter either event or item parameters should be used.
	EventParameterName string `protobuf:"bytes,1,opt,name=event_parameter_name,json=eventParameterName,proto3,oneof"`
}

type FunnelParameterFilter_InListFilter

type FunnelParameterFilter_InListFilter struct {
	// A filter for in list values.
	InListFilter *InListFilter `protobuf:"bytes,5,opt,name=in_list_filter,json=inListFilter,proto3,oneof"`
}

type FunnelParameterFilter_ItemParameterName

type FunnelParameterFilter_ItemParameterName struct {
	// This filter will be evaluated on the specified item parameter. Item
	// parameters are logged as parameters in the item array. Item parameters
	// include fields like "item_name" & "item_category".
	//
	// Item parameters can only be used in segments & funnels and can only be
	// used in a descendent filter from an EventFilter. In a descendent filter
	// from an EventFilter either event or item parameters should be used.
	//
	// Item parameters are only available in ecommerce events. To learn more
	// about ecommerce events, see the [Measure ecommerce]
	// (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)
	// guide.
	ItemParameterName string `protobuf:"bytes,2,opt,name=item_parameter_name,json=itemParameterName,proto3,oneof"`
}

type FunnelParameterFilter_NumericFilter

type FunnelParameterFilter_NumericFilter struct {
	// A filter for numeric or date values.
	NumericFilter *NumericFilter `protobuf:"bytes,6,opt,name=numeric_filter,json=numericFilter,proto3,oneof"`
}

type FunnelParameterFilter_StringFilter

type FunnelParameterFilter_StringFilter struct {
	// Strings related filter.
	StringFilter *StringFilter `protobuf:"bytes,4,opt,name=string_filter,json=stringFilter,proto3,oneof"`
}

type FunnelResponseMetadata

type FunnelResponseMetadata struct {

	// If funnel report results are
	// [sampled](https://support.google.com/analytics/answer/2637192), this
	// describes what percentage of events were used in this funnel report. One
	// `samplingMetadatas` is populated for each date range. Each
	// `samplingMetadatas` corresponds to a date range in order that date ranges
	// were specified in the request.
	//
	// However if the results are not sampled, this field will not be defined.
	SamplingMetadatas []*SamplingMetadata `protobuf:"bytes,1,rep,name=sampling_metadatas,json=samplingMetadatas,proto3" json:"sampling_metadatas,omitempty"`
	// contains filtered or unexported fields
}

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

func (*FunnelResponseMetadata) Descriptor deprecated

func (*FunnelResponseMetadata) Descriptor() ([]byte, []int)

Deprecated: Use FunnelResponseMetadata.ProtoReflect.Descriptor instead.

func (*FunnelResponseMetadata) GetSamplingMetadatas

func (x *FunnelResponseMetadata) GetSamplingMetadatas() []*SamplingMetadata

func (*FunnelResponseMetadata) ProtoMessage

func (*FunnelResponseMetadata) ProtoMessage()

func (*FunnelResponseMetadata) ProtoReflect

func (x *FunnelResponseMetadata) ProtoReflect() protoreflect.Message

func (*FunnelResponseMetadata) Reset

func (x *FunnelResponseMetadata) Reset()

func (*FunnelResponseMetadata) String

func (x *FunnelResponseMetadata) String() string

type FunnelStep

type FunnelStep struct {

	// The distinctive name for this step. If unspecified, steps will be named
	// by a 1 based indexed name (i.e. "0. ", "1. ", etc.). This name defines
	// string value returned by the `funnelStepName` dimension. For example,
	// specifying `name = Purchase` in the request's third funnel step will
	// produce `3. Purchase` in the funnel report response.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If true, this step must directly follow the previous step. If false,
	// there can be events between the previous step and this step. If
	// unspecified, `isDirectlyFollowedBy` is treated as false.
	IsDirectlyFollowedBy bool `` /* 126-byte string literal not displayed */
	// If specified, this step must complete within this duration of the
	// completion of the prior step. `withinDurationFromPriorStep` is inclusive
	// of the endpoint at the microsecond granularity. For example a duration of
	// 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
	// microsecond.
	//
	// `withinDurationFromPriorStep` is optional, and if unspecified, steps may
	// be separated by any time duration.
	WithinDurationFromPriorStep *durationpb.Duration `` /* 154-byte string literal not displayed */
	// The condition that your users must meet to be included in this step of
	// the funnel journey.
	FilterExpression *FunnelFilterExpression `protobuf:"bytes,4,opt,name=filter_expression,json=filterExpression,proto3" json:"filter_expression,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*FunnelStep) Descriptor deprecated

func (*FunnelStep) Descriptor() ([]byte, []int)

Deprecated: Use FunnelStep.ProtoReflect.Descriptor instead.

func (*FunnelStep) GetFilterExpression

func (x *FunnelStep) GetFilterExpression() *FunnelFilterExpression

func (*FunnelStep) GetIsDirectlyFollowedBy

func (x *FunnelStep) GetIsDirectlyFollowedBy() bool

func (*FunnelStep) GetName

func (x *FunnelStep) GetName() string

func (*FunnelStep) GetWithinDurationFromPriorStep

func (x *FunnelStep) GetWithinDurationFromPriorStep() *durationpb.Duration

func (*FunnelStep) ProtoMessage

func (*FunnelStep) ProtoMessage()

func (*FunnelStep) ProtoReflect

func (x *FunnelStep) ProtoReflect() protoreflect.Message

func (*FunnelStep) Reset

func (x *FunnelStep) Reset()

func (*FunnelStep) String

func (x *FunnelStep) String() string

type FunnelSubReport

type FunnelSubReport struct {

	// Describes dimension columns. Funnel reports always include the funnel step
	// dimension in sub report responses. Additional dimensions like breakdowns,
	// dates, and next actions may be present in the response if requested.
	DimensionHeaders []*DimensionHeader `protobuf:"bytes,1,rep,name=dimension_headers,json=dimensionHeaders,proto3" json:"dimension_headers,omitempty"`
	// Describes metric columns. Funnel reports always include active users in sub
	// report responses. The funnel table includes additional metrics like
	// completion rate, abandonments, and abandonments rate.
	MetricHeaders []*MetricHeader `protobuf:"bytes,2,rep,name=metric_headers,json=metricHeaders,proto3" json:"metric_headers,omitempty"`
	// Rows of dimension value combinations and metric values in the report.
	Rows []*Row `protobuf:"bytes,3,rep,name=rows,proto3" json:"rows,omitempty"`
	// Metadata for the funnel report.
	Metadata *FunnelResponseMetadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

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

func (*FunnelSubReport) Descriptor deprecated

func (*FunnelSubReport) Descriptor() ([]byte, []int)

Deprecated: Use FunnelSubReport.ProtoReflect.Descriptor instead.

func (*FunnelSubReport) GetDimensionHeaders

func (x *FunnelSubReport) GetDimensionHeaders() []*DimensionHeader

func (*FunnelSubReport) GetMetadata

func (x *FunnelSubReport) GetMetadata() *FunnelResponseMetadata

func (*FunnelSubReport) GetMetricHeaders

func (x *FunnelSubReport) GetMetricHeaders() []*MetricHeader

func (*FunnelSubReport) GetRows

func (x *FunnelSubReport) GetRows() []*Row

func (*FunnelSubReport) ProtoMessage

func (*FunnelSubReport) ProtoMessage()

func (*FunnelSubReport) ProtoReflect

func (x *FunnelSubReport) ProtoReflect() protoreflect.Message

func (*FunnelSubReport) Reset

func (x *FunnelSubReport) Reset()

func (*FunnelSubReport) String

func (x *FunnelSubReport) String() string

type InListFilter

type InListFilter struct {

	// The list of string values.
	// Must be non-empty.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// If true, the string value is case sensitive.
	CaseSensitive bool `protobuf:"varint,2,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
	// contains filtered or unexported fields
}

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

func (*InListFilter) Descriptor deprecated

func (*InListFilter) Descriptor() ([]byte, []int)

Deprecated: Use InListFilter.ProtoReflect.Descriptor instead.

func (*InListFilter) GetCaseSensitive

func (x *InListFilter) GetCaseSensitive() bool

func (*InListFilter) GetValues

func (x *InListFilter) GetValues() []string

func (*InListFilter) ProtoMessage

func (*InListFilter) ProtoMessage()

func (*InListFilter) ProtoReflect

func (x *InListFilter) ProtoReflect() protoreflect.Message

func (*InListFilter) Reset

func (x *InListFilter) Reset()

func (*InListFilter) String

func (x *InListFilter) String() string

type MetricHeader

type MetricHeader struct {

	// The metric's name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The metric's data type.
	Type MetricType `protobuf:"varint,2,opt,name=type,proto3,enum=google.analytics.data.v1alpha.MetricType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*MetricHeader) Descriptor deprecated

func (*MetricHeader) Descriptor() ([]byte, []int)

Deprecated: Use MetricHeader.ProtoReflect.Descriptor instead.

func (*MetricHeader) GetName

func (x *MetricHeader) GetName() string

func (*MetricHeader) GetType

func (x *MetricHeader) GetType() MetricType

func (*MetricHeader) ProtoMessage

func (*MetricHeader) ProtoMessage()

func (*MetricHeader) ProtoReflect

func (x *MetricHeader) ProtoReflect() protoreflect.Message

func (*MetricHeader) Reset

func (x *MetricHeader) Reset()

func (*MetricHeader) String

func (x *MetricHeader) String() string

type MetricType

type MetricType int32

A metric's value type.

const (
	// Unspecified type.
	MetricType_METRIC_TYPE_UNSPECIFIED MetricType = 0
	// Integer type.
	MetricType_TYPE_INTEGER MetricType = 1
	// Floating point type.
	MetricType_TYPE_FLOAT MetricType = 2
	// A duration of seconds; a special floating point type.
	MetricType_TYPE_SECONDS MetricType = 4
	// A duration in milliseconds; a special floating point type.
	MetricType_TYPE_MILLISECONDS MetricType = 5
	// A duration in minutes; a special floating point type.
	MetricType_TYPE_MINUTES MetricType = 6
	// A duration in hours; a special floating point type.
	MetricType_TYPE_HOURS MetricType = 7
	// A custom metric of standard type; a special floating point type.
	MetricType_TYPE_STANDARD MetricType = 8
	// An amount of money; a special floating point type.
	MetricType_TYPE_CURRENCY MetricType = 9
	// A length in feet; a special floating point type.
	MetricType_TYPE_FEET MetricType = 10
	// A length in miles; a special floating point type.
	MetricType_TYPE_MILES MetricType = 11
	// A length in meters; a special floating point type.
	MetricType_TYPE_METERS MetricType = 12
	// A length in kilometers; a special floating point type.
	MetricType_TYPE_KILOMETERS MetricType = 13
)

func (MetricType) Descriptor

func (MetricType) Descriptor() protoreflect.EnumDescriptor

func (MetricType) Enum

func (x MetricType) Enum() *MetricType

func (MetricType) EnumDescriptor deprecated

func (MetricType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetricType.Descriptor instead.

func (MetricType) Number

func (x MetricType) Number() protoreflect.EnumNumber

func (MetricType) String

func (x MetricType) String() string

func (MetricType) Type

type MetricValue

type MetricValue struct {

	// One of metric value
	//
	// Types that are assignable to OneValue:
	//	*MetricValue_Value
	OneValue isMetricValue_OneValue `protobuf_oneof:"one_value"`
	// contains filtered or unexported fields
}

The value of a metric.

func (*MetricValue) Descriptor deprecated

func (*MetricValue) Descriptor() ([]byte, []int)

Deprecated: Use MetricValue.ProtoReflect.Descriptor instead.

func (*MetricValue) GetOneValue

func (m *MetricValue) GetOneValue() isMetricValue_OneValue

func (*MetricValue) GetValue

func (x *MetricValue) GetValue() string

func (*MetricValue) ProtoMessage

func (*MetricValue) ProtoMessage()

func (*MetricValue) ProtoReflect

func (x *MetricValue) ProtoReflect() protoreflect.Message

func (*MetricValue) Reset

func (x *MetricValue) Reset()

func (*MetricValue) String

func (x *MetricValue) String() string

type MetricValue_Value

type MetricValue_Value struct {
	// Measurement value. See MetricHeader for type.
	Value string `protobuf:"bytes,4,opt,name=value,proto3,oneof"`
}

type NumericFilter

type NumericFilter struct {

	// The operation type for this filter.
	Operation NumericFilter_Operation `` /* 131-byte string literal not displayed */
	// A numeric value or a date value.
	Value *NumericValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Filters for numeric or date values.

func (*NumericFilter) Descriptor deprecated

func (*NumericFilter) Descriptor() ([]byte, []int)

Deprecated: Use NumericFilter.ProtoReflect.Descriptor instead.

func (*NumericFilter) GetOperation

func (x *NumericFilter) GetOperation() NumericFilter_Operation

func (*NumericFilter) GetValue

func (x *NumericFilter) GetValue() *NumericValue

func (*NumericFilter) ProtoMessage

func (*NumericFilter) ProtoMessage()

func (*NumericFilter) ProtoReflect

func (x *NumericFilter) ProtoReflect() protoreflect.Message

func (*NumericFilter) Reset

func (x *NumericFilter) Reset()

func (*NumericFilter) String

func (x *NumericFilter) String() string

type NumericFilter_Operation

type NumericFilter_Operation int32

The operation applied to a numeric filter

const (
	// Unspecified.
	NumericFilter_OPERATION_UNSPECIFIED NumericFilter_Operation = 0
	// Equal
	NumericFilter_EQUAL NumericFilter_Operation = 1
	// Less than
	NumericFilter_LESS_THAN NumericFilter_Operation = 2
	// Less than or equal
	NumericFilter_LESS_THAN_OR_EQUAL NumericFilter_Operation = 3
	// Greater than
	NumericFilter_GREATER_THAN NumericFilter_Operation = 4
	// Greater than or equal
	NumericFilter_GREATER_THAN_OR_EQUAL NumericFilter_Operation = 5
)

func (NumericFilter_Operation) Descriptor

func (NumericFilter_Operation) Enum

func (NumericFilter_Operation) EnumDescriptor deprecated

func (NumericFilter_Operation) EnumDescriptor() ([]byte, []int)

Deprecated: Use NumericFilter_Operation.Descriptor instead.

func (NumericFilter_Operation) Number

func (NumericFilter_Operation) String

func (x NumericFilter_Operation) String() string

func (NumericFilter_Operation) Type

type NumericValue

type NumericValue struct {

	// One of a numeric value
	//
	// Types that are assignable to OneValue:
	//	*NumericValue_Int64Value
	//	*NumericValue_DoubleValue
	OneValue isNumericValue_OneValue `protobuf_oneof:"one_value"`
	// contains filtered or unexported fields
}

To represent a number.

func (*NumericValue) Descriptor deprecated

func (*NumericValue) Descriptor() ([]byte, []int)

Deprecated: Use NumericValue.ProtoReflect.Descriptor instead.

func (*NumericValue) GetDoubleValue

func (x *NumericValue) GetDoubleValue() float64

func (*NumericValue) GetInt64Value

func (x *NumericValue) GetInt64Value() int64

func (*NumericValue) GetOneValue

func (m *NumericValue) GetOneValue() isNumericValue_OneValue

func (*NumericValue) ProtoMessage

func (*NumericValue) ProtoMessage()

func (*NumericValue) ProtoReflect

func (x *NumericValue) ProtoReflect() protoreflect.Message

func (*NumericValue) Reset

func (x *NumericValue) Reset()

func (*NumericValue) String

func (x *NumericValue) String() string

type NumericValue_DoubleValue

type NumericValue_DoubleValue struct {
	// Double value
	DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type NumericValue_Int64Value

type NumericValue_Int64Value struct {
	// Integer value
	Int64Value int64 `protobuf:"varint,1,opt,name=int64_value,json=int64Value,proto3,oneof"`
}

type PropertyQuota

type PropertyQuota struct {

	// Standard Analytics Properties can use up to 25,000 tokens per day;
	// Analytics 360 Properties can use 250,000 tokens per day. Most requests
	// consume fewer than 10 tokens.
	TokensPerDay *QuotaStatus `protobuf:"bytes,1,opt,name=tokens_per_day,json=tokensPerDay,proto3" json:"tokens_per_day,omitempty"`
	// Standard Analytics Properties can use up to 5,000 tokens per hour;
	// Analytics 360 Properties can use 50,000 tokens per hour. An API request
	// consumes a single number of tokens, and that number is deducted from both
	// the hourly and daily quotas.
	TokensPerHour *QuotaStatus `protobuf:"bytes,2,opt,name=tokens_per_hour,json=tokensPerHour,proto3" json:"tokens_per_hour,omitempty"`
	// Standard Analytics Properties can send up to 10 concurrent requests;
	// Analytics 360 Properties can use up to 50 concurrent requests.
	ConcurrentRequests *QuotaStatus `protobuf:"bytes,3,opt,name=concurrent_requests,json=concurrentRequests,proto3" json:"concurrent_requests,omitempty"`
	// Standard Analytics Properties and cloud project pairs can have up to 10
	// server errors per hour; Analytics 360 Properties and cloud project pairs
	// can have up to 50 server errors per hour.
	ServerErrorsPerProjectPerHour *QuotaStatus `` /* 156-byte string literal not displayed */
	// Analytics Properties can send up to 120 requests with potentially
	// thresholded dimensions per hour. In a batch request, each report request
	// is individually counted for this quota if the request contains potentially
	// thresholded dimensions.
	PotentiallyThresholdedRequestsPerHour *QuotaStatus `` /* 178-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*PropertyQuota) Descriptor deprecated

func (*PropertyQuota) Descriptor() ([]byte, []int)

Deprecated: Use PropertyQuota.ProtoReflect.Descriptor instead.

func (*PropertyQuota) GetConcurrentRequests

func (x *PropertyQuota) GetConcurrentRequests() *QuotaStatus

func (*PropertyQuota) GetPotentiallyThresholdedRequestsPerHour

func (x *PropertyQuota) GetPotentiallyThresholdedRequestsPerHour() *QuotaStatus

func (*PropertyQuota) GetServerErrorsPerProjectPerHour

func (x *PropertyQuota) GetServerErrorsPerProjectPerHour() *QuotaStatus

func (*PropertyQuota) GetTokensPerDay

func (x *PropertyQuota) GetTokensPerDay() *QuotaStatus

func (*PropertyQuota) GetTokensPerHour

func (x *PropertyQuota) GetTokensPerHour() *QuotaStatus

func (*PropertyQuota) ProtoMessage

func (*PropertyQuota) ProtoMessage()

func (*PropertyQuota) ProtoReflect

func (x *PropertyQuota) ProtoReflect() protoreflect.Message

func (*PropertyQuota) Reset

func (x *PropertyQuota) Reset()

func (*PropertyQuota) String

func (x *PropertyQuota) String() string

type QuotaStatus

type QuotaStatus struct {

	// Quota consumed by this request.
	Consumed int32 `protobuf:"varint,1,opt,name=consumed,proto3" json:"consumed,omitempty"`
	// Quota remaining after this request.
	Remaining int32 `protobuf:"varint,2,opt,name=remaining,proto3" json:"remaining,omitempty"`
	// contains filtered or unexported fields
}

Current state for a particular quota group.

func (*QuotaStatus) Descriptor deprecated

func (*QuotaStatus) Descriptor() ([]byte, []int)

Deprecated: Use QuotaStatus.ProtoReflect.Descriptor instead.

func (*QuotaStatus) GetConsumed

func (x *QuotaStatus) GetConsumed() int32

func (*QuotaStatus) GetRemaining

func (x *QuotaStatus) GetRemaining() int32

func (*QuotaStatus) ProtoMessage

func (*QuotaStatus) ProtoMessage()

func (*QuotaStatus) ProtoReflect

func (x *QuotaStatus) ProtoReflect() protoreflect.Message

func (*QuotaStatus) Reset

func (x *QuotaStatus) Reset()

func (*QuotaStatus) String

func (x *QuotaStatus) String() string

type Row

type Row struct {

	// List of requested dimension values. In a PivotReport, dimension_values
	// are only listed for dimensions included in a pivot.
	DimensionValues []*DimensionValue `protobuf:"bytes,1,rep,name=dimension_values,json=dimensionValues,proto3" json:"dimension_values,omitempty"`
	// List of requested visible metric values.
	MetricValues []*MetricValue `protobuf:"bytes,2,rep,name=metric_values,json=metricValues,proto3" json:"metric_values,omitempty"`
	// contains filtered or unexported fields
}

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"
}

] ```

func (*Row) Descriptor deprecated

func (*Row) Descriptor() ([]byte, []int)

Deprecated: Use Row.ProtoReflect.Descriptor instead.

func (*Row) GetDimensionValues

func (x *Row) GetDimensionValues() []*DimensionValue

func (*Row) GetMetricValues

func (x *Row) GetMetricValues() []*MetricValue

func (*Row) ProtoMessage

func (*Row) ProtoMessage()

func (*Row) ProtoReflect

func (x *Row) ProtoReflect() protoreflect.Message

func (*Row) Reset

func (x *Row) Reset()

func (*Row) String

func (x *Row) String() string

type RunFunnelReportRequest

type RunFunnelReportRequest struct {

	// A Google Analytics GA4 property identifier whose events are tracked.
	// Specified in the URL path and not the body. To learn more, see [where to
	// find your Property
	// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
	// Within a batch request, this property should either be unspecified or
	// consistent with the batch-level property.
	//
	// Example: properties/1234
	Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
	// Date ranges of data to read. If multiple date ranges are requested, each
	// response row will contain a zero based date range index. If two date
	// ranges overlap, the event data for the overlapping days is included in the
	// response rows for both date ranges.
	DateRanges []*DateRange `protobuf:"bytes,2,rep,name=date_ranges,json=dateRanges,proto3" json:"date_ranges,omitempty"`
	// The configuration of this request's funnel. This funnel configuration is
	// required.
	Funnel *Funnel `protobuf:"bytes,3,opt,name=funnel,proto3" json:"funnel,omitempty"`
	// If specified, this breakdown adds a dimension to the funnel table sub
	// report response. This breakdown dimension expands each funnel step to the
	// unique values of the breakdown dimension. For example, a breakdown by the
	// `deviceCategory` dimension will create rows for `mobile`, `tablet`,
	// `desktop`, and the total.
	FunnelBreakdown *FunnelBreakdown `protobuf:"bytes,4,opt,name=funnel_breakdown,json=funnelBreakdown,proto3" json:"funnel_breakdown,omitempty"`
	// If specified, next action adds a dimension to the funnel visualization sub
	// report response. This next action dimension expands each funnel step to the
	// unique values of the next action. For example a next action of the
	// `eventName` dimension will create rows for several events (i.e.
	// `session_start` & `click`) and the total.
	//
	// Next action only supports `eventName` and most Page / Screen dimensions
	// like `pageTitle` and `pagePath`.
	FunnelNextAction *FunnelNextAction `protobuf:"bytes,5,opt,name=funnel_next_action,json=funnelNextAction,proto3" json:"funnel_next_action,omitempty"`
	// The funnel visualization type controls the dimensions present in the funnel
	// visualization sub report response. If not specified, `STANDARD_FUNNEL` is
	// used.
	FunnelVisualizationType RunFunnelReportRequest_FunnelVisualizationType `` /* 215-byte string literal not displayed */
	// The configurations of segments. Segments are subsets of a property's data.
	// In a funnel report with segments, the funnel is evaluated in each segment.
	//
	// Each segment specified in this request
	// produces a separate row in the response; in the response, each segment
	// identified by its name.
	//
	// The segments parameter is optional. Requests are limited to 4 segments.
	Segments []*Segment `protobuf:"bytes,7,rep,name=segments,proto3" json:"segments,omitempty"`
	// The number of rows to return. If unspecified, 10,000 rows are returned. The
	// API returns a maximum of 100,000 rows per request, no matter how many you
	// ask for. `limit` must be positive.
	//
	// The API can also return fewer rows than the requested `limit`, if there
	// aren't as many dimension values as the `limit`.
	Limit int64 `protobuf:"varint,9,opt,name=limit,proto3" json:"limit,omitempty"`
	// Dimension filters allow you to ask for only specific dimension values in
	// the report. To learn more, see [Creating a Report: Dimension
	// Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
	// for examples. Metrics cannot be used in this filter.
	DimensionFilter *FilterExpression `protobuf:"bytes,10,opt,name=dimension_filter,json=dimensionFilter,proto3" json:"dimension_filter,omitempty"`
	// Toggles whether to return the current state of this Analytics Property's
	// quota. Quota is returned in [PropertyQuota](#PropertyQuota).
	ReturnPropertyQuota bool `protobuf:"varint,12,opt,name=return_property_quota,json=returnPropertyQuota,proto3" json:"return_property_quota,omitempty"`
	// contains filtered or unexported fields
}

The request for a funnel report.

func (*RunFunnelReportRequest) Descriptor deprecated

func (*RunFunnelReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use RunFunnelReportRequest.ProtoReflect.Descriptor instead.

func (*RunFunnelReportRequest) GetDateRanges

func (x *RunFunnelReportRequest) GetDateRanges() []*DateRange

func (*RunFunnelReportRequest) GetDimensionFilter

func (x *RunFunnelReportRequest) GetDimensionFilter() *FilterExpression

func (*RunFunnelReportRequest) GetFunnel

func (x *RunFunnelReportRequest) GetFunnel() *Funnel

func (*RunFunnelReportRequest) GetFunnelBreakdown

func (x *RunFunnelReportRequest) GetFunnelBreakdown() *FunnelBreakdown

func (*RunFunnelReportRequest) GetFunnelNextAction

func (x *RunFunnelReportRequest) GetFunnelNextAction() *FunnelNextAction

func (*RunFunnelReportRequest) GetFunnelVisualizationType

func (*RunFunnelReportRequest) GetLimit

func (x *RunFunnelReportRequest) GetLimit() int64

func (*RunFunnelReportRequest) GetProperty

func (x *RunFunnelReportRequest) GetProperty() string

func (*RunFunnelReportRequest) GetReturnPropertyQuota

func (x *RunFunnelReportRequest) GetReturnPropertyQuota() bool

func (*RunFunnelReportRequest) GetSegments

func (x *RunFunnelReportRequest) GetSegments() []*Segment

func (*RunFunnelReportRequest) ProtoMessage

func (*RunFunnelReportRequest) ProtoMessage()

func (*RunFunnelReportRequest) ProtoReflect

func (x *RunFunnelReportRequest) ProtoReflect() protoreflect.Message

func (*RunFunnelReportRequest) Reset

func (x *RunFunnelReportRequest) Reset()

func (*RunFunnelReportRequest) String

func (x *RunFunnelReportRequest) String() string

type RunFunnelReportRequest_FunnelVisualizationType

type RunFunnelReportRequest_FunnelVisualizationType int32

Controls the dimensions present in the funnel visualization sub report response.

const (
	// Unspecified type.
	RunFunnelReportRequest_FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED RunFunnelReportRequest_FunnelVisualizationType = 0
	// A standard (stepped) funnel. The funnel visualization sub report in the
	// response will not contain date.
	RunFunnelReportRequest_STANDARD_FUNNEL RunFunnelReportRequest_FunnelVisualizationType = 1
	// A trended (line chart) funnel. The funnel visualization sub report in the
	// response will contain the date dimension.
	RunFunnelReportRequest_TRENDED_FUNNEL RunFunnelReportRequest_FunnelVisualizationType = 2
)

func (RunFunnelReportRequest_FunnelVisualizationType) Descriptor

func (RunFunnelReportRequest_FunnelVisualizationType) Enum

func (RunFunnelReportRequest_FunnelVisualizationType) EnumDescriptor deprecated

Deprecated: Use RunFunnelReportRequest_FunnelVisualizationType.Descriptor instead.

func (RunFunnelReportRequest_FunnelVisualizationType) Number

func (RunFunnelReportRequest_FunnelVisualizationType) String

func (RunFunnelReportRequest_FunnelVisualizationType) Type

type RunFunnelReportResponse

type RunFunnelReportResponse struct {

	// The funnel table is a report with the funnel step, segment, breakdown
	// dimension, active users, completion rate, abandonments, and abandonments
	// rate.
	//
	// The segment dimension is only present in this response if a segment was
	// requested. The breakdown dimension is only present in this response if it
	// was requested.
	FunnelTable *FunnelSubReport `protobuf:"bytes,1,opt,name=funnel_table,json=funnelTable,proto3" json:"funnel_table,omitempty"`
	// The funnel visualization is a report with the funnel step, segment, date,
	// next action dimension, and active users.
	//
	// The segment dimension is only present in this response if a segment was
	// requested. The date dimension is only present in this response if it was
	// requested via the `TRENDED_FUNNEL` funnel type. The next action dimension
	// is only present in the response if it was requested.
	FunnelVisualization *FunnelSubReport `protobuf:"bytes,2,opt,name=funnel_visualization,json=funnelVisualization,proto3" json:"funnel_visualization,omitempty"`
	// This Analytics Property's quota state including this request.
	PropertyQuota *PropertyQuota `protobuf:"bytes,3,opt,name=property_quota,json=propertyQuota,proto3" json:"property_quota,omitempty"`
	// Identifies what kind of resource this message is. This `kind` is always the
	// fixed string "analyticsData#runFunnelReport". Useful to distinguish between
	// response types in JSON.
	Kind string `protobuf:"bytes,4,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RunFunnelReportResponse) Descriptor deprecated

func (*RunFunnelReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use RunFunnelReportResponse.ProtoReflect.Descriptor instead.

func (*RunFunnelReportResponse) GetFunnelTable

func (x *RunFunnelReportResponse) GetFunnelTable() *FunnelSubReport

func (*RunFunnelReportResponse) GetFunnelVisualization

func (x *RunFunnelReportResponse) GetFunnelVisualization() *FunnelSubReport

func (*RunFunnelReportResponse) GetKind

func (x *RunFunnelReportResponse) GetKind() string

func (*RunFunnelReportResponse) GetPropertyQuota

func (x *RunFunnelReportResponse) GetPropertyQuota() *PropertyQuota

func (*RunFunnelReportResponse) ProtoMessage

func (*RunFunnelReportResponse) ProtoMessage()

func (*RunFunnelReportResponse) ProtoReflect

func (x *RunFunnelReportResponse) ProtoReflect() protoreflect.Message

func (*RunFunnelReportResponse) Reset

func (x *RunFunnelReportResponse) Reset()

func (*RunFunnelReportResponse) String

func (x *RunFunnelReportResponse) String() string

type SamplingMetadata

type SamplingMetadata struct {

	// The total number of events read in this sampled report for a date range.
	// This is the size of the subset this property's data that was analyzed in
	// this funnel report.
	SamplesReadCount int64 `protobuf:"varint,1,opt,name=samples_read_count,json=samplesReadCount,proto3" json:"samples_read_count,omitempty"`
	// The total number of events present in this property's data that could
	// have been analyzed in this funnel report for a date range. Sampling
	// uncovers the meaningful information about the larger data set, and this
	// is the size of the larger data set.
	//
	// To calculate the percentage of available data that was used in this
	// funnel report, compute `samplesReadCount/samplingSpaceSize`.
	SamplingSpaceSize int64 `protobuf:"varint,2,opt,name=sampling_space_size,json=samplingSpaceSize,proto3" json:"sampling_space_size,omitempty"`
	// contains filtered or unexported fields
}

If funnel report results are [sampled](https://support.google.com/analytics/answer/2637192), 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.

func (*SamplingMetadata) Descriptor deprecated

func (*SamplingMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SamplingMetadata.ProtoReflect.Descriptor instead.

func (*SamplingMetadata) GetSamplesReadCount

func (x *SamplingMetadata) GetSamplesReadCount() int64

func (*SamplingMetadata) GetSamplingSpaceSize

func (x *SamplingMetadata) GetSamplingSpaceSize() int64

func (*SamplingMetadata) ProtoMessage

func (*SamplingMetadata) ProtoMessage()

func (*SamplingMetadata) ProtoReflect

func (x *SamplingMetadata) ProtoReflect() protoreflect.Message

func (*SamplingMetadata) Reset

func (x *SamplingMetadata) Reset()

func (*SamplingMetadata) String

func (x *SamplingMetadata) String() string

type Segment

type Segment struct {

	// The name for this segment. If unspecified, segments are named "Segment".
	// This name defines string value returned by the `segment` dimension. The
	// `segment` dimension prefixes segment names by the 1-based index number of
	// the segment in the request (i.e. "1. Segment", "2. Segment", etc.).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A segment is specified in one scope.
	//
	// Types that are assignable to OneSegmentScope:
	//	*Segment_UserSegment
	//	*Segment_SessionSegment
	//	*Segment_EventSegment
	OneSegmentScope isSegment_OneSegmentScope `protobuf_oneof:"one_segment_scope"`
	// contains filtered or unexported fields
}

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](https://support.google.com/analytics/answer/9304353).

func (*Segment) Descriptor deprecated

func (*Segment) Descriptor() ([]byte, []int)

Deprecated: Use Segment.ProtoReflect.Descriptor instead.

func (*Segment) GetEventSegment

func (x *Segment) GetEventSegment() *EventSegment

func (*Segment) GetName

func (x *Segment) GetName() string

func (*Segment) GetOneSegmentScope

func (m *Segment) GetOneSegmentScope() isSegment_OneSegmentScope

func (*Segment) GetSessionSegment

func (x *Segment) GetSessionSegment() *SessionSegment

func (*Segment) GetUserSegment

func (x *Segment) GetUserSegment() *UserSegment

func (*Segment) ProtoMessage

func (*Segment) ProtoMessage()

func (*Segment) ProtoReflect

func (x *Segment) ProtoReflect() protoreflect.Message

func (*Segment) Reset

func (x *Segment) Reset()

func (*Segment) String

func (x *Segment) String() string

type SegmentEventFilter

type SegmentEventFilter struct {

	// This filter matches events of this single event name. Event name is
	// required.
	EventName *string `protobuf:"bytes,1,opt,name=event_name,json=eventName,proto3,oneof" json:"event_name,omitempty"`
	// If specified, this filter matches events that match both the single event
	// name and the parameter filter expressions.
	//
	// Inside the parameter filter expression, only parameter filters are
	// available.
	SegmentParameterFilterExpression *SegmentParameterFilterExpression `` /* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

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.

func (*SegmentEventFilter) Descriptor deprecated

func (*SegmentEventFilter) Descriptor() ([]byte, []int)

Deprecated: Use SegmentEventFilter.ProtoReflect.Descriptor instead.

func (*SegmentEventFilter) GetEventName

func (x *SegmentEventFilter) GetEventName() string

func (*SegmentEventFilter) GetSegmentParameterFilterExpression

func (x *SegmentEventFilter) GetSegmentParameterFilterExpression() *SegmentParameterFilterExpression

func (*SegmentEventFilter) ProtoMessage

func (*SegmentEventFilter) ProtoMessage()

func (*SegmentEventFilter) ProtoReflect

func (x *SegmentEventFilter) ProtoReflect() protoreflect.Message

func (*SegmentEventFilter) Reset

func (x *SegmentEventFilter) Reset()

func (*SegmentEventFilter) String

func (x *SegmentEventFilter) String() string

type SegmentFilter

type SegmentFilter struct {

	// The dimension name or metric name.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// Specify one type of filter for `Filter`.
	//
	// Types that are assignable to OneFilter:
	//	*SegmentFilter_StringFilter
	//	*SegmentFilter_InListFilter
	//	*SegmentFilter_NumericFilter
	//	*SegmentFilter_BetweenFilter
	OneFilter isSegmentFilter_OneFilter `protobuf_oneof:"one_filter"`
	// Specifies the scope for the filter.
	FilterScoping *SegmentFilterScoping `protobuf:"bytes,8,opt,name=filter_scoping,json=filterScoping,proto3" json:"filter_scoping,omitempty"`
	// contains filtered or unexported fields
}

An expression to filter dimension or metric values.

func (*SegmentFilter) Descriptor deprecated

func (*SegmentFilter) Descriptor() ([]byte, []int)

Deprecated: Use SegmentFilter.ProtoReflect.Descriptor instead.

func (*SegmentFilter) GetBetweenFilter

func (x *SegmentFilter) GetBetweenFilter() *BetweenFilter

func (*SegmentFilter) GetFieldName

func (x *SegmentFilter) GetFieldName() string

func (*SegmentFilter) GetFilterScoping

func (x *SegmentFilter) GetFilterScoping() *SegmentFilterScoping

func (*SegmentFilter) GetInListFilter

func (x *SegmentFilter) GetInListFilter() *InListFilter

func (*SegmentFilter) GetNumericFilter

func (x *SegmentFilter) GetNumericFilter() *NumericFilter

func (*SegmentFilter) GetOneFilter

func (m *SegmentFilter) GetOneFilter() isSegmentFilter_OneFilter

func (*SegmentFilter) GetStringFilter

func (x *SegmentFilter) GetStringFilter() *StringFilter

func (*SegmentFilter) ProtoMessage

func (*SegmentFilter) ProtoMessage()

func (*SegmentFilter) ProtoReflect

func (x *SegmentFilter) ProtoReflect() protoreflect.Message

func (*SegmentFilter) Reset

func (x *SegmentFilter) Reset()

func (*SegmentFilter) String

func (x *SegmentFilter) String() string

type SegmentFilterExpression

type SegmentFilterExpression struct {

	// Specify one type of filter for `SegmentFilterExpression`.
	//
	// Types that are assignable to Expr:
	//	*SegmentFilterExpression_AndGroup
	//	*SegmentFilterExpression_OrGroup
	//	*SegmentFilterExpression_NotExpression
	//	*SegmentFilterExpression_SegmentFilter
	//	*SegmentFilterExpression_SegmentEventFilter
	Expr isSegmentFilterExpression_Expr `protobuf_oneof:"expr"`
	// contains filtered or unexported fields
}

Expresses combinations of segment filters.

func (*SegmentFilterExpression) Descriptor deprecated

func (*SegmentFilterExpression) Descriptor() ([]byte, []int)

Deprecated: Use SegmentFilterExpression.ProtoReflect.Descriptor instead.

func (*SegmentFilterExpression) GetAndGroup

func (*SegmentFilterExpression) GetExpr

func (m *SegmentFilterExpression) GetExpr() isSegmentFilterExpression_Expr

func (*SegmentFilterExpression) GetNotExpression

func (x *SegmentFilterExpression) GetNotExpression() *SegmentFilterExpression

func (*SegmentFilterExpression) GetOrGroup

func (*SegmentFilterExpression) GetSegmentEventFilter

func (x *SegmentFilterExpression) GetSegmentEventFilter() *SegmentEventFilter

func (*SegmentFilterExpression) GetSegmentFilter

func (x *SegmentFilterExpression) GetSegmentFilter() *SegmentFilter

func (*SegmentFilterExpression) ProtoMessage

func (*SegmentFilterExpression) ProtoMessage()

func (*SegmentFilterExpression) ProtoReflect

func (x *SegmentFilterExpression) ProtoReflect() protoreflect.Message

func (*SegmentFilterExpression) Reset

func (x *SegmentFilterExpression) Reset()

func (*SegmentFilterExpression) String

func (x *SegmentFilterExpression) String() string

type SegmentFilterExpressionList

type SegmentFilterExpressionList struct {

	// The list of segment filter expressions
	Expressions []*SegmentFilterExpression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// contains filtered or unexported fields
}

A list of segment filter expressions.

func (*SegmentFilterExpressionList) Descriptor deprecated

func (*SegmentFilterExpressionList) Descriptor() ([]byte, []int)

Deprecated: Use SegmentFilterExpressionList.ProtoReflect.Descriptor instead.

func (*SegmentFilterExpressionList) GetExpressions

func (*SegmentFilterExpressionList) ProtoMessage

func (*SegmentFilterExpressionList) ProtoMessage()

func (*SegmentFilterExpressionList) ProtoReflect

func (*SegmentFilterExpressionList) Reset

func (x *SegmentFilterExpressionList) Reset()

func (*SegmentFilterExpressionList) String

func (x *SegmentFilterExpressionList) String() string

type SegmentFilterExpression_AndGroup

type SegmentFilterExpression_AndGroup struct {
	// The SegmentFilterExpression in `andGroup` have an AND relationship.
	AndGroup *SegmentFilterExpressionList `protobuf:"bytes,1,opt,name=and_group,json=andGroup,proto3,oneof"`
}

type SegmentFilterExpression_NotExpression

type SegmentFilterExpression_NotExpression struct {
	// The SegmentFilterExpression is NOT of `notExpression`.
	NotExpression *SegmentFilterExpression `protobuf:"bytes,3,opt,name=not_expression,json=notExpression,proto3,oneof"`
}

type SegmentFilterExpression_OrGroup

type SegmentFilterExpression_OrGroup struct {
	// The SegmentFilterExpression in `orGroup` have an OR relationship.
	OrGroup *SegmentFilterExpressionList `protobuf:"bytes,2,opt,name=or_group,json=orGroup,proto3,oneof"`
}

type SegmentFilterExpression_SegmentEventFilter

type SegmentFilterExpression_SegmentEventFilter struct {
	// 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.
	SegmentEventFilter *SegmentEventFilter `protobuf:"bytes,5,opt,name=segment_event_filter,json=segmentEventFilter,proto3,oneof"`
}

type SegmentFilterExpression_SegmentFilter

type SegmentFilterExpression_SegmentFilter struct {
	// A primitive segment filter.
	SegmentFilter *SegmentFilter `protobuf:"bytes,4,opt,name=segment_filter,json=segmentFilter,proto3,oneof"`
}

type SegmentFilterScoping

type SegmentFilterScoping struct {

	// If `atAnyPointInTime` is true, this filter evaluates to true for all
	// events if it evaluates to true for any event in the date range of the
	// request.
	//
	// This `atAnyPointInTime` parameter does not extend the date range of
	// events in the report. If `atAnyPointInTime` is true, only events within
	// the report's date range are considered when evaluating this filter.
	//
	// This `atAnyPointInTime` is only able to be specified if the criteria
	// scoping is `ACROSS_ALL_SESSIONS` and is not able to be specified in
	// sequences.
	//
	// If the criteria scoping is `ACROSS_ALL_SESSIONS`, `atAnyPointInTime` =
	// false is used if unspecified.
	AtAnyPointInTime *bool `protobuf:"varint,1,opt,name=at_any_point_in_time,json=atAnyPointInTime,proto3,oneof" json:"at_any_point_in_time,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SegmentFilterScoping) Descriptor deprecated

func (*SegmentFilterScoping) Descriptor() ([]byte, []int)

Deprecated: Use SegmentFilterScoping.ProtoReflect.Descriptor instead.

func (*SegmentFilterScoping) GetAtAnyPointInTime

func (x *SegmentFilterScoping) GetAtAnyPointInTime() bool

func (*SegmentFilterScoping) ProtoMessage

func (*SegmentFilterScoping) ProtoMessage()

func (*SegmentFilterScoping) ProtoReflect

func (x *SegmentFilterScoping) ProtoReflect() protoreflect.Message

func (*SegmentFilterScoping) Reset

func (x *SegmentFilterScoping) Reset()

func (*SegmentFilterScoping) String

func (x *SegmentFilterScoping) String() string

type SegmentFilter_BetweenFilter

type SegmentFilter_BetweenFilter struct {
	// A filter for between two values.
	BetweenFilter *BetweenFilter `protobuf:"bytes,7,opt,name=between_filter,json=betweenFilter,proto3,oneof"`
}

type SegmentFilter_InListFilter

type SegmentFilter_InListFilter struct {
	// A filter for in list values.
	InListFilter *InListFilter `protobuf:"bytes,5,opt,name=in_list_filter,json=inListFilter,proto3,oneof"`
}

type SegmentFilter_NumericFilter

type SegmentFilter_NumericFilter struct {
	// A filter for numeric or date values.
	NumericFilter *NumericFilter `protobuf:"bytes,6,opt,name=numeric_filter,json=numericFilter,proto3,oneof"`
}

type SegmentFilter_StringFilter

type SegmentFilter_StringFilter struct {
	// Strings related filter.
	StringFilter *StringFilter `protobuf:"bytes,4,opt,name=string_filter,json=stringFilter,proto3,oneof"`
}

type SegmentParameterFilter

type SegmentParameterFilter struct {

	// The field that is being filtered.
	//
	// Types that are assignable to OneParameter:
	//	*SegmentParameterFilter_EventParameterName
	//	*SegmentParameterFilter_ItemParameterName
	OneParameter isSegmentParameterFilter_OneParameter `protobuf_oneof:"one_parameter"`
	// Specify one type of filter.
	//
	// Types that are assignable to OneFilter:
	//	*SegmentParameterFilter_StringFilter
	//	*SegmentParameterFilter_InListFilter
	//	*SegmentParameterFilter_NumericFilter
	//	*SegmentParameterFilter_BetweenFilter
	OneFilter isSegmentParameterFilter_OneFilter `protobuf_oneof:"one_filter"`
	// Specifies the scope for the filter.
	FilterScoping *SegmentParameterFilterScoping `protobuf:"bytes,8,opt,name=filter_scoping,json=filterScoping,proto3" json:"filter_scoping,omitempty"`
	// contains filtered or unexported fields
}

An expression to filter parameter values in a segment.

func (*SegmentParameterFilter) Descriptor deprecated

func (*SegmentParameterFilter) Descriptor() ([]byte, []int)

Deprecated: Use SegmentParameterFilter.ProtoReflect.Descriptor instead.

func (*SegmentParameterFilter) GetBetweenFilter

func (x *SegmentParameterFilter) GetBetweenFilter() *BetweenFilter

func (*SegmentParameterFilter) GetEventParameterName

func (x *SegmentParameterFilter) GetEventParameterName() string

func (*SegmentParameterFilter) GetFilterScoping

func (*SegmentParameterFilter) GetInListFilter

func (x *SegmentParameterFilter) GetInListFilter() *InListFilter

func (*SegmentParameterFilter) GetItemParameterName

func (x *SegmentParameterFilter) GetItemParameterName() string

func (*SegmentParameterFilter) GetNumericFilter

func (x *SegmentParameterFilter) GetNumericFilter() *NumericFilter

func (*SegmentParameterFilter) GetOneFilter

func (m *SegmentParameterFilter) GetOneFilter() isSegmentParameterFilter_OneFilter

func (*SegmentParameterFilter) GetOneParameter

func (m *SegmentParameterFilter) GetOneParameter() isSegmentParameterFilter_OneParameter

func (*SegmentParameterFilter) GetStringFilter

func (x *SegmentParameterFilter) GetStringFilter() *StringFilter

func (*SegmentParameterFilter) ProtoMessage

func (*SegmentParameterFilter) ProtoMessage()

func (*SegmentParameterFilter) ProtoReflect

func (x *SegmentParameterFilter) ProtoReflect() protoreflect.Message

func (*SegmentParameterFilter) Reset

func (x *SegmentParameterFilter) Reset()

func (*SegmentParameterFilter) String

func (x *SegmentParameterFilter) String() string

type SegmentParameterFilterExpression

type SegmentParameterFilterExpression struct {

	// Specify one type of filter for `SegmentParameterFilterExpression`.
	//
	// Types that are assignable to Expr:
	//	*SegmentParameterFilterExpression_AndGroup
	//	*SegmentParameterFilterExpression_OrGroup
	//	*SegmentParameterFilterExpression_NotExpression
	//	*SegmentParameterFilterExpression_SegmentParameterFilter
	Expr isSegmentParameterFilterExpression_Expr `protobuf_oneof:"expr"`
	// contains filtered or unexported fields
}

Expresses combinations of segment filter on parameters.

func (*SegmentParameterFilterExpression) Descriptor deprecated

func (*SegmentParameterFilterExpression) Descriptor() ([]byte, []int)

Deprecated: Use SegmentParameterFilterExpression.ProtoReflect.Descriptor instead.

func (*SegmentParameterFilterExpression) GetAndGroup

func (*SegmentParameterFilterExpression) GetExpr

func (m *SegmentParameterFilterExpression) GetExpr() isSegmentParameterFilterExpression_Expr

func (*SegmentParameterFilterExpression) GetNotExpression

func (*SegmentParameterFilterExpression) GetOrGroup

func (*SegmentParameterFilterExpression) GetSegmentParameterFilter

func (x *SegmentParameterFilterExpression) GetSegmentParameterFilter() *SegmentParameterFilter

func (*SegmentParameterFilterExpression) ProtoMessage

func (*SegmentParameterFilterExpression) ProtoMessage()

func (*SegmentParameterFilterExpression) ProtoReflect

func (*SegmentParameterFilterExpression) Reset

func (*SegmentParameterFilterExpression) String

type SegmentParameterFilterExpressionList

type SegmentParameterFilterExpressionList struct {

	// The list of segment parameter filter expressions.
	Expressions []*SegmentParameterFilterExpression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// contains filtered or unexported fields
}

A list of segment parameter filter expressions.

func (*SegmentParameterFilterExpressionList) Descriptor deprecated

func (*SegmentParameterFilterExpressionList) Descriptor() ([]byte, []int)

Deprecated: Use SegmentParameterFilterExpressionList.ProtoReflect.Descriptor instead.

func (*SegmentParameterFilterExpressionList) GetExpressions

func (*SegmentParameterFilterExpressionList) ProtoMessage

func (*SegmentParameterFilterExpressionList) ProtoMessage()

func (*SegmentParameterFilterExpressionList) ProtoReflect

func (*SegmentParameterFilterExpressionList) Reset

func (*SegmentParameterFilterExpressionList) String

type SegmentParameterFilterExpression_AndGroup

type SegmentParameterFilterExpression_AndGroup struct {
	// The SegmentParameterFilterExpression in `andGroup` have an AND
	// relationship.
	AndGroup *SegmentParameterFilterExpressionList `protobuf:"bytes,1,opt,name=and_group,json=andGroup,proto3,oneof"`
}

type SegmentParameterFilterExpression_NotExpression

type SegmentParameterFilterExpression_NotExpression struct {
	// The SegmentParameterFilterExpression is NOT of `notExpression`.
	NotExpression *SegmentParameterFilterExpression `protobuf:"bytes,3,opt,name=not_expression,json=notExpression,proto3,oneof"`
}

type SegmentParameterFilterExpression_OrGroup

type SegmentParameterFilterExpression_OrGroup struct {
	// The SegmentParameterFilterExpression in `orGroup` have an OR
	// relationship.
	OrGroup *SegmentParameterFilterExpressionList `protobuf:"bytes,2,opt,name=or_group,json=orGroup,proto3,oneof"`
}

type SegmentParameterFilterExpression_SegmentParameterFilter

type SegmentParameterFilterExpression_SegmentParameterFilter struct {
	// A primitive segment parameter filter.
	SegmentParameterFilter *SegmentParameterFilter `protobuf:"bytes,4,opt,name=segment_parameter_filter,json=segmentParameterFilter,proto3,oneof"`
}

type SegmentParameterFilterScoping

type SegmentParameterFilterScoping struct {

	// Accumulates the parameter over the specified period of days before
	// applying the filter. Only supported if criteria scoping is
	// `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the
	// parameter is `event_count`.
	//
	// For example if `inAnyNDayPeriod` is 3, the event_name is "purchase",
	// the event parameter is "event_count", and the Filter's criteria is
	// greater than 5, this filter will accumulate the event count of purchase
	// events over every 3 consecutive day period in the report's date range; a
	// user will pass this Filter's criteria to be included in this segment if
	// their count of purchase events exceeds 5 in any 3 consecutive day period.
	// For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to
	// 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.
	//
	// The date range is not extended for the purpose of having a full N day
	// window near the start of the date range. For example if a report is for
	// 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day
	// period will be effectively shortened because no event data outside the
	// report's date range will be read. For example, the first four periods
	// will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02,
	// 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.
	//
	// `inAnyNDayPeriod` is optional. If not specified, the
	// `segmentParameterFilter` is applied to each event individually.
	InAnyNDayPeriod *int64 `protobuf:"varint,1,opt,name=in_any_n_day_period,json=inAnyNDayPeriod,proto3,oneof" json:"in_any_n_day_period,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SegmentParameterFilterScoping) Descriptor deprecated

func (*SegmentParameterFilterScoping) Descriptor() ([]byte, []int)

Deprecated: Use SegmentParameterFilterScoping.ProtoReflect.Descriptor instead.

func (*SegmentParameterFilterScoping) GetInAnyNDayPeriod

func (x *SegmentParameterFilterScoping) GetInAnyNDayPeriod() int64

func (*SegmentParameterFilterScoping) ProtoMessage

func (*SegmentParameterFilterScoping) ProtoMessage()

func (*SegmentParameterFilterScoping) ProtoReflect

func (*SegmentParameterFilterScoping) Reset

func (x *SegmentParameterFilterScoping) Reset()

func (*SegmentParameterFilterScoping) String

type SegmentParameterFilter_BetweenFilter

type SegmentParameterFilter_BetweenFilter struct {
	// A filter for between two values.
	BetweenFilter *BetweenFilter `protobuf:"bytes,7,opt,name=between_filter,json=betweenFilter,proto3,oneof"`
}

type SegmentParameterFilter_EventParameterName

type SegmentParameterFilter_EventParameterName struct {
	// This filter will be evaluated on the specified event parameter. Event
	// parameters are logged as parameters of the event. Event parameters
	// include fields like "firebase_screen" & "currency".
	//
	// Event parameters can only be used in segments & funnels and can only be
	// used in a descendent filter from an EventFilter. In a descendent filter
	// from an EventFilter either event or item parameters should be used.
	EventParameterName string `protobuf:"bytes,1,opt,name=event_parameter_name,json=eventParameterName,proto3,oneof"`
}

type SegmentParameterFilter_InListFilter

type SegmentParameterFilter_InListFilter struct {
	// A filter for in list values.
	InListFilter *InListFilter `protobuf:"bytes,5,opt,name=in_list_filter,json=inListFilter,proto3,oneof"`
}

type SegmentParameterFilter_ItemParameterName

type SegmentParameterFilter_ItemParameterName struct {
	// This filter will be evaluated on the specified item parameter. Item
	// parameters are logged as parameters in the item array. Item parameters
	// include fields like "item_name" & "item_category".
	//
	// Item parameters can only be used in segments & funnels and can only be
	// used in a descendent filter from an EventFilter. In a descendent filter
	// from an EventFilter either event or item parameters should be used.
	//
	// Item parameters are only available in ecommerce events. To learn more
	// about ecommerce events, see the [Measure ecommerce]
	// (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)
	// guide.
	ItemParameterName string `protobuf:"bytes,2,opt,name=item_parameter_name,json=itemParameterName,proto3,oneof"`
}

type SegmentParameterFilter_NumericFilter

type SegmentParameterFilter_NumericFilter struct {
	// A filter for numeric or date values.
	NumericFilter *NumericFilter `protobuf:"bytes,6,opt,name=numeric_filter,json=numericFilter,proto3,oneof"`
}

type SegmentParameterFilter_StringFilter

type SegmentParameterFilter_StringFilter struct {
	// Strings related filter.
	StringFilter *StringFilter `protobuf:"bytes,4,opt,name=string_filter,json=stringFilter,proto3,oneof"`
}

type Segment_EventSegment

type Segment_EventSegment struct {
	// Event segments are subsets of events that were triggered on your site or
	// app.
	EventSegment *EventSegment `protobuf:"bytes,4,opt,name=event_segment,json=eventSegment,proto3,oneof"`
}

type Segment_SessionSegment

type Segment_SessionSegment struct {
	// Session segments are subsets of the sessions that occurred on your site
	// or app.
	SessionSegment *SessionSegment `protobuf:"bytes,3,opt,name=session_segment,json=sessionSegment,proto3,oneof"`
}

type Segment_UserSegment

type Segment_UserSegment struct {
	// User segments are subsets of users who engaged with your site or app.
	UserSegment *UserSegment `protobuf:"bytes,2,opt,name=user_segment,json=userSegment,proto3,oneof"`
}

type SessionCriteriaScoping

type SessionCriteriaScoping int32

Scoping specifies which events are considered when evaluating if a session meets a criteria.

const (
	// Unspecified criteria scoping. Do not specify.
	SessionCriteriaScoping_SESSION_CRITERIA_SCOPING_UNSPECIFIED SessionCriteriaScoping = 0
	// If the criteria is satisfied within one event, the session matches the
	// criteria.
	SessionCriteriaScoping_SESSION_CRITERIA_WITHIN_SAME_EVENT SessionCriteriaScoping = 1
	// If the criteria is satisfied within one session, the session matches
	// the criteria.
	SessionCriteriaScoping_SESSION_CRITERIA_WITHIN_SAME_SESSION SessionCriteriaScoping = 2
)

func (SessionCriteriaScoping) Descriptor

func (SessionCriteriaScoping) Enum

func (SessionCriteriaScoping) EnumDescriptor deprecated

func (SessionCriteriaScoping) EnumDescriptor() ([]byte, []int)

Deprecated: Use SessionCriteriaScoping.Descriptor instead.

func (SessionCriteriaScoping) Number

func (SessionCriteriaScoping) String

func (x SessionCriteriaScoping) String() string

func (SessionCriteriaScoping) Type

type SessionExclusionDuration

type SessionExclusionDuration int32

Enumerates options for how long an exclusion will last if a session matches the `sessionExclusionCriteria`.

const (
	// Unspecified exclusion duration. Do not specify.
	SessionExclusionDuration_SESSION_EXCLUSION_DURATION_UNSPECIFIED SessionExclusionDuration = 0
	// Temporarily exclude sessions from the segment during periods when the
	// session meets the `sessionExclusionCriteria` condition.
	SessionExclusionDuration_SESSION_EXCLUSION_TEMPORARY SessionExclusionDuration = 1
	// Permanently exclude sessions from the segment if the session ever meets
	// the `sessionExclusionCriteria` condition.
	SessionExclusionDuration_SESSION_EXCLUSION_PERMANENT SessionExclusionDuration = 2
)

func (SessionExclusionDuration) Descriptor

func (SessionExclusionDuration) Enum

func (SessionExclusionDuration) EnumDescriptor deprecated

func (SessionExclusionDuration) EnumDescriptor() ([]byte, []int)

Deprecated: Use SessionExclusionDuration.Descriptor instead.

func (SessionExclusionDuration) Number

func (SessionExclusionDuration) String

func (x SessionExclusionDuration) String() string

func (SessionExclusionDuration) Type

type SessionSegment

type SessionSegment struct {

	// Defines which sessions are included in this segment. Optional.
	SessionInclusionCriteria *SessionSegmentCriteria `` /* 135-byte string literal not displayed */
	// Defines which sessions are excluded in this segment. Optional.
	Exclusion *SessionSegmentExclusion `protobuf:"bytes,2,opt,name=exclusion,proto3" json:"exclusion,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*SessionSegment) Descriptor deprecated

func (*SessionSegment) Descriptor() ([]byte, []int)

Deprecated: Use SessionSegment.ProtoReflect.Descriptor instead.

func (*SessionSegment) GetExclusion

func (x *SessionSegment) GetExclusion() *SessionSegmentExclusion

func (*SessionSegment) GetSessionInclusionCriteria

func (x *SessionSegment) GetSessionInclusionCriteria() *SessionSegmentCriteria

func (*SessionSegment) ProtoMessage

func (*SessionSegment) ProtoMessage()

func (*SessionSegment) ProtoReflect

func (x *SessionSegment) ProtoReflect() protoreflect.Message

func (*SessionSegment) Reset

func (x *SessionSegment) Reset()

func (*SessionSegment) String

func (x *SessionSegment) String() string

type SessionSegmentConditionGroup

type SessionSegmentConditionGroup struct {

	// Data is included or excluded from the segment based on if it matches
	// the condition group. This scoping defines how many events the
	// `segmentFilterExpression` is evaluated on before the condition group
	// is determined to be matched or not. For example if `conditionScoping =
	// SESSION_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all
	// events in a session, and then, the condition group is determined to be
	// matched or not for this session. For example if `conditionScoping =
	// SESSION_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a
	// single event, and then, the condition group is determined to be matched or
	// not for this session.
	//
	// Optional. If unspecified, a `conditionScoping` of `WITHIN_SAME_SESSION`
	// is used.
	ConditionScoping SessionCriteriaScoping `` /* 168-byte string literal not displayed */
	// Data is included or excluded from the segment based on if it matches
	// this expression. Expressions express criteria on dimension, metrics,
	// and/or parameters.
	SegmentFilterExpression *SegmentFilterExpression `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*SessionSegmentConditionGroup) Descriptor deprecated

func (*SessionSegmentConditionGroup) Descriptor() ([]byte, []int)

Deprecated: Use SessionSegmentConditionGroup.ProtoReflect.Descriptor instead.

func (*SessionSegmentConditionGroup) GetConditionScoping

func (x *SessionSegmentConditionGroup) GetConditionScoping() SessionCriteriaScoping

func (*SessionSegmentConditionGroup) GetSegmentFilterExpression

func (x *SessionSegmentConditionGroup) GetSegmentFilterExpression() *SegmentFilterExpression

func (*SessionSegmentConditionGroup) ProtoMessage

func (*SessionSegmentConditionGroup) ProtoMessage()

func (*SessionSegmentConditionGroup) ProtoReflect

func (*SessionSegmentConditionGroup) Reset

func (x *SessionSegmentConditionGroup) Reset()

func (*SessionSegmentConditionGroup) String

type SessionSegmentCriteria

type SessionSegmentCriteria struct {

	// A session matches this criteria if the session matches each of these
	// `andConditionGroups`.
	AndConditionGroups []*SessionSegmentConditionGroup `protobuf:"bytes,1,rep,name=and_condition_groups,json=andConditionGroups,proto3" json:"and_condition_groups,omitempty"`
	// contains filtered or unexported fields
}

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

func (*SessionSegmentCriteria) Descriptor deprecated

func (*SessionSegmentCriteria) Descriptor() ([]byte, []int)

Deprecated: Use SessionSegmentCriteria.ProtoReflect.Descriptor instead.

func (*SessionSegmentCriteria) GetAndConditionGroups

func (x *SessionSegmentCriteria) GetAndConditionGroups() []*SessionSegmentConditionGroup

func (*SessionSegmentCriteria) ProtoMessage

func (*SessionSegmentCriteria) ProtoMessage()

func (*SessionSegmentCriteria) ProtoReflect

func (x *SessionSegmentCriteria) ProtoReflect() protoreflect.Message

func (*SessionSegmentCriteria) Reset

func (x *SessionSegmentCriteria) Reset()

func (*SessionSegmentCriteria) String

func (x *SessionSegmentCriteria) String() string

type SessionSegmentExclusion

type SessionSegmentExclusion struct {

	// Specifies how long an exclusion will last if a session matches the
	// `sessionExclusionCriteria`.
	//
	// Optional. If unspecified, a `sessionExclusionDuration` of
	// `SESSION_EXCLUSION_TEMPORARY` is used.
	SessionExclusionDuration SessionExclusionDuration `` /* 196-byte string literal not displayed */
	// If a session meets this condition, the session is excluded from
	// membership in the segment for the `sessionExclusionDuration`.
	SessionExclusionCriteria *SessionSegmentCriteria `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies which sessions are excluded in this segment.

func (*SessionSegmentExclusion) Descriptor deprecated

func (*SessionSegmentExclusion) Descriptor() ([]byte, []int)

Deprecated: Use SessionSegmentExclusion.ProtoReflect.Descriptor instead.

func (*SessionSegmentExclusion) GetSessionExclusionCriteria

func (x *SessionSegmentExclusion) GetSessionExclusionCriteria() *SessionSegmentCriteria

func (*SessionSegmentExclusion) GetSessionExclusionDuration

func (x *SessionSegmentExclusion) GetSessionExclusionDuration() SessionExclusionDuration

func (*SessionSegmentExclusion) ProtoMessage

func (*SessionSegmentExclusion) ProtoMessage()

func (*SessionSegmentExclusion) ProtoReflect

func (x *SessionSegmentExclusion) ProtoReflect() protoreflect.Message

func (*SessionSegmentExclusion) Reset

func (x *SessionSegmentExclusion) Reset()

func (*SessionSegmentExclusion) String

func (x *SessionSegmentExclusion) String() string

type StringFilter

type StringFilter struct {

	// The match type for this filter.
	MatchType StringFilter_MatchType `` /* 147-byte string literal not displayed */
	// The string value used for the matching.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// If true, the string value is case sensitive.
	CaseSensitive bool `protobuf:"varint,3,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
	// contains filtered or unexported fields
}

The filter for string

func (*StringFilter) Descriptor deprecated

func (*StringFilter) Descriptor() ([]byte, []int)

Deprecated: Use StringFilter.ProtoReflect.Descriptor instead.

func (*StringFilter) GetCaseSensitive

func (x *StringFilter) GetCaseSensitive() bool

func (*StringFilter) GetMatchType

func (x *StringFilter) GetMatchType() StringFilter_MatchType

func (*StringFilter) GetValue

func (x *StringFilter) GetValue() string

func (*StringFilter) ProtoMessage

func (*StringFilter) ProtoMessage()

func (*StringFilter) ProtoReflect

func (x *StringFilter) ProtoReflect() protoreflect.Message

func (*StringFilter) Reset

func (x *StringFilter) Reset()

func (*StringFilter) String

func (x *StringFilter) String() string

type StringFilter_MatchType

type StringFilter_MatchType int32

The match type of a string filter

const (
	// Unspecified
	StringFilter_MATCH_TYPE_UNSPECIFIED StringFilter_MatchType = 0
	// Exact match of the string value.
	StringFilter_EXACT StringFilter_MatchType = 1
	// Begins with the string value.
	StringFilter_BEGINS_WITH StringFilter_MatchType = 2
	// Ends with the string value.
	StringFilter_ENDS_WITH StringFilter_MatchType = 3
	// Contains the string value.
	StringFilter_CONTAINS StringFilter_MatchType = 4
	// Full match for the regular expression with the string value.
	StringFilter_FULL_REGEXP StringFilter_MatchType = 5
	// Partial match for the regular expression with the string value.
	StringFilter_PARTIAL_REGEXP StringFilter_MatchType = 6
)

func (StringFilter_MatchType) Descriptor

func (StringFilter_MatchType) Enum

func (StringFilter_MatchType) EnumDescriptor deprecated

func (StringFilter_MatchType) EnumDescriptor() ([]byte, []int)

Deprecated: Use StringFilter_MatchType.Descriptor instead.

func (StringFilter_MatchType) Number

func (StringFilter_MatchType) String

func (x StringFilter_MatchType) String() string

func (StringFilter_MatchType) Type

type UnimplementedAlphaAnalyticsDataServer

type UnimplementedAlphaAnalyticsDataServer struct {
}

UnimplementedAlphaAnalyticsDataServer can be embedded to have forward compatible implementations.

func (*UnimplementedAlphaAnalyticsDataServer) RunFunnelReport

type UserCriteriaScoping

type UserCriteriaScoping int32

Scoping specifies which events are considered when evaluating if a user meets a criteria.

const (
	// Unspecified criteria scoping. Do not specify.
	UserCriteriaScoping_USER_CRITERIA_SCOPING_UNSPECIFIED UserCriteriaScoping = 0
	// If the criteria is satisfied within one event, the user matches the
	// criteria.
	UserCriteriaScoping_USER_CRITERIA_WITHIN_SAME_EVENT UserCriteriaScoping = 1
	// If the criteria is satisfied within one session, the user matches the
	// criteria.
	UserCriteriaScoping_USER_CRITERIA_WITHIN_SAME_SESSION UserCriteriaScoping = 2
	// If the criteria is satisfied by any events for the user, the user
	// matches the criteria.
	UserCriteriaScoping_USER_CRITERIA_ACROSS_ALL_SESSIONS UserCriteriaScoping = 3
)

func (UserCriteriaScoping) Descriptor

func (UserCriteriaScoping) Enum

func (UserCriteriaScoping) EnumDescriptor deprecated

func (UserCriteriaScoping) EnumDescriptor() ([]byte, []int)

Deprecated: Use UserCriteriaScoping.Descriptor instead.

func (UserCriteriaScoping) Number

func (UserCriteriaScoping) String

func (x UserCriteriaScoping) String() string

func (UserCriteriaScoping) Type

type UserExclusionDuration

type UserExclusionDuration int32

Enumerates options for how long an exclusion will last if a user matches the `userExclusionCriteria`.

const (
	// Unspecified exclusion duration. Do not specify.
	UserExclusionDuration_USER_EXCLUSION_DURATION_UNSPECIFIED UserExclusionDuration = 0
	// Temporarily exclude users from the segment during periods when the
	// user meets the `userExclusionCriteria` condition.
	UserExclusionDuration_USER_EXCLUSION_TEMPORARY UserExclusionDuration = 1
	// Permanently exclude users from the segment if the user ever meets the
	// `userExclusionCriteria` condition.
	UserExclusionDuration_USER_EXCLUSION_PERMANENT UserExclusionDuration = 2
)

func (UserExclusionDuration) Descriptor

func (UserExclusionDuration) Enum

func (UserExclusionDuration) EnumDescriptor deprecated

func (UserExclusionDuration) EnumDescriptor() ([]byte, []int)

Deprecated: Use UserExclusionDuration.Descriptor instead.

func (UserExclusionDuration) Number

func (UserExclusionDuration) String

func (x UserExclusionDuration) String() string

func (UserExclusionDuration) Type

type UserSegment

type UserSegment struct {

	// Defines which users are included in this segment. Optional.
	UserInclusionCriteria *UserSegmentCriteria `` /* 126-byte string literal not displayed */
	// Defines which users are excluded in this segment. Optional.
	Exclusion *UserSegmentExclusion `protobuf:"bytes,2,opt,name=exclusion,proto3" json:"exclusion,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*UserSegment) Descriptor deprecated

func (*UserSegment) Descriptor() ([]byte, []int)

Deprecated: Use UserSegment.ProtoReflect.Descriptor instead.

func (*UserSegment) GetExclusion

func (x *UserSegment) GetExclusion() *UserSegmentExclusion

func (*UserSegment) GetUserInclusionCriteria

func (x *UserSegment) GetUserInclusionCriteria() *UserSegmentCriteria

func (*UserSegment) ProtoMessage

func (*UserSegment) ProtoMessage()

func (*UserSegment) ProtoReflect

func (x *UserSegment) ProtoReflect() protoreflect.Message

func (*UserSegment) Reset

func (x *UserSegment) Reset()

func (*UserSegment) String

func (x *UserSegment) String() string

type UserSegmentConditionGroup

type UserSegmentConditionGroup struct {

	// Data is included or excluded from the segment based on if it matches
	// the condition group. This scoping defines how many events the
	// `segmentFilterExpression` is evaluated on before the condition group
	// is determined to be matched or not. For example if `conditionScoping =
	// USER_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all
	// events in a session, and then, the condition group is determined to be
	// matched or not for this user. For example if `conditionScoping =
	// USER_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a single
	// event, and then, the condition group is determined to be matched or not for
	// this user.
	//
	// Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is
	// used.
	ConditionScoping UserCriteriaScoping `` /* 165-byte string literal not displayed */
	// Data is included or excluded from the segment based on if it matches
	// this expression. Expressions express criteria on dimension, metrics,
	// and/or parameters.
	SegmentFilterExpression *SegmentFilterExpression `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*UserSegmentConditionGroup) Descriptor deprecated

func (*UserSegmentConditionGroup) Descriptor() ([]byte, []int)

Deprecated: Use UserSegmentConditionGroup.ProtoReflect.Descriptor instead.

func (*UserSegmentConditionGroup) GetConditionScoping

func (x *UserSegmentConditionGroup) GetConditionScoping() UserCriteriaScoping

func (*UserSegmentConditionGroup) GetSegmentFilterExpression

func (x *UserSegmentConditionGroup) GetSegmentFilterExpression() *SegmentFilterExpression

func (*UserSegmentConditionGroup) ProtoMessage

func (*UserSegmentConditionGroup) ProtoMessage()

func (*UserSegmentConditionGroup) ProtoReflect

func (*UserSegmentConditionGroup) Reset

func (x *UserSegmentConditionGroup) Reset()

func (*UserSegmentConditionGroup) String

func (x *UserSegmentConditionGroup) String() string

type UserSegmentCriteria

type UserSegmentCriteria struct {

	// A user matches this criteria if the user matches each of these
	// `andConditionGroups` and each of the `andSequenceGroups`.
	// `andConditionGroups` may be empty if `andSequenceGroups` are specified.
	AndConditionGroups []*UserSegmentConditionGroup `protobuf:"bytes,1,rep,name=and_condition_groups,json=andConditionGroups,proto3" json:"and_condition_groups,omitempty"`
	// A user matches this criteria if the user matches each of these
	// `andSequenceGroups` and each of the `andConditionGroups`.
	// `andSequenceGroups` may be empty if `andConditionGroups` are specified.
	AndSequenceGroups []*UserSegmentSequenceGroup `protobuf:"bytes,2,rep,name=and_sequence_groups,json=andSequenceGroups,proto3" json:"and_sequence_groups,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UserSegmentCriteria) Descriptor deprecated

func (*UserSegmentCriteria) Descriptor() ([]byte, []int)

Deprecated: Use UserSegmentCriteria.ProtoReflect.Descriptor instead.

func (*UserSegmentCriteria) GetAndConditionGroups

func (x *UserSegmentCriteria) GetAndConditionGroups() []*UserSegmentConditionGroup

func (*UserSegmentCriteria) GetAndSequenceGroups

func (x *UserSegmentCriteria) GetAndSequenceGroups() []*UserSegmentSequenceGroup

func (*UserSegmentCriteria) ProtoMessage

func (*UserSegmentCriteria) ProtoMessage()

func (*UserSegmentCriteria) ProtoReflect

func (x *UserSegmentCriteria) ProtoReflect() protoreflect.Message

func (*UserSegmentCriteria) Reset

func (x *UserSegmentCriteria) Reset()

func (*UserSegmentCriteria) String

func (x *UserSegmentCriteria) String() string

type UserSegmentExclusion

type UserSegmentExclusion struct {

	// Specifies how long an exclusion will last if a user matches the
	// `userExclusionCriteria`.
	//
	// Optional. If unspecified, `userExclusionDuration` of
	// `USER_EXCLUSION_TEMPORARY` is used.
	UserExclusionDuration UserExclusionDuration `` /* 184-byte string literal not displayed */
	// If a user meets this condition, the user is excluded from membership in
	// the segment for the `userExclusionDuration`.
	UserExclusionCriteria *UserSegmentCriteria `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies which users are excluded in this segment.

func (*UserSegmentExclusion) Descriptor deprecated

func (*UserSegmentExclusion) Descriptor() ([]byte, []int)

Deprecated: Use UserSegmentExclusion.ProtoReflect.Descriptor instead.

func (*UserSegmentExclusion) GetUserExclusionCriteria

func (x *UserSegmentExclusion) GetUserExclusionCriteria() *UserSegmentCriteria

func (*UserSegmentExclusion) GetUserExclusionDuration

func (x *UserSegmentExclusion) GetUserExclusionDuration() UserExclusionDuration

func (*UserSegmentExclusion) ProtoMessage

func (*UserSegmentExclusion) ProtoMessage()

func (*UserSegmentExclusion) ProtoReflect

func (x *UserSegmentExclusion) ProtoReflect() protoreflect.Message

func (*UserSegmentExclusion) Reset

func (x *UserSegmentExclusion) Reset()

func (*UserSegmentExclusion) String

func (x *UserSegmentExclusion) String() string

type UserSegmentSequenceGroup

type UserSegmentSequenceGroup struct {

	// All sequence steps must be satisfied in the scoping for the user to
	// match the sequence. For example if `sequenceScoping =
	// USER_CRITERIA_WITHIN_SAME_SESSION`, all sequence steps must complete within
	// one session for the user to match the sequence. `sequenceScoping =
	// USER_CRITERIA_WITHIN_SAME_EVENT` is not supported.
	//
	// Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is
	// used.
	SequenceScoping UserCriteriaScoping `` /* 162-byte string literal not displayed */
	// Defines the time period in which the whole sequence must occur; for
	// example, 30 Minutes. `sequenceMaximumDuration` is inclusive
	// of the endpoint at the microsecond granularity. For example a sequence
	// with a maximum duration of 5 seconds can be completed at 4.9 or 5.0
	// seconds, but not 5 seconds and 1 microsecond.
	//
	// `sequenceMaximumDuration` is optional, and if unspecified, sequences can
	// be completed in any time duration.
	SequenceMaximumDuration *durationpb.Duration `` /* 132-byte string literal not displayed */
	// An ordered sequence of condition steps. A user's events must complete
	// each step in order for the user to match the
	// `UserSegmentSequenceGroup`.
	UserSequenceSteps []*UserSequenceStep `protobuf:"bytes,3,rep,name=user_sequence_steps,json=userSequenceSteps,proto3" json:"user_sequence_steps,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UserSegmentSequenceGroup) Descriptor deprecated

func (*UserSegmentSequenceGroup) Descriptor() ([]byte, []int)

Deprecated: Use UserSegmentSequenceGroup.ProtoReflect.Descriptor instead.

func (*UserSegmentSequenceGroup) GetSequenceMaximumDuration

func (x *UserSegmentSequenceGroup) GetSequenceMaximumDuration() *durationpb.Duration

func (*UserSegmentSequenceGroup) GetSequenceScoping

func (x *UserSegmentSequenceGroup) GetSequenceScoping() UserCriteriaScoping

func (*UserSegmentSequenceGroup) GetUserSequenceSteps

func (x *UserSegmentSequenceGroup) GetUserSequenceSteps() []*UserSequenceStep

func (*UserSegmentSequenceGroup) ProtoMessage

func (*UserSegmentSequenceGroup) ProtoMessage()

func (*UserSegmentSequenceGroup) ProtoReflect

func (x *UserSegmentSequenceGroup) ProtoReflect() protoreflect.Message

func (*UserSegmentSequenceGroup) Reset

func (x *UserSegmentSequenceGroup) Reset()

func (*UserSegmentSequenceGroup) String

func (x *UserSegmentSequenceGroup) String() string

type UserSequenceStep

type UserSequenceStep struct {

	// If true, the event satisfying this step must be the very next event
	// after the event satifying the last step. If false, this step indirectly
	// follows the prior step; for example, there may be events between the
	// prior step and this step. `isDirectlyFollowedBy` must be false for
	// the first step.
	IsDirectlyFollowedBy bool `` /* 126-byte string literal not displayed */
	// This sequence step must be satisfied in the scoping for the user to
	// match the sequence. For example if `sequenceScoping =
	// WITHIN_SAME_SESSION`, this sequence steps must complete within one
	// session for the user to match the sequence. `stepScoping =
	// ACROSS_ALL_SESSIONS` is only allowed if the `sequenceScoping =
	// ACROSS_ALL_SESSIONS`.
	//
	// Optional. If unspecified, `stepScoping` uses the same
	// `UserCriteriaScoping` as the `sequenceScoping`.
	StepScoping UserCriteriaScoping `` /* 150-byte string literal not displayed */
	// A user matches this sequence step if their events match this
	// expression. Expressions express criteria on dimension, metrics,
	// and/or parameters.
	SegmentFilterExpression *SegmentFilterExpression `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*UserSequenceStep) Descriptor deprecated

func (*UserSequenceStep) Descriptor() ([]byte, []int)

Deprecated: Use UserSequenceStep.ProtoReflect.Descriptor instead.

func (*UserSequenceStep) GetIsDirectlyFollowedBy

func (x *UserSequenceStep) GetIsDirectlyFollowedBy() bool

func (*UserSequenceStep) GetSegmentFilterExpression

func (x *UserSequenceStep) GetSegmentFilterExpression() *SegmentFilterExpression

func (*UserSequenceStep) GetStepScoping

func (x *UserSequenceStep) GetStepScoping() UserCriteriaScoping

func (*UserSequenceStep) ProtoMessage

func (*UserSequenceStep) ProtoMessage()

func (*UserSequenceStep) ProtoReflect

func (x *UserSequenceStep) ProtoReflect() protoreflect.Message

func (*UserSequenceStep) Reset

func (x *UserSequenceStep) Reset()

func (*UserSequenceStep) String

func (x *UserSequenceStep) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL