data

package
v0.0.0-...-af27646 Latest Latest
Warning

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

Go to latest
Published: Sep 30, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	MetricAggregation_name = map[int32]string{
		0: "METRIC_AGGREGATION_UNSPECIFIED",
		1: "TOTAL",
		5: "MINIMUM",
		6: "MAXIMUM",
		4: "COUNT",
	}
	MetricAggregation_value = map[string]int32{
		"METRIC_AGGREGATION_UNSPECIFIED": 0,
		"TOTAL":                          1,
		"MINIMUM":                        5,
		"MAXIMUM":                        6,
		"COUNT":                          4,
	}
)

Enum value maps for MetricAggregation.

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 (
	RestrictedMetricType_name = map[int32]string{
		0: "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
		1: "COST_DATA",
		2: "REVENUE_DATA",
	}
	RestrictedMetricType_value = map[string]int32{
		"RESTRICTED_METRIC_TYPE_UNSPECIFIED": 0,
		"COST_DATA":                          1,
		"REVENUE_DATA":                       2,
	}
)

Enum value maps for RestrictedMetricType.

View Source
var (
	Compatibility_name = map[int32]string{
		0: "COMPATIBILITY_UNSPECIFIED",
		1: "COMPATIBLE",
		2: "INCOMPATIBLE",
	}
	Compatibility_value = map[string]int32{
		"COMPATIBILITY_UNSPECIFIED": 0,
		"COMPATIBLE":                1,
		"INCOMPATIBLE":              2,
	}
)

Enum value maps for Compatibility.

View Source
var (
	Filter_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",
	}
	Filter_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 Filter_StringFilter_MatchType.

View Source
var (
	Filter_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",
	}
	Filter_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 Filter_NumericFilter_Operation.

View Source
var (
	OrderBy_DimensionOrderBy_OrderType_name = map[int32]string{
		0: "ORDER_TYPE_UNSPECIFIED",
		1: "ALPHANUMERIC",
		2: "CASE_INSENSITIVE_ALPHANUMERIC",
		3: "NUMERIC",
	}
	OrderBy_DimensionOrderBy_OrderType_value = map[string]int32{
		"ORDER_TYPE_UNSPECIFIED":        0,
		"ALPHANUMERIC":                  1,
		"CASE_INSENSITIVE_ALPHANUMERIC": 2,
		"NUMERIC":                       3,
	}
)

Enum value maps for OrderBy_DimensionOrderBy_OrderType.

View Source
var (
	CohortsRange_Granularity_name = map[int32]string{
		0: "GRANULARITY_UNSPECIFIED",
		1: "DAILY",
		2: "WEEKLY",
		3: "MONTHLY",
	}
	CohortsRange_Granularity_value = map[string]int32{
		"GRANULARITY_UNSPECIFIED": 0,
		"DAILY":                   1,
		"WEEKLY":                  2,
		"MONTHLY":                 3,
	}
)

Enum value maps for CohortsRange_Granularity.

View Source
var (
	MetricMetadata_BlockedReason_name = map[int32]string{
		0: "BLOCKED_REASON_UNSPECIFIED",
		1: "NO_REVENUE_METRICS",
		2: "NO_COST_METRICS",
	}
	MetricMetadata_BlockedReason_value = map[string]int32{
		"BLOCKED_REASON_UNSPECIFIED": 0,
		"NO_REVENUE_METRICS":         1,
		"NO_COST_METRICS":            2,
	}
)

Enum value maps for MetricMetadata_BlockedReason.

View Source
var File_google_analytics_data_v1beta_analytics_data_api_proto protoreflect.FileDescriptor
View Source
var File_google_analytics_data_v1beta_data_proto protoreflect.FileDescriptor

Functions

func RegisterBetaAnalyticsDataServer

func RegisterBetaAnalyticsDataServer(s *grpc.Server, srv BetaAnalyticsDataServer)

Types

type BatchRunPivotReportsRequest

type BatchRunPivotReportsRequest 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).
	// This property must be specified for the batch. The property within
	// RunPivotReportRequest may either be unspecified or consistent with this
	// property.
	//
	// Example: properties/1234
	Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
	// Individual requests. Each request has a separate pivot report response.
	// Each batch request is allowed up to 5 requests.
	Requests []*RunPivotReportRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

The batch request containing multiple pivot report requests.

func (*BatchRunPivotReportsRequest) Descriptor deprecated

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

Deprecated: Use BatchRunPivotReportsRequest.ProtoReflect.Descriptor instead.

func (*BatchRunPivotReportsRequest) GetProperty

func (x *BatchRunPivotReportsRequest) GetProperty() string

func (*BatchRunPivotReportsRequest) GetRequests

func (*BatchRunPivotReportsRequest) ProtoMessage

func (*BatchRunPivotReportsRequest) ProtoMessage()

func (*BatchRunPivotReportsRequest) ProtoReflect

func (*BatchRunPivotReportsRequest) Reset

func (x *BatchRunPivotReportsRequest) Reset()

func (*BatchRunPivotReportsRequest) String

func (x *BatchRunPivotReportsRequest) String() string

type BatchRunPivotReportsResponse

type BatchRunPivotReportsResponse struct {

	// Individual responses. Each response has a separate pivot report request.
	PivotReports []*RunPivotReportResponse `protobuf:"bytes,1,rep,name=pivot_reports,json=pivotReports,proto3" json:"pivot_reports,omitempty"`
	// Identifies what kind of resource this message is. This `kind` is always the
	// fixed string "analyticsData#batchRunPivotReports". Useful to distinguish
	// between response types in JSON.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

The batch response containing multiple pivot reports.

func (*BatchRunPivotReportsResponse) Descriptor deprecated

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

Deprecated: Use BatchRunPivotReportsResponse.ProtoReflect.Descriptor instead.

func (*BatchRunPivotReportsResponse) GetKind

func (x *BatchRunPivotReportsResponse) GetKind() string

func (*BatchRunPivotReportsResponse) GetPivotReports

func (x *BatchRunPivotReportsResponse) GetPivotReports() []*RunPivotReportResponse

func (*BatchRunPivotReportsResponse) ProtoMessage

func (*BatchRunPivotReportsResponse) ProtoMessage()

func (*BatchRunPivotReportsResponse) ProtoReflect

func (*BatchRunPivotReportsResponse) Reset

func (x *BatchRunPivotReportsResponse) Reset()

func (*BatchRunPivotReportsResponse) String

type BatchRunReportsRequest

type BatchRunReportsRequest 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).
	// This property must be specified for the batch. The property within
	// RunReportRequest may either be unspecified or consistent with this
	// property.
	//
	// Example: properties/1234
	Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
	// Individual requests. Each request has a separate report response. Each
	// batch request is allowed up to 5 requests.
	Requests []*RunReportRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

The batch request containing multiple report requests.

func (*BatchRunReportsRequest) Descriptor deprecated

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

Deprecated: Use BatchRunReportsRequest.ProtoReflect.Descriptor instead.

func (*BatchRunReportsRequest) GetProperty

func (x *BatchRunReportsRequest) GetProperty() string

func (*BatchRunReportsRequest) GetRequests

func (x *BatchRunReportsRequest) GetRequests() []*RunReportRequest

func (*BatchRunReportsRequest) ProtoMessage

func (*BatchRunReportsRequest) ProtoMessage()

func (*BatchRunReportsRequest) ProtoReflect

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

func (*BatchRunReportsRequest) Reset

func (x *BatchRunReportsRequest) Reset()

func (*BatchRunReportsRequest) String

func (x *BatchRunReportsRequest) String() string

type BatchRunReportsResponse

