diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 63b5c4fbcf0..c809edee89e 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -547,12 +547,147 @@

Method Details

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, + "adsenseLink": { # A link between a GA4 Property and an AdSense for Content ad client. # A snapshot of an AdSenseLink resource in change history. + "adClientCode": "A String", # Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890" + "name": "A String", # Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789 + }, "attributionSettings": { # The attribution settings used for a given property. This is a singleton resource. # A snapshot of AttributionSettings resource in change history. "acquisitionConversionEventLookbackWindow": "A String", # Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days. "name": "A String", # Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings" "otherConversionEventLookbackWindow": "A String", # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days. "reportingAttributionModel": "A String", # Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected. }, + "audience": { # A resource message representing a GA4 Audience. # A snapshot of an Audience resource in change history. + "adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization. + "description": "A String", # Required. The description of the Audience. + "displayName": "A String", # Required. The display name of the Audience. + "eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience. + "eventName": "A String", # Required. The event name that will be logged. + "logCondition": "A String", # Required. When to log the event. + }, + "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. + "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). + "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. + "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. + "scope": "A String", # Required. Immutable. Specifies the scope for this filter. + "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. + "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. + { # A condition that must occur in the specified step order for this user to match the sequence. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. + "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + "dimensionOrMetricFilter": { # A specific filter for a single dimension or metric. # A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression. + "atAnyPointInTime": True or False, # Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS. + "betweenFilter": { # A filter for numeric or date values between certain values on a dimension or metric. # A filter for numeric or date values between certain values on a dimension or metric. + "fromValue": { # To represent a number. # Required. Begins with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + "toValue": { # To represent a number. # Required. Ends with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "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. + "values": [ # Required. The list of possible string values to match against. Must be non-empty. + "A String", + ], + }, + "numericFilter": { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric. + "operation": "A String", # Required. The operation applied to a numeric filter. + "value": { # To represent a number. # Required. The numeric or date value to match against. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "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. + "matchType": "A String", # Required. The match type for the string filter. + "value": "A String", # Required. The string value to be matched against. + }, + }, + "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. + "eventName": "A String", # Required. Immutable. The name of the event to match against. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + }, + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + }, + "immediatelyFollows": True or False, # Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step. + "scope": "A String", # Required. Immutable. Specifies the scope for this step. + }, + ], + }, + "simpleFilter": { # Defines a simple filter that a user must satisfy to be a member of the Audience. # A simple filter that a user must satisfy to be a member of the Audience. + "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters. + "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + "dimensionOrMetricFilter": { # A specific filter for a single dimension or metric. # A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression. + "atAnyPointInTime": True or False, # Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS. + "betweenFilter": { # A filter for numeric or date values between certain values on a dimension or metric. # A filter for numeric or date values between certain values on a dimension or metric. + "fromValue": { # To represent a number. # Required. Begins with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + "toValue": { # To represent a number. # Required. Ends with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "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. + "values": [ # Required. The list of possible string values to match against. Must be non-empty. + "A String", + ], + }, + "numericFilter": { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric. + "operation": "A String", # Required. The operation applied to a numeric filter. + "value": { # To represent a number. # Required. The numeric or date value to match against. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "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. + "matchType": "A String", # Required. The match type for the string filter. + "value": "A String", # Required. The string value to be matched against. + }, + }, + "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. + "eventName": "A String", # Required. Immutable. The name of the event to match against. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + }, + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + }, + "scope": "A String", # Required. Immutable. Specifies the scope for this filter. + }, + }, + ], + "membershipDurationDays": 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days. + "name": "A String", # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} + }, "bigqueryLink": { # A link between a GA4 Property and BigQuery project. # A snapshot of a BigQuery link resource in change history. "createTime": "A String", # Output only. Time when the link was created. "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project. @@ -690,6 +825,25 @@

Method Details

"uriQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters. "videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. }, + "eventCreateRule": { # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule. # A snapshot of an EventCreateRule resource in change history. + "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter + "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied. + { # Defines a condition for when an Event Edit or Event Creation rule applies to an event. + "comparisonType": "A String", # Required. The type of comparison to be applied to the value. + "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces. + "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'. + "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value. + }, + ], + "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule} + "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. + { # Defines an event parameter to mutate. + "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place. + "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters). + }, + ], + "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied. + }, "expandedDataSet": { # A resource message representing a GA4 ExpandedDataSet. # A snapshot of an ExpandedDataSet resource in change history. "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. @@ -782,12 +936,147 @@

Method Details

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code. "updateTime": "A String", # Output only. Time when account payload fields were last updated. }, + "adsenseLink": { # A link between a GA4 Property and an AdSense for Content ad client. # A snapshot of an AdSenseLink resource in change history. + "adClientCode": "A String", # Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890" + "name": "A String", # Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789 + }, "attributionSettings": { # The attribution settings used for a given property. This is a singleton resource. # A snapshot of AttributionSettings resource in change history. "acquisitionConversionEventLookbackWindow": "A String", # Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days. "name": "A String", # Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings" "otherConversionEventLookbackWindow": "A String", # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days. "reportingAttributionModel": "A String", # Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected. }, + "audience": { # A resource message representing a GA4 Audience. # A snapshot of an Audience resource in change history. + "adsPersonalizationEnabled": True or False, # Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization. + "description": "A String", # Required. The description of the Audience. + "displayName": "A String", # Required. The display name of the Audience. + "eventTrigger": { # Specifies an event to log when a user joins the Audience. # Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience. + "eventName": "A String", # Required. The event name that will be logged. + "logCondition": "A String", # Required. When to log the event. + }, + "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. + "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). + "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. + "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. + "scope": "A String", # Required. Immutable. Specifies the scope for this filter. + "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. + "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. + { # A condition that must occur in the specified step order for this user to match the sequence. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. + "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + "dimensionOrMetricFilter": { # A specific filter for a single dimension or metric. # A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression. + "atAnyPointInTime": True or False, # Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS. + "betweenFilter": { # A filter for numeric or date values between certain values on a dimension or metric. # A filter for numeric or date values between certain values on a dimension or metric. + "fromValue": { # To represent a number. # Required. Begins with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + "toValue": { # To represent a number. # Required. Ends with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "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. + "values": [ # Required. The list of possible string values to match against. Must be non-empty. + "A String", + ], + }, + "numericFilter": { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric. + "operation": "A String", # Required. The operation applied to a numeric filter. + "value": { # To represent a number. # Required. The numeric or date value to match against. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "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. + "matchType": "A String", # Required. The match type for the string filter. + "value": "A String", # Required. The string value to be matched against. + }, + }, + "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. + "eventName": "A String", # Required. Immutable. The name of the event to match against. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + }, + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + }, + "immediatelyFollows": True or False, # Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step. + "scope": "A String", # Required. Immutable. Specifies the scope for this step. + }, + ], + }, + "simpleFilter": { # Defines a simple filter that a user must satisfy to be a member of the Audience. # A simple filter that a user must satisfy to be a member of the Audience. + "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters. + "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + "dimensionOrMetricFilter": { # A specific filter for a single dimension or metric. # A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression. + "atAnyPointInTime": True or False, # Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS. + "betweenFilter": { # A filter for numeric or date values between certain values on a dimension or metric. # A filter for numeric or date values between certain values on a dimension or metric. + "fromValue": { # To represent a number. # Required. Begins with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + "toValue": { # To represent a number. # Required. Ends with this number, inclusive. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "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. + "values": [ # Required. The list of possible string values to match against. Must be non-empty. + "A String", + ], + }, + "numericFilter": { # A filter for numeric or date values on a dimension or metric. # A filter for numeric or date values on a dimension or metric. + "operation": "A String", # Required. The operation applied to a numeric filter. + "value": { # To represent a number. # Required. The numeric or date value to match against. + "doubleValue": 3.14, # Double value. + "int64Value": "A String", # Integer value. + }, + }, + "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. + "matchType": "A String", # Required. The match type for the string filter. + "value": "A String", # Required. The string value to be matched against. + }, + }, + "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. + "eventName": "A String", # Required. Immutable. The name of the event to match against. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + }, + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. + "filterExpressions": [ # A list of Audience filter expressions. + # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression + ], + }, + }, + "scope": "A String", # Required. Immutable. Specifies the scope for this filter. + }, + }, + ], + "membershipDurationDays": 42, # Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days. + "name": "A String", # Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId} + }, "bigqueryLink": { # A link between a GA4 Property and BigQuery project. # A snapshot of a BigQuery link resource in change history. "createTime": "A String", # Output only. Time when the link was created. "dailyExportEnabled": True or False, # If set true, enables daily data export to the linked Google Cloud project. @@ -925,6 +1214,25 @@

Method Details

"uriQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters. "videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. }, + "eventCreateRule": { # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule. # A snapshot of an EventCreateRule resource in change history. + "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter + "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied. + { # Defines a condition for when an Event Edit or Event Creation rule applies to an event. + "comparisonType": "A String", # Required. The type of comparison to be applied to the value. + "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces. + "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'. + "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value. + }, + ], + "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule} + "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. + { # Defines an event parameter to mutate. + "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place. + "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters). + }, + ], + "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied. + }, "expandedDataSet": { # A resource message representing a GA4 ExpandedDataSet. # A snapshot of an ExpandedDataSet resource in change history. "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. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.adSenseLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.adSenseLinks.html new file mode 100644 index 00000000000..94c987a44cd --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.adSenseLinks.html @@ -0,0 +1,208 @@ + + + +

Google Analytics Admin API . properties . adSenseLinks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an AdSenseLink.

+

+ delete(name, x__xgafv=None)

+

Deletes an AdSenseLink.

+

+ get(name, x__xgafv=None)

+

Looks up a single AdSenseLink.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists AdSenseLinks on a property.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates an AdSenseLink.
+
+Args:
+  parent: string, Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A link between a GA4 Property and an AdSense for Content ad client.
+  "adClientCode": "A String", # Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890"
+  "name": "A String", # Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A link between a GA4 Property and an AdSense for Content ad client.
+  "adClientCode": "A String", # Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890"
+  "name": "A String", # Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes an AdSenseLink.
+
+Args:
+  name: string, Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/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) + 
Looks up a single AdSenseLink.
+
+Args:
+  name: string, Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/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 link between a GA4 Property and an AdSense for Content ad client.
+  "adClientCode": "A String", # Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890"
+  "name": "A String", # Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists AdSenseLinks on a property.
+
+Args:
+  parent: string, Required. Resource name of the parent property. Format: properties/{propertyId} Example: 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 `ListAdSenseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdSenseLinks` 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 ListAdSenseLinks method.
+  "adsenseLinks": [ # List of AdSenseLinks.
+    { # A link between a GA4 Property and an AdSense for Content ad client.
+      "adClientCode": "A String", # Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: "ca-pub-1234567890"
+      "name": "A String", # Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789
+    },
+  ],
+  "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.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html b/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html index 0371aff589c..ac0ec57627f 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.audiences.html @@ -144,14 +144,14 @@

