Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportUserEventsRequest

Inherits:

Object

• Object
• Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportUserEventsRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Request message for the ExportUserEvents method.

Instance Attribute Summary

• #filter ⇒ String

  A filtering expression to specify restrictions on returned events.

• #output_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig

  The output configuration setting.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudRetailV2alphaExportUserEventsRequest constructor

  A new instance of GoogleCloudRetailV2alphaExportUserEventsRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaExportUserEventsRequest

Returns a new instance of GoogleCloudRetailV2alphaExportUserEventsRequest.

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3079

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filter ⇒ String

A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, eventTime > "2012- 04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43. 511Z" eventType=search We expect only three types of fields: * eventTime: This can be specified twice, once with a less than operator and once with a greater than operator. The eventTime restriction should result in one, contiguous, valid, eventTime range. * eventType: Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * eventsMissingCatalogItems: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * Example 2: eventTime > "2012-04- 23T18:25:43.511Z" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18: 30:43.511Z" * Example 4: eventTime > "2012-04-23T18:25:43.511Z" * Example 5: eventType = (detail-page-view OR search) * Example 6: eventsMissingCatalogItems Corresponds to the JSON property filter

Returns:

• (String)

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3072

def filter
  @filter
end

#output_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig

The output configuration setting. Corresponds to the JSON property outputConfig

Returns:

• (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig)

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3077

def output_config
  @output_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3084

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @output_config = args[:output_config] if args.key?(:output_config)
end