Reference

This guide is a reference of the supported feed formats and fields for creating automotive ads.

All enum fields are case-insensitive.

Automotive Inventory Ads - Supported Feed Formats

Provide your feed in the correct format: CSV, TSV, or XML. Once you create the feed file, you should host it at a URL for regular scheduled updates.

Feed Format Description & Guidelines Sample Feed

CSV

Comma-separated value.

  • The first row specifies the column header. Subsequent rows supply the corresponding values for each route.

  • Fields containing whitespace or commas should be enclosed in "double quotes". A double quote inside a double-quoted field must be escaped with two consecutive double quotes.

  • Nested or multi-value fields, such as image, can be represented using JSON-encoded values or by a set of "flattened" plain-text columns labeled using JSON-path syntax. Example: (image[0].url, image[0].tag[0], image[0].tag[1])

  • Both conventions can be used interchangeably in the same file.

See Feed CSV/TSV example, Address CSV/TSV example.

Download > Right-click > Save Link As

TSV

Tab-separated value. See guidelines for CSV.

See Feed CSV/TSV example, Address CSV/TSV example.

Download > Right-click > Save Link As

XML

Format typically generated by automated feed provider systems or web servers. A set of item XML nodes represents a product list and must begin with the <?xml declaration tag.

See Feed XML example.

Download > Right-click > Save Link As

Example - TSV file with tab delimiters

vehicle_id title description url make model year mileage.value mileage.unit image[0].url image[0].tag[0] transmission fuel_type body_style drivetrain vin condition price address exterior_color sale_price availability date_first_on_lot state_of_vehicle latitude longitude i2 EndoHatch GE. Turbocharged! Gasoline! http://www.example.com/test g GE http://www.facebook.com/teapic.jpg Gym AUTOMATIC GASOLINE SEDAN FWD 1FADP5AU6DL536022 EXCELLENT 18000 USD {addr1: '550 Auto Center Dr', city: 'Watsonville', region: 'CA', postal_code: '96075', country: 'US'} white 16000 USD AVAILABLE 2018-02-21  NEW 52.35 42.10

Example — Feed with images as an array

auto_listing_id title description url make model year mileage.value mileage.unit image transmission fuel_type body_style drivetrain vin condition price address exterior_color sale_price availability date_first_on_lot state_of_vehicle latitude longitude
"i2" $299 per month for the EndoHatch GE. Turbocharged! Gasoline! http://www.example.com/test Endomoto "[{""url"":""https://images.trvl-media.com/hotels/3000000/2260000/2250400/2250336/2250336_1_y.jpg""}]" AUTOMATIC GASOLINE SEDAN FWD 1FADP5AU6DL536022 EXCELLENT 18000 USD {addr1: '550 Auto Center Dr', city: 'Watsonville', region: 'CA', postal_code: '96075', country: 'US'} white 16000 USD AVAILABLE 2018-09-15 NEW 52.35 42.10

This sample feed is as XML:

<?xml version="1.0" encoding="UTF-8"?>
<listings>
    <title>Vehicles Feed</title>
    <link rel="self" href="http://www.example.com"/>
    <listing>
      <vehicle_id>SED1234</vehicle_id>
      <title>$299 per month for the EndoHatch GE</title>
      <description>EndoHatch GE. Turbocharged! Gasoline!</description>
      <url>http://www.example.com/test</url>
      <make>Endomoto</make>
      <image>
        <url>http://example.com/some.image_1.jpg</url>
        <tag>Exterior</tag>
      </image>
      <model>EndoHatch</model>
      <year>2017</year>
      <mileage>
        <value>10</value>
        <unit>MI</unit>
      </mileage>
      <drivetrain>FWD</drivetrain>
      <vin>1FADP5AU6DL536022</vin>
      <body_style>SEDAN</body_style>
      <fuel_type>GASOLINE</fuel_type>
      <transmission>AUTOMATIC</transmission>
      <condition>EXCELLENT</condition>
      <price>18000 USD</price>
      <address format="simple">
          <component name="addr1">550 Auto Center Dr</component>
          <component name="city">Watsonville</component>
          <component name="region">CA</component>
          <component name="postal_code">95076</component>
          <component name="country">US</component>
      </address>
      <latitude>52.35</latitude>
      <longitude>42.10</longitude>
      <exterior_color>white</exterior_color>
      <sale_price>16000 USD</sale_price>
      <availability>AVAILABLE</availability>
      <date_first_on_lot>2018-02-21</date_first_on_lot>
      <state_of_vehicle>NEW</state_of_vehicle>
      <dealer_id>ABC1234</dealer_id>
    </listing>