Method Details

}, "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. - { # A clause for defining either a simple or sequence filter. A filter can be inclusive (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., users satisfying the filter clause are excluded from the Audience). + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. "scope": "A String", # Required. Immutable. Specifies the scope for this filter. "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. { # A condition that must occur in the specified step order for this user to match the sequence. - "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. "filterExpressions": [ # A list of Audience filter expressions. @@ -170,8 +170,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -193,9 +193,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -226,8 +226,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -249,9 +249,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -284,14 +284,14 @@

Method Details

}, "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. - { # A clause for defining either a simple or sequence filter. A filter can be inclusive (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., users satisfying the filter clause are excluded from the Audience). + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. "scope": "A String", # Required. Immutable. Specifies the scope for this filter. "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. { # A condition that must occur in the specified step order for this user to match the sequence. - "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. "filterExpressions": [ # A list of Audience filter expressions. @@ -310,8 +310,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -333,9 +333,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -366,8 +366,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -389,9 +389,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -431,14 +431,14 @@

Method Details

}, "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. - { # A clause for defining either a simple or sequence filter. A filter can be inclusive (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., users satisfying the filter clause are excluded from the Audience). + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. "scope": "A String", # Required. Immutable. Specifies the scope for this filter. "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. { # A condition that must occur in the specified step order for this user to match the sequence. - "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. "filterExpressions": [ # A list of Audience filter expressions. @@ -457,8 +457,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -480,9 +480,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -513,8 +513,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -536,9 +536,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -582,14 +582,14 @@

Method Details

}, "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. - { # A clause for defining either a simple or sequence filter. A filter can be inclusive (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., users satisfying the filter clause are excluded from the Audience). + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. "scope": "A String", # Required. Immutable. Specifies the scope for this filter. "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. { # A condition that must occur in the specified step order for this user to match the sequence. - "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. "filterExpressions": [ # A list of Audience filter expressions. @@ -608,8 +608,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -631,9 +631,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -664,8 +664,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -687,9 +687,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -741,14 +741,14 @@

Method Details

}, "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. - { # A clause for defining either a simple or sequence filter. A filter can be inclusive (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., users satisfying the filter clause are excluded from the Audience). + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. "scope": "A String", # Required. Immutable. Specifies the scope for this filter. "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. { # A condition that must occur in the specified step order for this user to match the sequence. - "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. "filterExpressions": [ # A list of Audience filter expressions. @@ -767,8 +767,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -790,9 +790,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -823,8 +823,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -846,9 +846,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -882,14 +882,14 @@

Method Details

}, "exclusionDurationMode": "A String", # Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. "filterClauses": [ # Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. - { # A clause for defining either a simple or sequence filter. A filter can be inclusive (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., users satisfying the filter clause are excluded from the Audience). + { # A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience). "clauseType": "A String", # Required. Specifies whether this is an include or exclude filter clause. "sequenceFilter": { # Defines filters that must occur in a specific order for the user to be a member of the Audience. # Filters that must occur in a specific order for the user to be a member of the Audience. "scope": "A String", # Required. Immutable. Specifies the scope for this filter. "sequenceMaximumDuration": "A String", # Optional. Defines the time period in which the whole sequence must occur. "sequenceSteps": [ # Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. { # A condition that must occur in the specified step order for this user to match the sequence. - "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. + "constraintDuration": "A String", # Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. "filterExpression": { # A logical expression of Audience dimension, metric, or event filters. # Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. "andGroup": { # A list of Audience filter expressions. # A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. "filterExpressions": [ # A list of Audience filter expressions. @@ -908,8 +908,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -931,9 +931,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression @@ -964,8 +964,8 @@

