Class: Google::Cloud::DiscoveryEngine::V1::DocumentInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/user_event.rb

Overview

Detailed document information associated with a user event.

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ ::String

Returns The Document resource ID.

Returns:

  • (::String) —

    The Document resource ID.



454
455
456
457
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 454

class DocumentInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#joined ⇒ ::Boolean (readonly)

Returns Output only. Whether the referenced Document can be found in the data store.

Returns:

  • (::Boolean) —

    Output only. Whether the referenced Document can be found in the data store.



454
455
456
457
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 454

class DocumentInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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}.

Returns:

  • (::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}



454
455
456
457
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 454

class DocumentInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#promotion_ids ⇒ ::Array<::String>

Returns The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

Returns:

  • (::Array<::String>) —

    The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.



454
455
456
457
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 454

class DocumentInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#quantity ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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


454
455
456
457
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 454

class DocumentInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uri ⇒ ::String

Returns The Document URI - only allowed for website data stores.

Returns:

  • (::String) —

    The Document URI - only allowed for website data stores.



454
455
456
457
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 454

class DocumentInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end