Dynamic Ads for Automotive - Events

Dynamic Ads for Automotive uses four events. Every event has a set of parameters (full list of event parameter details). You can use the Facebook Pixel on your website and mobile app events in your Android app and iOS app.

Standard and Required Events

  • Standard events are actions we recognize and support across ad products. This consistency in how we name and categorize key actions improves our ability to show your ads to the people in your audience who are most likely to take the actions that matter to your business. See the full list (there are currently 9) and best practices for standard events here.
  • Required events - See table below. The code sample is Pixel, Android, iOS for all required events.
EventWhen to FireCode Sample

Search

On search result pages for vehicle/inventory searches

Pixel | Android | iOS

ViewContent

On webpages where you want to track views of key content. For example: vehicle detail pages, model pages, vehicle offers, or incentive pages.

Pixel | Android | iOS

AddToWishlist

When a user saves, favorites, or shows interest in a specific vehicle listing

Pixel | Android | iOS

Lead

Include this event to track lower funnel actions, such as dealer inquiries (contacting an agent about a listing), test drive, or other types of appointment requests, personalized finance quote requests, and so on.

Pixel | Android | iOS


Facebook Pixel (for websites)

This guide assumes you already have a Facebook Pixel installed. If not, see Using Marketing API with Pixel.

Before you Begin

  • Make sure the pixel base code is already loaded when you fire an event.
  • If you use a tag manager, make sure you include the tag that contains the pixel code on every page. The tag should appear before the tag that contains the pixel event code.
  • Use the Facebook Pixel Helper to validate your pixel implementation.

Search Pixel Event

    // This sample assumes the FB Pixel base code is already loaded

fbq('track', 'Search', {
      content_type: 'vehicle', // REQUIRED: DO NOT change this, must be set to 'vehicle'
      content_ids: ['123'], // REQUIRED: array of vehicle IDs
      postal_code: '94025', // RECOMMENDED
      make: 'Lexus', // RECOMMENDED
      model: 'ES', // RECOMMENDED
      year: '2017', // RECOMMENDED
      state_of_vehicle: 'CPO', // RECOMMENDED
      exterior_color: 'black', // RECOMMENDED
      transmission: 'automatic', // RECOMMENDED
      body_style: 'sedan', // RECOMMENDED
      fuel_type: 'gasoline', // RECOMMENDED
      drivetrain: 'awd', // RECOMMDENDED
      price: 1234.99, // RECOMMENDED, up to 2 decimals optional
      currency: 'USD', // REQUIRED: if price and preferred_price_range is used, currency has to be the same for both price and preferred_price_range 
      preferred_price_range: '[10000,20000]' // Optional up to two decimals, min,max
});

ViewContent Pixel Event

    // This sample assumes the FB Pixel base code is already loaded

fbq('track', 'ViewContent', {
      content_type: 'vehicle', // REQUIRED: DO NOT change this, must be set to 'vehicle'
      content_ids: ['123'], // REQUIRED: array of vehicle IDs
      postal_code: '94025', // RECOMMENDED
      make: 'Lexus', // RECOMMENDED
      model: 'ES', // RECOMMENDED
      year: '2017', // RECOMMENDED
      state_of_vehicle: 'CPO', // RECOMMENDED
      exterior_color: 'black', // RECOMMENDED
      transmission: 'automatic', // RECOMMENDED
      body_style: 'sedan', // RECOMMENDED
      fuel_type: 'gasoline', // RECOMMENDED
      drivetrain: 'awd', // RECOMMDENDED
      price: 1234.99, // RECOMMENDED, up to 2 decimals optional
      currency: 'USD', // REQUIRED: if price and preferred_price_range is used 
      preferred_price_range: '[10000,20000]' // Optional up to two decimals, min,max
});

AddToWishlist Pixel Event

// This sample assumes the FB Pixel base code is already loaded

