Referencia de API
Definiciones completas de tipos TypeScript para @converlay/sdk.
createConverlay(config)
Función de fábrica que crea una instancia de tracking de Converlay. Todo el estado reside en closures — sin efectos secundarios globales.
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
El objeto devuelto por createConverlay().
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
}TrackProperties
Propiedades pasadas a track(). Acepta claves adicionales arbitrarias.
interface TrackProperties {
ecommerce?: EcommerceData
userData?: UserData
pageType?: string
[key: string]: unknown
}IdentifyData
Datos de cliente pasados a identify(). Todos los campos son opcionales.
interface IdentifyData {
customerId?: string
email?: string
phone?: string
firstName?: string
lastName?: string
}Tipos de consentimiento
ConsentInput es lo que pasas al SDK. ConsentData es el formato de transmisión incluido en las cargas de eventos.
interface ConsentInput {
analytics?: boolean
marketing?: boolean
}
interface ConsentData {
analytics: boolean
marketing: boolean
ad_user_data: boolean
ad_personalization: boolean
}Tipos de ecommerce
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
Datos de usuario para coincidencia avanzada. Se envían en texto plano al endpoint de recopilación y se hashean del lado del servidor antes del reenvío.
interface UserData {
email?: string
phone?: string
firstName?: string
lastName?: string
city?: string
state?: string
country?: string
postalCode?: string
}EventPayload
La carga en formato de transmisión enviada al endpoint de recopilación. No la construyes directamente — el SDK la genera a partir de tus llamadas a track() e identify().
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
}