Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Panel
titleFollowing steps are covered
Table of Contents

Add Additional Parameters to Your XML-file

For the algorithm to work properly every product in your XML Product Feed should have additional properties:

  • gender this product is targeted at;
  • product volume and type;
  • additional category-specific information.

This data should be included into the XML-file in the form of specific product parameters and send to PersonaClick.

Section <cosmetics>

A distinctive beauty (incl. fragrances) and cosmetic product feature is presence of the <cosmetics> subsection inside the <offer>  section.

Add the following parameters to each product to your XML-File

Gender

Mandatory parameter <gender>. Placed inside the <offer> section, within the <cosmetics> subsection.

Consider the following table of possible values:

...

Consider the following example of use:

Code Block
languagexml
titleXML example
 ...
<offer ...>
    ...
	<cosmetic>
	    <gender>f</gender>
	</cosmetic>
</offer>
...
Info

No need to specify the gender this particular product is targeted at, if you do not have correct data (gender). In this case, this particular product will simply be marked as 'unisex' and will have a lower displaying priority in relation to other products with the specified gender parameter.

Hypoallargenic Properties

Oprtional parameter <hypoallergenic>. Placed inside the <offer> section, within the <cosmetics> subsection.

Consider the following table of possible values:

...

Consider the following example of use:

...

languagexml
titleXML example

...

Additional niches properties of products allow studying user preferences and calculating recommendations more accurately. This section describes allowing filling the product feed with niche features of cosmetics and perfumes. 



Case Sensitivity

Warning

All parameter names are case-sensitive and should follow the spelling used in this documentation.



Cosmetics

The "cosmetics" element must be inside the "offer" element.

Code Block
languagexml
themeMidnight
<offer ...>
    ...
    <cosmetics>
        ...
    </cosmetics>
</offer>


Gender

Anchor
gender
gender
The "gender" element must be inside the "cosmetics" element and can have one of the following values:

ValueDescription
mFor men's products
fFor women's products

Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    <gender>f</gender>
	</cosmetic>
</offer>

Tip

If the product is equally suitable for either gender, there is no need to add this element.



Hypoallergenic

The "hypoallergenic" element must be inside the "cosmetics" element and can have the following values:

ValueDescription
1Product is hypoallergenic
0Product is non-hypoallergenic. The default value.

Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    <hypoallergenic>1</hypoallergenic>
	</cosmetic>
</offer>


Skin

Anchor
skin
skin
The "skin" element must be inside the "cosmetics" element.

Code Block
languagexml
themeMidnight
<offer ...>
    <cosmetics>
       ...
        <skin>
            ...
        </skin>
    </cosmetics>
</offer>


Type (skin)

Anchor
skin_type
skin_type
The "type" elements must be inside the "skin" element of the "cosmetics" element and can have one of the following values:

ValueDescription
dryProducts related to dry skin
normalProducts related to normal skin
oilyProducts related to oily skin
combyProducts related to combination skin

Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    

...

<skin>
			<type>normal</type>
			<type>dry</type>
		</skin>
	</cosmetic>
</offer>

...

Info

No need to specify the gender this particular product is targeted at, if you do not have correct data (hypoallergenic properties). By default, every cosmetic product is set to non-hypoallergenic.

Subsection <skin>

Subsection <skin> contains additional characteristics of Skin Care products.

Add the following parameters to each skin care product to your XML-File.

Skin Type 

Optional parameter <type>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <skin> sub-subsection.

...



Condition (skin)

Anchor
skin_condition
skin_condition
The "condition" elements must be inside the "skin" element of the "cosmetics" element and can have one of the following values:

ValueDescription

...

dehydratedProducts related to dehydrated skin

...

sensitive

...

Products related to sensitive skin

...

problem

...

Products related to problematic skin

...

fadingProducts related to aging skin

Current Skin Condition 

Optional parameter <condition>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <skin> sub-subsection.

Consider the following table of possible values:

...

Consider the following examle of use:

...

languagexml
titleXML example

...


Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    <skin>
			

...

<condition>sensitive</

...

condition>
			

...

<condition>fading</

...

condition>
		

...

</

...

skin>
	

...

</

...

Local Application

Optional parameter <part>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <skin> sub-subsection.

Consider the following table of possible values:

...

Info

If this particular product is intended for various purposes/various local applications, additional data is passed in the form of a list in the <part> section.

Consider the following examle of use:

...

languagexml
titleXML example

...

cosmetic>
</offer>


Part

The "part" elements must be inside the "skin" element of the "cosmetics" element and can have one of the following values:

