Search Context

YieldWord Platform API

The YieldWord platform provides two modus operandi called contexts. These are page and search.

The page context takes an URL as it’s primary input whereas the search context takes a search query. Both contexts analyze their inputs and deliver ads and/or reviews based on these.

Search context

GET /V2/SEARCH/LINK

Get link ads for the given search query.

Example:

http://search.srvtrck.com/v2/search/link?q=lg+handy&api_key=1&site_id=2

Response:

{
  "link":[
    {
      "title":"handy-bestkauf.de - gebrauchte Handys verkaufen",
      "keywords":[
        "lg handy"
      ],
      "ad":"http://r.srvtrck.com/v1/redirect?type=search&adId=handy-bestkauf.de&adType=advertiser&api_key=1&site_id=2&criterionId=lg+handy",
      "display_type":[
        "link"
      ]
    },
    {
      "title":"Nokia Lumia 630 Dual-SIM Smartphone (11,4 cm (4,5 Zoll) Touchscreen, 5 Megapixel Kamera, HD-Ready Video, Snapdragon 400, 1,2GHz Quad-Core, Windows Phone 8.1) schwarz",
      "keywords":[
        "handy"
      ],
      "ad":"http://r.srvtrck.com/v1/redirect?type=search&adId=AMAZON.1.B00JVL2X1I&adType=product&api_key=1&site_id=2&criterionId=handy",
      "display_type":[
        "widget"
      ]
    }
  ]
}

Request parameters:

Field	Description
api_key	Partner’s API key.
site_id	Publisher’s site id.
site_id	Publisher’s site id.
advertiser_filter	Advertiser domain must match and must be used with ctx.dist=none
loc (optional)	A two digit ISO3166 country code in lowercase. Used to make ads relevant for the target location. The special value use_geo instructs the service to use the client’s geo location if possible.
lang (optional)	A two digit ISO369_1 language code. Used to make ads relevant for the target language. The special value use_locale instructs the service to use client’s locale language.
fields (optional)	A comma separated list of fields to be included in the response for each link entry. Valid values are: price, manufacturer, logo, ad_type, description, advertiser, gtin, category. Note that these fields are not always available in all ads.
logo.dim (optional)	Include product logo URL in the response. Valid values are: 75X75, 90X90, 100X100, 125X125, 150X150.
ad_type (optional)	A comma separated list of ad types to retrieve. Valid values are: advertiser, product, coupon.
ctx.dist (optional)	In order to control how “strict” are the search results it is possible to add the parameter ctx.dist=high/low/none. By default is high and none delivers the full tech search.
size (optional)	Number of results.
page (optional)	Page number.