Bitrix API

Event implements ConversionEventInterface

Table of Contents

Interfaces

ConversionEventInterface

Constants

ACTION_SOURCE_APP  = 'app'
ACTION_SOURCE_CHAT  = 'chat'
ACTION_SOURCE_EMAIL  = 'email'
ACTION_SOURCE_OTHER  = 'other'
ACTION_SOURCE_PHONE_CALL  = 'phone_call'
ACTION_SOURCE_PHYSICAL_STORE  = 'physical_store'
ACTION_SOURCE_SYSTEM_GENERATED  = 'system_generated'
ACTION_SOURCE_WEBSITE  = 'website'
EVENT_ADD_PAYMENT  = 'AddPaymentInfo'
EVENT_ADD_TO_CART  = 'AddToCart'
EVENT_ADD_TO_WISH_LIST  = 'AddToWishlist'
EVENT_COMPLETE_REGISTRATION  = 'CompleteRegistration'
EVENT_CONTACT  = 'Contact'
EVENT_DONATE  = 'CustomizeProduct'
EVENT_FIND_LOCATION  = 'FindLocation'
EVENT_INITIATE_CHECKOUT  = 'InitiateCheckout'
EVENT_LEAD  = 'Lead'
EVENT_PAGE_VIEW  = 'PageView'
EVENT_PURCHASE  = 'Purchase'
EVENT_SEARCH  = 'Search'
EVENT_START_TRIAL  = 'StartTrial'
EVENT_SUBMIT_APPLICATION  = 'SubmitApplication'
EVENT_SUBSCRIBE  = 'Subscribe'
EVENT_VIEW_CONTENT  = 'ViewContent'

Methods

__construct()  : mixed
Event constructor.
getActionSourceList()  : array<string|int, mixed>
getEventTypeList()  : mixed
prepareData()  : array<string|int, mixed>
setActionSource()  : $this
docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#action-source
setCustomData()  : $this
docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#custom-data
setDynamicAdsOption()  : $this
docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#opt-out
setEventType()  : Event
docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#event-name
setSource()  : $this
docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#event-source-url
setTime()  : $this
docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#event-time
setUserData()  : $this
docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#user-data
validate()  : bool

Constants

ACTION_SOURCE_APP

public mixed ACTION_SOURCE_APP = 'app'

ACTION_SOURCE_CHAT

public mixed ACTION_SOURCE_CHAT = 'chat'

ACTION_SOURCE_EMAIL

public mixed ACTION_SOURCE_EMAIL = 'email'

ACTION_SOURCE_OTHER

public mixed ACTION_SOURCE_OTHER = 'other'

ACTION_SOURCE_PHONE_CALL

public mixed ACTION_SOURCE_PHONE_CALL = 'phone_call'

ACTION_SOURCE_PHYSICAL_STORE

public mixed ACTION_SOURCE_PHYSICAL_STORE = 'physical_store'

ACTION_SOURCE_SYSTEM_GENERATED

public mixed ACTION_SOURCE_SYSTEM_GENERATED = 'system_generated'

ACTION_SOURCE_WEBSITE

public mixed ACTION_SOURCE_WEBSITE = 'website'

EVENT_ADD_PAYMENT

public mixed EVENT_ADD_PAYMENT = 'AddPaymentInfo'

EVENT_ADD_TO_CART

public mixed EVENT_ADD_TO_CART = 'AddToCart'

EVENT_ADD_TO_WISH_LIST

public mixed EVENT_ADD_TO_WISH_LIST = 'AddToWishlist'

EVENT_COMPLETE_REGISTRATION

public mixed EVENT_COMPLETE_REGISTRATION = 'CompleteRegistration'

EVENT_CONTACT

public mixed EVENT_CONTACT = 'Contact'

EVENT_DONATE

public mixed EVENT_DONATE = 'CustomizeProduct'

EVENT_FIND_LOCATION

public mixed EVENT_FIND_LOCATION = 'FindLocation'

EVENT_INITIATE_CHECKOUT

public mixed EVENT_INITIATE_CHECKOUT = 'InitiateCheckout'

EVENT_LEAD

public mixed EVENT_LEAD = 'Lead'

EVENT_PAGE_VIEW

public mixed EVENT_PAGE_VIEW = 'PageView'

EVENT_PURCHASE

public mixed EVENT_PURCHASE = 'Purchase'

EVENT_SEARCH

public mixed EVENT_SEARCH = 'Search'

EVENT_START_TRIAL

public mixed EVENT_START_TRIAL = 'StartTrial'

EVENT_SUBMIT_APPLICATION

public mixed EVENT_SUBMIT_APPLICATION = 'SubmitApplication'

EVENT_SUBSCRIBE

public mixed EVENT_SUBSCRIBE = 'Subscribe'

EVENT_VIEW_CONTENT

public mixed EVENT_VIEW_CONTENT = 'ViewContent'

Methods

__construct()

Event constructor.

public __construct([array<string|int, mixed>|null $params = null ]) : mixed
Parameters
$params : array<string|int, mixed>|null = null

getActionSourceList()

public static getActionSourceList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getEventTypeList()

public static getEventTypeList() : mixed

prepareData()

public prepareData() : array<string|int, mixed>
Return values
array<string|int, mixed>

setActionSource()

docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#action-source

public setActionSource([mixed $action = self::ACTION_SOURCE_WEBSITE ]) : $this
Parameters
$action : mixed = self::ACTION_SOURCE_WEBSITE
Return values
$this

setCustomData()

docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#custom-data

public setCustomData(CustomData $data) : $this
Parameters
$data : CustomData
Return values
$this

setDynamicAdsOption()

docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#opt-out

public setDynamicAdsOption([bool $option = false ]) : $this
Parameters
$option : bool = false
Return values
$this

setEventType()

docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#event-name

public setEventType(string $type) : Event
Parameters
$type : string
Return values
Event

setSource()

docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#event-source-url

public setSource(string|null $source) : $this
Parameters
$source : string|null
Return values
$this

setTime()

docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#event-time

public setTime(int|null $timeStamp) : $this
Parameters
$timeStamp : int|null
Return values
$this

setUserData()

docs: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event#user-data

public setUserData(UserData $userData) : $this
Parameters
$userData : UserData
Return values
$this

validate()

public validate() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results