fbq('track', 'AddToWishlist', {
      content_type: 'vehicle', // REQUIRED: DO NOT change this, must be set to 'vehicle'
      content_ids: ['123'], // REQUIRED: array of vehicle IDs
      postal_code: '94025', // RECOMMENDED
      make: 'Lexus', // RECOMMENDED
      model: 'ES', // RECOMMENDED
      year: '2017', // RECOMMENDED
      state_of_vehicle: 'CPO', // RECOMMENDED
      exterior_color: 'black', // RECOMMENDED
      transmission: 'automatic', // RECOMMENDED
      body_style: 'sedan', // RECOMMENDED
      fuel_type: 'gasoline', // RECOMMENDED
      drivetrain: 'awd', // RECOMMDENDED
      price: 1234.99, // RECOMMENDED, up to 2 decimals optional
      currency: 'USD', // REQUIRED: if price and preferred_price_range is used 
      preferred_price_range: '[10000,20000]' // Optional up to two decimals, min,max
});

Lead Pixel Event

// This sample assumes the FB Pixel base code is already loaded

fbq('track', 'Lead', {
      content_type: 'vehicle', // REQUIRED: DO NOT change this, must be set to 'vehicle'
      content_ids: ['123'], // REQUIRED: array of vehicle IDs
      postal_code: '94025', // RECOMMENDED
      make: 'Lexus', // RECOMMENDED
      model: 'ES', // RECOMMENDED
      year: '2017', // RECOMMENDED
      state_of_vehicle: 'CPO', // RECOMMENDED
      exterior_color: 'black', // RECOMMENDED
      transmission: 'automatic', // RECOMMENDED
      body_style: 'sedan', // RECOMMENDED
      fuel_type: 'gasoline', // RECOMMENDED
      drivetrain: 'awd', // RECOMMDENDED
      price: 1234.99, // RECOMMENDED, up to 2 decimals optional
      currency: 'USD', // REQUIRED: if price and preferred_price_range is used 
      preferred_price_range: '[10000,20000]' // Optional up to two decimals, min,max
});

Mobile App Events for Android

This guide assumes you have the Facebook SDK implemented in your Android mobile app. If not, see the Android SDK. If you use a measurement partner, make sure they pass required events to Facebook.

Search Android Event

Bundle parameters = new Bundle();
// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY

// REQUIRED: DO NOT change this, must be set to 'vehicle'
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_TYPE, "vehicle");

// REQUIRED: content ids - include eg top 5 search results
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_ID, "[\"123\", \"234\", \"345\", \"456\", \"567\"]"); // top search results

// RECOMMENDED: postal_code
parameters.putString("fb_postal_code", "94025");

// RECOMMENDED: make
// Allows you to target people based on their search of a specific make
parameters.putString("fb_make", "Lexus");

// RECOMMENDED: model
// Allows you to target people based on their search of a specific make model
parameters.putString("fb_model", "ES");

// RECOMMENDED: year, in yyyy format
// Allows you to target people based on their search for vehicles manufactured from a specific year
parameters.putInt("fb_year", "2017");

// RECOMMENDED: state_of_vehicle
// Allows you to target people based on their search of specific type of vehicle
parameters.putString("fb_state_of_vehicle", "CPO");

// RECOMMENDED: exterior_color
parameters.putString("fb_exterior_color", "black");

// RECOMMENDED: transmission
parameters.putString("fb_transmission", "automatic");

// RECOMMENDED: body_style
// Allows you to target people based on their search of a vehicle body style
parameters.putString("fb_body_style", "sedan");

// RECOMMENDED: fuel_type
parameters.putString("fb_fuel_type", "gasoline");

// RECOMMENDED: drivetrain
parameters.putString("fb_drivetrain", "awd");

// RECOMMENDED: price
parameters.putInt("fb_price", 1234.99);

// RECOMMENDED: currency
parameters.putInt("fb_currency", 'USD');

// RECOMMENDED: preferred_price_range
parameters.putInt("fb_preferred_price_range", '[10000,20000]');

// Fire the 'Search' event on the search results page
logger.logEvent(AppEventsConstants.EVENT_NAME_SEARCHED,
  parameters

);

ViewContent Android Event

Bundle parameters = new Bundle();
// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY

// REQUIRED: DO NOT change this, must be set to 'vehicle'
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_TYPE, "vehicle");

// REQUIRED: content id of the vehicle that is shown
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_ID, "123");

// RECOMMENDED: postal_code
parameters.putString("fb_postal_code", "94025");

// RECOMMENDED: make
// Allows you to target people based on their search of a specific make
parameters.putString("fb_make", "Lexus");

// RECOMMENDED: model
// Allows you to target people based on their search of a specific make model
parameters.putString("fb_model", "ES");

// RECOMMENDED: year, in yyyy format
// Allows you to target people based on their search for vehicles manufactured from a specific year
parameters.putInt("fb_year", "2017");

// RECOMMENDED: state_of_vehicle
// Allows you to target people based on their search of specific type of vehicle
parameters.putString("fb_state_of_vehicle", "CPO");

// RECOMMENDED: exterior_color
parameters.putString("fb_exterior_color", "black");

// RECOMMENDED: transmission
parameters.putString("fb_transmission", "automatic");

// RECOMMENDED: body_style
// Allows you to target people based on their search of a vehicle body style
parameters.putString("fb_body_style", "sedan");

// RECOMMENDED: fuel_type
parameters.putString("fb_fuel_type", "gasoline");

// RECOMMENDED: drivetrain
parameters.putString("fb_drivetrain", "awd");

// RECOMMENDED: price
parameters.putInt("fb_price", 1234.99);

// RECOMMENDED: currency
parameters.putInt("fb_currency", 'USD');

// RECOMMENDED: preferred_price_range
parameters.putInt("fb_preferred_price_range", '[10000,20000]');

// Fire the 'ViewContent' event on the vehicle details or other specific content page
logger.logEvent(AppEventsConstants.EVENT_NAME_VIEWED_CONTENT,
  parameters

);

AddToWishlist Android Event

Bundle parameters = new Bundle();
// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY

// REQUIRED: DO NOT change this, must be set to 'vehicle'
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_TYPE, "vehicle");

// REQUIRED: content id of the vehicle that is added to wishlist
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_ID, "123");

// RECOMMENDED: postal_code
parameters.putString("fb_postal_code", "94025");

// RECOMMENDED: make
// Allows you to target people based on their search of a specific make
parameters.putString("fb_make", "Lexus");

// RECOMMENDED: model
// Allows you to target people based on their search of a specific make model
parameters.putString("fb_model", "ES");

// RECOMMENDED: year, in yyyy format
// Allows you to target people based on their search for vehicles manufactured from a specific year
parameters.putInt("fb_year", "2017");

// RECOMMENDED: state_of_vehicle
// Allows you to target people based on their search of specific type of vehicle
parameters.putString("fb_state_of_vehicle", "CPO");

// RECOMMENDED: exterior_color
parameters.putString("fb_exterior_color", "black");

// RECOMMENDED: transmission
parameters.putString("fb_transmission", "automatic");

// RECOMMENDED: body_style
// Allows you to target people based on their search of a vehicle body style
parameters.putString("fb_body_style", "sedan");

// RECOMMENDED: fuel_type
parameters.putString("fb_fuel_type", "gasoline");

// RECOMMENDED: drivetrain
parameters.putString("fb_drivetrain", "awd");

// RECOMMENDED: price
parameters.putInt("fb_price", 1234.99);

// RECOMMENDED: currency
parameters.putInt("fb_currency", 'USD');

// RECOMMENDED: preferred_price_range
parameters.putInt("fb_preferred_price_range", '[10000,20000]');

// Fire the 'AddToWishlist' event on the vehicle details or other specific content page
logger.logEvent(AppEventsConstants.EVENT_NAME_ADDED_TO_WISHLIST,
  parameters

);

Lead Android Event

Bundle parameters = new Bundle();
// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY

// REQUIRED: DO NOT change this, must be set to 'vehicle'
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_TYPE, "vehicle");

// REQUIRED: content id of the vehicle that is related to the lead
parameters.putString(AppEventsConstants.EVENT_PARAM_CONTENT_ID, "123");

// RECOMMENDED: postal_code
parameters.putString("fb_postal_code", "94025");

// RECOMMENDED: make
// Allows you to target people based on their search of a specific make
parameters.putString("fb_make", "Lexus");

// RECOMMENDED: model
// Allows you to target people based on their search of a specific make model
parameters.putString("fb_model", "ES");

// RECOMMENDED: year, in yyyy format
// Allows you to target people based on their search for vehicles manufactured from a specific year
parameters.putInt("fb_year", "2017");

