post https://www.example.com/searchblox/rest/v2/api/ads/update
JSON Payload
JSON Fields | Value |
---|---|
apikey | API key accessible in the SearchBlox Admin Console. It is also present in the config.xml file. |
title | Title of the ad. |
url | URL for the ad. |
uid | Unique id for the ad. Note: Each ad should be given unique ID |
startDate | Start date to display the ad. |
expiryDate | Expiry date for the ad. |
expiryCount | Expiry count, i.e., number of times the ad has to be displayed. |
priority | Priority in which the ad has to be displayed. The value has to be given in numbers eg 1, 2, 3 as per the priority. |
active | This is to activate the ad while creating. When value is true the ad will be activated while creating. When value is false the ad will be deactivated while creating. |
keywordType | For Keyword Match the value is keyword For Phrase Match the value is phrase For Exact Match the value is exact |
keywordsFieldType | Whether it is words or string or keywords URL. The value can be STRING for keywords and URL for keywords URL. |
keywords | The list of keywords for the ads. |
keywordsurl | The keywords URL for the ads. |
type | The type of ad, whether TEXT or GRAPHIC. |
description | Description of the ad. |
imageUrl | If the ad is a graphic, then the image URL has to be given in this field. |
useDates | Whether to use start and end dates for the ads. |
keywordsphrase | If keywords are to be taken as phrase then the value has to be entered as true. |
collections | The list of collections separated by comma for which the ads are to be displayed. |