type BatchRunReportsResponse struct {

	// Individual responses. Each response has a separate report request.
	Reports []*RunReportResponse `protobuf:"bytes,1,rep,name=reports,proto3" json:"reports,omitempty"`
	// Identifies what kind of resource this message is. This `kind` is always the
	// fixed string "analyticsData#batchRunReports". Useful to distinguish between
	// response types in JSON.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

The batch response containing multiple reports.

func (*BatchRunReportsResponse) Descriptor deprecated

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

Deprecated: Use BatchRunReportsResponse.ProtoReflect.Descriptor instead.

func (*BatchRunReportsResponse) GetKind

func (x *BatchRunReportsResponse) GetKind() string

func (*BatchRunReportsResponse) GetReports

func (x *BatchRunReportsResponse) GetReports() []*RunReportResponse

func (*BatchRunReportsResponse) ProtoMessage

func (*BatchRunReportsResponse) ProtoMessage()

func (*BatchRunReportsResponse) ProtoReflect

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

func (*BatchRunReportsResponse) Reset

func (x *BatchRunReportsResponse) Reset()

func (*BatchRunReportsResponse) String

func (x *BatchRunReportsResponse) String() string

type BetaAnalyticsDataClient

type BetaAnalyticsDataClient interface {
	// Returns a customized report of your Google Analytics event data. Reports
	// contain statistics derived from data collected by the Google Analytics
	// tracking code. The data returned from the API is as a table with columns
	// for the requested dimensions and metrics. Metrics are individual
	// measurements of user activity on your property, such as active users or
	// event count. Dimensions break down metrics across some common criteria,
	// such as country or event name.
	//
	// For a guide to constructing requests & understanding responses, see
	// [Creating a
	// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).
	RunReport(ctx context.Context, in *RunReportRequest, opts ...grpc.CallOption) (*RunReportResponse, error)
	// Returns a customized pivot report of your Google Analytics event data.
	// Pivot reports are more advanced and expressive formats than regular
	// reports. In a pivot report, dimensions are only visible if they are
	// included in a pivot. Multiple pivots can be specified to further dissect
	// your data.
	RunPivotReport(ctx context.Context, in *RunPivotReportRequest, opts ...grpc.CallOption) (*RunPivotReportResponse, error)
	// Returns multiple reports in a batch. All reports must be for the same
	// GA4 Property.
	BatchRunReports(ctx context.Context, in *BatchRunReportsRequest, opts ...grpc.CallOption) (*BatchRunReportsResponse, error)
	// Returns multiple pivot reports in a batch. All reports must be for the same
	// GA4 Property.
	BatchRunPivotReports(ctx context.Context, in *BatchRunPivotReportsRequest, opts ...grpc.CallOption) (*BatchRunPivotReportsResponse, error)
	// Returns metadata for dimensions and metrics available in reporting methods.
	// Used to explore the dimensions and metrics. In this method, a Google
	// Analytics GA4 Property Identifier is specified in the request, and
	// the metadata response includes Custom dimensions and metrics as well as
	// Universal metadata.
	//
	// For example if a custom metric with parameter name `levels_unlocked` is
	// registered to a property, the Metadata response will contain
	// `customEvent:levels_unlocked`. Universal metadata are dimensions and
	// metrics applicable to any property such as `country` and `totalUsers`.
	GetMetadata(ctx context.Context, in *GetMetadataRequest, opts ...grpc.CallOption) (*Metadata, error)
	// Returns a customized report of realtime event data for your property.
	// Events appear in realtime reports seconds after they have been sent to
	// the Google Analytics. Realtime reports show events and usage data for the
	// periods of time ranging from the present moment to 30 minutes ago (up to
	// 60 minutes for Google Analytics 360 properties).
	//
	// For a guide to constructing realtime requests & understanding responses,
	// see [Creating a Realtime
	// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
	RunRealtimeReport(ctx context.Context, in *RunRealtimeReportRequest, opts ...grpc.CallOption) (*RunRealtimeReportResponse, error)
	// This compatibility method lists dimensions and metrics that can be added to
	// a report request and maintain compatibility. This method fails if the
	// request's dimensions and metrics are incompatible.
	//
	// In Google Analytics, reports fail if they request incompatible dimensions
	// and/or metrics; in that case, you will need to remove dimensions and/or
	// metrics from the incompatible report until the report is compatible.
	//
	// The Realtime and Core reports have different compatibility rules. This
	// method checks compatibility for Core reports.
	CheckCompatibility(ctx context.Context, in *CheckCompatibilityRequest, opts ...grpc.CallOption) (*CheckCompatibilityResponse, error)
}

BetaAnalyticsDataClient is the client API for BetaAnalyticsData service.

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

type BetaAnalyticsDataServer

type BetaAnalyticsDataServer interface {
	// Returns a customized report of your Google Analytics event data. Reports
	// contain statistics derived from data collected by the Google Analytics
	// tracking code. The data returned from the API is as a table with columns
	// for the requested dimensions and metrics. Metrics are individual
	// measurements of user activity on your property, such as active users or
	// event count. Dimensions break down metrics across some common criteria,
	// such as country or event name.
	//
	// For a guide to constructing requests & understanding responses, see
	// [Creating a
	// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).
	RunReport(context.Context, *RunReportRequest) (*RunReportResponse, error)
	// Returns a customized pivot report of your Google Analytics event data.
	// Pivot reports are more advanced and expressive formats than regular
	// reports. In a pivot report, dimensions are only visible if they are
	// included in a pivot. Multiple pivots can be specified to further dissect
	// your data.
	RunPivotReport(context.Context, *RunPivotReportRequest) (*RunPivotReportResponse, error)
	// Returns multiple reports in a batch. All reports must be for the same
	// GA4 Property.
	BatchRunReports(context.Context, *BatchRunReportsRequest) (*BatchRunReportsResponse, error)
	// Returns multiple pivot reports in a batch. All reports must be for the same
	// GA4 Property.
	BatchRunPivotReports(context.Context, *BatchRunPivotReportsRequest) (*BatchRunPivotReportsResponse, error)
	// Returns metadata for dimensions and metrics available in reporting methods.
	// Used to explore the dimensions and metrics. In this method, a Google
	// Analytics GA4 Property Identifier is specified in the request, and
	// the metadata response includes Custom dimensions and metrics as well as
	// Universal metadata.
	//
	// For example if a custom metric with parameter name `levels_unlocked` is
	// registered to a property, the Metadata response will contain
	// `customEvent:levels_unlocked`. Universal metadata are dimensions and
	// metrics applicable to any property such as `country` and `totalUsers`.
	GetMetadata(context.Context, *GetMetadataRequest) (*Metadata, error)
	// Returns a customized report of realtime event data for your property.
	// Events appear in realtime reports seconds after they have been sent to
	// the Google Analytics. Realtime reports show events and usage data for the
	// periods of time ranging from the present moment to 30 minutes ago (up to
	// 60 minutes for Google Analytics 360 properties).
	//
	// For a guide to constructing realtime requests & understanding responses,
	// see [Creating a Realtime
	// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
	RunRealtimeReport(context.Context, *RunRealtimeReportRequest) (*RunRealtimeReportResponse, error)
	// This compatibility method lists dimensions and metrics that can be added to
	// a report request and maintain compatibility. This method fails if the
	// request's dimensions and metrics are incompatible.
	//
	// In Google Analytics, reports fail if they request incompatible dimensions
	// and/or metrics; in that case, you will need to remove dimensions and/or
	// metrics from the incompatible report until the report is compatible.
	//
	// The Realtime and Core reports have different compatibility rules. This
	// method checks compatibility for Core reports.
	CheckCompatibility(context.Context, *CheckCompatibilityRequest) (*CheckCompatibilityResponse, error)
}

BetaAnalyticsDataServer is the server API for BetaAnalyticsData service.

type CheckCompatibilityRequest

type CheckCompatibilityRequest struct {

	// A Google Analytics GA4 property identifier whose events are tracked. To
	// learn more, see [where to find your Property
	// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
	// `property` should be the same value as in your `runReport` request.
	//
	// Example: properties/1234
	//
	// Set the Property ID to 0 for compatibility checking on dimensions and
	// metrics common to all properties. In this special mode, this method will
	// not return custom dimensions and metrics.
	Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
	// The dimensions in this report. `dimensions` should be the same value as in
	// your `runReport` request.
	Dimensions []*Dimension `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
	// The metrics in this report. `metrics` should be the same value as in your
	// `runReport` request.
	Metrics []*Metric `protobuf:"bytes,3,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// The filter clause of dimensions. `dimensionFilter` should be the same value
	// as in your `runReport` request.
	DimensionFilter *FilterExpression `protobuf:"bytes,4,opt,name=dimension_filter,json=dimensionFilter,proto3" json:"dimension_filter,omitempty"`
	// The filter clause of metrics. `metricFilter` should be the same value as in
	// your `runReport` request
	MetricFilter *FilterExpression `protobuf:"bytes,5,opt,name=metric_filter,json=metricFilter,proto3" json:"metric_filter,omitempty"`
	// Filters the dimensions and metrics in the response to just this
	// compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”`
	// to only return compatible dimensions & metrics.
	CompatibilityFilter Compatibility `` /* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the `runReport` request should be the same values as in your `runReport` request.

func (*CheckCompatibilityRequest) Descriptor deprecated

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

Deprecated: Use CheckCompatibilityRequest.ProtoReflect.Descriptor instead.

func (*CheckCompatibilityRequest) GetCompatibilityFilter

func (x *CheckCompatibilityRequest) GetCompatibilityFilter() Compatibility

func (*CheckCompatibilityRequest) GetDimensionFilter

func (x *CheckCompatibilityRequest) GetDimensionFilter() *FilterExpression

func (*CheckCompatibilityRequest) GetDimensions

func (x *CheckCompatibilityRequest) GetDimensions() []*Dimension

func (*CheckCompatibilityRequest) GetMetricFilter

func (x *CheckCompatibilityRequest) GetMetricFilter() *FilterExpression

func (*CheckCompatibilityRequest) GetMetrics

func (x *CheckCompatibilityRequest) GetMetrics() []*Metric

func (*CheckCompatibilityRequest) GetProperty

func (x *CheckCompatibilityRequest) GetProperty() string

func (*CheckCompatibilityRequest) ProtoMessage

func (*CheckCompatibilityRequest) ProtoMessage()

func (*CheckCompatibilityRequest) ProtoReflect

func (*CheckCompatibilityRequest) Reset

func (x *CheckCompatibilityRequest) Reset()

func (*CheckCompatibilityRequest) String

func (x *CheckCompatibilityRequest) String() string

type CheckCompatibilityResponse

type CheckCompatibilityResponse struct {

	// The compatibility of each dimension.
	DimensionCompatibilities []*DimensionCompatibility `` /* 133-byte string literal not displayed */
	// The compatibility of each metric.
	MetricCompatibilities []*MetricCompatibility `protobuf:"bytes,2,rep,name=metric_compatibilities,json=metricCompatibilities,proto3" json:"metric_compatibilities,omitempty"`
	// contains filtered or unexported fields
}

The compatibility response with the compatibility of each dimension & metric.

func (*CheckCompatibilityResponse) Descriptor deprecated

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

Deprecated: Use CheckCompatibilityResponse.ProtoReflect.Descriptor instead.

func (*CheckCompatibilityResponse) GetDimensionCompatibilities

func (x *CheckCompatibilityResponse) GetDimensionCompatibilities() []*DimensionCompatibility

func (*CheckCompatibilityResponse) GetMetricCompatibilities

func (x *CheckCompatibilityResponse) GetMetricCompatibilities() []*MetricCompatibility

func (*CheckCompatibilityResponse) ProtoMessage

func (*CheckCompatibilityResponse) ProtoMessage()

func (*CheckCompatibilityResponse) ProtoReflect

func (*CheckCompatibilityResponse) Reset

func (x *CheckCompatibilityResponse) Reset()

func (*CheckCompatibilityResponse) String

func (x *CheckCompatibilityResponse) String() string

type Cohort

type Cohort struct {

	// Assigns a name to this cohort. The dimension `cohort` is valued to this
	// name in a report response. If set, cannot begin with `cohort_` or
	// `RESERVED_`. If not set, cohorts are named by their zero based index
	// `cohort_0`, `cohort_1`, etc.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Dimension used by the cohort. Required and only supports
	// `firstSessionDate`.
	Dimension string `protobuf:"bytes,2,opt,name=dimension,proto3" json:"dimension,omitempty"`
	// The cohort selects users whose first touch date is between start date and
	// end date defined in the `dateRange`. This `dateRange` does not specify the
	// full date range of event data that is present in a cohort report. In a
	// cohort report, this `dateRange` is extended by the granularity and offset
	// present in the `cohortsRange`; event data for the extended reporting date
	// range is present in a cohort report.
	//
	// In a cohort request, this `dateRange` is required and the `dateRanges` in
	// the `RunReportRequest` or `RunPivotReportRequest` must be unspecified.
	//
	// This `dateRange` should generally be aligned with the cohort's granularity.
	// If `CohortsRange` uses daily granularity, this `dateRange` can be a single
	// day. If `CohortsRange` uses weekly granularity, this `dateRange` can be
	// aligned to a week boundary, starting at Sunday and ending Saturday. If
	// `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to
	// a month, starting at the first and ending on the last day of the month.
	DateRange *DateRange `protobuf:"bytes,3,opt,name=date_range,json=dateRange,proto3" json:"date_range,omitempty"`
	// contains filtered or unexported fields
}

Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort.

func (*Cohort) Descriptor deprecated

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

Deprecated: Use Cohort.ProtoReflect.Descriptor instead.

func (*Cohort) GetDateRange

func (x *Cohort) GetDateRange() *DateRange

func (*Cohort) GetDimension

func (x *Cohort) GetDimension() string

func (*Cohort) GetName

func (x *Cohort) GetName() string

func (*Cohort) ProtoMessage

func (*Cohort) ProtoMessage()

func (*Cohort) ProtoReflect

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

func (*Cohort) Reset

func (x *Cohort) Reset()

func (*Cohort) String

func (x *Cohort) String() string

type CohortReportSettings

type CohortReportSettings struct {

	// If true, accumulates the result from first touch day to the end day. Not
	// supported in `RunReportRequest`.
	Accumulate bool `protobuf:"varint,1,opt,name=accumulate,proto3" json:"accumulate,omitempty"`
	// contains filtered or unexported fields
}

Optional settings of a cohort report.

func (*CohortReportSettings) Descriptor deprecated

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

Deprecated: Use CohortReportSettings.ProtoReflect.Descriptor instead.

func (*CohortReportSettings) GetAccumulate

func (x *CohortReportSettings) GetAccumulate() bool

func (*CohortReportSettings) ProtoMessage

func (*CohortReportSettings) ProtoMessage()

func (*CohortReportSettings) ProtoReflect

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

func (*CohortReportSettings) Reset

func (x *CohortReportSettings) Reset()

func (*CohortReportSettings) String

func (x *CohortReportSettings) String() string

type CohortSpec

type CohortSpec struct {

	// Defines the selection criteria to group users into cohorts.
	//
	// Most cohort reports define only a single cohort. If multiple cohorts are
	// specified, each cohort can be recognized in the report by their name.
	Cohorts []*Cohort `protobuf:"bytes,1,rep,name=cohorts,proto3" json:"cohorts,omitempty"`
	// Cohort reports follow cohorts over an extended reporting date range. This
	// range specifies an offset duration to follow the cohorts over.
	CohortsRange *CohortsRange `protobuf:"bytes,2,opt,name=cohorts_range,json=cohortsRange,proto3" json:"cohorts_range,omitempty"`
	// Optional settings for a cohort report.
	CohortReportSettings *CohortReportSettings `protobuf:"bytes,3,opt,name=cohort_report_settings,json=cohortReportSettings,proto3" json:"cohort_report_settings,omitempty"`
	// contains filtered or unexported fields
}

The specification of cohorts for a cohort report.

Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object.

For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples).

The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.

func (*CohortSpec) Descriptor deprecated

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

Deprecated: Use CohortSpec.ProtoReflect.Descriptor instead.

func (*CohortSpec) GetCohortReportSettings

func (x *CohortSpec) GetCohortReportSettings() *CohortReportSettings

func (*CohortSpec) GetCohorts

func (x *CohortSpec) GetCohorts() []*Cohort

func (*CohortSpec) GetCohortsRange

func (x *CohortSpec) GetCohortsRange() *CohortsRange

func (*CohortSpec) ProtoMessage

func (*CohortSpec) ProtoMessage()

func (*CohortSpec) ProtoReflect

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

func (*CohortSpec) Reset

func (x *CohortSpec) Reset()

func (*CohortSpec) String

func (x *CohortSpec) String() string

type CohortsRange

