Google Analytics Admin V1alpha Client - Class ExpandedDataSet (0.12.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ExpandedDataSet.

A resource message representing a GA4 ExpandedDataSet.

Generated from protobuf message google.analytics.admin.v1alpha.ExpandedDataSet

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

↳ display_name string

Required. The display name of the ExpandedDataSet. Max 200 chars.

↳ description string

Optional. The description of the ExpandedDataSet. Max 50 chars.

↳ dimension_names array

Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.

↳ metric_names array

Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.

↳ dimension_filter_expression Google\Analytics\Admin\V1alpha\ExpandedDataSetFilterExpression

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

↳ data_collection_start_time Google\Protobuf\Timestamp

Output only. Time when expanded data set began (or will begin) collecing data.

getName

Output only. The resource name for this ExpandedDataSet resource.

Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

Returns
TypeDescription
string

setName

Output only. The resource name for this ExpandedDataSet resource.

Format: properties/{property_id}/expandedDataSets/{expanded_data_set}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Required. The display name of the ExpandedDataSet.

Max 200 chars.

Returns
TypeDescription
string

setDisplayName

Required. The display name of the ExpandedDataSet.

Max 200 chars.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. The description of the ExpandedDataSet.

Max 50 chars.

Returns
TypeDescription
string

setDescription

Optional. The description of the ExpandedDataSet.

Max 50 chars.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDimensionNames

Immutable. The list of dimensions included in the ExpandedDataSet.

See the API Dimensions for the list of dimension names.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDimensionNames

Immutable. The list of dimensions included in the ExpandedDataSet.

See the API Dimensions for the list of dimension names.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getMetricNames

Immutable. The list of metrics included in the ExpandedDataSet.

See the API Metrics for the list of dimension names.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMetricNames

Immutable. The list of metrics included in the ExpandedDataSet.

See the API Metrics for the list of dimension names.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getDimensionFilterExpression

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\ExpandedDataSetFilterExpression|null

hasDimensionFilterExpression

clearDimensionFilterExpression

setDimensionFilterExpression

Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering other row.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\ExpandedDataSetFilterExpression
Returns
TypeDescription
$this

getDataCollectionStartTime

Output only. Time when expanded data set began (or will begin) collecing data.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasDataCollectionStartTime

clearDataCollectionStartTime

setDataCollectionStartTime

Output only. Time when expanded data set began (or will begin) collecing data.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this