GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentInfo (google_api_discovery_engine v0.28.0)

Detailed document information associated with a user event.

Attributes

conversionValue (type: number(), default: nil) - 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.
id (type: String.t, default: nil) - The Document resource ID.
joined (type: boolean(), default: nil) - Output only. Whether the referenced Document can be found in the data store.
name (type: String.t, default: nil) - 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}
promotionIds (type: list(String.t), default: nil) - The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
quantity (type: integer(), default: nil) - 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
uri (type: String.t, default: nil) - The Document URI - only allowed for website data stores.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentInfo{
    conversionValue: number() | nil,
    id: String.t() | nil,
    joined: boolean() | nil,
    name: String.t() | nil,
    promotionIds: [String.t()] | nil,
    quantity: integer() | nil,
    uri: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.