type CohortsRange struct {

	// Required. The granularity used to interpret the `startOffset` and
	// `endOffset` for the extended reporting date range for a cohort report.
	Granularity CohortsRange_Granularity `` /* 135-byte string literal not displayed */
	// `startOffset` specifies the start date of the extended reporting date range
	// for a cohort report. `startOffset` is commonly set to 0 so that reports
	// contain data from the acquisition of the cohort forward.
	//
	// If `granularity` is `DAILY`, the `startDate` of the extended reporting date
	// range is `startDate` of the cohort plus `startOffset` days.
	//
	// If `granularity` is `WEEKLY`, the `startDate` of the extended reporting
	// date range is `startDate` of the cohort plus `startOffset * 7` days.
	//
	// If `granularity` is `MONTHLY`, the `startDate` of the extended reporting
	// date range is `startDate` of the cohort plus `startOffset * 30` days.
	StartOffset int32 `protobuf:"varint,2,opt,name=start_offset,json=startOffset,proto3" json:"start_offset,omitempty"`
	// Required. `endOffset` specifies the end date of the extended reporting date
	// range for a cohort report. `endOffset` can be any positive integer but is
	// commonly set to 5 to 10 so that reports contain data on the cohort for the
	// next several granularity time periods.
	//
	// If `granularity` is `DAILY`, the `endDate` of the extended reporting date
	// range is `endDate` of the cohort plus `endOffset` days.
	//
	// If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date
	// range is `endDate` of the cohort plus `endOffset * 7` days.
	//
	// If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date
	// range is `endDate` of the cohort plus `endOffset * 30` days.
	EndOffset int32 `protobuf:"varint,3,opt,name=end_offset,json=endOffset,proto3" json:"end_offset,omitempty"`
	// contains filtered or unexported fields
}

Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.

func (*CohortsRange) Descriptor deprecated

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

Deprecated: Use CohortsRange.ProtoReflect.Descriptor instead.

func (*CohortsRange) GetEndOffset

func (x *CohortsRange) GetEndOffset() int32

func (*CohortsRange) GetGranularity

func (x *CohortsRange) GetGranularity() CohortsRange_Granularity

func (*CohortsRange) GetStartOffset

func (x *CohortsRange) GetStartOffset() int32

func (*CohortsRange) ProtoMessage

func (*CohortsRange) ProtoMessage()

func (*CohortsRange) ProtoReflect

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

func (*CohortsRange) Reset

func (x *CohortsRange) Reset()

func (*CohortsRange) String

func (x *CohortsRange) String() string

type CohortsRange_Granularity

type CohortsRange_Granularity int32

The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report.

const (
	// Should never be specified.
	CohortsRange_GRANULARITY_UNSPECIFIED CohortsRange_Granularity = 0
	// Daily granularity. Commonly used if the cohort's `dateRange` is a single
	// day and the request contains `cohortNthDay`.
	CohortsRange_DAILY CohortsRange_Granularity = 1
	// Weekly granularity. Commonly used if the cohort's `dateRange` is a week
	// in duration (starting on Sunday and ending on Saturday) and the request
	// contains `cohortNthWeek`.
	CohortsRange_WEEKLY CohortsRange_Granularity = 2
	// Monthly granularity. Commonly used if the cohort's `dateRange` is a month
	// in duration and the request contains `cohortNthMonth`.
	CohortsRange_MONTHLY CohortsRange_Granularity = 3
)

func (CohortsRange_Granularity) Descriptor

func (CohortsRange_Granularity) Enum

func (CohortsRange_Granularity) EnumDescriptor deprecated

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

Deprecated: Use CohortsRange_Granularity.Descriptor instead.

func (CohortsRange_Granularity) Number

func (CohortsRange_Granularity) String

func (x CohortsRange_Granularity) String() string

func (CohortsRange_Granularity) Type

type Compatibility

type Compatibility int32

The compatibility types for a single dimension or metric.

const (
	// Unspecified compatibility.
	Compatibility_COMPATIBILITY_UNSPECIFIED Compatibility = 0
	// The dimension or metric is compatible. This dimension or metric can be
	// successfully added to a report.
	Compatibility_COMPATIBLE Compatibility = 1
	// The dimension or metric is incompatible. This dimension or metric cannot be
	// successfully added to a report.
	Compatibility_INCOMPATIBLE Compatibility = 2
)

func (Compatibility) Descriptor

func (Compatibility) Enum

func (x Compatibility) Enum() *Compatibility

func (Compatibility) EnumDescriptor deprecated

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

Deprecated: Use Compatibility.Descriptor instead.

func (Compatibility) Number

func (Compatibility) String

func (x Compatibility) String() string

func (Compatibility) Type

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". Requests are allowed up to 9 dimensions.

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 DimensionCompatibility

