- Resource: ExpandedDataSet
- ExpandedDataSetFilterExpression
- ExpandedDataSetFilterExpressionList
- ExpandedDataSetFilter
- StringFilter
- MatchType
- InListFilter
- Methods
Resource: ExpandedDataSet
A resource message representing a GA4 ExpandedDataSet.
JSON representation |
---|
{
"name": string,
"displayName": string,
"description": string,
"dimensionNames": [
string
],
"metricNames": [
string
],
"dimensionFilterExpression": {
object ( |
Fields | |
---|---|
name |
Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expandedDataSet} |
displayName |
Required. The display name of the ExpandedDataSet. Max 200 chars. |
description |
Optional. The description of the ExpandedDataSet. Max 50 chars. |
dimensionNames[] |
Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names. |
metricNames[] |
Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names. |
dimensionFilterExpression |
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 |
dataCollectionStartTime |
Output only. Time when expanded data set began (or will begin) collecing data. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
ExpandedDataSetFilterExpression
A logical expression of EnhancedDataSet dimension filters.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field expr . The expression applied to a filter. expr can be only one of the following: |
|
andGroup |
A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either notExpression or dimensionFilter. This must be set for the top level ExpandedDataSetFilterExpression. |
notExpression |
A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimensionFilter. This cannot be set on the top level ExpandedDataSetFilterExpression. |
filter |
A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression. |
ExpandedDataSetFilterExpressionList
A list of ExpandedDataSet filter expressions.
JSON representation |
---|
{
"filterExpressions": [
{
object ( |
Fields | |
---|---|
filterExpressions[] |
A list of ExpandedDataSet filter expressions. |
ExpandedDataSetFilter
A specific filter for a single dimension
JSON representation |
---|
{ "fieldName": string, // Union field |
Fields | |
---|---|
fieldName |
Required. The dimension name to filter. |
Union field one_filter . One of the above filters. one_filter can be only one of the following: |
|
stringFilter |
A filter for a string-type dimension that matches a particular pattern. |
inListFilter |
A filter for a string dimension that matches a particular list of options. |
StringFilter
A filter for a string-type dimension that matches a particular pattern.
JSON representation |
---|
{
"matchType": enum ( |
Fields | |
---|---|
matchType |
Required. The match type for the string filter. |
value |
Required. The string value to be matched against. |
caseSensitive |
Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when matchType is EXACT. Must be false when matchType is CONTAINS. |
MatchType
The match type for the string filter.
Enums | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Unspecified |
EXACT |
Exact match of the string value. |
CONTAINS |
Contains the string value. |
InListFilter
A filter for a string dimension that matches a particular list of options.
JSON representation |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Fields | |
---|---|
values[] |
Required. The list of possible string values to match against. Must be non-empty. |
caseSensitive |
Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true. |
Methods |
|
---|---|
|
Creates a ExpandedDataSet. |
|
Deletes a ExpandedDataSet on a property. |
|
Lookup for a single ExpandedDataSet. |
|
Lists ExpandedDataSets on a property. |
|
Updates a ExpandedDataSet on a property. |