</listings>

Example - Feed CSV/TSV

"vehicle_id","vehicle_registration_plate","vin","make","model","year","transmission","body_style","fuel_type","drivetrain","description","image[0].url", "image[1].url","image[2].url","mileage.value","mileage.unit","url","title","price","state_of_vehicle","exterior_color","address","latitude","longitude","trim","interior_colour","dealer_id","dealer_name","postal_code","dealer_phone","fb_page_id","dealer_communication_channel","dealer_privacy_policy_url"
"56345636","AB12CDE","YV1DZ8256F2693747","Volvo","XC60","2014","AUTOMATIC","OTHER","DIESEL","OTHER","Volvo XC60 2.4 TD D5 R-Design Lux Geartronic 5dr (Nav)","http://website.com/images/stock/car1.jpg","http://website.com/images/stock/car2.jpg","http://website.com/images/stock/car3.jpg","12950","MI","http://www.dealership.co.uk","Volvo XC60 2.4 TD D5 R-Design Lux Geartronic 5dr (Nav)","22495.00 GBP","Used","White","{""addr1"":""Sample Road"",""city"":""London"",""region"":""Greater London"",""postal_code"":""SW31 3EW"",""country"":""United Kingdom""}","52.7445867","-2.7337375","2.4 TD D5 R-Design Lux Geartronic 5dr (Nav)","Black","436456435347346","Dealer Group","SSW31 3EW","","3562564376375","CHAT","https://www.dealership.co.uk/site/privacy-and-legal/"

Example - Address CSV/TSV

"{addr1: '1 Hacker Way', city: 'Menlo Park', region: 'CA', postal_code: '94025', country: 'US'}"

Example - Feed XML

<?xml version="1.0" encoding="UTF-8"?>
<listings>
  <title>Sample Vehicles Feed</title>
  <link rel="self" href="https://www.example.com/dealers/cars/1234/?r=vddn" />
  <listing>
    <vehicle_id>3456553</vehicle_id>
    <title>$299 per month for the EndoHatch GE</title>
    <description>Adjustable Steering Column, Adjustable Steering Wheel, Air Bags, Air Conditioning, Alloy Wheels, Anti Lock Brakes, Bluetooth Preparation (Phone), CD Player, CD Radio, Driver Airbag, Electric & Heated Door Mirrors, Electric Windows, Electronic Stability Programme (ESP), Front Electric Windows, Front Fog Lights, Height Adjustable Drivers Seat, Passenger Airbag, Power Assisted Steering (PAS), Power Fold &amp; Heated DoorMirrors, Rear Parking Sensor, Remote Boot Release, Remote Central Locking, Solid Paint,LOW MILEAGE WITH A FULL FORD HISTORY, SUPPLIED FROM US,</description>
    <url>https://www.example.com/car-1234>
    <make>Endomoto</make>
    <image>
      <url>https://www.example.com/1234/image_1.jpg</url>
    </image>
    <image>
      <url>https://www.example.com/1234/image_2.jpg</url>
    </image>
    <image>
      <url>https://www.example.com/1234/image_3.jpg</url>
    </image>
    <model>B-MAX</model>
    <year>2015</year>
    <mileage>
      <value>15617</value>
      <unit>MI</unit>
    </mileage>
    <drivetrain>Other</drivetrain>
    <vin>1A2BCDEF3GH456789</vin>
    <body_style>OTHER</body_style>
    <fuel_type>Gasoline</fuel_type>
    <transmission>Manual</transmission>
    <price>9490 GBP</price>
    <address format="simple">
      <component name="addr1">Sample Road</component>
      <component name="city">Carland</component>
      <component name="region">North Test</component>
      <component name="country">United States of America</component>
      <component name="postal_code">12345</component>
    </address>
    <latitude>37.484419</latitude>
    <longitude>-122.148406</longitude>
    <exterior_color>White</exterior_color>
    <state_of_vehicle>Used</state_of_vehicle>
    <dealer_id>453356</dealer_id>
    <vehicle_registration_plate>AB12CD</vehicle_registration_plate>
    <fb_page_id>5636367576574</fb_page_id>
    <dealer_communication_channel>LEAD_FORM</dealer_communication_channel>
    <dealer_privacy_policy_url>https://www.example.com/privacy/</dealer_privacy_policy_url>
  </listing>
