Reference documentation and code samples for the Google Analytics Data V1alpha 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, city could be "Paris" or "New York".
Requests are allowed up to 8 dimensions.
Generated from protobuf message google.analytics.data.v1alpha.Dimension
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. If |
↳ dimension_expression |
Google\Analytics\Data\V1alpha\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.
If dimensionExpression
is specified, name
can be any string that you
would like. For example if a dimensionExpression
concatenates country
and city
, you could call that dimension countryAndCity
.
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.
If dimensionExpression
is specified, name
can be any string that you
would like. For example if a dimensionExpression
concatenates country
and city
, you could call that dimension countryAndCity
.
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 |
Google\Analytics\Data\V1alpha\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 |
Google\Analytics\Data\V1alpha\DimensionExpression
|
Returns | |
---|---|
Type | Description |
$this |