Download the PHP package berno/pff2-fb-conversion-api without Composer
On this page you can find all versions of the php package berno/pff2-fb-conversion-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download berno/pff2-fb-conversion-api
More information about berno/pff2-fb-conversion-api
Files in berno/pff2-fb-conversion-api
Package pff2-fb-conversion-api
Short Description Module to manage facebook conversion api
License MIT
Homepage https://github.com/berno/pff2-fb-conversion-api
Informations about the package pff2-fb-conversion-api
Pff2 Facebook conversion Api
Request common parameters
The basic request sent to the facebook api:
event_name
is based on the event and set by the specific method called.event_time
is set with the current timestamp valueevent_source_url
is set with the $event_source_url parameter, if it is not specified is replaced with the current request url by default.client_ip_address
is set with the$_SERVER['REMOTE_ADDR']
valueclient_user_agent
is set with the$_SERVER['HTTP_USER_AGENT']
valuefbp
is set with the$_COOKIE['_fbp']
cookie value if it's presentfbc
is set with the$_COOKIE['_fbc']
cookie value if it's presentcustom_data
depends on the specific event sent, see the event specific documentation.test_event_code
is present only if the debug config param is not false
Events
The facebook pixel events managed by the module are:
PageView
To send a PageView event create an action in a controller in which you call sendPageViewEvent()
:
Insert a render action in the main layout which refers to the action created (for ex. in the Layout_Controller)
This method does not create a custom data request field.
CompleteRegistration
string|null $event_source_url
The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain. Ifnull
the parameter value is replaced with the absolute url of the request.string|null $user_email
User email, if specified it has added to theuser_data
request field.string $status
The status of the registration event, as a string. Example: 'registered'.
example of custom data created:
InitiateCheckout
string|null $event_source_url
The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain. Ifnull
the parameter value is replaced with the absolute url of the request.string|null
User email, if specified it has added to theuser_data
request field.float $value
The total of order when the checkout process beginsstring
$currency The currency for the $value specified. Currency must be a valid ISO 4217 three digit currency code. Example: 'EUR'.
example of custom data created:
ViewContent
string|null $event_source_url
The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain. Ifnull
the parameter value is replaced with the absolute url of the request.string|null
User email, if specified it has added to theuser_data
request field.string $content_name
The name of the page or product associated with the event.[string] $content_ids
The content IDs associated with the event in the form ['ABC','123']float $value
A numeric value associated with this event.string $currency
The currency for the $value specified. Currency must be a valid ISO 4217 three digit currency code. Example: 'EUR'.
example of custom data created:
AddToCart
string|null $event_source_url
The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain. Ifnull
the parameter value is replaced with the absolute url of the request.string|null
User email, if specified it has added to theuser_data
request field.[array] $contents
array of associative arrays[array("id" => <product_id>, "quantity" => <product_qnt>)]
float $value
Total cost of the item added (price * quantity).string $currency
The currency for the $value specified. Currency must be a valid ISO 4217 three digit currency code. Example: 'EUR'.
example of custom data created:
Purchase
string|null $event_source_url
The browser URL where the event happened. The URL must begin with http:// or https:// and should match the verified domain. Ifnull
the parameter value is replaced with the absolute url of the request.string|null
User email, if specified it has added to theuser_data
request field.[string] $content_ids
The content IDs associated with the event in the form['ABC','123']
.float $order_value
Total order amountstring $currency
The currency for the $order_value specified. Currency must be a valid ISO 4217 three digit currency code. Example: 'EUR'.
example of custom data created: