Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo

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

Overview

Detailed document information associated with a user event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1DocumentInfo

Returns a new instance of GoogleCloudDiscoveryengineV1DocumentInfo.



4537
4538
4539
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4537

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) 


4498
4499
4500
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4498

def conversion_value
  @conversion_value
end

#id ⇒ String

The Document resource ID. Corresponds to the JSON property id

Returns:

  • (String) 


4503
4504
4505
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4503

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) 


4508
4509
4510
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4508

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) 


4516
4517
4518
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4516

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>) 


4522
4523
4524
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4522

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) 


4530
4531
4532
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4530

def quantity
  @quantity
end

#uri ⇒ String

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

Returns:

  • (String) 


4535
4536
4537
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4535

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4542
4543
4544
4545
4546
4547
4548
4549
4550
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4542

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