Method Details

"int64Value": "A String", # Integer value. }, }, - "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. - "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. + "fieldName": "A String", # Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). + "inAnyNDayPeriod": 42, # Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. "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. "values": [ # Required. The list of possible string values to match against. Must be non-empty. @@ -987,9 +987,9 @@

Method Details

}, "eventFilter": { # A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. # Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. "eventName": "A String", # Required. Immutable. The name of the event to match against. - "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. + "eventParameterFilterExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. }, - "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. + "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression # A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. "orGroup": { # A list of Audience filter expressions. # A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. "filterExpressions": [ # A list of Audience filter expressions. # Object with schema name: GoogleAnalyticsAdminV1alphaAudienceFilterExpression diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.eventCreateRules.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.eventCreateRules.html new file mode 100644 index 00000000000..f5612b9586a --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.eventCreateRules.html @@ -0,0 +1,330 @@ + + + +

Google Analytics Admin API . properties . dataStreams . eventCreateRules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates an EventCreateRule.

+

+ delete(name, x__xgafv=None)

+

Deletes an EventCreateRule.

+

+ get(name, x__xgafv=None)

+

Lookup for a single EventCreateRule.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists EventCreateRules on a web data stream.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates an EventCreateRule.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates an EventCreateRule.
+
+Args:
+  parent: string, Required. Example format: properties/123/dataStreams/456 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.
+  "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
+  "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
+    { # Defines a condition for when an Event Edit or Event Creation rule applies to an event.
+      "comparisonType": "A String", # Required. The type of comparison to be applied to the value.
+      "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.
+      "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.
+      "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
+    },
+  ],
+  "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
+  "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
+    { # Defines an event parameter to mutate.
+      "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
+      "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+    },
+  ],
+  "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.
+  "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
+  "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
+    { # Defines a condition for when an Event Edit or Event Creation rule applies to an event.
+      "comparisonType": "A String", # Required. The type of comparison to be applied to the value.
+      "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.
+      "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.
+      "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
+    },
+  ],
+  "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
+  "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
+    { # Defines an event parameter to mutate.
+      "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
+      "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+    },
+  ],
+  "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes an EventCreateRule.
+
+Args:
+  name: string, Required. Example format: properties/123/dataStreams/456/eventCreateRules/789 (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 EventCreateRule.
+
+Args:
+  name: string, Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789 (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.
+  "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
+  "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
+    { # Defines a condition for when an Event Edit or Event Creation rule applies to an event.
+      "comparisonType": "A String", # Required. The type of comparison to be applied to the value.
+      "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.
+      "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.
+      "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
+    },
+  ],
+  "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
+  "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
+    { # Defines an event parameter to mutate.
+      "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
+      "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+    },
+  ],
+  "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists EventCreateRules on a web data stream.
+
+Args:
+  parent: string, Required. Example format: properties/123/dataStreams/456 (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 `ListEventCreateRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventCreateRules` 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 ListEventCreateRules RPC.
+  "eventCreateRules": [ # List of EventCreateRules. These will be ordered stably, but in an arbitrary order.
+    { # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.
+      "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
+      "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
+        { # Defines a condition for when an Event Edit or Event Creation rule applies to an event.
+          "comparisonType": "A String", # Required. The type of comparison to be applied to the value.
+          "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.
+          "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.
+          "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
+        },
+      ],
+      "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
+      "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
+        { # Defines an event parameter to mutate.
+          "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
+          "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+        },
+      ],
+      "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
+    },
+  ],
+  "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 an EventCreateRule.
+
+Args:
+  name: string, Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.
+  "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
+  "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
+    { # Defines a condition for when an Event Edit or Event Creation rule applies to an event.
+      "comparisonType": "A String", # Required. The type of comparison to be applied to the value.
+      "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.
+      "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.
+      "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
+    },
+  ],
+  "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
+  "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
+    { # Defines an event parameter to mutate.
+      "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
+      "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+    },
+  ],
+  "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
+}
+
+  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:
+
+    { # An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.
+  "destinationEvent": "A String", # Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
+  "eventConditions": [ # Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
+    { # Defines a condition for when an Event Edit or Event Creation rule applies to an event.
+      "comparisonType": "A String", # Required. The type of comparison to be applied to the value.
+      "field": "A String", # Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.
+      "negated": True or False, # Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.
+      "value": "A String", # Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
+    },
+  ],
+  "name": "A String", # Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
+  "parameterMutations": [ # Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
+    { # Defines an event parameter to mutate.
+      "parameter": "A String", # Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.
+      "parameterValue": "A String", # Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
+    },
+  ],
+  "sourceCopyParameters": True or False, # If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html index ba21618fff6..3e3dad435d0 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html @@ -74,6 +74,11 @@

Google Analytics Admin API . properties . dataStreams

Instance Methods

+

+ eventCreateRules() +

+

Returns the eventCreateRules Resource.

+

measurementProtocolSecrets()

diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index a18fcc437b9..eaa4e9d6165 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -79,6 +79,11 @@

Instance Methods

Returns the accessBindings Resource.

+

+ adSenseLinks() +

+

Returns the adSenseLinks Resource.

+

audiences()

diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index aebfe23e422..29c4222af77 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -1693,6 +1693,112 @@ } } }, + "adSenseLinks": { + "methods": { + "create": { + "description": "Creates an AdSenseLink.", + "flatPath": "v1alpha/properties/{propertiesId}/adSenseLinks", + "httpMethod": "POST", + "id": "analyticsadmin.properties.adSenseLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/adSenseLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaAdSenseLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAdSenseLink" + } + }, + "delete": { + "description": "Deletes an AdSenseLink.", + "flatPath": "v1alpha/properties/{propertiesId}/adSenseLinks/{adSenseLinksId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.adSenseLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/adSenseLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + } + }, + "get": { + "description": "Looks up a single AdSenseLink.", + "flatPath": "v1alpha/properties/{propertiesId}/adSenseLinks/{adSenseLinksId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.adSenseLinks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/adSenseLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAdSenseLink" + } + }, + "list": { + "description": "Lists AdSenseLinks on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/adSenseLinks", + "httpMethod": "GET", + "id": "analyticsadmin.properties.adSenseLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous `ListAdSenseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdSenseLinks` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/adSenseLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListAdSenseLinksResponse" + } + } + } + }, "audiences": { "methods": { "archive": { @@ -2745,6 +2851,160 @@ } }, "resources": { + "eventCreateRules": { + "methods": { + "create": { + "description": "Creates an EventCreateRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules", + "httpMethod": "POST", + "id": "analyticsadmin.properties.dataStreams.eventCreateRules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/123/dataStreams/456", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/eventCreateRules", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaEventCreateRule" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEventCreateRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes an EventCreateRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules/{eventCreateRulesId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.dataStreams.eventCreateRules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: properties/123/dataStreams/456/eventCreateRules/789", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/eventCreateRules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single EventCreateRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules/{eventCreateRulesId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.eventCreateRules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/eventCreateRules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEventCreateRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Lists EventCreateRules on a web data stream.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.eventCreateRules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListEventCreateRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventCreateRules` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: properties/123/dataStreams/456", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/eventCreateRules", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates an EventCreateRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules/{eventCreateRulesId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.dataStreams.eventCreateRules.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/eventCreateRules/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaEventCreateRule" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEventCreateRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, "measurementProtocolSecrets": { "methods": { "create": { @@ -4062,7 +4322,7 @@ } } }, - "revision": "20230416", + "revision": "20230523", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -4536,6 +4796,22 @@ "properties": {}, "type": "object" }, + "GoogleAnalyticsAdminV1alphaAdSenseLink": { + "description": "A link between a GA4 Property and an AdSense for Content ad client.", + "id": "GoogleAnalyticsAdminV1alphaAdSenseLink", + "properties": { + "adClientCode": { + "description": "Immutable. The AdSense ad client code that the GA4 property is linked to. Example format: \"ca-pub-1234567890\"", + "type": "string" + }, + "name": { + "description": "Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest": { "description": "Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.", "id": "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest", @@ -4705,11 +4981,11 @@ "description": "A filter for numeric or date values between certain values on a dimension or metric." }, "fieldName": { - "description": "Required. Immutable. The dimension name or metric name to filter.", + "description": "Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).", "type": "string" }, "inAnyNDayPeriod": { - "description": "Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (i.e., infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.", + "description": "Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.", "format": "int32", "type": "integer" }, @@ -4850,7 +5126,7 @@ }, "eventParameterFilterExpression": { "$ref": "GoogleAnalyticsAdminV1alphaAudienceFilterExpression", - "description": "Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (i.e., nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for \"eventCount\", only that one will be considered; all the other filters will be ignored." + "description": "Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for \"eventCount\", only that one will be considered; all the other filters will be ignored." } }, "type": "object" @@ -4881,7 +5157,7 @@ "type": "object" }, "GoogleAnalyticsAdminV1alphaAudienceFilterClause": { - "description": "A clause for defining either a simple or sequence filter. A filter can be inclusive (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., users satisfying the filter clause are excluded from the Audience).", + "description": "A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience).", "id": "GoogleAnalyticsAdminV1alphaAudienceFilterClause", "properties": { "clauseType": { @@ -4927,7 +5203,7 @@ }, "notExpression": { "$ref": "GoogleAnalyticsAdminV1alphaAudienceFilterExpression", - "description": "A filter expression to be NOT'ed (i.e., inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression." + "description": "A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression." }, "orGroup": { "$ref": "GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList", @@ -4990,7 +5266,7 @@ "id": "GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep", "properties": { "constraintDuration": { - "description": "Optional. When set, this step must be satisfied within the constraint_duration of the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.", + "description": "Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.", "format": "google-duration", "type": "string" }, @@ -5384,10 +5660,18 @@ "$ref": "GoogleAnalyticsAdminV1alphaAccount", "description": "A snapshot of an Account resource in change history." }, + "adsenseLink": { + "$ref": "GoogleAnalyticsAdminV1alphaAdSenseLink", + "description": "A snapshot of an AdSenseLink resource in change history." + }, "attributionSettings": { "$ref": "GoogleAnalyticsAdminV1alphaAttributionSettings", "description": "A snapshot of AttributionSettings resource in change history." }, + "audience": { + "$ref": "GoogleAnalyticsAdminV1alphaAudience", + "description": "A snapshot of an Audience resource in change history." + }, "bigqueryLink": { "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink", "description": "A snapshot of a BigQuery link resource in change history." @@ -5428,6 +5712,10 @@ "$ref": "GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings", "description": "A snapshot of EnhancedMeasurementSettings resource in change history." }, + "eventCreateRule": { + "$ref": "GoogleAnalyticsAdminV1alphaEventCreateRule", + "description": "A snapshot of an EventCreateRule resource in change history." + }, "expandedDataSet": { "$ref": "GoogleAnalyticsAdminV1alphaExpandedDataSet", "description": "A snapshot of an ExpandedDataSet resource in change history." @@ -6211,6 +6499,40 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaEventCreateRule": { + "description": "An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.", + "id": "GoogleAnalyticsAdminV1alphaEventCreateRule", + "properties": { + "destinationEvent": { + "description": "Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter", + "type": "string" + }, + "eventConditions": { + "description": "Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaMatchingCondition" + }, + "type": "array" + }, + "name": { + "description": "Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}", + "readOnly": true, + "type": "string" + }, + "parameterMutations": { + "description": "Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaParameterMutation" + }, + "type": "array" + }, + "sourceCopyParameters": { + "description": "If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaExpandedDataSet": { "description": "A resource message representing a GA4 ExpandedDataSet.", "id": "GoogleAnalyticsAdminV1alphaExpandedDataSet", @@ -6627,6 +6949,24 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaListAdSenseLinksResponse": { + "description": "Response message for ListAdSenseLinks method.", + "id": "GoogleAnalyticsAdminV1alphaListAdSenseLinksResponse", + "properties": { + "adsenseLinks": { + "description": "List of AdSenseLinks.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaAdSenseLink" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaListAudiencesResponse": { "description": "Response message for ListAudiences RPC.", "id": "GoogleAnalyticsAdminV1alphaListAudiencesResponse", @@ -6814,6 +7154,24 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse": { + "description": "Response message for ListEventCreateRules RPC.", + "id": "GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse", + "properties": { + "eventCreateRules": { + "description": "List of EventCreateRules. These will be ordered stably, but in an arbitrary order.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaEventCreateRule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse": { "description": "Response message for ListExpandedDataSets RPC.", "id": "GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse", @@ -6940,6 +7298,63 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaMatchingCondition": { + "description": "Defines a condition for when an Event Edit or Event Creation rule applies to an event.", + "id": "GoogleAnalyticsAdminV1alphaMatchingCondition", + "properties": { + "comparisonType": { + "description": "Required. The type of comparison to be applied to the value.", + "enum": [ + "COMPARISON_TYPE_UNSPECIFIED", + "EQUALS", + "EQUALS_CASE_INSENSITIVE", + "CONTAINS", + "CONTAINS_CASE_INSENSITIVE", + "STARTS_WITH", + "STARTS_WITH_CASE_INSENSITIVE", + "ENDS_WITH", + "ENDS_WITH_CASE_INSENSITIVE", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "REGULAR_EXPRESSION", + "REGULAR_EXPRESSION_CASE_INSENSITIVE" + ], + "enumDescriptions": [ + "Unknown", + "Equals, case sensitive", + "Equals, case insensitive", + "Contains, case sensitive", + "Contains, case insensitive", + "Starts with, case sensitive", + "Starts with, case insensitive", + "Ends with, case sensitive", + "Ends with, case insensitive", + "Greater than", + "Greater than or equal", + "Less than", + "Less than or equal", + "regular expression. Only supported for web streams.", + "regular expression, case insensitive. Only supported for web streams." + ], + "type": "string" + }, + "field": { + "description": "Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces.", + "type": "string" + }, + "negated": { + "description": "Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'.", + "type": "boolean" + }, + "value": { + "description": "Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret": { "description": "A secret value used for sending hits to Measurement Protocol.", "id": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret", @@ -6978,6 +7393,21 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaParameterMutation": { + "description": "Defines an event parameter to mutate.", + "id": "GoogleAnalyticsAdminV1alphaParameterMutation", + "properties": { + "parameter": { + "description": "Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'event_name' to modify the event_name in place.", + "type": "string" + }, + "parameterValue": { + "description": "Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like \"[[other_parameter]]\" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaProperty": { "description": "A resource message representing a Google Analytics GA4 property.", "id": "GoogleAnalyticsAdminV1alphaProperty", @@ -7398,7 +7828,10 @@ "ATTRIBUTION_SETTINGS", "EXPANDED_DATA_SET", "CHANNEL_GROUP", - "ENHANCED_MEASUREMENT_SETTINGS" + "ENHANCED_MEASUREMENT_SETTINGS", + "ADSENSE_LINK", + "AUDIENCE", + "EVENT_CREATE_RULE" ], "enumDescriptions": [ "Resource type unknown or not specified.", @@ -7419,7 +7852,10 @@ "AttributionSettings resource", "ExpandedDataSet resource", "ChannelGroup resource", - "EnhancedMeasurementSettings resource" + "EnhancedMeasurementSettings resource", + "AdSenseLink resource", + "Audience resource", + "EventCreateRule resource" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index 5827707e963..cca3b1f0ce3 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -1594,7 +1594,7 @@ } } }, - "revision": "20230416", + "revision": "20230524", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": {