type DimensionCompatibility struct {

	// The dimension metadata contains the API name for this compatibility
	// information. The dimension metadata also contains other helpful information
	// like the UI name and description.
	DimensionMetadata *DimensionMetadata `protobuf:"bytes,1,opt,name=dimension_metadata,json=dimensionMetadata,proto3,oneof" json:"dimension_metadata,omitempty"`
	// The compatibility of this dimension. If the compatibility is COMPATIBLE,
	// this dimension can be successfully added to the report.
	Compatibility *Compatibility `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

The compatibility for a single dimension.

func (*DimensionCompatibility) Descriptor deprecated

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

Deprecated: Use DimensionCompatibility.ProtoReflect.Descriptor instead.

func (*DimensionCompatibility) GetCompatibility

func (x *DimensionCompatibility) GetCompatibility() Compatibility

func (*DimensionCompatibility) GetDimensionMetadata

func (x *DimensionCompatibility) GetDimensionMetadata() *DimensionMetadata

func (*DimensionCompatibility) ProtoMessage

func (*DimensionCompatibility) ProtoMessage()

func (*DimensionCompatibility) ProtoReflect

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

func (*DimensionCompatibility) Reset

func (x *DimensionCompatibility) Reset()

func (*DimensionCompatibility) String

func (x *DimensionCompatibility) 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 DimensionMetadata

type DimensionMetadata struct {

	// This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
	// example, `eventName`.
	ApiName string `protobuf:"bytes,1,opt,name=api_name,json=apiName,proto3" json:"api_name,omitempty"`
	// This dimension's name within the Google Analytics user interface. For
	// example, `Event name`.
	UiName string `protobuf:"bytes,2,opt,name=ui_name,json=uiName,proto3" json:"ui_name,omitempty"`
	// Description of how this dimension is used and calculated.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Still usable but deprecated names for this dimension. If populated, this
	// dimension is available by either `apiName` or one of `deprecatedApiNames`
	// for a period of time. After the deprecation period, the dimension will be
	// available only by `apiName`.
	DeprecatedApiNames []string `protobuf:"bytes,4,rep,name=deprecated_api_names,json=deprecatedApiNames,proto3" json:"deprecated_api_names,omitempty"`
	// True if the dimension is a custom dimension for this property.
	CustomDefinition bool `protobuf:"varint,5,opt,name=custom_definition,json=customDefinition,proto3" json:"custom_definition,omitempty"`
	// The display name of the category that this dimension belongs to. Similar
	// dimensions and metrics are categorized together.
	Category string `protobuf:"bytes,7,opt,name=category,proto3" json:"category,omitempty"`
	// contains filtered or unexported fields
}

Explains a dimension.

func (*DimensionMetadata) Descriptor deprecated

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

Deprecated: Use DimensionMetadata.ProtoReflect.Descriptor instead.

func (*DimensionMetadata) GetApiName

func (x *DimensionMetadata) GetApiName() string

func (*DimensionMetadata) GetCategory

func (x *DimensionMetadata) GetCategory() string

func (*DimensionMetadata) GetCustomDefinition

func (x *DimensionMetadata) GetCustomDefinition() bool

func (*DimensionMetadata) GetDeprecatedApiNames

func (x *DimensionMetadata) GetDeprecatedApiNames() []string

func (*DimensionMetadata) GetDescription

func (x *DimensionMetadata) GetDescription() string

func (*DimensionMetadata) GetUiName

func (x *DimensionMetadata) GetUiName() string

func (*DimensionMetadata) ProtoMessage

func (*DimensionMetadata) ProtoMessage()

func (*DimensionMetadata) ProtoReflect

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

func (*DimensionMetadata) Reset

func (x *DimensionMetadata) Reset()

func (*DimensionMetadata) String

func (x *DimensionMetadata) 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 Filter

type Filter struct {

	// The dimension name or metric name.
	//
	// In most methods, dimensions & metrics can be used for the first time in
	// this field. However in a RunPivotReportRequest, this field must be
	// additionally specified by name in the RunPivotReportRequest's 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() *Filter_BetweenFilter

func (*Filter) GetFieldName

func (x *Filter) GetFieldName() string

func (*Filter) GetInListFilter

func (x *Filter) GetInListFilter() *Filter_InListFilter

func (*Filter) GetNumericFilter

func (x *Filter) GetNumericFilter() *Filter_NumericFilter

func (*Filter) GetOneFilter

func (m *Filter) GetOneFilter() isFilter_OneFilter

func (*Filter) GetStringFilter

func (x *Filter) GetStringFilter() *Filter_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 {

	// 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 (*Filter_BetweenFilter) Descriptor deprecated

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

Deprecated: Use Filter_BetweenFilter.ProtoReflect.Descriptor instead.

func (*Filter_BetweenFilter) GetFromValue

func (x *Filter_BetweenFilter) GetFromValue() *NumericValue

func (*Filter_BetweenFilter) GetToValue

func (x *Filter_BetweenFilter) GetToValue() *NumericValue

func (*Filter_BetweenFilter) ProtoMessage

func (*Filter_BetweenFilter) ProtoMessage()

func (*Filter_BetweenFilter) ProtoReflect

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

func (*Filter_BetweenFilter) Reset

func (x *Filter_BetweenFilter) Reset()

func (*Filter_BetweenFilter) String

func (x *Filter_BetweenFilter) String() string

type Filter_BetweenFilter_

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

type Filter_InListFilter

type Filter_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 (*Filter_InListFilter) Descriptor deprecated

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

Deprecated: Use Filter_InListFilter.ProtoReflect.Descriptor instead.

func (*Filter_InListFilter) GetCaseSensitive

func (x *Filter_InListFilter) GetCaseSensitive() bool

func (*Filter_InListFilter) GetValues

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

func (*Filter_InListFilter) ProtoMessage

func (*Filter_InListFilter) ProtoMessage()

func (*Filter_InListFilter) ProtoReflect

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

func (*Filter_InListFilter) Reset

func (x *Filter_InListFilter) Reset()

func (*Filter_InListFilter) String

func (x *Filter_InListFilter) String() string

type Filter_InListFilter_

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

type Filter_NumericFilter

type Filter_NumericFilter struct {

	// The operation type for this filter.
	Operation Filter_NumericFilter_Operation `` /* 137-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 (*Filter_NumericFilter) Descriptor deprecated

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

Deprecated: Use Filter_NumericFilter.ProtoReflect.Descriptor instead.

func (*Filter_NumericFilter) GetOperation

func (*Filter_NumericFilter) GetValue

func (x *Filter_NumericFilter) GetValue() *NumericValue

func (*Filter_NumericFilter) ProtoMessage

func (*Filter_NumericFilter) ProtoMessage()

func (*Filter_NumericFilter) ProtoReflect

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

func (*Filter_NumericFilter) Reset

func (x *Filter_NumericFilter) Reset()

func (*Filter_NumericFilter) String

func (x *Filter_NumericFilter) String() string

type Filter_NumericFilter_

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

type Filter_NumericFilter_Operation

type Filter_NumericFilter_Operation int32

The operation applied to a numeric filter

const (
	// Unspecified.
	Filter_NumericFilter_OPERATION_UNSPECIFIED Filter_NumericFilter_Operation = 0
	// Equal
	Filter_NumericFilter_EQUAL Filter_NumericFilter_Operation = 1
	// Less than
	Filter_NumericFilter_LESS_THAN Filter_NumericFilter_Operation = 2
	// Less than or equal
	Filter_NumericFilter_LESS_THAN_OR_EQUAL Filter_NumericFilter_Operation = 3
	// Greater than
	Filter_NumericFilter_GREATER_THAN Filter_NumericFilter_Operation = 4
	// Greater than or equal
	Filter_NumericFilter_GREATER_THAN_OR_EQUAL Filter_NumericFilter_Operation = 5
)

func (Filter_NumericFilter_Operation) Descriptor

func (Filter_NumericFilter_Operation) Enum

func (Filter_NumericFilter_Operation) EnumDescriptor deprecated

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

Deprecated: Use Filter_NumericFilter_Operation.Descriptor instead.

func (Filter_NumericFilter_Operation) Number

func (Filter_NumericFilter_Operation) String

func (Filter_NumericFilter_Operation) Type

type Filter_StringFilter

type Filter_StringFilter struct {

	// The match type for this filter.
	MatchType Filter_StringFilter_MatchType `` /* 153-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 (*Filter_StringFilter) Descriptor deprecated

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

Deprecated: Use Filter_StringFilter.ProtoReflect.Descriptor instead.

func (*Filter_StringFilter) GetCaseSensitive

func (x *Filter_StringFilter) GetCaseSensitive() bool

func (*Filter_StringFilter) GetMatchType

func (*Filter_StringFilter) GetValue

func (x *Filter_StringFilter) GetValue() string

func (*Filter_StringFilter) ProtoMessage

func (*Filter_StringFilter) ProtoMessage()

func (*Filter_StringFilter) ProtoReflect

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

func (*Filter_StringFilter) Reset

func (x *Filter_StringFilter) Reset()

func (*Filter_StringFilter) String

func (x *Filter_StringFilter) String() string

type Filter_StringFilter_

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

type Filter_StringFilter_MatchType

type Filter_StringFilter_MatchType int32

The match type of a string filter

const (
	// Unspecified
	Filter_StringFilter_MATCH_TYPE_UNSPECIFIED Filter_StringFilter_MatchType = 0
	// Exact match of the string value.
	Filter_StringFilter_EXACT Filter_StringFilter_MatchType = 1
	// Begins with the string value.
	Filter_StringFilter_BEGINS_WITH Filter_StringFilter_MatchType = 2
	// Ends with the string value.
	Filter_StringFilter_ENDS_WITH Filter_StringFilter_MatchType = 3
	// Contains the string value.
	Filter_StringFilter_CONTAINS Filter_StringFilter_MatchType = 4
	// Full match for the regular expression with the string value.
	Filter_StringFilter_FULL_REGEXP Filter_StringFilter_MatchType = 5
	// Partial match for the regular expression with the string value.
	Filter_StringFilter_PARTIAL_REGEXP Filter_StringFilter_MatchType = 6
)

func (Filter_StringFilter_MatchType) Descriptor

func (Filter_StringFilter_MatchType) Enum

func (Filter_StringFilter_MatchType) EnumDescriptor deprecated

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

Deprecated: Use Filter_StringFilter_MatchType.Descriptor instead.

func (Filter_StringFilter_MatchType) Number

func (Filter_StringFilter_MatchType) String

func (Filter_StringFilter_MatchType) Type

type GetMetadataRequest

type GetMetadataRequest struct {

	// Required. The resource name of the metadata to retrieve. This name field is
	// specified in the URL path and not URL parameters. Property is a numeric
	// Google Analytics GA4 Property identifier. To learn more, see [where to find
	// your Property
	// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
	//
	// Example: properties/1234/metadata
	//
	// Set the Property ID to 0 for dimensions and metrics common to all
	// properties. In this special mode, this method will not return custom
	// dimensions and metrics.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for a property's dimension and metric metadata.

func (*GetMetadataRequest) Descriptor deprecated

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

Deprecated: Use GetMetadataRequest.ProtoReflect.Descriptor instead.

func (*GetMetadataRequest) GetName

func (x *GetMetadataRequest) GetName() string

func (*GetMetadataRequest) ProtoMessage

func (*GetMetadataRequest) ProtoMessage()

func (*GetMetadataRequest) ProtoReflect

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

func (*GetMetadataRequest) Reset

func (x *GetMetadataRequest) Reset()

func (*GetMetadataRequest) String

func (x *GetMetadataRequest) String() string

type Metadata

type Metadata struct {

	// Resource name of this metadata.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// The dimension descriptions.
	Dimensions []*DimensionMetadata `protobuf:"bytes,1,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
	// The metric descriptions.
	Metrics []*MetricMetadata `protobuf:"bytes,2,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

The dimensions and metrics currently accepted in reporting methods.

func (*Metadata) Descriptor deprecated

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

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetDimensions

func (x *Metadata) GetDimensions() []*DimensionMetadata

func (*Metadata) GetMetrics

func (x *Metadata) GetMetrics() []*MetricMetadata

func (*Metadata) GetName

func (x *Metadata) GetName() string

func (*Metadata) ProtoMessage

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect

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

func (*Metadata) Reset

func (x *Metadata) Reset()

func (*Metadata) String

func (x *Metadata) String() string

type Metric

type Metric struct {

	// The name of the metric. See the [API
	// Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
	// for the list of metric names.
	//
	// If `expression` is specified, `name` can be any string that you would like
	// within the allowed character set. For example if `expression` is
	// `screenPageViews/sessions`, you could call that metric's name =
	// `viewsPerSession`. Metric names that you choose must match the regular
	// expression `^[a-zA-Z0-9_]$`.
	//
	// Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
	// `expression`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A mathematical expression for derived metrics. For example, the metric
	// Event count per user is `eventCount/totalUsers`.
	Expression string `protobuf:"bytes,2,opt,name=expression,proto3" json:"expression,omitempty"`
	// Indicates if a metric is invisible in the report response. If a metric is
	// invisible, the metric will not produce a column in the response, but can be
	// used in `metricFilter`, `orderBys`, or a metric `expression`.
	Invisible bool `protobuf:"varint,3,opt,name=invisible,proto3" json:"invisible,omitempty"`
	// contains filtered or unexported fields
}

The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.

func (*Metric) Descriptor deprecated

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

Deprecated: Use Metric.ProtoReflect.Descriptor instead.

func (*Metric) GetExpression

func (x *Metric) GetExpression() string

func (*Metric) GetInvisible

func (x *Metric) GetInvisible() bool

func (*Metric) GetName

func (x *Metric) GetName() string

func (*Metric) ProtoMessage

func (*Metric) ProtoMessage()

func (*Metric) ProtoReflect

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

func (*Metric) Reset

func (x *Metric) Reset()

func (*Metric) String

func (x *Metric) String() string

type MetricAggregation

type MetricAggregation int32

Represents aggregation of metrics.

const (
	// Unspecified operator.
	MetricAggregation_METRIC_AGGREGATION_UNSPECIFIED MetricAggregation = 0
	// SUM operator.
	MetricAggregation_TOTAL MetricAggregation = 1
	// Minimum operator.
	MetricAggregation_MINIMUM MetricAggregation = 5
	// Maximum operator.
	MetricAggregation_MAXIMUM MetricAggregation = 6
	// Count operator.
	MetricAggregation_COUNT MetricAggregation = 4
)

func (MetricAggregation) Descriptor

func (MetricAggregation) Enum

func (MetricAggregation) EnumDescriptor deprecated

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

Deprecated: Use MetricAggregation.Descriptor instead.

func (MetricAggregation) Number

func (MetricAggregation) String

func (x MetricAggregation) String() string

func (MetricAggregation) Type

type MetricCompatibility

type MetricCompatibility struct {

	// The metric metadata contains the API name for this compatibility
	// information. The metric metadata also contains other helpful information
	// like the UI name and description.
	MetricMetadata *MetricMetadata `protobuf:"bytes,1,opt,name=metric_metadata,json=metricMetadata,proto3,oneof" json:"metric_metadata,omitempty"`
	// The compatibility of this metric. If the compatibility is COMPATIBLE,
	// this metric can be successfully added to the report.
	Compatibility *Compatibility `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

The compatibility for a single metric.

func (*MetricCompatibility) Descriptor deprecated

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

Deprecated: Use MetricCompatibility.ProtoReflect.Descriptor instead.

func (*MetricCompatibility) GetCompatibility

func (x *MetricCompatibility) GetCompatibility() Compatibility

func (*MetricCompatibility) GetMetricMetadata

func (x *MetricCompatibility) GetMetricMetadata() *MetricMetadata

func (*MetricCompatibility) ProtoMessage

func (*MetricCompatibility) ProtoMessage()

func (*MetricCompatibility) ProtoReflect

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

func (*MetricCompatibility) Reset

func (x *MetricCompatibility) Reset()

func (*MetricCompatibility) String

func (x *MetricCompatibility) 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.v1beta.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 MetricMetadata

type MetricMetadata struct {

	// A metric name. Useable in [Metric](#Metric)'s `name`. For example,
	// `eventCount`.
	ApiName string `protobuf:"bytes,1,opt,name=api_name,json=apiName,proto3" json:"api_name,omitempty"`
	// This metric's name within the Google Analytics user interface. For example,
	// `Event count`.
	UiName string `protobuf:"bytes,2,opt,name=ui_name,json=uiName,proto3" json:"ui_name,omitempty"`
	// Description of how this metric is used and calculated.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Still usable but deprecated names for this metric. If populated, this
	// metric is available by either `apiName` or one of `deprecatedApiNames`
	// for a period of time. After the deprecation period, the metric will be
	// available only by `apiName`.
	DeprecatedApiNames []string `protobuf:"bytes,4,rep,name=deprecated_api_names,json=deprecatedApiNames,proto3" json:"deprecated_api_names,omitempty"`
	// The type of this metric.
	Type MetricType `protobuf:"varint,5,opt,name=type,proto3,enum=google.analytics.data.v1beta.MetricType" json:"type,omitempty"`
	// The mathematical expression for this derived metric. Can be used in
	// [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics
	// are not expressions, and for non-expressions, this field is empty.
	Expression string `protobuf:"bytes,6,opt,name=expression,proto3" json:"expression,omitempty"`
	// True if the metric is a custom metric for this property.
	CustomDefinition bool `protobuf:"varint,7,opt,name=custom_definition,json=customDefinition,proto3" json:"custom_definition,omitempty"`
	// If reasons are specified, your access is blocked to this metric for this
	// property. API requests from you to this property for this metric will
	// succeed; however, the report will contain only zeros for this metric. API
	// requests with metric filters on blocked metrics will fail. If reasons are
	// empty, you have access to this metric.
	//
	// To learn more, see [Access and data-restriction
	// management](https://support.google.com/analytics/answer/10851388).
	BlockedReasons []MetricMetadata_BlockedReason `` /* 174-byte string literal not displayed */
	// The display name of the category that this metrics belongs to. Similar
	// dimensions and metrics are categorized together.
	Category string `protobuf:"bytes,10,opt,name=category,proto3" json:"category,omitempty"`
	// contains filtered or unexported fields
}

Explains a metric.

func (*MetricMetadata) Descriptor deprecated

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

Deprecated: Use MetricMetadata.ProtoReflect.Descriptor instead.

func (*MetricMetadata) GetApiName

func (x *MetricMetadata) GetApiName() string

func (*MetricMetadata) GetBlockedReasons

func (x *MetricMetadata) GetBlockedReasons() []MetricMetadata_BlockedReason

func (*MetricMetadata) GetCategory

func (x *MetricMetadata) GetCategory() string

func (*MetricMetadata) GetCustomDefinition

func (x *MetricMetadata) GetCustomDefinition() bool

func (*MetricMetadata) GetDeprecatedApiNames

func (x *MetricMetadata) GetDeprecatedApiNames() []string

func (*MetricMetadata) GetDescription

func (x *MetricMetadata) GetDescription() string

func (*MetricMetadata) GetExpression

func (x *MetricMetadata) GetExpression() string

func (*MetricMetadata) GetType

func (x *MetricMetadata) GetType() MetricType

func (*MetricMetadata) GetUiName

func (x *MetricMetadata) GetUiName() string

func (*MetricMetadata) ProtoMessage

func (*MetricMetadata) ProtoMessage()

func (*MetricMetadata) ProtoReflect

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

func (*MetricMetadata) Reset

func (x *MetricMetadata) Reset()

func (*MetricMetadata) String

func (x *MetricMetadata) String() string

type MetricMetadata_BlockedReason

type MetricMetadata_BlockedReason int32

Justifications for why this metric is blocked.

const (
	// Will never be specified in API response.
	MetricMetadata_BLOCKED_REASON_UNSPECIFIED MetricMetadata_BlockedReason = 0
	// If present, your access is blocked to revenue related metrics for this
	// property, and this metric is revenue related.
	MetricMetadata_NO_REVENUE_METRICS MetricMetadata_BlockedReason = 1
	// If present, your access is blocked to cost related metrics for this
	// property, and this metric is cost related.
	MetricMetadata_NO_COST_METRICS MetricMetadata_BlockedReason = 2
)

func (MetricMetadata_BlockedReason) Descriptor

func (MetricMetadata_BlockedReason) Enum

func (MetricMetadata_BlockedReason) EnumDescriptor deprecated

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

Deprecated: Use MetricMetadata_BlockedReason.Descriptor instead.

func (MetricMetadata_BlockedReason) Number

func (MetricMetadata_BlockedReason) String

func (MetricMetadata_BlockedReason) Type

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 MinuteRange

type MinuteRange struct {

	// The inclusive start minute for the query as a number of minutes before now.
	// For example, `"startMinutesAgo": 29` specifies the report should include
	// event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`.
	//
	// If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
	// properties can request up to the last 30 minutes of event data
	// (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
	// the last 60 minutes of event data (`startMinutesAgo <= 59`).
	StartMinutesAgo *int32 `protobuf:"varint,1,opt,name=start_minutes_ago,json=startMinutesAgo,proto3,oneof" json:"start_minutes_ago,omitempty"`
	// The inclusive end minute for the query as a number of minutes before now.
	// Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
	// specifies the report should include event data from prior to 15 minutes
	// ago.
	//
	// If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
	// properties can request any minute in the last 30 minutes of event data
	// (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
	// minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
	EndMinutesAgo *int32 `protobuf:"varint,2,opt,name=end_minutes_ago,json=endMinutesAgo,proto3,oneof" json:"end_minutes_ago,omitempty"`
	// Assigns a name to this minute 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, minute 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 minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.

func (*MinuteRange) Descriptor deprecated

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

Deprecated: Use MinuteRange.ProtoReflect.Descriptor instead.

func (*MinuteRange) GetEndMinutesAgo

func (x *MinuteRange) GetEndMinutesAgo() int32

func (*MinuteRange) GetName

func (x *MinuteRange) GetName() string

func (*MinuteRange) GetStartMinutesAgo

func (x *MinuteRange) GetStartMinutesAgo() int32

func (*MinuteRange) ProtoMessage

func (*MinuteRange) ProtoMessage()

func (*MinuteRange) ProtoReflect

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

func (*MinuteRange) Reset

func (x *MinuteRange) Reset()

func (*MinuteRange) String

func (x *MinuteRange) String() string

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 OrderBy

type OrderBy struct {

	// Specify one type of order by for `OrderBy`.
	//
	// Types that are assignable to OneOrderBy:
	//
	//	*OrderBy_Metric
	//	*OrderBy_Dimension
	//	*OrderBy_Pivot
	OneOrderBy isOrderBy_OneOrderBy `protobuf_oneof:"one_order_by"`
	// If true, sorts by descending order.
	Desc bool `protobuf:"varint,4,opt,name=desc,proto3" json:"desc,omitempty"`
	// contains filtered or unexported fields
}

Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering.

func (*OrderBy) Descriptor deprecated

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

Deprecated: Use OrderBy.ProtoReflect.Descriptor instead.

func (*OrderBy) GetDesc

func (x *OrderBy) GetDesc() bool

func (*OrderBy) GetDimension

func (x *OrderBy) GetDimension() *OrderBy_DimensionOrderBy

func (*OrderBy) GetMetric

func (x *OrderBy) GetMetric() *OrderBy_MetricOrderBy

func (*OrderBy) GetOneOrderBy

func (m *OrderBy) GetOneOrderBy() isOrderBy_OneOrderBy

func (*OrderBy) GetPivot

func (x *OrderBy) GetPivot() *OrderBy_PivotOrderBy

func (*OrderBy) ProtoMessage

func (*OrderBy) ProtoMessage()

func (*OrderBy) ProtoReflect

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

func (*OrderBy) Reset

func (x *OrderBy) Reset()

func (*OrderBy) String

func (x *OrderBy) String() string

type OrderBy_Dimension

type OrderBy_Dimension struct {
	// Sorts results by a dimension's values.
	Dimension *OrderBy_DimensionOrderBy `protobuf:"bytes,2,opt,name=dimension,proto3,oneof"`
}

type OrderBy_DimensionOrderBy

type OrderBy_DimensionOrderBy struct {

	// A dimension name in the request to order by.
	DimensionName string `protobuf:"bytes,1,opt,name=dimension_name,json=dimensionName,proto3" json:"dimension_name,omitempty"`
	// Controls the rule for dimension value ordering.
	OrderType OrderBy_DimensionOrderBy_OrderType `` /* 158-byte string literal not displayed */
	// contains filtered or unexported fields
}

Sorts by dimension values.

func (*OrderBy_DimensionOrderBy) Descriptor deprecated

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

Deprecated: Use OrderBy_DimensionOrderBy.ProtoReflect.Descriptor instead.

func (*OrderBy_DimensionOrderBy) GetDimensionName

func (x *OrderBy_DimensionOrderBy) GetDimensionName() string

func (*OrderBy_DimensionOrderBy) GetOrderType

func (*OrderBy_DimensionOrderBy) ProtoMessage

func (*OrderBy_DimensionOrderBy) ProtoMessage()

func (*OrderBy_DimensionOrderBy) ProtoReflect

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

func (*OrderBy_DimensionOrderBy) Reset

func (x *OrderBy_DimensionOrderBy) Reset()

func (*OrderBy_DimensionOrderBy) String

func (x *OrderBy_DimensionOrderBy) String() string

type OrderBy_DimensionOrderBy_OrderType

type OrderBy_DimensionOrderBy_OrderType int32

Rule to order the string dimension values by.

const (
	// Unspecified.
	OrderBy_DimensionOrderBy_ORDER_TYPE_UNSPECIFIED OrderBy_DimensionOrderBy_OrderType = 0
	// Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" <
	// "b" < "z".
	OrderBy_DimensionOrderBy_ALPHANUMERIC OrderBy_DimensionOrderBy_OrderType = 1
	// Case insensitive alphanumeric sort by lower case Unicode code point.
	// For example, "2" < "A" < "b" < "X" < "z".
	OrderBy_DimensionOrderBy_CASE_INSENSITIVE_ALPHANUMERIC OrderBy_DimensionOrderBy_OrderType = 2
	// Dimension values are converted to numbers before sorting. For example
	// in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" <
	// "25". Non-numeric dimension values all have equal ordering value below
	// all numeric values.
	OrderBy_DimensionOrderBy_NUMERIC OrderBy_DimensionOrderBy_OrderType = 3
)

func (OrderBy_DimensionOrderBy_OrderType) Descriptor

func (OrderBy_DimensionOrderBy_OrderType) Enum

func (OrderBy_DimensionOrderBy_OrderType) EnumDescriptor deprecated

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

Deprecated: Use OrderBy_DimensionOrderBy_OrderType.Descriptor instead.

func (OrderBy_DimensionOrderBy_OrderType) Number

func (OrderBy_DimensionOrderBy_OrderType) String

func (OrderBy_DimensionOrderBy_OrderType) Type

type OrderBy_Metric

type OrderBy_Metric struct {
	// Sorts results by a metric's values.
	Metric *OrderBy_MetricOrderBy `protobuf:"bytes,1,opt,name=metric,proto3,oneof"`
}

type OrderBy_MetricOrderBy

type OrderBy_MetricOrderBy struct {

	// A metric name in the request to order by.
	MetricName string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
	// contains filtered or unexported fields
}

Sorts by metric values.

func (*OrderBy_MetricOrderBy) Descriptor deprecated

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

Deprecated: Use OrderBy_MetricOrderBy.ProtoReflect.Descriptor instead.

func (*OrderBy_MetricOrderBy) GetMetricName

func (x *OrderBy_MetricOrderBy) GetMetricName() string

func (*OrderBy_MetricOrderBy) ProtoMessage

func (*OrderBy_MetricOrderBy) ProtoMessage()

func (*OrderBy_MetricOrderBy) ProtoReflect

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

func (*OrderBy_MetricOrderBy) Reset

func (x *OrderBy_MetricOrderBy) Reset()

func (*OrderBy_MetricOrderBy) String

func (x *OrderBy_MetricOrderBy) String() string

type OrderBy_Pivot

type OrderBy_Pivot struct {
	// Sorts results by a metric's values within a pivot column group.
	Pivot *OrderBy_PivotOrderBy `protobuf:"bytes,3,opt,name=pivot,proto3,oneof"`
}

type OrderBy_PivotOrderBy

type OrderBy_PivotOrderBy struct {

	// In the response to order by, order rows by this column. Must be a metric
	// name from the request.
	MetricName string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
	// Used to select a dimension name and value pivot. If multiple pivot
	// selections are given, the sort occurs on rows where all pivot selection
	// dimension name and value pairs match the row's dimension name and value
	// pair.
	PivotSelections []*OrderBy_PivotOrderBy_PivotSelection `protobuf:"bytes,2,rep,name=pivot_selections,json=pivotSelections,proto3" json:"pivot_selections,omitempty"`
	// contains filtered or unexported fields
}

Sorts by a pivot column group.

func (*OrderBy_PivotOrderBy) Descriptor deprecated

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

Deprecated: Use OrderBy_PivotOrderBy.ProtoReflect.Descriptor instead.

func (*OrderBy_PivotOrderBy) GetMetricName

func (x *OrderBy_PivotOrderBy) GetMetricName() string

func (*OrderBy_PivotOrderBy) GetPivotSelections

func (x *OrderBy_PivotOrderBy) GetPivotSelections() []*OrderBy_PivotOrderBy_PivotSelection

func (*OrderBy_PivotOrderBy) ProtoMessage

func (*OrderBy_PivotOrderBy) ProtoMessage()

func (*OrderBy_PivotOrderBy) ProtoReflect

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

func (*OrderBy_PivotOrderBy) Reset

func (x *OrderBy_PivotOrderBy) Reset()

func (*OrderBy_PivotOrderBy) String

func (x *OrderBy_PivotOrderBy) String() string

type OrderBy_PivotOrderBy_PivotSelection

type OrderBy_PivotOrderBy_PivotSelection struct {

	// Must be a dimension name from the request.
	DimensionName string `protobuf:"bytes,1,opt,name=dimension_name,json=dimensionName,proto3" json:"dimension_name,omitempty"`
	// Order by only when the named dimension is this value.
	DimensionValue string `protobuf:"bytes,2,opt,name=dimension_value,json=dimensionValue,proto3" json:"dimension_value,omitempty"`
	// contains filtered or unexported fields
}

A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value.

For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome.

---------|----------|----------------|----------|----------------
         |  Chrome  |    Chrome      |  Safari  |     Safari
---------|----------|----------------|----------|----------------
 Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions
---------|----------|----------------|----------|----------------
    US   |    2     |       2        |     3    |        1
---------|----------|----------------|----------|----------------
  Canada |    3     |       1        |     4    |        1
---------|----------|----------------|----------|----------------

func (*OrderBy_PivotOrderBy_PivotSelection) Descriptor deprecated

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

Deprecated: Use OrderBy_PivotOrderBy_PivotSelection.ProtoReflect.Descriptor instead.

func (*OrderBy_PivotOrderBy_PivotSelection) GetDimensionName

func (x *OrderBy_PivotOrderBy_PivotSelection) GetDimensionName() string

func (*OrderBy_PivotOrderBy_PivotSelection) GetDimensionValue

func (x *OrderBy_PivotOrderBy_PivotSelection) GetDimensionValue() string

func (*OrderBy_PivotOrderBy_PivotSelection) ProtoMessage

func (*OrderBy_PivotOrderBy_PivotSelection) ProtoMessage()

func (*OrderBy_PivotOrderBy_PivotSelection) ProtoReflect

func (*OrderBy_PivotOrderBy_PivotSelection) Reset

func (*OrderBy_PivotOrderBy_PivotSelection) String

type Pivot

type Pivot struct {

	// Dimension names for visible columns in the report response. Including
	// "dateRange" produces a date range column; for each row in the response,
	// dimension values in the date range column will indicate the corresponding
	// date range from the request.
	FieldNames []string `protobuf:"bytes,1,rep,name=field_names,json=fieldNames,proto3" json:"field_names,omitempty"`
	// Specifies how dimensions are ordered in the pivot. In the first Pivot, the
	// OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
	// Pivots, the OrderBys determine only PivotDimensionHeader ordering.
	// Dimensions specified in these OrderBys must be a subset of
	// Pivot.field_names.
	OrderBys []*OrderBy `protobuf:"bytes,2,rep,name=order_bys,json=orderBys,proto3" json:"order_bys,omitempty"`
	// The row count of the start row. The first row is counted as row 0.
	Offset int64 `protobuf:"varint,3,opt,name=offset,proto3" json:"offset,omitempty"`
	// The number of unique combinations of dimension values to return in this
	// pivot. The `limit` parameter is required. A `limit` of 10,000 is common for
	// single pivot requests.
	//
	// The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
	// must not exceed 100,000. For example, a two pivot request with `limit:
	// 1000` in each pivot will fail because the product is `1,000,000`.
	Limit int64 `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// Aggregate the metrics by dimensions in this pivot using the specified
	// metric_aggregations.
	MetricAggregations []MetricAggregation `` /* 175-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes the visible dimension columns and rows in the report response.

func (*Pivot) Descriptor deprecated

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

Deprecated: Use Pivot.ProtoReflect.Descriptor instead.

func (*Pivot) GetFieldNames

func (x *Pivot) GetFieldNames() []string

func (*Pivot) GetLimit

func (x *Pivot) GetLimit() int64

func (*Pivot) GetMetricAggregations

func (x *Pivot) GetMetricAggregations() []MetricAggregation

func (*Pivot) GetOffset

func (x *Pivot) GetOffset() int64

func (*Pivot) GetOrderBys

func (x *Pivot) GetOrderBys() []*OrderBy

func (*Pivot) ProtoMessage

func (*Pivot) ProtoMessage()

func (*Pivot) ProtoReflect

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

func (*Pivot) Reset

func (x *Pivot) Reset()

func (*Pivot) String

func (x *Pivot) String() string

type PivotDimensionHeader

type PivotDimensionHeader struct {

	// Values of multiple dimensions in a pivot.
	DimensionValues []*DimensionValue `protobuf:"bytes,1,rep,name=dimension_values,json=dimensionValues,proto3" json:"dimension_values,omitempty"`
	// contains filtered or unexported fields
}

Summarizes dimension values from a row for this pivot.

func (*PivotDimensionHeader) Descriptor deprecated

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

Deprecated: Use PivotDimensionHeader.ProtoReflect.Descriptor instead.

func (*PivotDimensionHeader) GetDimensionValues

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

func (*PivotDimensionHeader) ProtoMessage

func (*PivotDimensionHeader) ProtoMessage()

func (*PivotDimensionHeader) ProtoReflect

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

func (*PivotDimensionHeader) Reset

func (x *PivotDimensionHeader) Reset()

func (*PivotDimensionHeader) String

func (x *PivotDimensionHeader) String() string

type PivotHeader

type PivotHeader struct {

	// The size is the same as the cardinality of the corresponding dimension
	// combinations.
	PivotDimensionHeaders []*PivotDimensionHeader `` /* 126-byte string literal not displayed */
	// The cardinality of the pivot. The total number of rows for this pivot's
	// fields regardless of how the parameters `offset` and `limit` are specified
	// in the request.
	RowCount int32 `protobuf:"varint,2,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
	// contains filtered or unexported fields
}

Dimensions' values in a single pivot.

func (*PivotHeader) Descriptor deprecated

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

Deprecated: Use PivotHeader.ProtoReflect.Descriptor instead.

func (*PivotHeader) GetPivotDimensionHeaders

func (x *PivotHeader) GetPivotDimensionHeaders() []*PivotDimensionHeader

func (*PivotHeader) GetRowCount

func (x *PivotHeader) GetRowCount() int32

func (*PivotHeader) ProtoMessage

func (*PivotHeader) ProtoMessage()

func (*PivotHeader) ProtoReflect

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

func (*PivotHeader) Reset

func (x *PivotHeader) Reset()

func (*PivotHeader) String

func (x *PivotHeader) String() string

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 all of
	// the hourly, daily, and per project hourly 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 */
	// Analytics Properties can use up to 25% of their tokens per project per
	// hour. This amounts to standard Analytics Properties can use up to 1,250
	// tokens per project per hour, and Analytics 360 Properties can use 12,500
	// tokens per project per hour. An API request consumes a single number of
	// tokens, and that number is deducted from all of the hourly, daily, and per
	// project hourly quotas.
	TokensPerProjectPerHour *QuotaStatus `` /* 136-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) GetTokensPerProjectPerHour

func (x *PropertyQuota) GetTokensPerProjectPerHour() *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 ResponseMetaData

type ResponseMetaData struct {

	// If true, indicates some buckets of dimension combinations are rolled into
	// "(other)" row. This can happen for high cardinality reports.
	DataLossFromOtherRow bool `` /* 128-byte string literal not displayed */
	// Describes the schema restrictions actively enforced in creating this
	// report. To learn more, see [Access and data-restriction
	// management](https://support.google.com/analytics/answer/10851388).
	SchemaRestrictionResponse *ResponseMetaData_SchemaRestrictionResponse `` /* 144-byte string literal not displayed */
	// The currency code used in this report. Intended to be used in formatting
	// currency metrics like `purchaseRevenue` for visualization. If currency_code
	// was specified in the request, this response parameter will echo the request
	// parameter; otherwise, this response parameter is the property's current
	// currency_code.
	//
	// Currency codes are string encodings of currency types from the ISO 4217
	// standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD",
	// "EUR", "JPY". To learn more, see
	// https://support.google.com/analytics/answer/9796179.
	CurrencyCode *string `protobuf:"bytes,5,opt,name=currency_code,json=currencyCode,proto3,oneof" json:"currency_code,omitempty"`
	// The property's current timezone. Intended to be used to interpret
	// time-based dimensions like `hour` and `minute`. Formatted as strings from
	// the IANA Time Zone database (https://www.iana.org/time-zones); for example
	// "America/New_York" or "Asia/Tokyo".
	TimeZone *string `protobuf:"bytes,6,opt,name=time_zone,json=timeZone,proto3,oneof" json:"time_zone,omitempty"`
	// If empty reason is specified, the report is empty for this reason.
	EmptyReason *string `protobuf:"bytes,7,opt,name=empty_reason,json=emptyReason,proto3,oneof" json:"empty_reason,omitempty"`
	// If `subjectToThresholding` is true, this report is subject to thresholding
	// and only returns data that meets the minimum aggregation thresholds. It is
	// possible for a request to be subject to thresholding thresholding and no
	// data is absent from the report, and this happens when all data is above the
	// thresholds. To learn more, see [Data
	// thresholds](https://support.google.com/analytics/answer/9383630) and [About
	// Demographics and
	// Interests](https://support.google.com/analytics/answer/2799357).
	SubjectToThresholding *bool `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response's metadata carrying additional information about the report content.

func (*ResponseMetaData) Descriptor deprecated

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

Deprecated: Use ResponseMetaData.ProtoReflect.Descriptor instead.

func (*ResponseMetaData) GetCurrencyCode

func (x *ResponseMetaData) GetCurrencyCode() string

func (*ResponseMetaData) GetDataLossFromOtherRow

func (x *ResponseMetaData) GetDataLossFromOtherRow() bool

func (*ResponseMetaData) GetEmptyReason

func (x *ResponseMetaData) GetEmptyReason() string

func (*ResponseMetaData) GetSchemaRestrictionResponse

func (x *ResponseMetaData) GetSchemaRestrictionResponse() *ResponseMetaData_SchemaRestrictionResponse

func (*ResponseMetaData) GetSubjectToThresholding

func (x *ResponseMetaData) GetSubjectToThresholding() bool

func (*ResponseMetaData) GetTimeZone

func (x *ResponseMetaData) GetTimeZone() string

func (*ResponseMetaData) ProtoMessage

func (*ResponseMetaData) ProtoMessage()

func (*ResponseMetaData) ProtoReflect

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

func (*ResponseMetaData) Reset

func (x *ResponseMetaData) Reset()

func (*ResponseMetaData) String

func (x *ResponseMetaData) String() string

type ResponseMetaData_SchemaRestrictionResponse

type ResponseMetaData_SchemaRestrictionResponse struct {

	// All restrictions actively enforced in creating the report. For example,
	// `purchaseRevenue` always has the restriction type `REVENUE_DATA`.
	// However, this active response restriction is only populated if the user's
	// custom role disallows access to `REVENUE_DATA`.
	ActiveMetricRestrictions []*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).

func (*ResponseMetaData_SchemaRestrictionResponse) Descriptor deprecated

Deprecated: Use ResponseMetaData_SchemaRestrictionResponse.ProtoReflect.Descriptor instead.

func (*ResponseMetaData_SchemaRestrictionResponse) GetActiveMetricRestrictions

func (*ResponseMetaData_SchemaRestrictionResponse) ProtoMessage

func (*ResponseMetaData_SchemaRestrictionResponse) ProtoReflect

func (*ResponseMetaData_SchemaRestrictionResponse) Reset

func (*ResponseMetaData_SchemaRestrictionResponse) String

type ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction

type ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction struct {

	// The name of the restricted metric.
	MetricName *string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3,oneof" json:"metric_name,omitempty"`
	// The reason for this metric's restriction.
	RestrictedMetricTypes []RestrictedMetricType `` /* 189-byte string literal not displayed */
	// contains filtered or unexported fields
}

A metric actively restricted in creating the report.

func (*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction) Descriptor deprecated

Deprecated: Use ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction.ProtoReflect.Descriptor instead.

func (*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction) GetMetricName

func (*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction) GetRestrictedMetricTypes

func (*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction) ProtoMessage

func (*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction) ProtoReflect

func (*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction) Reset

func (*ResponseMetaData_SchemaRestrictionResponse_ActiveMetricRestriction) String

type RestrictedMetricType

type RestrictedMetricType int32

Categories of data that you may be restricted from viewing on certain GA4 properties.

const (
	// Unspecified type.
	RestrictedMetricType_RESTRICTED_METRIC_TYPE_UNSPECIFIED RestrictedMetricType = 0
	// Cost metrics such as `adCost`.
	RestrictedMetricType_COST_DATA RestrictedMetricType = 1
	// Revenue metrics such as `purchaseRevenue`.
	RestrictedMetricType_REVENUE_DATA RestrictedMetricType = 2
)

func (RestrictedMetricType) Descriptor

func (RestrictedMetricType) Enum

func (RestrictedMetricType) EnumDescriptor deprecated

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

Deprecated: Use RestrictedMetricType.Descriptor instead.

func (RestrictedMetricType) Number

func (RestrictedMetricType) String

func (x RestrictedMetricType) String() string

func (RestrictedMetricType) Type

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 RunPivotReportRequest

type RunPivotReportRequest 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"`
	// The dimensions requested. All defined dimensions must be used by one of the
	// following: dimension_expression, dimension_filter, pivots, order_bys.
	Dimensions []*Dimension `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
	// The metrics requested, at least one metric needs to be specified. All
	// defined metrics must be used by one of the following: metric_expression,
	// metric_filter, order_bys.
	Metrics []*Metric `protobuf:"bytes,3,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// The date range to retrieve event data for the report. If multiple date
	// ranges are specified, event data from each date range is used in the
	// report. A special dimension with field name "dateRange" can be included in
	// a Pivot's field names; if included, the report compares between date
	// ranges. In a cohort request, this `dateRanges` must be unspecified.
	DateRanges []*DateRange `protobuf:"bytes,4,rep,name=date_ranges,json=dateRanges,proto3" json:"date_ranges,omitempty"`
	// Describes the visual format of the report's dimensions in columns or rows.
	// The union of the fieldNames (dimension names) in all pivots must be a
	// subset of dimension names defined in Dimensions. No two pivots can share a
	// dimension. A dimension is only visible if it appears in a pivot.
	Pivots []*Pivot `protobuf:"bytes,5,rep,name=pivots,proto3" json:"pivots,omitempty"`
	// The filter clause of dimensions. Dimensions must be requested to be used in
	// this filter. Metrics cannot be used in this filter.
	DimensionFilter *FilterExpression `protobuf:"bytes,6,opt,name=dimension_filter,json=dimensionFilter,proto3" json:"dimension_filter,omitempty"`
	// The filter clause of metrics. Applied at post aggregation phase, similar to
	// SQL having-clause. Metrics must be requested to be used in this filter.
	// Dimensions cannot be used in this filter.
	MetricFilter *FilterExpression `protobuf:"bytes,7,opt,name=metric_filter,json=metricFilter,proto3" json:"metric_filter,omitempty"`
	// A currency code in ISO4217 format, such as "AED", "USD", "JPY".
	// If the field is empty, the report uses the property's default currency.
	CurrencyCode string `protobuf:"bytes,8,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Cohort group associated with this request. If there is a cohort group
	// in the request the 'cohort' dimension must be present.
	CohortSpec *CohortSpec `protobuf:"bytes,9,opt,name=cohort_spec,json=cohortSpec,proto3" json:"cohort_spec,omitempty"`
	// If false or unspecified, each row with all metrics equal to 0 will not be
	// returned. If true, these rows will be returned if they are not separately
	// removed by a filter.
	KeepEmptyRows bool `protobuf:"varint,10,opt,name=keep_empty_rows,json=keepEmptyRows,proto3" json:"keep_empty_rows,omitempty"`
	// Toggles whether to return the current state of this Analytics Property's
	// quota. Quota is returned in [PropertyQuota](#PropertyQuota).
	ReturnPropertyQuota bool `protobuf:"varint,11,opt,name=return_property_quota,json=returnPropertyQuota,proto3" json:"return_property_quota,omitempty"`
	// contains filtered or unexported fields
}

The request to generate a pivot report.

func (*RunPivotReportRequest) Descriptor deprecated

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

Deprecated: Use RunPivotReportRequest.ProtoReflect.Descriptor instead.

func (*RunPivotReportRequest) GetCohortSpec

func (x *RunPivotReportRequest) GetCohortSpec() *CohortSpec

func (*RunPivotReportRequest) GetCurrencyCode

func (x *RunPivotReportRequest) GetCurrencyCode() string

func (*RunPivotReportRequest) GetDateRanges

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

func (*RunPivotReportRequest) GetDimensionFilter

func (x *RunPivotReportRequest) GetDimensionFilter() *FilterExpression

func (*RunPivotReportRequest) GetDimensions

func (x *RunPivotReportRequest) GetDimensions() []*Dimension

func (*RunPivotReportRequest) GetKeepEmptyRows

func (x *RunPivotReportRequest) GetKeepEmptyRows() bool

func (*RunPivotReportRequest) GetMetricFilter

func (x *RunPivotReportRequest) GetMetricFilter() *FilterExpression

func (*RunPivotReportRequest) GetMetrics

func (x *RunPivotReportRequest) GetMetrics() []*Metric

func (*RunPivotReportRequest) GetPivots

func (x *RunPivotReportRequest) GetPivots() []*Pivot

func (*RunPivotReportRequest) GetProperty

func (x *RunPivotReportRequest) GetProperty() string

func (*RunPivotReportRequest) GetReturnPropertyQuota

func (x *RunPivotReportRequest) GetReturnPropertyQuota() bool

func (*RunPivotReportRequest) ProtoMessage

func (*RunPivotReportRequest) ProtoMessage()

func (*RunPivotReportRequest) ProtoReflect

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

func (*RunPivotReportRequest) Reset

func (x *RunPivotReportRequest) Reset()

func (*RunPivotReportRequest) String

func (x *RunPivotReportRequest) String() string

type RunPivotReportResponse

type RunPivotReportResponse struct {

	// Summarizes the columns and rows created by a pivot. Each pivot in the
	// request produces one header in the response. If we have a request like
	// this:
	//
	//	"pivots": [{
	//	  "fieldNames": ["country",
	//	    "city"]
	//	},
	//	{
	//	  "fieldNames": "eventName"
	//	}]
	//
	// We will have the following `pivotHeaders` in the response:
	//
	//	"pivotHeaders" : [{
	//	  "dimensionHeaders": [{
	//	    "dimensionValues": [
	//	       { "value": "United Kingdom" },
	//	       { "value": "London" }
	//	     ]
	//	  },
	//	  {
	//	    "dimensionValues": [
	//	    { "value": "Japan" },
	//	    { "value": "Osaka" }
	//	    ]
	//	  }]
	//	},
	//	{
	//	  "dimensionHeaders": [{
	//	    "dimensionValues": [{ "value": "session_start" }]
	//	  },
	//	  {
	//	    "dimensionValues": [{ "value": "scroll" }]
	//	  }]
	//	}]
	PivotHeaders []*PivotHeader `protobuf:"bytes,1,rep,name=pivot_headers,json=pivotHeaders,proto3" json:"pivot_headers,omitempty"`
	// Describes dimension columns. The number of DimensionHeaders and ordering of
	// DimensionHeaders matches the dimensions present in rows.
	DimensionHeaders []*DimensionHeader `protobuf:"bytes,2,rep,name=dimension_headers,json=dimensionHeaders,proto3" json:"dimension_headers,omitempty"`
	// Describes metric columns. The number of MetricHeaders and ordering of
	// MetricHeaders matches the metrics present in rows.
	MetricHeaders []*MetricHeader `protobuf:"bytes,3,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,4,rep,name=rows,proto3" json:"rows,omitempty"`
	// Aggregation of metric values. Can be totals, minimums, or maximums. The
	// returned aggregations are controlled by the metric_aggregations in the
	// pivot. The type of aggregation returned in each row is shown by the
	// dimension_values which are set to "RESERVED_<MetricAggregation>".
	Aggregates []*Row `protobuf:"bytes,5,rep,name=aggregates,proto3" json:"aggregates,omitempty"`
	// Metadata for the report.
	Metadata *ResponseMetaData `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// This Analytics Property's quota state including this request.
	PropertyQuota *PropertyQuota `protobuf:"bytes,7,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#runPivotReport". Useful to distinguish between
	// response types in JSON.
	Kind string `protobuf:"bytes,8,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

The response pivot report table corresponding to a pivot request.

func (*RunPivotReportResponse) Descriptor deprecated

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

Deprecated: Use RunPivotReportResponse.ProtoReflect.Descriptor instead.

func (*RunPivotReportResponse) GetAggregates

func (x *RunPivotReportResponse) GetAggregates() []*Row

func (*RunPivotReportResponse) GetDimensionHeaders

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

func (*RunPivotReportResponse) GetKind

func (x *RunPivotReportResponse) GetKind() string

func (*RunPivotReportResponse) GetMetadata

func (x *RunPivotReportResponse) GetMetadata() *ResponseMetaData

func (*RunPivotReportResponse) GetMetricHeaders

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

func (*RunPivotReportResponse) GetPivotHeaders

func (x *RunPivotReportResponse) GetPivotHeaders() []*PivotHeader

func (*RunPivotReportResponse) GetPropertyQuota

func (x *RunPivotReportResponse) GetPropertyQuota() *PropertyQuota

func (*RunPivotReportResponse) GetRows

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

func (*RunPivotReportResponse) ProtoMessage

func (*RunPivotReportResponse) ProtoMessage()

func (*RunPivotReportResponse) ProtoReflect

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

func (*RunPivotReportResponse) Reset

func (x *RunPivotReportResponse) Reset()

func (*RunPivotReportResponse) String

func (x *RunPivotReportResponse) String() string

type RunRealtimeReportRequest

type RunRealtimeReportRequest 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).
	//
	// Example: properties/1234
	Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
	// The dimensions requested and displayed.
	Dimensions []*Dimension `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
	// The metrics requested and displayed.
	Metrics []*Metric `protobuf:"bytes,3,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// The filter clause of dimensions. Metrics cannot be used in this filter.
	DimensionFilter *FilterExpression `protobuf:"bytes,4,opt,name=dimension_filter,json=dimensionFilter,proto3" json:"dimension_filter,omitempty"`
	// The filter clause of metrics. Applied at post aggregation phase, similar to
	// SQL having-clause. Dimensions cannot be used in this filter.
	MetricFilter *FilterExpression `protobuf:"bytes,5,opt,name=metric_filter,json=metricFilter,proto3" json:"metric_filter,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`. For instance, there are
	// fewer than 300 possible values for the dimension `country`, so when
	// reporting on only `country`, you can't get more than 300 rows, even if you
	// set `limit` to a higher value.
	Limit int64 `protobuf:"varint,6,opt,name=limit,proto3" json:"limit,omitempty"`
	// Aggregation of metrics. Aggregated metric values will be shown in rows
	// where the dimension_values are set to "RESERVED_(MetricAggregation)".
	MetricAggregations []MetricAggregation `` /* 175-byte string literal not displayed */
	// Specifies how rows are ordered in the response.
	OrderBys []*OrderBy `protobuf:"bytes,8,rep,name=order_bys,json=orderBys,proto3" json:"order_bys,omitempty"`
	// Toggles whether to return the current state of this Analytics Property's
	// Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
	ReturnPropertyQuota bool `protobuf:"varint,9,opt,name=return_property_quota,json=returnPropertyQuota,proto3" json:"return_property_quota,omitempty"`
	// The minute ranges of event data to read. If unspecified, one minute range
	// for the last 30 minutes will be used. If multiple minute ranges are
	// requested, each response row will contain a zero based minute range index.
	// If two minute ranges overlap, the event data for the overlapping minutes is
	// included in the response rows for both minute ranges.
	MinuteRanges []*MinuteRange `protobuf:"bytes,10,rep,name=minute_ranges,json=minuteRanges,proto3" json:"minute_ranges,omitempty"`
	// contains filtered or unexported fields
}