ValueDescription
faceProducts related to facial care, makeup, oral hygiene, etc.
bodyProducts related to body care, perfume, etc.
intimProducts related to personal hygiene
handProducts related to hand and nail care
legProducts related to foot care

Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    <skin>
			<part>face</part>
			<part>body</part>
		</skin>
	</cosmetic>
</offer>


Hair

Anchor
hair
hair
The "hair" element must be inside the "cosmetics" element.

Code Block
languagexml
themeMidnight
<offer ...>
    <cosmetics>
       ...
        <hair>
            ...
        </hair>
    </cosmetics>
</offer>


Type (hair)

Anchor
hair_type
hair_type
The "type" elements must be inside the "hair" element of the "cosmetics" element and can have one of the following values:

ValueDescription
dryProducts related to dry hair
normalProducts related to normal hair
oilyProducts related to oily hair
combyProducts related to combination hair

Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    <hair>
			<type>normal</type>
			<type>oily</type>
		</hair>
	</cosmetic>
</offer>


Condition (hair)

Anchor
hair_condition
hair_condition
The "condition" elements must be inside the "hair" element of the "cosmetics" element and can have one of the following values:

Value Description
coloredProducts related to dyed hair
damagedProducts related to damaged hair
wavedProducts related to curly hair
seboreaProducts related to dandruff
akneProducts related to aсne, others head skin conditions
lossProducts related to hair loss treatment
growProducts related to hair growth helping

Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    <hair>
			<condition>colored</condition>
			<condition>damaged</condition>
		</hair>
	</cosmetic>
</offer>


Nail

Anchor
nail
nail
The "nail" element must be inside the "cosmetics" element.

Code Block
languagexml
themeMidnight
<offer ...>
    ...
    <cosmetics>
        <nail>
            ...

...

 

...

    

...

 

...

 

...

 

...

</

...

nail>

...

Subsection <hair>

Subsection <hair> contains additional characteristics of Hair Care products.

Hair Type

Optional parameter <type>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <hair> sub-subsection.

Consider the following table of possible values:

...

Current Hair Condition

Optional parameter <condition>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <hair> sub-subsection.

Consider the following table of possible values:

...

    <cosmetics>
</offer>


Type (nail)

The "type" elements must be inside the "nail" element of the "cosmetics" element and can have one of the following values:

ValueDescription
toolProducts related to nail care tool
polishProducts related to nail polish
gelProducts related to gel polish
oilProducts related to nail oil
cleanerProducts related to nail cleaner

Code Block
languagexml

...

theme

...

Midnight
<offer ...>
    ...
	<cosmetic>
	    

...

<nail>
			

...

<type>tool</type>
		

...

</

...

nail>
	

...

</

...

Subsection <nail>

Subsection <nails> contains additional characteristics of Nail Care Care products.

Care Type

Optional parameter <type>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <nail> sub-subsection.

Consider the following table of possible values:

...

cosmetic>
</offer>


Polish Color

The "polish_color" element must be inside the "nail" element of the "cosmetics" element and can have any value describing the color of the nail polish.

Note

This element can only be used in combination with the "polish" type. See above.


Code Block
languagexml
themeMidnight
<offer ...>
    ...
	<cosmetic>
	    <nail>
			<type>polish</type>
            <polish_color>red</polish_color>
		</nail>
	</cosmetic>
</offer>


Perfume

Anchor
perfume
perfume
The "perfume" element must be inside the "cosmetics" element.

Code Block
languagexml

...

theme

...

Midnight
<offer ...>
    ...

...


    <cosmetics>
        <perfume>
          

...

 

...

 ...
        </perfume>
  

...

 

...

 <cosmetics>
</offer>

...

Subsection <perfume>

Subsection <perfume> contains characteristics of fragrances.

Main fragrance families (<family>)

Mandatory parameter <family>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <perfume> sub-subsection.

...



Family

Anchor
family
family
The "family" element must be inside the "perfume" element of the "cosmetics" element and can have one of the following values:

ValueDescription
floral

...

Perfume products of the floral note family
oriental

...

Perfume products of the oriental note family
woody

...

Perfume products of the woody note family
fresh

...

Perfume products of the fresh note family

Code Block
languagexml

...

theme

...

Midnight
<offer ...>
    ...
	<cosmetic>
	    <perfume>
			<family>woody</family>
		</perfume>
	</cosmetic>
</offer>

...

Subgroups of fragrance families (<aroma>)

