Ads Service Arguments
The following arguments are specific to the Ads service. All Ads arguments are case sensitive!
When requesting Ads, the BOSS API sends the same query term you entered to Ads service. This ensures that the Ad is associated with your BOSS API query term. The following table displays the advertising parameters used in BOSS API.
For addtional information see the Ad FAQ's.
| Arguments | Default Value | Required | Description |
|---|---|---|---|
| Partner | A unique alpha numeric string | Yes | Partner Tag/Source Tag associated with the user's unique usage. Do not encode this parameter. |
| Type | A unique alpha numeric string | Yes | Partner Tag/Source Tag associated with the user's unique usage |
| start | Default value = 1 | No | Optional. Start count of Ad to be returned |
| test | false | Yes | Optional. Set value to true to return a fake ad for testing purposes. The fake ad returned by the call is not representative of the Ad Marketplace but allows developers to test their token generation and search ads deployment. Clicks made by users on the Ad do NOT count towards advertising revenue. |
| count | Default value = 10 | No | Optional. Number of Ads to be returned |
| url | A unique url string | Yes | The URL for the Partner where to return the Ads. |
Note
Please prefix the ads Service to parameters. For example:
ads.Partner = BOSS_PARTNER. Parameters are passed in the
request to get the token.
Note
The argument ads.Token can only be used by BOSS API qualified publishers pre 11/7/2011. Set ads.Token=true to migrate to new system.