// RECOMMENDED: state_of_vehicle
// Allows you to target people based on their search of specific type of vehicle
parameters.putString("fb_state_of_vehicle", "CPO");

// RECOMMENDED: exterior_color
parameters.putString("fb_exterior_color", "black");

// RECOMMENDED: transmission
parameters.putString("fb_transmission", "automatic");

// RECOMMENDED: body_style
// Allows you to target people based on their search of a vehicle body style
parameters.putString("fb_body_style", "sedan");

// RECOMMENDED: fuel_type
parameters.putString("fb_fuel_type", "gasoline");

// RECOMMENDED: drivetrain
parameters.putString("fb_drivetrain", "awd");

// RECOMMENDED: price
parameters.putInt("fb_price", 1234.99);

// RECOMMENDED: currency
parameters.putInt("fb_currency", 'USD');

// RECOMMENDED: preferred_price_range
parameters.putInt("fb_preferred_price_range", '[10000,20000]');

// Fire the 'Lead' event on the hard lead pages where information was captured for test drives, brochure requests, etc
logger.logEvent("fb_mobile_lead",
  parameters

);

Mobile App Events for iOS

This guide assumes you already have the Facebook SDK implemented in your iOS mobile app. If not, see the iOS SDK. If you use a measurement partner, make sure they pass required events to Facebook.

Search iOS Event

// Fire the 'Search' event on the search results page  
[FBSDKAppEvents logEvent:FBSDKAppEventNameSearched

// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY
  parameters:@{
    // REQUIRED: DO NOT change this, must be set to 'vehicle'
    FBSDKAppEventParameterNameContentType : @"vehicle",
    // RECOMMENDED: content ids - include eg top 5 search results
    FBSDKAppEventParameterNameContentID : @"[\"123\", \"234\", \"345\", \"456\", \"567\"]",

    // RECOMMENDED: postal_code    
    @"fb_postal_code" : @"94110",
    
    // RECOMMENDED: make    
    // Allows you to target people based on their search of a specific make
    @"fb_make" : @"Toyota",
    
    // RECOMMENDED: model
    // Allows you to target people based on their search of a specific make model
    @"fb_model" : @"Camry",
    
    // RECOMMENDED: year, in yyyy format
    @"fb_year" : @"2015", 
        
    // RECOMMENDED: state_of_vehicle
    // Allows you to target people based on their search of specific type of vehicle
    @"fb_state_of_vehicle" : @"CPO",
    
    // RECOMMENDED: exterior_color
    @"fb_exterior_color" : @"black", 
    
    // RECOMMENDED: transmission
    @"fb_transmission" : @"automatic",
    
    // RECOMMENDED: body_style
    // Allows you to target people based on their search of a vehicle body style
    @"fb_body_style" : @"Sedan",
    
    // RECOMMENDED: fuel_type
    @"fb_fuel_type" : @"gasoline", 
    
    // RECOMMENDED: drivetrain
    @"fb_drivetrain" : @"awd", 
    
    // RECOMMENDED: price
    @"fb_price" : @18000, 
              
    // RECOMMENDED: currency
    @"fb_currency" : @"USD",

    // RECOMMENDED: preferred_price_range
    @"fb_preferred_price_range" : @"[10000,20000]",
    }
  ];          

ViewContent iOS Event

// Fire the 'ViewContent' event on the search results page  
[FBSDKAppEvents logEvent:FBSDKAppEventNameViewedContent

// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY
  parameters:@{
    // REQUIRED: DO NOT change this, must be set to 'vehicle'
    FBSDKAppEventParameterNameContentType : @"vehicle",
    // RECOMMENDED: content ids for vehicle shown
    FBSDKAppEventParameterNameContentID : @"123",

    // RECOMMENDED: postal_code    
    @"fb_postal_code" : @"94110",

    // RECOMMENDED: make
    // Allows you to target people based on their search of a specific make
    @"fb_make" : @"Toyota",
    
    // RECOMMENDED: model
    // Allows you to target people based on their search of a specific make model
    @"fb_model" : @"Camry",
    
    // RECOMMENDED: year, in yyyy format
    @"fb_year" : @"2015", 
    
    // RECOMMENDED: body_style
    // Allows you to target people based on their search of a vehicle body style
    @"fb_body_style" : @"Sedan",
    
    // RECOMMENDED: state_of_vehicle
    // Allows you to target people based on their search of specific type of vehicle
    @"fb_state_of_vehicle" : @"CPO",  
    
    // RECOMMENDED: exterior_color
    @"fb_exterior_color" : @"black", 
    
    // RECOMMENDED: transmission
    @"fb_transmission" : @"automatic",  
    
    // RECOMMENDED: fuel_type
    @"fb_fuel_type" : @"gasoline", 
    
    // RECOMMENDED: drivetrain
    @"fb_drivetrain" : @"FWD", 
    
    // RECOMMENDED: price
    @"fb_price" : 18000, 
              

    }
  ];          

