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

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::DocumentInfo

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

• #conversion_value ⇒ ::Float

  Optional.

• #id ⇒ ::String

  The Document resource ID.

• #joined ⇒ ::Boolean readonly

  Output only.

• #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}.

• #promotion_ids ⇒ ::Array<::String>

  The promotion IDs associated with this Document.

• #quantity ⇒ ::Integer

  Quantity of the Document associated with the user event.

• #uri ⇒ ::String

  The Document URI - only allowed for website data stores.

Instance Attribute Details

#conversion_value ⇒ ::Float

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

Returns:

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

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 491

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

#id ⇒ ::String

Returns The Document resource ID.

Note: The following fields are mutually exclusive: id, name, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::String) —

  The Document resource ID.

  Note: The following fields are mutually exclusive: id, name, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 491

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.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 491

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}

Note: The following fields are mutually exclusive: name, id, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

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}

  Note: The following fields are mutually exclusive: name, id, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 491

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.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 491

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

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 491

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

#uri ⇒ ::String

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

Note: The following fields are mutually exclusive: uri, id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::String) —

  The Document URI - only allowed for website data stores.

  Note: The following fields are mutually exclusive: uri, id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 491

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