Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a ExpandedDataSet.
Deletes a ExpandedDataSet on a property.
Lookup for a single ExpandedDataSet.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists ExpandedDataSets on a property.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a ExpandedDataSet on a property.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a ExpandedDataSet.
Args:
parent: string, Required. Example format: properties/1234 (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing a GA4 ExpandedDataSet.
"dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data.
"description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars.
"dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # 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.
"andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
"filterExpressions": [ # A list of ExpandedDataSet filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
],
},
"filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.
"fieldName": "A String", # Required. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
},
"dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.
"A String",
],
"displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars.
"metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.
"A String",
],
"name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a GA4 ExpandedDataSet.
"dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data.
"description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars.
"dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # 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.
"andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
"filterExpressions": [ # A list of ExpandedDataSet filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
],
},
"filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.
"fieldName": "A String", # Required. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
},
"dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.
"A String",
],
"displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars.
"metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.
"A String",
],
"name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
}
delete(name, x__xgafv=None)
Deletes a ExpandedDataSet on a property.
Args:
name: string, Required. Example format: properties/1234/expandedDataSets/5678 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Lookup for a single ExpandedDataSet.
Args:
name: string, Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a GA4 ExpandedDataSet.
"dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data.
"description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars.
"dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # 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.
"andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
"filterExpressions": [ # A list of ExpandedDataSet filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
],
},
"filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.
"fieldName": "A String", # Required. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
},
"dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.
"A String",
],
"displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars.
"metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.
"A String",
],
"name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists ExpandedDataSets on a property.
Args:
parent: string, Required. Example format: properties/1234 (required)
pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
pageToken: string, A page token, received from a previous `ListExpandedDataSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExpandedDataSet` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListExpandedDataSets RPC.
"expandedDataSets": [ # List of ExpandedDataSet. These will be ordered stably, but in an arbitrary order.
{ # A resource message representing a GA4 ExpandedDataSet.
"dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data.
"description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars.
"dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # 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.
"andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
"filterExpressions": [ # A list of ExpandedDataSet filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
],
},
"filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.
"fieldName": "A String", # Required. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
},
"dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.
"A String",
],
"displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars.
"metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.
"A String",
],
"name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a ExpandedDataSet on a property.
Args:
name: string, Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set} (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing a GA4 ExpandedDataSet.
"dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data.
"description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars.
"dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # 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.
"andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
"filterExpressions": [ # A list of ExpandedDataSet filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
],
},
"filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.
"fieldName": "A String", # Required. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
},
"dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.
"A String",
],
"displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars.
"metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.
"A String",
],
"name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
}
updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a GA4 ExpandedDataSet.
"dataCollectionStartTime": "A String", # Output only. Time when expanded data set began (or will begin) collecing data.
"description": "A String", # Optional. The description of the ExpandedDataSet. Max 50 chars.
"dimensionFilterExpression": { # A logical expression of EnhancedDataSet dimension filters. # 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.
"andGroup": { # A list of ExpandedDataSet filter expressions. # A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
"filterExpressions": [ # A list of ExpandedDataSet filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression
],
},
"filter": { # A specific filter for a single dimension # A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression.
"fieldName": "A String", # Required. The dimension name to filter.
"inListFilter": { # A filter for a string dimension that matches a particular list of options. # A filter for a string dimension that matches a particular list of options.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true.
"values": [ # Required. The list of possible string values to match against. Must be non-empty.
"A String",
],
},
"stringFilter": { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
"caseSensitive": True or False, # Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
"matchType": "A String", # Required. The match type for the string filter.
"value": "A String", # Required. The string value to be matched against.
},
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression # A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
},
"dimensionNames": [ # Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names.
"A String",
],
"displayName": "A String", # Required. The display name of the ExpandedDataSet. Max 200 chars.
"metricNames": [ # Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names.
"A String",
],
"name": "A String", # Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
}