AddToWishlist iOS Event

// Fire the 'AddToWishlist' event on the search results page  
[FBSDKAppEvents logEvent:FBSDKAppEventNameAddedToWishlist

// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY
  parameters:@{
    // REQUIRED: DO NOT change this, must be set to 'vehicle'
    FBSDKAppEventParameterNameContentType : @"vehicle",
    // RECOMMENDED: content id of vehicle added to wishlist
    FBSDKAppEventParameterNameContentID : @"123",  
    
    // RECOMMENDED: postal_code    
    @"fb_postal_code" : @"94110",
    
    // RECOMMENDED: make
    // Allows you to target people based on their search of a specific make
    @"fb_make" : @"Toyota",
    
    // RECOMMENDED: model
    // Allows you to target people based on their search of a specific make model
    @"fb_model" : @"Camry",
    
    // RECOMMENDED: year, in yyyy format
    @"fb_year" : @"2015", 
    
    // RECOMMENDED: body_style
    // Allows you to target people based on their search of a vehicle body style
    @"fb_body_style" : @"Sedan",
    
    // RECOMMENDED: state_of_vehicle
    // Allows you to target people based on their search of specific type of vehicle
    @"fb_state_of_vehicle" : @"CPO",  
    
    // RECOMMENDED: exterior_color
    @"fb_exterior_color" : @"black", 
    
    // RECOMMENDED: transmission
    @"fb_transmission" : @"automatic",  
    
    // RECOMMENDED: fuel_type
    @"fb_fuel_type" : @"gasoline", 
    
    // RECOMMENDED: drivetrain
    @"fb_drivetrain" : @"FWD", 
    
    // RECOMMENDED: price
    @"fb_price" : 18000, 
              

    }
  ];          

Lead iOS Event

// Fire the 'Lead' event on the search results page  
[FBSDKAppEvents logEvent:"fb_mobile_lead"

// IF YOU CHOOSE NOT TO USE A RECOMMENDED PARAM, THEN REMOVE IT, DON'T LEAVE IT EMPTY
  parameters:@{
    // REQUIRED: DO NOT change this, must be set to 'vehicle'
    FBSDKAppEventParameterNameContentType : @"vehicle",
    // RECOMMENDED: content id of vehicle related to the lead
    FBSDKAppEventParameterNameContentID : @"123",

    // RECOMMENDED: postal_code    
    @"fb_postal_code" : @"94110",
    
    // RECOMMENDED: make
    // Allows you to target people based on their search of a specific make
    @"fb_make" : @"Toyota",
    
    // RECOMMENDED: model
    // Allows you to target people based on their search of a specific make model
    @"fb_model" : @"Camry",
    
    // RECOMMENDED: year, in yyyy format
    @"fb_year" : @"2015", 
    
    // RECOMMENDED: body_style
    // Allows you to target people based on their search of a vehicle body style
    @"fb_body_style" : @"Sedan",
    
    // RECOMMENDED: state_of_vehicle
    // Allows you to target people based on their search of specific type of vehicle
    @"fb_state_of_vehicle" : @"CPO",  
    
    // RECOMMENDED: exterior_color
    @"fb_exterior_color" : @"black", 
    
    // RECOMMENDED: transmission
    @"fb_transmission" : @"automatic",  
    
    // RECOMMENDED: fuel_type
    @"fb_fuel_type" : @"gasoline", 
    
    // RECOMMENDED: drivetrain
    @"fb_drivetrain" : @"FWD", 
    
    // RECOMMENDED: price
    @"fb_price" : 18000, 
              

    }
  ];          

