Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::DocumentInfo (v0.1.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::DocumentInfo.

Detailed document information associated with a user event.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#id

def id() -> ::String
Returns
  • (::String) — Required. The Document resource ID.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Required. The Document resource ID.
Returns
  • (::String) — Required. The Document resource ID.

#name

def name() -> ::String
Returns
  • (::String) — Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
Returns
  • (::String) — Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

#promotion_ids

def promotion_ids() -> ::Array<::String>
Returns
  • (::Array<::String>) — The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

#promotion_ids=

def promotion_ids=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.

#quantity

def quantity() -> ::Integer
Returns
  • (::Integer) —

    Quantity of the Document associated with the user event. Defaults to 1.

    For example, this field will be 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

#quantity=

def quantity=(value) -> ::Integer
Parameter
  • value (::Integer) —

    Quantity of the Document associated with the user event. Defaults to 1.

    For example, this field will be 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 will be 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