Advertising API

Purpose

Typically the Advertising API will be used by website agencies and classified portals to retrieve images and videos for displaying on a Vehicle Search Results and Detail web pages.

Available Media Files

Subject to individual account configurations, available for each vehicle are,

  • Up to 50 jpg image URLs per vehicle

  • 1 mp4 video as

    • Vzaar URL

    • Vzaar embed HTML

    • YouTube embed URL

    • YouTube watch URL

    • YouTube embed HTML

Which Endpoint?

Very Important to choose the right endpoint for your use case.

/GetMedia
/GetMediaByDealer
/GetMediaByGroup
/GetMedia

Use this endpoint if you want to retrieve media for a single vehicle at a time.

👍 Best for incremental updates

/GetMediaByDealer

Use this endpoint if you want to retrieve all media for a single Dealer at a time.

/GetMediaByGroup

Use this endpoint if you want to retrieve all media for all locations for a Dealer Group at a time.

👍 If there isn't a 1:1 relationship between locations in B2see and your system then this endpoint is best suited.

👎 If you would prefer the extra security of checking for by Dealer use /GetMediaByDealer or /GetMedia