ConverlayConverlay

एपीआई संदर्भ

@converlay/sdk के लिए पूर्ण टाइपस्क्रिप्ट प्रकार परिभाषाएँ।

createConverlay(कॉन्फ़िगरेशन)

फ़ैक्टरी फ़ंक्शन जो Converlay ट्रैकिंग इंस्टेंस बनाता है। सभी राज्य बंद हैं - कोई वैश्विक दुष्प्रभाव नहीं।

ConverlayConfig
interface ConverlayConfig {
  /** Your .myshopify.com domain (required). */
  shopDomain: string
  /** Collection endpoint. Default: "https://converlay.app/api/events/collect" */
  endpoint?: string
  /** Send page_view on init. Default: false */
  autoPageView?: boolean
  /** Enable debug logging. Default: false */
  debug?: boolean
  /** Initial consent state. Default: both granted */
  consent?: ConsentInput
}

ConverlayInstance

ऑब्जेक्ट createConverlay() द्वारा लौटाया गया।

ConverlayInstance
interface ConverlayInstance {
  /** Track a named event with optional properties. */
  track: (eventName: string, properties?: TrackProperties) => void
  /** Identify the current user for enhanced matching. */
  identify: (data: IdentifyData) => void
  /** Update consent state. */
  setConsent: (consent: ConsentInput) => void
  /** Force-send any queued events immediately. */
  flush: () => Promise<void>
  /** Cleanup timers and state. */
  destroy: () => void
}

ट्रैकप्रॉपर्टीज़

संपत्तियाँ track() को दे दी गईं। मनमानी अतिरिक्त कुंजियाँ स्वीकार करता है।

TrackProperties
interface TrackProperties {
  ecommerce?: EcommerceData
  userData?: UserData
  pageType?: string
  [key: string]: unknown
}

डेटा की पहचान करें

ग्राहक डेटा identify() को भेज दिया गया। सभी फ़ील्ड वैकल्पिक हैं.

IdentifyData
interface IdentifyData {
  customerId?: string
  email?: string
  phone?: string
  firstName?: string
  lastName?: string
}

सहमति के प्रकार

ConsentInput वह है जिसे आप SDK को पास करते हैं। ConsentData इवेंट पेलोड में शामिल वायर प्रारूप है।

ConsentInput & ConsentData
interface ConsentInput {
  analytics?: boolean
  marketing?: boolean
}

interface ConsentData {
  analytics: boolean
  marketing: boolean
  ad_user_data: boolean
  ad_personalization: boolean
}

ईकॉमर्स प्रकार

EcommerceData & EcommerceItem
interface EcommerceData {
  transaction_id?: string
  value?: number
  currency?: string
  items?: EcommerceItem[]
  item_list_id?: string
  item_list_name?: string
  search_term?: string
}

interface EcommerceItem {
  item_id: string
  item_name?: string
  item_variant?: string
  price: number
  quantity: number
}

उपयोक्ताडेटा

उन्नत मिलान के लिए उपयोगकर्ता डेटा. संग्रह समापन बिंदु पर सादे पाठ में भेजा गया, अग्रेषित करने से पहले सर्वर-साइड को हैश किया गया।

UserData
interface UserData {
  email?: string
  phone?: string
  firstName?: string
  lastName?: string
  city?: string
  state?: string
  country?: string
  postalCode?: string
}

इवेंटपेलोड

तार-प्रारूप पेलोड संग्रह समापन बिंदु पर भेजा गया। आप इसे सीधे नहीं बनाते हैं - SDK इसे आपके track() और identify() कॉल से बनाता है।

EventPayload
interface EventPayload {
  event_id: string
  event_name: string
  shop_domain: string
  page_url: string
  referrer: string
  client_id: string
  session_id: string
  fbp: string
  fbc?: string
  gclid?: string
  ttclid?: string
  fbclid?: string
  utm_source?: string
  utm_medium?: string
  utm_campaign?: string
  utm_term?: string
  utm_content?: string
  customer_id?: string
  page_type?: string
  user_data: WireUserData
  consent_data: ConsentData
  ecommerce: WireEcommerceData | null
  user_agent: string
  sdk_version: string
}