snapchat_extension
extends abstract_extension
in package
Extension: snapchat_extension - snapchat conversion - ATP Custom Plugin for WordPress
Tags
Table of Contents
- API_VERSION = '/v1'
- SNAPCHAT_API_ENDPOINT = 'https://tr.snapchat.com/v2/conversion'
- SNAPCHAT_API_VALIDATE = 'https://tr.snapchat.com/v2/conversion/validate'
- SNAPCHAT_AUTH_ENDPOINT = 'https://accounts.snapchat.com/login/oauth2'
- VERSION = '23.1109.1'
- __construct() : void
- constructor method
- addActionsAndFilters() : void
- Add filters and actions - called from main plugin
- addFooterScript() : void
- Add snapchat ajax api script
- admin_options_settings() : void
- register options on options_settings_page
- defaultRequest() : void
- Default request array
- initialize() : void
- initialize method - called from main plugin
- receive_snap_code() : void
- Receive snapchat authentication code
- refresh_snap_token() : array<string|int, mixed>
- Refresh the access token
- request_snap_code() : string
- filter for options_form_post_ _api_code - get oauth access
- request_snap_tokens() : array<string|int, mixed>
- Generate the access & refresh tokens from api code
- snap_addtocart_conversion() : void
- add-to-cart conversion
- snap_checkout_conversion() : void
- add-to-cart conversion
- snap_contentview_conversion() : void
- content view conversion
- snap_pageview_conversion() : void
- page view conversion
- snap_purchase_conversion() : void
- purchase conversion
- snapchatAPI() : void
- Snapchat API
Constants
API_VERSION
public
string
API_VERSION
= '/v1'
api version endpoint (incoming)
SNAPCHAT_API_ENDPOINT
public
string
SNAPCHAT_API_ENDPOINT
= 'https://tr.snapchat.com/v2/conversion'
snapchat API endpoint
SNAPCHAT_API_VALIDATE
public
string
SNAPCHAT_API_VALIDATE
= 'https://tr.snapchat.com/v2/conversion/validate'
snapchat API endpoint for validation (testing)
SNAPCHAT_AUTH_ENDPOINT
public
string
SNAPCHAT_AUTH_ENDPOINT
= 'https://accounts.snapchat.com/login/oauth2'
snapchat Auth endpoint
VERSION
public
string
VERSION
= '23.1109.1'
extension version
Methods
__construct()
constructor method
public
__construct(object $plugin) : void
Parameters
- $plugin : object
-
main plugin object
Return values
void —addActionsAndFilters()
Add filters and actions - called from main plugin
public
addActionsAndFilters() : void
Return values
void —addFooterScript()
Add snapchat ajax api script
public
addFooterScript() : void
Return values
void —admin_options_settings()
register options on options_settings_page
public
admin_options_settings() : void
Tags
Return values
void —defaultRequest()
Default request array
public
defaultRequest([array<string|int, mixed> $method = 'POST' ][, string $token = null ]) : void
Parameters
- $method : array<string|int, mixed> = 'POST'
-
http method (POST | GET)
- $token : string = null
-
the authorization token
Return values
void —initialize()
initialize method - called from main plugin
public
initialize() : void
Return values
void —receive_snap_code()
Receive snapchat authentication code
public
receive_snap_code() : void
Return values
void —refresh_snap_token()
Refresh the access token
public
refresh_snap_token() : array<string|int, mixed>
{ "access_token": "0.MGQCxyz123", "token_type": "Bearer", "expires_in": 1800, "refresh_token": "32eb12f037712a6b60404d6d9c170ee9ae4d5b9936c73dd03c23fffff1213cb3", "scope": "snapchat-offline-conversions-api" }
Return values
array<string|int, mixed> —decode result array
request_snap_code()
filter for options_form_post_ _api_code - get oauth access
public
request_snap_code(string $function[, string $fieldName = null ][, array<string|int, mixed> $metaData = null ][, string $priorValue = null ]) : string
Parameters
- $function : string
-
- the value (button) POSTed
- $fieldName : string = null
-
- the name of the field/option
- $metaData : array<string|int, mixed> = null
-
- the option metadata
- $priorValue : string = null
-
- the prior option value
Return values
string —$function
request_snap_tokens()
Generate the access & refresh tokens from api code
public
request_snap_tokens() : array<string|int, mixed>
{ "expires_in": 1800, "token_type": "Bearer", "refresh_token": "32eb12f037712a6b60404d6d9c170ee9ae4d5b9936c73dd03c23fffff1213cb3", "access_token": "0.MGQCxyz123" }
Return values
array<string|int, mixed> —decode result array
snap_addtocart_conversion()
add-to-cart conversion
public
snap_addtocart_conversion() : void
Return values
void —snap_checkout_conversion()
add-to-cart conversion
public
snap_checkout_conversion() : void
Return values
void —snap_contentview_conversion()
content view conversion
public
snap_contentview_conversion() : void
Return values
void —snap_pageview_conversion()
page view conversion
public
snap_pageview_conversion() : void
Return values
void —snap_purchase_conversion()
purchase conversion
public
snap_purchase_conversion([mixed $params = null ]) : void
Parameters
- $params : mixed = null
Return values
void —snapchatAPI()
Snapchat API
public
snapchatAPI(array<string|int, mixed> $bodyArray) : void
Parameters
- $bodyArray : array<string|int, mixed>
-
values passed in conversion api