XML Feeds

XML Feeds

Tato kapitola popisuje konfiguraci feedů

Konfigurační soubor se standardně nachází v adresáři /config/module-edeeshop/features/interface/xml-feed.xml.

Zkopírovat odkaz na sekciPříklad konfigurace

xml
1 <xmlFeed>2    <alternativeImgGallery/>3    <alternativeImgVariant/>4    <defaultCategoryKey/>5    <disableShipping/>6    <exportShippingBlackList/>7    <feedTypes>8        <feedType>9            <code/>10            <interval/>11        </feedType>12    </feedTypes>13    <ignoredPricePolicies/>14    <imgDefault/>15    <imgGallery/>16    <imgVariant/>17    <productFeedPageSize/>18    <snippetProductQuery/>19    <storage/>20    <templatePath/>21    <feeds>22        <feed>23            <region/>24            <code>google</code>25            <type>PRODUCTS</type>26            <alternativeImgGallery>galerie</alternativeImgGallery>27            <alternativeImgVariant>eshop-product-detail</alternativeImgVariant>28            <categoryPathSeparator>&gt;</categoryPathSeparator>29            <exportFileName>googlec43vwp</exportFileName>30            <externalCategorySource>google</externalCategorySource>31            <imgDefault>/img/eshop/placeholder/eshop-product-detail.jpg</imgDefault>32            <imgGallery>hlavni-motiv</imgGallery>33            <imgVariant>eshop-product-detail</imgVariant>34            <multiplyPriceByPackage/>35            <profile>heurekaProfile</profile>36            <salePrice/>37            <shouldSkipItem/>38            <snippetTemplate>feed-product-google.ftl</snippetTemplate>39            <template>feed-google.ftl</template>40        </feed>41    </feeds>42    <profiles>43        <profile>44            <code/>45            <converters>46                <converter>47                    <code>shippingType</code>48                    <values>     &lt;values&gt;49      &lt;POST_OFFICE_TO_HAND&gt;CESKA_POSTA&lt;/POST_OFFICE_TO_HAND&gt;50   &lt;POST_OFFICE_TO_POST_OFFICE&gt;CESKA_POSTA_NAPOSTU_DEPOTAPI&lt;/POST_OFFICE_TO_POST_OFFICE&gt;51&lt;DPD&gt;DPD&lt;/DPD&gt;52&lt;DHL&gt;DHL&lt;/DHL&gt;53     &lt;/values&gt;54</values>55                </converter>56            </converters>57        </profile>58    </profiles>59    <catalogSpecific>60        <catalogCode/>61        <alternativeImgGallery/>62        <alternativeImgVariant/>63        <defaultCategoryKey/>64        <disableShipping/>65        <exportShippingBlackList/>66        <ignoredPricePolicies/>67        <imgDefault/>68        <imgGallery/>69        <imgVariant/>70        <productFeedPageSize/>71        <snippetProductQuery/>72        <storage/>73        <templatePath/>74        <feeds>75            <feed>76                <region/>77                <code>google</code>78                <type>PRODUCTS</type>79                <alternativeImgGallery>galerie</alternativeImgGallery>80                <alternativeImgVariant>eshop-product-detail</alternativeImgVariant>81                <categoryPathSeparator>&gt;</categoryPathSeparator>82                <exportFileName>googlec43vwp</exportFileName>83                <externalCategorySource>google</externalCategorySource>84                <imgDefault>/img/eshop/placeholder/eshop-product-detail.jpg</imgDefault>85                <imgGallery>hlavni-motiv</imgGallery>86                <imgVariant>eshop-product-detail</imgVariant>87                <multiplyPriceByPackage/>88                <profile>heurekaProfile</profile>89                <salePrice/>90                <shouldSkipItem/>91                <snippetTemplate>feed-product-google.ftl</snippetTemplate>92                <template>feed-google.ftl</template>93            </feed>94        </feeds>95    </catalogSpecific>96</xmlFeed>

Zkopírovat odkaz na sekciPopis

Zkopírovat odkaz na sekcixmlFeed

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
alternativeImgGallery

Použitý kód galerie pro načtení alternativních obrázků pro feed

String

-

galerie

alternativeImgVariant

Kód alternativní varianty pro načtení obrázku z galerie

String

-

eshop-product-detail

defaultCategoryKey

Kód kategorie, pokud žádná kategorie pro produkt neexistuje

String

-

-

disableShipping

Zrušení načítání doprav pro konkrétní produkt po vložení do košíku.

Boolean

-

false

exportShippingBlackList

Ignorované dopravy při zpracování feedů

List: String

-

-

feedTypes/feedType

Typy exportních feedů, pokud není použitá použije výchozí

Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.

feedTypes/feedType

-

-

ignoredPricePolicies

Ignorované cenové politiky při vkládání produktu do košíku / načítání doprav pro produkt

List: String

-

[voucher, credit, productBundlePolicyStrategy]

imgDefault

Relativní URL, která je použita v metodě: WithPublishedURL#getAbsoluteUrlFromRelative(String) pokud nebyla u produktu nalezena

String

-

/img/eshop/placeholder/eshop-product-detail.jpg

imgGallery

