Events and objects

Which events you must trigger depends on your website type. See the relevant section based on your website’s objective:

• Required events for purchase sites
• Required events for lead generation sites

Required events for purchase sites

page_view event

Trigger the page_view when a user navigates to a new page on your site. Trigger this event on every page of your site and optionally include these parameters:

view_item event

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

add_to_cart event

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

begin_checkout event

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

purchase event

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

Recommended events for purchase sites

AppLovin recommends the events listed below, but they are 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 buy something. When you send this event, include these parameters:

generate_lead event

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

login event

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

sign_up event

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

search event

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

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. When you send this event, include these parameters:

remove_from_cart event

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

view_cart event

Trigger this event when a user views their cart. When you send this event, include these parameters:

Required events for lead generation sites

page_view event

Trigger the page_view when a user navigates to a new page on your site. Trigger this event on every page of your site and optionally include these parameters:

generate_lead event

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

Objects

The Axon item object

Axon item is a common object required with most events. All fields must be named and formatted exactly as shown in the table below:

¹ quantity is required for add_to_cart, remove_from_cart, and purchase events

The user data object

User data contains additional information about the user. You should only pass these data after you receive consent from the user.

#include <iostream>
#include <string>
#include <iomanip>
#include <sstream>
#include <algorithm>
#include <openssl/sha.h>

std::string normalizeAndHash(const std::string& email){
  std::string normalized = email;
  normalized.erase(0, normalized.find_first_not_of(" \t\n\r"));
  normalized.erase(normalized.find_last_not_of(" \t\n\r") + 1);
  std::transform(normalized.begin(), normalized.end(), normalized.begin(), ::tolower);

  unsigned char hash[SHA256_DIGEST_LENGTH];
  SHA256((unsigned char*)normalized.c_str(), normalized.size(), hash);

  std::ostringstream oss;
  for (int i = 0; i < SHA256_DIGEST_LENGTH; ++i)
    oss << std::hex << std::setw(2) << std::setfill('0') << (int)hash[i];
  return oss.str();
}

int main(){
  std::cout << normalizeAndHash(" John_Smith@gmail.com") << std::endl;
}

using System;
using System.Text;
using System.Security.Cryptography;

class Program {
  static string NormalizeAndHash(string email) {
    string normalized = email.Trim().ToLower();
    using (SHA256 sha256 = SHA256.Create()) {
      byte[] bytes = sha256.ComputeHash(Encoding.UTF8.GetBytes(normalized));
      StringBuilder sb = new StringBuilder();
      foreach (byte b in bytes)
        sb.Append(b.ToString("x2"));
      return sb.ToString();
    }
  }

  static void Main() {
    Console.WriteLine(NormalizeAndHash(" John_Smith@gmail.com"));
  }
}

import java.security.MessageDigest;
import java.nio.charset.StandardCharsets;

public class HashEmail {
  public static String normalizeAndHash(String email) throws Exception {
    String normalized = email.trim().toLowerCase();
    MessageDigest digest = MessageDigest.getInstance("SHA-256");
    byte[] hash = digest.digest(normalized.getBytes(StandardCharsets.UTF_8));
    StringBuilder hex = new StringBuilder();
    for (byte b : hash) hex.append(String.format("%02x", b));
    return hex.toString();
  }

  public static void main(String[] args) throws Exception {
    System.out.println(normalizeAndHash(" John_Smith@gmail.com"));
  }
}

import { createHash } from "crypto";

function normalizeAndHash(email) {
  const normalized = email.trim().toLowerCase();
  return createHash("sha256").update(normalized).digest("hex");
}

// Example
console.log(normalizeAndHash(" John_Smith@gmail.com"));

import java.security.MessageDigest

fun normalizeAndHash(email: String): String {
  val normalized = email.trim().lowercase()
  val bytes = MessageDigest.getInstance("SHA-256").digest(normalized.toByteArray())
  return bytes.joinToString("") { "%02x".format(it) }
}

fun main() {
  println(normalizeAndHash(" John_Smith@gmail.com"))
}

import hashlib

def normalize_and_hash(email):
  normalized = email.strip().lower()
  return hashlib.sha256(normalized.encode()).hexdigest()

# Example
print(normalize_and_hash(" John_Smith@gmail.com"))

import Foundation
import CryptoKit

func normalizeAndHash(_ email: String) -> String {
  let normalized = email.trimmingCharacters(in: .whitespacesAndNewlines).lowercased()
  let hash = SHA256.hash(data: normalized.data(using: .utf8)!)
  return hash.map { String(format: "%02x", $0) }.joined()
}

print(normalizeAndHash(" John_Smith@gmail.com"))

62a14e44f765419d10fea99367361a727c12365e2520f32218d505ed9aa0f62f

Category IDs

Your item may be in one of several thousand possible categories. Set item_category_id to the ID number corresponding to your chosen category. The following list contains the complete set of categories and their ID numbers (in parentheses):