Additional
PropertiesAdditional niches properties of products allow studying user preferences and calculating recommendations more accurately. This section describes allowing filling the product feed with vehicle niche features.
Case Sensitivity
| Warning |
|---|
All parameter names are case-sensitive and should follow the spelling used in this documentation. |
Auto
The "auto" element must be inside the "offer" element.
| Code Block |
|---|
| language | xml |
|---|
| titletheme | XML exampleMidnight |
|---|
|
<offer ...>
...
<auto>
...
</auto>
...
</offer> |
Product Compatibility with Different Car Brands and Models
Mandatory parameter <compatibility>. Placed inside the <offer> section, within the <auto> subsection.
Contains one to few notes of product compatibility with certain car brands and models.
Consider the following example of use:
Compatibility
The "compatibility" elements must be inside the "auto" element and can have the following attributes:
| Name | Requirement | Description |
|---|
| brand | required | Allows specifying the brand of the vehicle. |
| model | optionally | Allows specifying the model of the vehicle. No specific model makes the product compatible with all brand models. |
| Tip |
|---|
This allows adding more than one model of the same brand. There is no need to set this element if the product is compatible with all brands and models. |
| Code Block |
|---|
| language | xml |
|---|
| titletheme | XML example |
|---|
| ...
|
<offer ...>
...
<auto>
...
<!-- using brand without specific model automatically makes the product compatible with any model within this brand -->
<compatibility brand="BMW" />
<!-- using brand and model specifies product compatibility with defined model and brand -->
<compatibility brand="Mini" model="Cooper S" />
<!-- note that it is possible to list more than just one model -->
<compatibility brand="Mini" model="Cooper One" />
</auto>
</offer>
... |
| Info |
|---|
No need to specify compatibility elements, if the product is cross-compatible with all brands and models. |
Frequently purchased product
Optional parameter <periodic>. Placed inside the <offer> <auto> subsection.
Consider the following table of possible attributes:
Mandatory?
Periodic
The "periodic" element must be inside the "auto" element and can have the following values:
No |
|---|
| 1 | Product is purchased frequently |
No |
| 0 | Product is purchased occasionally |
Consider the following example of use:
| Code Block |
|---|
| language | xml |
|---|
| titletheme | XML example |
|---|
| ...
|
<offer ...>
...
<auto>
...
<periodic>1</periodic>
</auto>
</offer>
... |
Car identifier VIN (part of <vds>)
Optional parameter <vds>. Placed inside the <offer> <auto> subsection.
Contains one to few VDS notes - from the VIN section that describes car configuration details;
Consider the following example of use:
VDS
The "vds" element must be inside the "auto" element.
| Code Block |
|---|
| language | xml |
|---|
| titletheme | XML example |
|---|
| ...
|
<offer ...>
...
<auto>
...
<vds>BP8AN5</vds>
<vds>HH5820</vds>
</auto>
</offer>
... |