Použitý kód galerie pro načtení hlavního obrázku pro feed

String

-

hlavni-motiv

imgVariant

Kód varianty pro načtení obrázku z galerie ()}

String

-

eshop-product-detail

productFeedPageSize

Velikost stránky produktů pro zpracování při generování snippetů.

Integer

-

250

snippetProductQuery

Metoda načte query pro produkty při zpracování snippetů

ProductQuery

-

-

storage

Storage, která je použita pro uložený vygenerovaných feedů

String

-

f.pub

templatePath

Konfigurační cesta ke složce, která obsahuje freemarker šablony pro zpracování feedu. Dostupné konvence pro zapsání cesty ke složce jsou bežně používané v používané v EdeeCMS com.fg.webapp.cps.v1.modules.spring.context.ModuleContext

String

-

storage:f.cfg:/module-edeeshop/interface/template/

feeds/feed

Seznam konfigurovaných feedů pro všechny katalogy, nebo specifikovaný katalog

List: feeds/feed

-

-

profiles/profile

Seznam feed profilů zaregistrovaných pomocí konfigurace. Aplikace obsahuje již předpřipravené profily, které je možné přetížit či vytvořit nové.

Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.

List: profiles/profile

-

-

catalogSpecific

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

-

-

Zkopírovat odkaz na sekcifeedTypes/feedType

Typy exportních feedů, pokud není použitá použije výchozí

Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

String

-

-

interval

String

-

-

Zkopírovat odkaz na sekcifeeds/feed

Seznam konfigurovaných feedů pro všechny katalogy, nebo specifikovaný katalog

VlastnostPopisHodnotaPovinnáVýchozí hodnota
region

Region feedu, ve kterém bude konkrétní feed zpracován. Region určuje například měnu.

String

-

czcsczk

code

Kód feedu

String

✔

-

type

Typ feedu. Možné hodnoty:

  • PRODUCTS
  • STOCK_INFO
  • RATINGS Pro každý typ jsou vytvořeny joby, které zpracovávají snippety a generují feedy. Ve výchozí konfiguraci feed pro produkty běhá 1x za den, přičemž feed pro sklady běhá každých 10 min

String

-

PRODUCTS

alternativeImgGallery

Použitý kód galerie pro načtení alternativních obrázků pro feed

String

-

-

alternativeImgVariant

Kód alternativní varianty pro načtení obrázku z galerie

String

-

-

categoryPathSeparator

Separátor, který je použit při skládání řetězce kategorií

String

-

>

exportFileName

Název souboru pro uložení feedu do storage

String

✔

-

externalCategorySource

Klíč pro mapování EdeeShop kategorií na externí kategorie dle feedu Dostupné hodnoty:

  • heureka
  • heurekaSk
  • zbozi
  • glami
  • google

String

✔

-

imgDefault

Relativní URL, která je použita v metodě: WithPublishedURL#getAbsoluteUrlFromRelative(String) pokud nebyla u produktu nalezena

String

-

-

imgGallery

Použitý kód galerie pro načtení hlavního obrázku pro feed

String

-

-

imgVariant

Kód varianty pro načtení obrázku z galerie

String

-

-

multiplyPriceByPackage

Vlastnost, která určuje, zda má být cena vypočtena dle počtu kusů.

boolean

-

false

profile

Kód profilu, který bude použitý při generování snippetu

String

-

-

salePrice

Vlastnost, která určuje zda má být vypočtena dvojí cena pro produkt.

boolean

-

false

shouldSkipItem

Výraz (SPeL), který definuje, jestli má být produkt pro feed přeskočen. Pro přeskočení produktu existují dvě možné cesty

  • obalení .ftl šablony snippetu do podmínky (pokud výsledek .ftl je prázdný produkt je přeskočen)
  • definice SpeLu pro vyhodnocení podmínky

Dostupné parametry ve SPeLu jsou:

  • item

String

-

-

snippetTemplate

Šablona, která bude při zpracování snippetu použita

Existující šablony v aplikaci:

  • feed-product-facebook.ftl
  • feed-product-google.ftl
  • feed-product-glami.ftl
  • feed-product-heureka.ftl
  • feed-product-zbozi.ftl

String

✔

-

template

Šablona, která bude při zpracování feedu použita. Při zpracování feedu dochází k načtení již vytvořených snippetů z databáze.

Existujicí šablony v aplikaci:

  • feed-facebook.ftl
  • feed-google.ftl
  • feed-glami.ftl
  • feed-heureka.ftl
  • feed-zbozi.ftl

String

✔

-

Zkopírovat odkaz na sekciprofiles/profile

Seznam feed profilů zaregistrovaných pomocí konfigurace. Aplikace obsahuje již předpřipravené profily, které je možné přetížit či vytvořit nové.

Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

Unikátní identifikátor profilu katalogu.

String

✔

-

converters/converter

Konvertery profilu

Zdroje hodnot:

List: converters/converter

✔

-

Zkopírovat odkaz na sekciconverters/converter

Konvertery profilu

Zdroje hodnot:

VlastnostPopisHodnotaPovinnáVýchozí hodnota
code

String

-

-

values

values

-

Zkopírovat odkaz na sekcivalues