</listings>

Automotive Inventory Ads - Supported Fields - Vehicle

The following supported fields are designed for items you add to your product catalog.

For localized catalogs, see supported fields for vehicle.

NameDescriptionUse in CreativeUse as a product set filter

fb_page_id

type: int

Required for inventory ads with on-Facebook destination.

Facebook page ID of the partner or dealership. Your catalog must be added to the allow list by your Facebook representative before you can send your page IDs. The page must be added to the allow list using the Business Manager before can be ingested. See Managing Permissions.

N

N

vehicle_id

type: string

Required.

Max characters: 100

Unique ID for item. Can be a variant for a vehicle. If there are multiple instances of the same ID, we ignore all instances. You can also use the VIN for both vehicle_id and vin.

Example: 1FADP5AU6DL536022

Y

Y

title

type: string

Required.

Max characters: 500.

Full name of vehicle. This is relevant and specific to each vehicle and it should contain what is set in year, make, model, trim.

Example: $299 per month for the EndoHatch GE

Y

Y

description

type: string

Required.

Max characters: 5000

Short text describing the vehicle. Don't include promotional text or any links. Don't enter text in all capital letters. Use line breaks to format your description.

Example: Used 2017 Volvo XC90 in great condition, available now.

Y

N

url

type: url

Required.

Link to the external site where you can view the vehicle listing.

Y

N

make

type: string

Required.

Make or brand of the vehicle.

Example: Endomoto

Y

Y

model

type: string

Required.

Model of the vehicle.

Example: EndoHatch

Y

Y

year

type: int

Required.

Year the vehicle was launched in yyyy format.

Example: 2015

Y

Y

mileage.value

type: int

Required.

For used vehicles, current mileage of the vehicle in kilometers (kms) or miles (MI). For new vehicles, use zero (0). For Marketplace, vehicles must have over 500 miles/kms.

Example: '1500'

Y

Y

mileage.unit

type: string

Required.

Mileage units: MI (miles) or KM (kilometers)

Y

N

image[0].url

type: string

Required.

Max items: 20

URL of the vehicle image. If you have more than one vehicle image, follow this naming convention: image[1].url, image[2].url, and so on. You must provide at least one image. Each image can be up to 4 MB in size. For Marketplace, a 2-image minimum is required.

  • To use carousel ads — Provide a square 1:1 aspect ratio images (600x600px).

  • To show single vehicle ads — Provide images with 1.91:1 aspect ratio image (1200x630px).

Learn more about Marketplace Best Practices for images.

N

N

image[0].tag[0]

type: string

Optional.

Max items: 20

Tag appended to the image that shows what's in the image. There can be multiple tags associated with an image. Follow this naming convention: image[0].tag[0], image[0].tag[1] .... image[1].tag[0], image[1].tag[1] ....

Example: Exterior, Interior, StockImage

N

Y

transmission

Type: enum

Optional.

Transmission type of the vehicle: Automatic or Manual.

N

Y

body_style

Type: enum

Required.

Body style of the vehicle: CONVERTIBLE, COUPE, HATCHBACK, MINIVAN, TRUCK, SUV, SEDAN, VAN, WAGON, CROSSOVER, SMALL_CAR, or OTHER.