The request to generate a realtime report.

func (*RunRealtimeReportRequest) Descriptor deprecated

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

Deprecated: Use RunRealtimeReportRequest.ProtoReflect.Descriptor instead.

func (*RunRealtimeReportRequest) GetDimensionFilter

func (x *RunRealtimeReportRequest) GetDimensionFilter() *FilterExpression

func (*RunRealtimeReportRequest) GetDimensions

func (x *RunRealtimeReportRequest) GetDimensions() []*Dimension

func (*RunRealtimeReportRequest) GetLimit

func (x *RunRealtimeReportRequest) GetLimit() int64

func (*RunRealtimeReportRequest) GetMetricAggregations

func (x *RunRealtimeReportRequest) GetMetricAggregations() []MetricAggregation

func (*RunRealtimeReportRequest) GetMetricFilter

func (x *RunRealtimeReportRequest) GetMetricFilter() *FilterExpression

func (*RunRealtimeReportRequest) GetMetrics

func (x *RunRealtimeReportRequest) GetMetrics() []*Metric

func (*RunRealtimeReportRequest) GetMinuteRanges

func (x *RunRealtimeReportRequest) GetMinuteRanges() []*MinuteRange

func (*RunRealtimeReportRequest) GetOrderBys

func (x *RunRealtimeReportRequest) GetOrderBys() []*OrderBy

