Nats display adtools
Applies to NATS 4.0.25 and greater. searchinline feature applies to NATS 4.0.66 and greater.
nats_display_adtools
Displays adtools with a particular type ID number.
Alias: display_adtools
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| category | The category id of the adtool | Any valid category id | The category ID from the request | category=1 |
| tpl | Template used to display output | Any valid template | The template, function_display_adtools | tpl="mytemplate" |
| assign_prefix | Prefix output variable names with this word | Any valid Smarty variable name | Empty | assign_prefix="myvar" |
| typeid | The type of adtool | Any valid adtool type ID number | The type ID from the request | typeid="123" |
| siteid | Only show adtools for one site | Any valid site ID number | None | siteid="123" |
| start | Skip this many adtools | Any whole number greater than, or equal to, zero | 0. Skips no adtools | start="10" |
| count | Display this many adtools | Any whole number greater than zero | 20. Displays 20 adtools | count="10" |
| order | Set the order the adtools will be returned | Any valid order statement | None. (No prefix is used) | assign_prefix="myvar" |
| assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None | order="published_date ASC" |
| data_only | Set variables but don't display the template | 1 | None. The template is displayed. | data_only=1 |
| searchinline | Allows searching through params | 1 or 0 (exclusive) | 0 do not check params for search vars | searchinline=1 |
| search_{field} | limitation when using searchinline | {search_setting}:{setting} (see below) | none | search_type = '5:2' |
Output
A list of adtools matching an adtool type ID number. Also outputs several variables; variables are prefixed with the argument to the assign_prefix parameter described above.
- .type
- .type_details
- .field_assoc
- .adtools
- .adcount
- .typeid
- .start
- .count
Notes
search_{$field}
The available values for {$field} are dependent on the adtool type being searched for. for instance, FHGs have a 'type' field, with the possible values 1(pictures) 2(videos) 3(mixed) .
search_type = '5:2'
Is a limit on this type field. 5 means = (see below) and 2 is the value we are limiting to. This returns any adtools adtoolfield type=2 For FHGs, this means videos.
search_type = '4:2'
Would search for adtools with type <= 2. For FHGs that returns pictures and videos (but not mixed).
search_width = '1:50'
Searches for an adtools with width > 50
You can get the exact field names and possible values from the adtools admin (edit type) or by doing a search on the affiliate side and using the search[] variables from the resulting URL.
Default Categories
| Category | Name |
| 1 | Banners |
| 2 | Hosted Adtools ( FHGs ) |
| 3 | Downloadable ( content zips ) |
Search Settings
| Setting | Value |
| 1 | > |
| 2 | >= |
| 3 | < |
| 4 | <= |
| 5 | = |
| 6 | != |
See Also
- New NATS4 Affiliate Adtools -- NATS4 Adtools Page uses this function
