コンテンツにスキップ

AXON Pixel Events and Objects

このコンテンツはまだ日本語訳がありません。

Required Events

page_view Event

Send the page_view event to track Page View events with the AXON Pixel.

view_item Event

Trigger this event when a user lands on a specific product page. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringtrueThree-letter ISO 4217 code for currency
itemsAXONItem[]trueThe items for the event
valuenumberfalseMonetary value of the event, calculated by the sum of price × quantity for each item

add_to_cart Event

Trigger this event when a user adds an item to their cart. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringtrueThree-letter ISO 4217 code for currency
itemsAXONItem[]trueThe items for the event
valuenumberrecommendedMonetary value of the items added to cart, calculated by the sum of price × quantity for each item

begin_checkout Event

Trigger this event when a user initiates the checkout process. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringtrueThree-letter ISO 4217 code for currency
itemsAXONItem[]trueThe items for the event
valuenumbertrueMonetary value of the event, calculated by the sum of price × quantity for each item

purchase Event

Trigger this event when a user makes a purchase. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringtrueThree-letter ISO 4217 code for currency
itemsAXONItem[]trueThe items for the event
transaction_idstringtrueThe unique identifier of a transaction
valuenumbertrueMonetary value of the event, calculated by the sum of price × quantity for each item
shippingnumberrecommendedShipping cost associated with the transaction
taxnumberrecommendedTax cost associated with a transaction
user_idstringrecommendedThe unique identifier for the customer

The remaining events listed below are recommended but not required:

add_payment_info Event

Trigger this event when a customer submits their payment information to the site. For example, when a user fills in their payment information when they make a purchase. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringtrueThree-letter ISO 4217 code for currency
itemsAXONItem[]recommendedThe items for the event
payment_typePayment TyperecommendedThe payment type used
valuenumberrecommendedMonetary value of the event, calculated by the sum of price × quantity for each item

generate_lead Event

Trigger this event when a potential customer expresses interest, typically by submitting a form. For example, when a user fills out a contact form to receive more information about a product. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringfalseThree-letter ISO 4217 code for currency
user_idstringfalseThe unique identifier for the customer
valuenumberfalseMonetary value of the event

login Event

Trigger this event when a user logs into an account on the site. To send this event, include these parameters:

NameTypeRequiredDescription
user_idstringtrueThe unique identifier for the customer

sign_up Event

Trigger this event when a user signs up for an account on the site. For example, when a user registers for a new account by using their email or social media login. To send this event, include these parameters:

NameTypeRequiredDescription
user_idstringtrueThe unique identifier for the customer
methodstringrecommendedThe method used for sign up

search Event

Trigger this event when a user uses a search bar to search for content on your site. To send this event, include these parameters:

NameTypeRequiredDescription
search_termstringtrueThe term that was searched for
resultsAXONItem[]recommendedThe items for the event

subscribe Event

Trigger this event when a user subscribes to a service. For example, when a user subscribes to a premium content service, such as an online magazine. Often this means that the user has paid for a membership. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringfalseThree-letter ISO 4217 code for currency
user_idstringfalseThe unique identifier for the customer
valuenumberfalseMonetary value of the event

remove_from_cart Event

Trigger this event when a user removes an item from their cart. To send this event, include these parameters:

NameTypeRequiredDescription
currencystringtrueThree-letter ISO 4217 code for currency
itemsAXONItem[]trueThe items for the event
valuenumberrecommendedMonetary value of the event, calculated by the sum of price × quantity for each item

Objects

The AXON Item Object

AXONItem is a common object required with most events. quantity, price, item_name, and item_id are required with this object and must be named and formatted exactly as shown in the table below:

NameTypeRequiredDescription
item_idstringtrueThe ID of the item
item_namestringtrueThe name of the item
pricenumbertrueThe monetary value of the item (in the user’s currency). If a discount applies, set price to the discounted price, and specify the discount in the discount parameter.
quantitynumbertrue1Item quantity
image_urlstringrecommendedThe URL to an image of the item
item_categorystringrecommendedThe first category hierarchy for the item
item_variantstringrecommendedThe item variant or code
affiliationstringfalseThe specific supplier, company, or physical store associated with the product
discountnumberfalseThe discount applied to the item
item_brandstringfalseThe brand of the item

1 quantity not required for view_item event

Payment Types

The supported payment methods are:

NameDescription
credit_cardA saved or manually entered credit card
deferredA deferred payment, if you plan to collect payment later
redeemableA redeemable payment method, like a gift card or store credit
payment_on_deliveryA payment that is collected upon delivery
walletAn integrated wallet, like PayPal, Google Pay, Apple Pay, etc.
otherAnother type of payment not defined above