func (*RunRealtimeReportRequest) GetProperty

func (x *RunRealtimeReportRequest) GetProperty() string

func (*RunRealtimeReportRequest) GetReturnPropertyQuota

func (x *RunRealtimeReportRequest) GetReturnPropertyQuota() bool

func (*RunRealtimeReportRequest) ProtoMessage

func (*RunRealtimeReportRequest) ProtoMessage()

func (*RunRealtimeReportRequest) ProtoReflect

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

func (*RunRealtimeReportRequest) Reset

func (x *RunRealtimeReportRequest) Reset()

func (*RunRealtimeReportRequest) String

func (x *RunRealtimeReportRequest) String() string

type RunRealtimeReportResponse

type RunRealtimeReportResponse struct {

	// Describes dimension columns. The number of DimensionHeaders and ordering of
	// DimensionHeaders matches the dimensions present in rows.
	DimensionHeaders []*DimensionHeader `protobuf:"bytes,1,rep,name=dimension_headers,json=dimensionHeaders,proto3" json:"dimension_headers,omitempty"`
	// Describes metric columns. The number of MetricHeaders and ordering of
	// MetricHeaders matches the metrics present in rows.
	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"`
	// If requested, the totaled values of metrics.
	Totals []*Row `protobuf:"bytes,4,rep,name=totals,proto3" json:"totals,omitempty"`
	// If requested, the maximum values of metrics.
	Maximums []*Row `protobuf:"bytes,5,rep,name=maximums,proto3" json:"maximums,omitempty"`
	// If requested, the minimum values of metrics.
	Minimums []*Row `protobuf:"bytes,6,rep,name=minimums,proto3" json:"minimums,omitempty"`
	// The total number of rows in the query result. `rowCount` is independent of
	// the number of rows returned in the response and the `limit` request
	// parameter. For example if a query returns 175 rows and includes `limit`
	// of 50 in the API request, the response will contain `rowCount` of 175 but
	// only 50 rows.
	RowCount int32 `protobuf:"varint,7,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
	// This Analytics Property's Realtime quota state including this request.
	PropertyQuota *PropertyQuota `protobuf:"bytes,8,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#runRealtimeReport". Useful to distinguish
	// between response types in JSON.
	Kind string `protobuf:"bytes,9,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

The response realtime report table corresponding to a request.

func (*RunRealtimeReportResponse) Descriptor deprecated

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

Deprecated: Use RunRealtimeReportResponse.ProtoReflect.Descriptor instead.

func (*RunRealtimeReportResponse) GetDimensionHeaders

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

func (*RunRealtimeReportResponse) GetKind

func (x *RunRealtimeReportResponse) GetKind() string

func (*RunRealtimeReportResponse) GetMaximums

func (x *RunRealtimeReportResponse) GetMaximums() []*Row

func (*RunRealtimeReportResponse) GetMetricHeaders

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

func (*RunRealtimeReportResponse) GetMinimums

func (x *RunRealtimeReportResponse) GetMinimums() []*Row

func (*RunRealtimeReportResponse) GetPropertyQuota

func (x *RunRealtimeReportResponse) GetPropertyQuota() *PropertyQuota

func (*RunRealtimeReportResponse) GetRowCount

func (x *RunRealtimeReportResponse) GetRowCount() int32

func (*RunRealtimeReportResponse) GetRows

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

func (*RunRealtimeReportResponse) GetTotals

func (x *RunRealtimeReportResponse) GetTotals() []*Row

func (*RunRealtimeReportResponse) ProtoMessage

func (*RunRealtimeReportResponse) ProtoMessage()

func (*RunRealtimeReportResponse) ProtoReflect

func (*RunRealtimeReportResponse) Reset

func (x *RunRealtimeReportResponse) Reset()

func (*RunRealtimeReportResponse) String

func (x *RunRealtimeReportResponse) String() string

type RunReportRequest

type RunReportRequest 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"`
	// The dimensions requested and displayed.
	Dimensions []*Dimension `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
	// The metrics requested and displayed.
	Metrics []*Metric `protobuf:"bytes,3,rep,name=metrics,proto3" json:"metrics,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. In a cohort request, this `dateRanges`
	// must be unspecified.
	DateRanges []*DateRange `protobuf:"bytes,4,rep,name=date_ranges,json=dateRanges,proto3" json:"date_ranges,omitempty"`
	// Dimension filters allow you to ask for only specific dimension values in
	// the report. To learn more, see [Fundamentals of 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,5,opt,name=dimension_filter,json=dimensionFilter,proto3" json:"dimension_filter,omitempty"`
	// The filter clause of metrics. Applied after aggregating the report's rows,
	// similar to SQL having-clause. Dimensions cannot be used in this filter.
	MetricFilter *FilterExpression `protobuf:"bytes,6,opt,name=metric_filter,json=metricFilter,proto3" json:"metric_filter,omitempty"`
	// The row count of the start row. The first row is counted as row 0.
	//
	// When paging, the first request does not specify offset; or equivalently,
	// sets offset to 0; the first request returns the first `limit` of rows. The
	// second request sets offset to the `limit` of the first request; the second
	// request returns the second `limit` of rows.
	//
	// To learn more about this pagination parameter, see
	// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
	Offset int64 `protobuf:"varint,7,opt,name=offset,proto3" json:"offset,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`. For instance, there are
	// fewer than 300 possible values for the dimension `country`, so when
	// reporting on only `country`, you can't get more than 300 rows, even if you
	// set `limit` to a higher value.
	//
	// To learn more about this pagination parameter, see
	// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
	Limit int64 `protobuf:"varint,8,opt,name=limit,proto3" json:"limit,omitempty"`
	// Aggregation of metrics. Aggregated metric values will be shown in rows
	// where the dimension_values are set to "RESERVED_(MetricAggregation)".
	MetricAggregations []MetricAggregation `` /* 175-byte string literal not displayed */
	// Specifies how rows are ordered in the response.
	OrderBys []*OrderBy `protobuf:"bytes,10,rep,name=order_bys,json=orderBys,proto3" json:"order_bys,omitempty"`
	// A currency code in ISO4217 format, such as "AED", "USD", "JPY".
	// If the field is empty, the report uses the property's default currency.
	CurrencyCode string `protobuf:"bytes,11,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Cohort group associated with this request. If there is a cohort group
	// in the request the 'cohort' dimension must be present.
	CohortSpec *CohortSpec `protobuf:"bytes,12,opt,name=cohort_spec,json=cohortSpec,proto3" json:"cohort_spec,omitempty"`
	// If false or unspecified, each row with all metrics equal to 0 will not be
	// returned. If true, these rows will be returned if they are not separately
	// removed by a filter.
	KeepEmptyRows bool `protobuf:"varint,13,opt,name=keep_empty_rows,json=keepEmptyRows,proto3" json:"keep_empty_rows,omitempty"`
	// Toggles whether to return the current state of this Analytics Property's
	// quota. Quota is returned in [PropertyQuota](#PropertyQuota).
	ReturnPropertyQuota bool `protobuf:"varint,14,opt,name=return_property_quota,json=returnPropertyQuota,proto3" json:"return_property_quota,omitempty"`
	// contains filtered or unexported fields
}

The request to generate a report.

func (*RunReportRequest) Descriptor deprecated

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

Deprecated: Use RunReportRequest.ProtoReflect.Descriptor instead.

func (*RunReportRequest) GetCohortSpec

func (x *RunReportRequest) GetCohortSpec() *CohortSpec

func (*RunReportRequest) GetCurrencyCode

func (x *RunReportRequest) GetCurrencyCode() string

func (*RunReportRequest) GetDateRanges

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

func (*RunReportRequest) GetDimensionFilter

func (x *RunReportRequest) GetDimensionFilter() *FilterExpression

func (*RunReportRequest) GetDimensions

func (x *RunReportRequest) GetDimensions() []*Dimension

func (*RunReportRequest) GetKeepEmptyRows

func (x *RunReportRequest) GetKeepEmptyRows() bool

func (*RunReportRequest) GetLimit

func (x *RunReportRequest) GetLimit() int64

func (*RunReportRequest) GetMetricAggregations

func (x *RunReportRequest) GetMetricAggregations() []MetricAggregation

func (*RunReportRequest) GetMetricFilter

func (x *RunReportRequest) GetMetricFilter() *FilterExpression

func (*RunReportRequest) GetMetrics

func (x *RunReportRequest) GetMetrics() []*Metric

func (*RunReportRequest) GetOffset

func (x *RunReportRequest) GetOffset() int64

func (*RunReportRequest) GetOrderBys

func (x *RunReportRequest) GetOrderBys() []*OrderBy

func (*RunReportRequest) GetProperty

func (x *RunReportRequest) GetProperty() string

func (*RunReportRequest) GetReturnPropertyQuota

func (x *RunReportRequest) GetReturnPropertyQuota() bool

func (*RunReportRequest) ProtoMessage

func (*RunReportRequest) ProtoMessage()

func (*RunReportRequest) ProtoReflect

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

func (*RunReportRequest) Reset

func (x *RunReportRequest) Reset()

func (*RunReportRequest) String

func (x *RunReportRequest) String() string

type RunReportResponse

type RunReportResponse struct {

	// Describes dimension columns. The number of DimensionHeaders and ordering of
	// DimensionHeaders matches the dimensions present in rows.
	DimensionHeaders []*DimensionHeader `protobuf:"bytes,1,rep,name=dimension_headers,json=dimensionHeaders,proto3" json:"dimension_headers,omitempty"`
	// Describes metric columns. The number of MetricHeaders and ordering of
	// MetricHeaders matches the metrics present in rows.
	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"`
	// If requested, the totaled values of metrics.
	Totals []*Row `protobuf:"bytes,4,rep,name=totals,proto3" json:"totals,omitempty"`
	// If requested, the maximum values of metrics.
	Maximums []*Row `protobuf:"bytes,5,rep,name=maximums,proto3" json:"maximums,omitempty"`
	// If requested, the minimum values of metrics.
	Minimums []*Row `protobuf:"bytes,6,rep,name=minimums,proto3" json:"minimums,omitempty"`
	// The total number of rows in the query result. `rowCount` is independent of
	// the number of rows returned in the response, the `limit` request
	// parameter, and the `offset` request parameter. For example if a query
	// returns 175 rows and includes `limit` of 50 in the API request, the
	// response will contain `rowCount` of 175 but only 50 rows.
	//
	// To learn more about this pagination parameter, see
	// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
	RowCount int32 `protobuf:"varint,7,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
	// Metadata for the report.
	Metadata *ResponseMetaData `protobuf:"bytes,8,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// This Analytics Property's quota state including this request.
	PropertyQuota *PropertyQuota `protobuf:"bytes,9,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#runReport". Useful to distinguish between
	// response types in JSON.
	Kind string `protobuf:"bytes,10,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

The response report table corresponding to a request.

func (*RunReportResponse) Descriptor deprecated

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

Deprecated: Use RunReportResponse.ProtoReflect.Descriptor instead.

func (*RunReportResponse) GetDimensionHeaders

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

func (*RunReportResponse) GetKind

func (x *RunReportResponse) GetKind() string

func (*RunReportResponse) GetMaximums

func (x *RunReportResponse) GetMaximums() []*Row

func (*RunReportResponse) GetMetadata

func (x *RunReportResponse) GetMetadata() *ResponseMetaData

func (*RunReportResponse) GetMetricHeaders

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

func (*RunReportResponse) GetMinimums

func (x *RunReportResponse) GetMinimums() []*Row

func (*RunReportResponse) GetPropertyQuota

func (x *RunReportResponse) GetPropertyQuota() *PropertyQuota

func (*RunReportResponse) GetRowCount

func (x *RunReportResponse) GetRowCount() int32

func (*RunReportResponse) GetRows

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

func (*RunReportResponse) GetTotals

func (x *RunReportResponse) GetTotals() []*Row

func (*RunReportResponse) ProtoMessage

func (*RunReportResponse) ProtoMessage()

func (*RunReportResponse) ProtoReflect

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

func (*RunReportResponse) Reset

func (x *RunReportResponse) Reset()

func (*RunReportResponse) String

func (x *RunReportResponse) String() string

type UnimplementedBetaAnalyticsDataServer

type UnimplementedBetaAnalyticsDataServer struct {
}

UnimplementedBetaAnalyticsDataServer can be embedded to have forward compatible implementations.

func (*UnimplementedBetaAnalyticsDataServer) BatchRunPivotReports

func (*UnimplementedBetaAnalyticsDataServer) BatchRunReports

func (*UnimplementedBetaAnalyticsDataServer) CheckCompatibility

func (*UnimplementedBetaAnalyticsDataServer) GetMetadata

func (*UnimplementedBetaAnalyticsDataServer) RunPivotReport

func (*UnimplementedBetaAnalyticsDataServer) RunRealtimeReport

func (*UnimplementedBetaAnalyticsDataServer) RunReport

Jump to

Keyboard shortcuts

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