Namespace Google.Analytics.Data.V1Beta
Classes
AudienceDimension
An audience dimension is a user attribute. Specific user attributed are
requested and then later returned in the QueryAudienceExportResponse
.
AudienceDimensionValue
The value of a dimension.
AudienceExport
An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.
AudienceExport.Types
Container for nested types declared in the AudienceExport message type.
AudienceExportMetadata
This metadata is currently blank.
AudienceExportName
Resource name for the AudienceExport
resource.
AudienceRow
Dimension value attributes for the audience user row.
BatchRunPivotReportsRequest
The batch request containing multiple pivot report requests.
BatchRunPivotReportsResponse
The batch response containing multiple pivot reports.
BatchRunReportsRequest
The batch request containing multiple report requests.
BatchRunReportsResponse
The batch response containing multiple reports.
BetaAnalyticsData
Google Analytics reporting data service.
BetaAnalyticsData.BetaAnalyticsDataBase
Base class for server-side implementations of BetaAnalyticsData
BetaAnalyticsData.BetaAnalyticsDataClient
Client for BetaAnalyticsData
BetaAnalyticsDataClient
BetaAnalyticsData client wrapper, for convenient use.
BetaAnalyticsDataClientBuilder
Builder class for BetaAnalyticsDataClient to provide simple configuration of credentials, endpoint etc.
BetaAnalyticsDataClientImpl
BetaAnalyticsData client wrapper implementation, for convenient use.
BetaAnalyticsDataSettings
Settings for BetaAnalyticsDataClient instances.
CheckCompatibilityRequest
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.
CheckCompatibilityResponse
The compatibility response with the compatibility of each dimension & metric.
Cohort
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.
CohortReportSettings
Optional settings of a cohort report.
CohortSpec
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.
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.
CohortsRange
Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.
CohortsRange.Types
Container for nested types declared in the CohortsRange message type.
Comparison
Defines an individual comparison. Most requests will include multiple comparisons so that the report compares between the comparisons.
ComparisonMetadata
The metadata for a single comparison.
CreateAudienceExportRequest
A request to create a new audience export.
DateRange
A contiguous set of days: startDate
, startDate + 1
, ..., endDate
.
Requests are allowed up to 4 date ranges.
Dimension
Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions.
DimensionCompatibility
The compatibility for a single dimension.
DimensionExpression
Used to express a dimension which is the result of a formula of multiple dimensions. Example usages:
- lower_case(dimension)
- concatenate(dimension1, symbol, dimension2).
DimensionExpression.Types
Container for nested types declared in the DimensionExpression message type.
DimensionExpression.Types.CaseExpression
Used to convert a dimension value to a single case.
DimensionExpression.Types.ConcatenateExpression
Used to combine dimension values to a single dimension.
DimensionHeader
Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.
DimensionMetadata
Explains a dimension.
DimensionValue
The value of a dimension.
Filter
An expression to filter dimension or metric values.
Filter.Types
Container for nested types declared in the Filter message type.
Filter.Types.BetweenFilter
To express that the result needs to be between two numbers (inclusive).
Filter.Types.InListFilter
The result needs to be in a list of string values.
Filter.Types.NumericFilter
Filters for numeric or date values.
Filter.Types.NumericFilter.Types
Container for nested types declared in the NumericFilter message type.
Filter.Types.StringFilter
The filter for string
Filter.Types.StringFilter.Types
Container for nested types declared in the StringFilter message type.
FilterExpression
To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.
FilterExpressionList
A list of filter expressions.
GetAudienceExportRequest
A request to retrieve configuration metadata about a specific audience export.
GetMetadataRequest
Request for a property's dimension and metric metadata.
ListAudienceExportsRequest
A request to list all audience exports for a property.
ListAudienceExportsResponse
A list of all audience exports for a property.
Metadata
The dimensions, metrics and comparisons currently accepted in reporting methods.
MetadataName
Resource name for the Metadata
resource.
Metric
The quantitative measurements of a report. For example, the metric
eventCount
is the total number of events. Requests are allowed up to 10
metrics.
MetricCompatibility
The compatibility for a single metric.
MetricHeader
Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.
MetricMetadata
Explains a metric.
MetricMetadata.Types
Container for nested types declared in the MetricMetadata message type.
MetricValue
The value of a metric.
MinuteRange
A contiguous set of minutes: startMinutesAgo
, startMinutesAgo + 1
, ...,
endMinutesAgo
. Requests are allowed up to 2 minute ranges.
NumericValue
To represent a number.
OrderBy
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.
OrderBy.Types
Container for nested types declared in the OrderBy message type.
OrderBy.Types.DimensionOrderBy
Sorts by dimension values.
OrderBy.Types.DimensionOrderBy.Types
Container for nested types declared in the DimensionOrderBy message type.
OrderBy.Types.MetricOrderBy
Sorts by metric values.
OrderBy.Types.PivotOrderBy
Sorts by a pivot column group.
OrderBy.Types.PivotOrderBy.Types
Container for nested types declared in the PivotOrderBy message type.
OrderBy.Types.PivotOrderBy.Types.PivotSelection
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
---------|----------|----------------|----------|----------------
Pivot
Describes the visible dimension columns and rows in the report response.
PivotDimensionHeader
Summarizes dimension values from a row for this pivot.
PivotHeader
Dimensions' values in a single pivot.
PropertyName
Resource name for the Property
resource.
PropertyQuota
Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.
QueryAudienceExportRequest
A request to list users in an audience export.
QueryAudienceExportResponse
A list of users in an audience export.
QuotaStatus
Current state for a particular quota group.
ResponseMetaData
Response's metadata carrying additional information about the report content.
ResponseMetaData.Types
Container for nested types declared in the ResponseMetaData message type.
ResponseMetaData.Types.SchemaRestrictionResponse
The schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.
ResponseMetaData.Types.SchemaRestrictionResponse.Types
Container for nested types declared in the SchemaRestrictionResponse message type.
ResponseMetaData.Types.SchemaRestrictionResponse.Types.ActiveMetricRestriction
A metric actively restricted in creating the report.
Row
Report data for each row. For example if RunReportRequest contains:
"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:
"dimensionValues": [
{
"value": "in_app_purchase"
},
{
"value": "JP"
}
],
"metricValues": [
{
"value": "15"
}
]
RunPivotReportRequest
The request to generate a pivot report.
RunPivotReportResponse
The response pivot report table corresponding to a pivot request.
RunRealtimeReportRequest
The request to generate a realtime report.
RunRealtimeReportResponse
The response realtime report table corresponding to a request.
RunReportRequest
The request to generate a report.
RunReportResponse
The response report table corresponding to a request.
SamplingMetadata
If this report results is sampled, this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.
Enums
AudienceDimensionValue.OneValueOneofCase
Enum of possible cases for the "one_value" oneof.
AudienceExport.Types.State
The AudienceExport currently exists in this state.
AudienceExportName.ResourceNameType
The possible contents of AudienceExportName.
CohortsRange.Types.Granularity
The granularity used to interpret the startOffset
and endOffset
for the
extended reporting date range for a cohort report.
Comparison.OneComparisonOneofCase
Enum of possible cases for the "one_comparison" oneof.
Compatibility
The compatibility types for a single dimension or metric.
DimensionExpression.OneExpressionOneofCase
Enum of possible cases for the "one_expression" oneof.
DimensionValue.OneValueOneofCase
Enum of possible cases for the "one_value" oneof.
Filter.OneFilterOneofCase
Enum of possible cases for the "one_filter" oneof.
Filter.Types.NumericFilter.Types.Operation
The operation applied to a numeric filter
Filter.Types.StringFilter.Types.MatchType
The match type of a string filter
FilterExpression.ExprOneofCase
Enum of possible cases for the "expr" oneof.
MetadataName.ResourceNameType
The possible contents of MetadataName.
MetricAggregation
Represents aggregation of metrics.
MetricMetadata.Types.BlockedReason
Justifications for why this metric is blocked.
MetricType
A metric's value type.
MetricValue.OneValueOneofCase
Enum of possible cases for the "one_value" oneof.
NumericValue.OneValueOneofCase
Enum of possible cases for the "one_value" oneof.
OrderBy.OneOrderByOneofCase
Enum of possible cases for the "one_order_by" oneof.
OrderBy.Types.DimensionOrderBy.Types.OrderType
Rule to order the string dimension values by.
PropertyName.ResourceNameType
The possible contents of PropertyName.
RestrictedMetricType
Categories of data that you may be restricted from viewing on certain GA4 properties.