Referência da API
Definições completas de tipos TypeScript para @converlay/sdk.
createConverlay(config)
Função factory que cria uma instância de rastreamento Converlay. Todo o estado vive em closures — sem efeitos colaterais globais.
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
O objeto retornado 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
Propriedades passadas para track(). Aceita chaves adicionais arbitrárias.
interface TrackProperties {
ecommerce?: EcommerceData
userData?: UserData
pageType?: string
[key: string]: unknown
}IdentifyData
Dados do cliente passados para identify(). Todos os campos são opcionais.
interface IdentifyData {
customerId?: string
email?: string
phone?: string
firstName?: string
lastName?: string
}Tipos de consentimento
ConsentInput é o que você passa para o SDK. ConsentData é o formato de transmissão incluído nos payloads de eventos.
interface ConsentInput {
analytics?: boolean
marketing?: boolean
}
interface ConsentData {
analytics: boolean
marketing: boolean
ad_user_data: boolean
ad_personalization: boolean
}Tipos de e-commerce
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
Dados do usuário para correspondência aprimorada. Enviados em texto simples para o endpoint de coleta, hasheados server-side antes do encaminhamento.
interface UserData {
email?: string
phone?: string
firstName?: string
lastName?: string
city?: string
state?: string
country?: string
postalCode?: string
}EventPayload
O payload no formato de transmissão enviado para o endpoint de coleta. Você não constrói isso diretamente — o SDK o monta a partir das suas chamadas de 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
}