Description:
Enter a bid into BEDROCK's marketplace. A bid is a request to receive visits to a specified landing page for a defined set of parameters.
- WARNING: As soon as a bid is entered, BEDROCK may start sending visits which will incur a cost.
URL:
https://api.bedrock.com/query/1.0/bid/submit
HTTP Request Methods:
GET, POST
API Rate Limit:
None. However, BEDROCK reserves the right to limit API requests. If you are concerned about your volume please contact support.
Sample API Call
https://api.bedrock.com/query/1.0/bid/submit?apikey=3eb2b085c8363457dd56f42f54ee9gh6&keyword=digital%20cameras&amount=0.105&trafficid=vertical
&countryrule=include&country=US&url=http%3A%2F%2Fbuyersite%2Ecom%2Findex%2Ephp%3Fsource%3Dbedrock%0D%0A%26q%3D%7Bkeyword%7D%26tracking%3D%7Btrafficid%7D |
Request Parameters:
| Name |
Description |
Required |
Example Value |
| apikey |
A 32-character secret key given to you upon registration. |
Yes |
3eb2b085c8363457dd56f42f54ee9gh6 |
| amount |
The cost per visit associated with a bid. The value is rounded to the nearest 10th of a cent. |
Yes |
0.105 |
| url |
Visits will be sent to this landing page. The URL can contain special tokens that BEDROCK will replace with values.
- Tokens are denoted by curly braces: { }
- There is a limit of up to 512-characters.
Supported Tokens
- {keyword} The keyword associated with the visit.
- {trafficid} The identifier associated with the bid that produced the visit (see below).
|
Yes |
http://buyersite.com/index.php?source=bedrock&q={keyword}&tracking={trafficid} |
countryrule
| Used w/ country to specify the country(ies) that should be included or excluded.- Both parameters, countryrule & country must be used.
- countryrule has two possible values:
- include Only drive visits for countries specified using country.
- exclude Do not drive visits for countries specified using country but include everything else.
Sample Use Cases
- countryrule=include&country=uk Only send visits from the United Kingdom.
- countryrule=exclude&country=us&country=ca Send all visits but filter out visits from the United States & Canada.
| No | include
| | country | Used w/ countryrule to specify the country(ies) that should be included or excluded.
- Both parameters, countryrule & country must be used.
- Use ISO-3166-1-alpsha-2 code elements. Found here.
- Multiple countries can be specified by repeating the country parameter with different values.
| No | US |
| format |
Choose a response format. Supported formats:
|
No
|
xml
|
| callback |
Used w/ json format. Response will be JSONP w/ the passed value as a callback. |
No
|
foo |
| keyword |
The keyword(s) associated with a bid to receive visits.
- A keyword can be up to 128-characters.
- No keyword parameter = run-of-network. You will receive visits for any keyword.
- Multiple keywords can be specified by repeating the keyword parameter with different values.
|
No |
digital cameras
|
| trafficid |
A 16-character identifier of your choice. It can be inserted into your landing page url for tracking.
|
No
|
vertical
|
XML Response
A successful response will have <success> and <bid> elements containing a bid ID for your submitted bid.
<response>
<success>true</success>
<bidid>293842</bidid>
</response> |
An unsuccessful response will contain one or more <error> elements indicating the problematic request parameter field.
<errors>
<error>
<field>apikey</field>
<message>cannot be empty</message>
</error>
</errors> |
|
|
