Google Analytics Data V1beta Client - Class Dimension (0.21.1)

Reference documentation and code samples for the Google Analytics Data V1beta Client class 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.

Generated from protobuf message google.analytics.data.v1beta.Dimension

Namespace

Google \ Analytics \ Data \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The name of the dimension. See the API Dimensions for the list of dimension names supported by core reporting methods such as runReport and batchRunReports. See Realtime Dimensions for the list of dimension names supported by the runRealtimeReport method. See Funnel Dimensions for the list of dimension names supported by the runFunnelReport method. 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.
↳ dimension_expression DimensionExpression

One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

getName

The name of the dimension. See the API Dimensions for the list of dimension names supported by core reporting methods such as runReport and batchRunReports. See Realtime Dimensions for the list of dimension names supported by the runRealtimeReport method. See Funnel Dimensions for the list of dimension names supported by the runFunnelReport method.

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.

Returns
Type Description
string

setName

The name of the dimension. See the API Dimensions for the list of dimension names supported by core reporting methods such as runReport and batchRunReports. See Realtime Dimensions for the list of dimension names supported by the runRealtimeReport method. See Funnel Dimensions for the list of dimension names supported by the runFunnelReport method.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDimensionExpression

One dimension can be the result of an expression of multiple dimensions.

For example, dimension "country, city": concatenate(country, ", ", city).

Returns
Type Description
DimensionExpression|null

hasDimensionExpression

clearDimensionExpression

setDimensionExpression

One dimension can be the result of an expression of multiple dimensions.

For example, dimension "country, city": concatenate(country, ", ", city).

Parameter
Name Description
var DimensionExpression
Returns
Type Description
$this