Y

Y

drivetrain

Type: enum

Optional.

Vehicle drivetrain. Supported values: 4X2, 4X4, AWD, FWD, RWD, Other.

N

Y

vin

Type: string

Optional.

Max characters: 17

Vehicle ID number (VIN) of the vehicle. You can also use the VIN for both vehicle_id and vin. Note: The VIN must be exactly 17 characters and it isn't required for pre-1983 vehicles. Boats have less digits and some vehicles (such as trailers) don't need VINs.

Example: 1FADP5AU6DL536022

Y

Y

price

Type: string

Required.

Cost and currency of the vehicle. Format the price as the cost, followed by the ISO currency code, with a space between cost and currency.

Example: 18000 USD, 32000 USD

Y

Y

exterior_color

type: string

Required.

Vehicle color.

Example: Black, White, Blue, Red

Y

Y

state_of_vehicle

type: enum

Required.

Current state of the vehicle. Supported values: New, Used, or CPO (certified pre-owned).

N

Y

fuel_type

type: enum

Optional.

Vehicle fuel type. Supported values: DIESEL, ELECTRIC, FLEX, GASOLINE, HYBRID, OTHER.

N

Y

tag (image tag)

type: string

Optional.

String that describes the image. There can be multiple tags associated with an image.

Example: Exterior, Interior, StockImage

Y

N

chrome_id

type: int

Optional.

Similar to autodata_id.

N

N

condition

type: enum

Optional.

Condition of the vehicle. Supported values: EXCELLENT, GOOD, FAIR, POOR, OTHER.

N

Y

sale_price

type: integer

Optional.

Sale price or special price. Format the price as the cost, followed by the ISO currency code, with a space between cost and currency.

Example: 16000 USD

Y

Y

availability

type: enum

Optional.

Vehicle availability: available or not available. We don't show vehicles that are unavailable in the ad.

N

Y

vehicle_type

type: string

Optional.

Type of vehicle. Expected values: car_truck (default if not supplied), boat, commercial, motorcycle, powersport, rv_camper, trailer, or other.

N

Y

trim

type: string

Optional.

Max characters: 50

Trim of the vehicle.

Example: 5DR HB SE

Y

Y

interior_color

type: string

Optional.

Max characters: 50

Vehicle interior color.

N

Y

date_first_on_lot

type: string

Optional.

Date when this vehicle first arrived at the dealer lot. Used to indicate inventory age. Use the yyyy-mm-dd format.

Example: 2018-09-05

N

Y

days_on_lot

type: int

Optional.

Number of days the vehicle has been on the lot. Should be incremented daily.

Example: 62

N

Y

status

type: string

Optional.

Controls whether an item is active or archived in your catalog. Only active items can be seen by people in your ads, shops or any other channels. Supported values: active, archived. Items are active by default. Learn more about archiving items.

Example: active


Note: Some partner platforms such as Shopify may sync items to your catalog with a status called staging, which behaves the same as archived.

This field was previously called visibility. While we still support the old field name, we recommend that you use the new name.

N

N

custom_number_0
custom_number_1
custom_number_2

type: init

Up to five custom fields for any additional number-related information you want to filter items by when you create sets. This field allows you to filter by number ranges (is greater than and is less than) when you create a set. For example, you could use this field to indicate the year an item was produced, and then filter a certain year range into a set.


This field supports whole numbers between 0 and 4294967295. It doesn't support negative numbers, decimal numbers or commas, such as -2, 5.5 or 10,000.


Example: 2022

Y

Y

Automotive Inventory Ads - Supported Fields - Dealership

There are two formats for providing addresses and you should use one or the other, but not both. You can use either the address format or you can provide each address field individually. Note that using both formats will result in an error.

NameDescriptionUse in CreativeUse as a product set filter

address

type: string

Required.

Complete dealership physical address, formatted as:

