Dokumentacja
API
Emisja
Sponsored Products Deprecated

title = ‘Oferty Sponsorowane — deprecated’ weight = 9

Integracja przez API /v1/dsa/raw — deprecated

⚠️
Opisane tutaj jest stare API, które nie wspiera odpytania o wiele jednostek reklamowych naraz oraz powoduje problemy przy przekazywaniu listy ścieżek kategorii zawierających przecinki. Zalecamy korzystanie z API /v1/dsa/raw/batch.

W modelu integracji przez API AdsHero odpowiada wyłącznie za dobór reklam. Ich wyświetlanie realizowane jest przez serwis odpytujący AdsHero o reklamy.

Podstawowe zapytanie o reklamy (request emisyjny) wygląda następująco:

GET https://dispatcher.ahevds.com/v1/dsa/raw/{slotHash}/{adCount} HTTP/2
cid: {cid}
uid: {uid}
curl --location --request GET 'https://dispatcher.ahevds.com/v1/dsa/raw/{slotHash}/{adCount}' \
    --header 'cid: {cid}' \
    --header 'uid: {uid}'
  • slotHash to identyfikator jednostki reklamowej dostępny w panelu wydawcy (sklepu) na liście jednostek reklamowych (menu “Sloty”).
  • adCount to maksymalna liczba reklam, które mają być zwrócone.

Wszystkie dodatkowe parametry przekazywane są jako “query parameters”, tj. parametry URL w formie key=value podawane po znaku ? i oddzielone znakiem &.

Dostępne parametry:

NazwaOpisPrzykład wartości
searchDataFraza wyszukiwania.karma dla kota
excludeShopProductsIdsLista ID produktów do wykluczenia.BAM-SWA-BLA-MIN
priceMinFiltr na minimalną cenę.1.23
priceMaxFiltr na maksymalną cenę.12.3
currencyWaluta strony.PLN
brandMarka produktu.Fun with Mum
productTitleTytuł produktu.Kocyk Bambusowy - Mint
categoriesLista ID kategorii.113
categoryPathsLista ścieżek kategorii.Kocyki > Kocyki Dziane > Kocyk Bambusowy
shopProductIdID produktu, w którego kontekście wyświetlana jest reklama.BAM-SWA-BLA-MIN
attributesDodatkowe atrybuty. Opis poniżej.[{"name":"color","value":"red"}]
adTypePozwala ograniczyć dobór reklam do tylko autopromo, lub tylko ofert sponsorowanych.ALL

Jeśli przekazujemy więcej niż jedną wartość dla danego parametru, należy dany parametr przekazać wielokrotnie np. categories=113&categories=114.

Parametr attributes

attributes służy dodatkowemu filtrowaniu produktów. Wartości tych parametrów nie wpływają na jakość dopasowania ofert: gwarantują jedynie, że zwrócone zostaną tylko oferty, które posiadają podane wartości atrybutów.

Każdy atrybut przyjmujemy w postaci:

{
  "name": "name",
  "value": "value"
}

Całość atrybutów powinna być przekazana jako tekst z tablicą w json, tj. [{"name": "color", "value": "red"}].

name to nazwa atrybutu, a value to jego wartość.

Akceptujemy atrybuty (z feedu):

  • adult
  • age_group
  • color
  • energy_efficiency_class
  • gender
  • google_product_category
  • gtin
  • material
  • mpn
  • pattern
  • size
  • unit_pricing_measure

Oraz wszystkie atrybuty przekazane w product_detail.

Algorytmy