Optional parameter <aroma>. Placed inside the <offer> section, within the <cosmetics> subsection, within the <perfume> sub-subsection, within the <family> sub-sub-subsection.

...

Floral notes

Oriental notes

Woody notes

Fresh notes

...



Aroma

Anchor
aroma
aroma
The "aroma" element must be inside the "perfume" element of the "cosmetics" element and can have one of the following values:

ValueRelationsDescriptionCommentary
fruity_floralFloral Family

Fruity Floral (Fruity + Floral Notes)Main notes include fruits and floral notes
floralFloral (Floral + Fresh Notes)Main notes include fresh-cut flowers

...

soft_floralSoft Floral (Floral Notes)Main notes

...

include aldehydes and powdery notes

...

floral_orientalOriental FamilyFloral Oriental (Floral + Oriental Notes)Main notes include white flowers (such as orange blossom) and sweet spices

...

soft_orientalSoft Oriental (Oriental + Floral Notes)Main notes include incense and amber

...

orientalOriental (Oriental Notes)Main notes include oriental resins such as frankincense, and vanilla

...

woody_orientalWoody Oriental (Oriental + Woody Notes)Main notes include sandalwood and patchouli.
woodsWoody FamilyWoodsMain notes include aromatic woods and vetiver

...

mossy_woodsMossy Woods (Woody + Oriental Notes)Main notes include oakmoss and amber

...

dry_woodsDry Woods (Woody Notes)Main notes include dry woods and leather

...

aromaticFresh FamilyAromatic Fougère (Fresh Notes)Main notes include lavender and aromatic herbs. This universal fragrance group includes elements from different families: the freshness from the Citrus family, floral notes of lavender, the spicy-sweetness of a Floral Oriental, the ambery depth of an Oriental and the Mossy Woods warmth of sandalwood and oakmoss.
citrusCitrus (Woody + Fresh Notes)Main notes include bergamot and other citrus oils

...

waterWater (Fresh + Floral Notes)Main notes include marine and aquatic notes, generally from the chemical calone

...

greenGreen (Fresh + Floral Notes)Main notes include galbanum and green notes.
fruityFruity (Fresh + Floral Notes)Main notes include berries and other non-citrus fruits

...

Consider the following example of use:


Code Block
languagexml

...

theme

...

Midnight
<offer ...>
    ...
	<cosmetic>
	    <perfume>
			<family>woody</family>
            <aroma>mossy_woods</aroma> 
		</perfume>
	</cosmetic>
</offer>

...

Product Volume

Optional parameter <volume> and <price> are wrapped in the parameter <volumes>. Placed inside the <offer> section, within the <cosmetics> subsection.

<volumes> allows to specify product volume and volume-dependable pricing.

Consider the following table of possible sub-parameters:

...



Volume

The "volume" elements must be inside the "volumes" element of the "cosmetics" element. Each "volume" element must contain the "value" and "price" elements:

NameTypeDescription
valuenumberVolume in milliliters
pricenumberPrice for each volume

Consider the following example of use:


Code Block
languagexml

...

themeMidnight
<offer ...>
    ...
	<cosmetic>
		<volumes>
 			<volume>
    			<value>200</value>
				<price>1000</price>
  			</volume>
			<volume>
    			<value>400</value>
				<price>2000</price>
  			</volume>
		</volumes>
	

...

Info
titleIMPORTANT

Measurment units for the <value> parameter are milliliters.

Purchase Frequency

Optional parameter <periodic>. Placed inside the <offer> section, within the <cosmetics> subsection.

...

</cosmetic>
</offer>


Periodic

The "periodic" element must be inside the "cosmetics" element and can have the following values:

ValueDescription
1Product is purchased frequently
0Product is purchased occasionally

...

. The default value.

Code Block
languagexml

...

theme

...

Midnight
<offer ...>
    ...
	<cosmetic>
	    <periodic>1</periodic>
	</cosmetic>
</offer>

...



Professional

...

Optional parameter <professional>. Placed inside the <offer> section, within the <cosmetics> subsection.

...

The "professional" element must be inside the "cosmetics" element and can have the following values:

ValueDescription
1Product is purchased for professional use (by professionals)
0Product is purchased for everyday use (by ordinary customers)

...

. The default value.

Code Block
languagexml

...

theme

...

Midnight
<offer ...>
    ...
	<cosmetic>
	    <professional>1</professional>
	</cosmetic>
</offer>

...



Column

Page Navigation

Table of Contents
maxLevel2
indent0px
stylenone




Related Pages

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
sorttitle
cqllabel = "products"