{addr 1: [STREET ADDRESS], city: [CITY], region: [STATE, COUNTY, REGION OR PROVINCE], country: [COUNTRY].

The postal code is optional.

Example: {addr1: '550 Auto Center Dr', city: 'Watsonville', region: 'CA', postal_code: '96075', country: 'US'}

N

N

address.city

type: string

Required.

City where the dealership is located.

Example: Palo Alto

Y

Y

address.region

type: string

Required.

State, county, region, or province where the dealership is located.

Example: California

Y

Y

address.country

type: string

Required.

Country where the dealership is located.

Example: United States

N

Y

latitude

type: float

Required.

Latitude of the dealership location.

Example: 37.484100

N

N

longitude

type: float

Required.

Longitude of the dealership location.

Example: -122.148252

N

N

address.postal_code

type: string

Optional.

Postal code for dealership (outside the U.S. or zip code within the U.S.).

Example: 75008 (Paris, France) or 94025 (Menlo Park)

N

N

dealer_id

type: string

Optional.

Max characters: 100

Alphanumeric ID of the dealership.

Y

Y

dealer_name

type: string

Optional.

Max characters: 100

Name of the dealership.

Y

Y

dealer_phone

type: string

Optional.

Phone number of dealership. Phone number of the dealership. Requirements:

  • Must display the Call button on a Marketplace listing.
  • Must be a valid phone number format.
  • Must include the country code.

Example: +1 3603453333, 001 (360)345-3333

N

N

dealer_communication_channel

type: enum

Optional.

Method with which the dealer will be contacted by the user. Available values: CHAT or LEAD_FORM.


Note: If you select LEAD_FORM, you must also include a privacy policy. See dealer_privacy_policy_url for more.

N

N

dealer_privacy_policy_url

type: url

Required for Lead Form contact method.


Optional for Messenger (Chat) contact method.


Link to the privacy URL of the dealer listing the vehicle. This should match the dealer of the Facebook page ID (fb_page_id).

N

N

stock_number

type: string

Optional.

Dealership's own designation of the car on their lot. The stock number is a way for the dealer to inventory specific vehicles.

Example: N8990

Y

Y

custom_label_0

type: string

Optional.

Max character limit: 100

Additional information about the vehicle you want to include.

Y

Y

custom_label_1

type: string

Optional.

Max character limit: 100

Additional information about the vehicle you want to include.

Y

Y

custom_label_2

type: string

Optional.

Max character limit: 100

Additional information about the vehicle you want to include.

Y

Y

status

type: string

Optional.

Controls whether an item is active or archived in your catalog. Only active items can be seen by people in your ads, shops or any other channels. Supported values: active, archived. Items are active by default. Learn more about archiving items.

Example: active


Note: Some partner platforms such as Shopify may sync items to your catalog with a status called staging, which behaves the same as archived.

This field was previously called visibility. While we still support the old field name, we recommend that you use the new name.

N

N

Automotive Model Ads — Supported Formats

A feed can be in CSV, TSV, XML formats.

Example—TSV file, using tab as the delimiter

vehicle_offer_id    market_name     make     model    trim   year    offer_disclaimer                               offer_type    amount    amount_percentage    amount_qualifier    term_length    term_qualifier    downpayment    downpayment_qualifier    offer_description    url    image[0].url      start_date      end_date    availability     drivetrain     fuel_type     generation     interior_color     interior_upholstery     exterior_color     transmission 

offer34220          market1234    MakeA    ModelA    E3    2017    *Available on approved credit to very well qualified customers    lease    USD 419        a month    36    months    USD 0    due at signing.    Expires 09/05/2017. Excludes official fees, taxes and dealer charges. No security deposit required. 10,000 mile/year limit.    https://test123.com/offers1    http://www.test123.com/cm-img/facebook/offer1.jpg    2018-09-05    2018-12-31    AVAILABLE   FWD    DIESEL    Mk1    Blue    FABRIC    Blue    AUTOMATIC       
offer34221          market1234    MakeB    ModelB    E4    2017    *Available on approved credit to very well qualified customers    cash    USD 1500        cash                    Expires 09/05/2017.    https://test123.com/offers2    http://www.test123.com/cm-img/facebook/offer2.jpg    2018-09-05    2018-12-31    AVAILABLE   AWD    PETROL    Mk2    Yellow    LEATHER    Yellow    AUTOMATIC

offer34222          market2345    MakeC    ModelC    E5    2017    *Available on approved credit to very well qualified customers    finance        4.9    APR    60    months            Expires 09/05/2017. Excludes official fees, taxes and dealer charges.    https://test123.com/offers3    http://www.test123.com/cm-img/facebook/offer3.jpg    2018-09-05    2018-12-31    AVAILABLE   FWD    DIESEL    Mk3    Green    LEATHER    Green    AUTOMATIC

Automotive Model Ads — Supported Fields

These feeds can be uploaded via the UI or API.

NameDescriptionProduct Set FilterCan Use in Creative?

vehicle_offer_id

type: string

Required.

Unique ID for the vehicle. that advertisers will use to identify an offer. This is also the same value that is passed under the content_id parameter in the pixel.

Example: offer1

Y

Y

make

type: string

Required.

Make or brand of the vehicle. Example: Endomoto

Y

Y

model

type: string

Required.

Model of the vehicle.

Example: EndoHatch

Y

Y

year

type: integer

Required.

Year the vehicle was launched in yyyy format. Example: 2015

Y

Y

offer_type

type: enum

Required for Offers. Optional for Models.

Type of offer. Valid values: lease, finance, cash

Y

N

title

type: string

Required.

Title of the ad/offer.

Example: "$299 per month for the EndoHatch GE!"

N

Y

offer_description

type: string

Required.

Description of the offer.

Example: This offer is valid only during the month of September.

N

Y

url

type: url

Required.

Link to the external site where you can view the offer.

N

Y

offer_disclaimer

type: string

Required for offers.

Disclaimer associated with the offer.

N

N

image[0].url

type: string

Required.

URL of the vehicle image used in the ad creative.

Note: To use carousel ads, provide square 1:1 aspect ratio images at 600x600px. To show single-vehicle ads, provide images with 1.91:1 aspect ratio image at 1200x630px.

For more image ratio information, see Best Practices for Aspect Ratios.

N

N

image[0].tag[0]

type: string

Optional.

String that represents what's in the image. There can be multiple tags associated with an image, such as Lease Offer, Financing, and so on.

image[0].tag[m]

type: string

Optional.

String that represents what's in the image. We support multiple tags. Increment the m value to add more tags.

N

N

image[n].url

type: string

Optional.

String that represents what's in the image. You can upload more than 1 image by incrementing the digit n starting from 1 to 20. The value of n should be in sequential order. For example, if you have 0,1,2, then you need to have 3, and cannot directly have 4.

N

N

image[n].tag[0]

type: string

Optional.

String that represents what's in the image. We support multiple tags. Increment the m value to add more tags.

N

N

image[n].tag[m]

type: string

Optional.

String that represents what's in the image. There can be multiple tags associated with an image, such as Lease Offer, Financing, and so on.

N

N

amount_price

type: string

Recommended.

Amount of the lease or cash offer. Format price as the cost, followed by the ISO currency code, with a space between cost and currency.

Example: For a lease of $329/month or a cashback of $2000, the values that are 329 USD or 2000 USD.

N

Y

amount_percentage

type: string

Recommended for offers.

Percentage value, if present in the offer. Sometimes the value is a percentage (example: 3.9% APR) instead of an amount.

N

N

amount_qualifier

type: string

Recommended for offers.

Qualifier for the amount dollar value or amount percentage. Valid values can be per month or APR.

Example: /mo in $100/mo for lease offers. APR in 1.1% APR for finance offers.

N

Y

term_length

type: integer

Recommended for offers.

Duration for which the offer applies. If the offer is a lease of $329/mo for 3 years, then the value is 3 and the corresponding value in term_qualifier is years.

Example: /mo in $100/mo for lease offers. APR in 1.1% APR for finance offers.

N

Y

term_qualifier

type: enum

Recommended for offers.

Units for the term of the offer. Valid values are "months" or "years".

Example: months for an offer of $329/month for 36 months and year for an offer of $329/month for 3 years.

N

Y

downpayment

type: string

Recommended for offers.

Down payment value at time of purchase or lease. Format price as the cost, followed by the ISO currency code, with a space between cost and currency.

Example: Use 1500 USD as the value if the downpayment conditions are $1500 due at signing + 1 month payment.

N

Y

downpayment_qualifier

type: string

Recommended for offers.

Qualifier for the downpayment value. Example: Use the due at signing + 1 month payment value if the down payment conditions are $1500 due at signing + 1 month payment.

Y

trim

type: string

Recommended.

Trim of the vehicle. Example: GE.

N

Y

price

type: string

Required for models. Recommended for offers

MSRP of vehicle with currency. Format price as the cost, followed by the ISO currency code, with a space between cost and currency. Example: 13,999 USD

N

N

body_style

type: enum

Required for models. Optional for offers.

Body style of the vehicles. Valid values: CONVERTIBLE, COUPE, CROSSOVER, ESTATE, GRANDTOURER, HATCHBACK, MINIBUS, MINIVAN, MPV, PICKUP, ROADSTER, SALOON, SEDAN, SPORTSCAR, SUPERCAR, SUPERMINI, SUV, TRUCK, VAN, WAGON, OTHER or NONE

N

N

start_date

type: string

Optional.

Start date from which an offer is valid. Should be in date format yyyy-mm-dd.

Example: 2018-09-05

N

N

end_date

type: string

Optional.

End date after which an offer is valid. Should be in date format yyyy-mm-dd.

Example: 2018-09-05

N

N

market_name

type: string

Optional.

Name of market/designated market area (DMA).

Y

N

dma_codes

type: array of strings

Required for regional offers. Optional for national offers.

List of Designated Market Area (DMA) codes for the specific market provided in the following format ['502', '201'] ['516'...]. Note: This is for CSV format, see below example feeds for XML format. See DMA code standard. Leave empty for national offer.

Y

N

status

type: string

Optional.

Controls whether an item is active or archived in your catalog. Only active items can be seen by people in your ads, shops or any other channels. Supported values: active, archived. Items are active by default. Learn more about archiving items.

Example: active


Note: Some partner platforms such as Shopify may sync items to your catalog with a status called staging, which behaves the same as archived.

This field was previously called visibility. While we still support the old field name, we recommend that you use the new name.

N

N

generation

type: string

Recommended for models.

The generation of the model shown. Example: The EndoHatch 5 Series

N

Y

transmission

type: enum

Recommended for models.

Transmission type of the vehicle. Options are Automatic, Manual, Other, None.

Y

Y

drivetrain

type: enum

Recommended for models.

Drivetrain (Powertrain) of the vehicle. Options are:

  • 4X2
  • 4X4
  • AWD
  • FWD
  • RWD
  • Other
  • None

Y

Y

fuel_type

type: enum

Recommended for models.

Options are:

  • Diesel
  • Electric
  • Gasoline
  • Flex
  • Hybrid
  • Petrol
  • PlugIn_Hybrid
  • Other

Y

Y

availability

type: enum

Recommended for models.

Availability of the vehicle. Options are AVAILABLE and NOT_AVAILABLE.


We do not show NOT_AVAILABLE vehicles in the ad.

N

N

exterior_color

type: string

Recommended for models.

Vehicle exterior color.

Y

Y

interior_color

type: string

Recommended for models.

Vehicle interior color.

N

Y

interior_upholstery

type: string

Recommended for models.

Type of interior upholstery. Available options are:

  • LEATHER
  • FABRIC
  • OTHER

N

Y

Example—To create a catalog for Advantage+ catalog ads, see Catalog, Reference.

curl \
  -F 'name=catalog name' \
  -F 'access_token=<ACCESS TOKEN>' \
  -F 'vertical=vehicle_offers' \
  https://graph.facebook.com/<API_VERSION>/<BUSINESS ID>/product_catalogs