REST Resource: properties.expandedDataSets

Resource: ExpandedDataSet

A resource message representing a GA4 ExpandedDataSet.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "dimensionNames": [
    string
  ],
  "metricNames": [
    string
  ],
  "dimensionFilterExpression": {
    object (ExpandedDataSetFilterExpression)
  },
  "dataCollectionStartTime": string
}
Fields
name

string

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

string

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

string

Optional. The description of the ExpandedDataSet. Max 50 chars.
dimensionNames[]

string

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

string

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

object (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.
dataCollectionStartTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ExpandedDataSetFilterExpression

A logical expression of EnhancedDataSet dimension filters.

JSON representation 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (ExpandedDataSetFilterExpressionList)
  },
  "notExpression": {
    object (ExpandedDataSetFilterExpression)
  },
  "filter": {
    object (ExpandedDataSetFilter)
  }
  // End of list of possible types for union field expr.
}
Fields
Union field expr. The expression applied to a filter. expr can be only one of the following:
andGroup

object (ExpandedDataSetFilterExpressionList)

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

object (ExpandedDataSetFilterExpression)

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

object (ExpandedDataSetFilter)

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 (ExpandedDataSetFilterExpression)
    }
  ]
}
Fields
filterExpressions[]

object (ExpandedDataSetFilterExpression)

A list of ExpandedDataSet filter expressions.

ExpandedDataSetFilter

A specific filter for a single dimension

JSON representation 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  }
  // End of list of possible types for union field one_filter.
}
Fields
fieldName

string

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

object (StringFilter)

A filter for a string-type dimension that matches a particular pattern.
inListFilter

object (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 (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Fields
matchType

enum (MatchType)

Required. The match type for the string filter.
value

string

Required. The string value to be matched against.
caseSensitive

boolean

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[]

string

Required. The list of possible string values to match against. Must be non-empty.
caseSensitive

boolean

Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.

Methods

create

 Creates a ExpandedDataSet.

delete

 Deletes a ExpandedDataSet on a property.

get

 Lookup for a single ExpandedDataSet.

list

 Lists ExpandedDataSets on a property.

patch

 Updates a ExpandedDataSet on a property.