Skip to content

ConversionEvent.md

Latest commit

 

History

History
36 lines (30 loc) · 2.08 KB

ConversionEvent.md

File metadata and controls

36 lines (30 loc) · 2.08 KB
Raw

Zernio::ConversionEvent

Properties

Name Type Description Notes
event_name String Standard event name (Purchase, Lead, CompleteRegistration, AddToCart, InitiateCheckout, AddPaymentInfo, Subscribe, StartTrial, ViewContent, Search, Contact, SubmitApplication, Schedule) or a custom string (only supported on platforms that accept custom events — Meta). Per-platform behavior: - Meta: free-form; standard names match Meta's built-ins. - Google: ignored — the conversion action's category determines the type. - LinkedIn: ignored — the conversion rule's `type` is locked to the destination.
event_time Integer When the conversion happened, in unix seconds.
event_id String Unique dedup key. The same eventId must be used on pixel + CAPI to prevent double-counting. Mapped to event_id on Meta, transactionId on Google, eventId on LinkedIn (LinkedIn deduplicates against Insight Tag events with the same eventId; the Insight Tag event wins when both arrive).
value Float Conversion value in the specified currency. [optional]
currency String ISO 4217 currency code. [optional]
user ConversionEventUser
items Array<ConversionEventItemsInner> Item-level detail for ecommerce events. [optional]
source_url String URL where the conversion originated (used by Meta). [optional]
action_source String Where the conversion happened. Used by Meta; Google ignores. [optional]
platform_data Hash<String, Object> Escape hatch for platform-specific fields we haven't normalized. Forwarded as-is. [optional]

Example

require 'zernio-sdk'

instance = Zernio::ConversionEvent.new(
  event_name: Purchase,
  event_time: 1744732800,
  event_id: order_abc_123,
  value: 99.5,
  currency: USD,
  user: null,
  items: null,
  source_url: null,
  action_source: null,
  platform_data: null
)