Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

Detailed document information associated with a user event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDocumentInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaDocumentInfo.



8993
8994
8995
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8993

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

Instance Attribute Details

#conversion_value ⇒ Float

Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the watch conversion type. Corresponds to the JSON property conversionValue

Returns:

  • (Float) 


8954
8955
8956
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8954

def conversion_value
  @conversion_value
end

#id ⇒ String

The Document resource ID. Corresponds to the JSON property id

Returns:

  • (String) 


8959
8960
8961
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8959

def id
  @id
end

#joined ⇒ Boolean Also known as: joined?

Output only. Whether the referenced Document can be found in the data store. Corresponds to the JSON property joined

Returns:

  • (Boolean) 


8964
8965
8966
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8964

def joined
  @joined
end

#name ⇒ String

The Document resource full name, of the form: projects/project/locations/ location/collections/collection_id/dataStores/data_store_id/branches/ branch_id/documents/document_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


8972
8973
8974
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8972

def name
  @name
end

#promotion_ids ⇒ Array<String>

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. Corresponds to the JSON property promotionIds

Returns:

  • (Array<String>) 


8978
8979
8980
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8978

def promotion_ids
  @promotion_ids
end

#quantity ⇒ Fixnum

Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types: * add-to-cart * purchase Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


8986
8987
8988
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8986

def quantity
  @quantity
end

#uri ⇒ String

The Document URI - only allowed for website data stores. Corresponds to the JSON property uri

Returns:

  • (String) 


8991
8992
8993
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8991

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8998
8999
9000
9001
9002
9003
9004
9005
9006
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8998

def update!(**args)
  @conversion_value = args[:conversion_value] if args.key?(:conversion_value)
  @id = args[:id] if args.key?(:id)
  @joined = args[:joined] if args.key?(:joined)
  @name = args[:name] if args.key?(:name)
  @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
  @quantity = args[:quantity] if args.key?(:quantity)
  @uri = args[:uri] if args.key?(:uri)
end