Pixel and App Event Parameters Specifications

While each automotive advertiser may have slightly different goals or custom tracking needs on the website, we've provided some recommended parameters below based on the most common actions and KPIs for automotive websites.

Parameters are subsets of a standard event that track additional information about each action. For example, if you're tracking a ViewContent event on a Vehicle Detail Page (VDP), you can use parameters to also capture information each time that VDP is viewed, such as the make, model, and year of the vehicle.

While parameters are optional for general pixel setup, there are a few specific parameters required for Dynamic Ads for Automotive. We recommend adding those (at the very least) to make it easier to set up DAA now or in the future.

App Event Parameter Specifications

  • On mobile, the parameter names are different than for Facebook Pixel. Often prepended by fb_, with a few exceptions, such as content_ids versus fb_content_id, value versus _valueToSum.
  • When you send multiple values, for example with content_ids or content_type, it provides a JSON-encoded array of values: ["value1", "value2"]. Note: Do not concatenate values with a comma.
Field NameTypeRequired for DAAValuesDescription>

event_name

String

Yes. Required for Search, ViewContent, AddToWishlist, Lead

Search, ViewContent, AddToWishlist, Lead

Predefined event names that allow you to measure the performance of your campaigns and capture intent from your audiences

content_type

String

Yes. Required for Search, ViewContent, AddToWishlist, Lead

vehicle

Product or content type

content_ids

Array of strings

Yes. Required for Search, ViewContent, AddToWishlist, Lead

Ex: ['123', 456]

Relevant ID as listed in your vehicle catalog

postal_code

String

Recommended

Ex: 94112

Postal code for the vehicle location

make

String

Recommended

Ex: Ford, Toyota, Honda

Vehicle make/brand/manufacturer

model

String

Recommended

Ex: F-150, Camry, Accord

Vehicle model

year

Integer

Recommended

yyyy format; ex: 2013

Year the vehicle was launched in yyyy format

state_of_vehicle

enum

Recommended

Values accepted: New, Used, or CPO

Essential to know whether the vehicle is new or used

mileage.value

Integer

Recommended

Ex: 5000

Vehicle mileage (in km or miles); zero (0) for new vehicles.

mileage.unit

String

Recommended

MI or KM only

Mileage unints

exterior_color

String

Recommended

Ex: black, blue, white, and so on

Vehicle exterior color

transmission

enum

Recommended

Values accepted: Automatic, Manual, or Other

Vehicle transmission type

body_style

enum

Recommended

Values accepted: Convertible, Coupe, Hatchback, Minivan, Truck, SUV, Sedan, Van, Wagon, Crossover, or Other

Vehicle body style

fuel_type

enum

Recommended

Values accepted: Diesel, Electric, Flex, Gasoline, Hybrid, or Other

Vehicle fuel type

drivetrain

enum

Recommended

Values accepted: AWD, FOUR_WD, FWD, RWD, TWO_WD, or Other

Vehicle drivetrain

price

float

Recommended

Ex: 8000

Vehicle price

preferred_price_range

[float (min), float (max)]

Recommended

Ex: [8000, 12000]

Vehicle price range

currency

String

Recommended

Specified using ISO 4217 currency format, such as USD

Currency for the price and price_range

trim

String

Recommended

Ex: 5DR HB SE

Vehicle trim

vin

String

Recommended

Ex: KL9CD9S99EC111111

Vehicle identification number; 17 characters

interior_color

String

Optional

Ex: Black, White, Blue, and so on

Vehicle interior color

condition_of_vehicle

enum

Optional

Values accepted: Excellent, Good, Fair, Poor, or Other

Vehicle physical condition

lead_type

String

Optional for Lead

Ex: Test Drive, Personal Finance Quote

Can use this and create customize values (as needed) to differentiate between lead types

viewcontent_type

String

Optional for ViewContent

Ex: Model Page, Offers Page

Can use this to differentiate between soft lead landing pages

search_type

String

Optional for Search

Ex: Dealer Locator

Can use this to different other user searches (such as dealer lookup) from inventory search

registriation_type

String

Optional for CompleteRegistration

Ex: Brochure request

Can use this to differentiate between different types of customer registration on website