get_ad
Retrieve ads from a specified AdButler zone via GET request, enabling keyword, platform, and URL targeting to return the most eligible ad or ranked list.
Instructions
Retrieve an ad via GET request. Same parameters as serve_ad but uses GET instead of POST.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ID | Yes | Your AdButler account ID | |
| ip | No | IPv4 address for geographic targeting (required for server-side requests) | |
| kw | No | Keywords for keyword targeting | |
| rf | No | Pass 1 to include is_redirectable field in response | |
| sh | No | Screen height for platform targeting | |
| sw | No | Screen width for platform targeting | |
| ua | No | User agent string for platform targeting | |
| pid | No | Page ID for unique delivery/roadblocks (random number, same for all zones on page) | |
| spr | No | Screen pixel ratio for platform targeting | |
| size | No | Expected ad size (e.g. "300x250") | |
| type | Yes | Response type: "json" for most eligible ad, "jsonr" for all eligible ads ranked | |
| place | No | Place counter for unique delivery (0, 1, 2, etc.) | |
| setID | Yes | Zone ID to serve an ad from | |
| referrer | No | Page URL for URL targeting (required for server-side requests) | |
| _abdk_json | No | Data key key-value pairs for data key targeting | |
| defer_signing | No | Defer beacon signing hash generation |