Nats display adtools

From TMMwiki
(Redirected from Display adtools)
Jump to: navigation, search
NATS 4
    Template Functions
nats_add_to_array
nats_adtool_replace_linkcode
nats_array_flip
nats_array_to_xml
nats_build_array_by_reference
nats_convert_bytes
nats_decode
nats_display_account_campaigns
nats_display_account_change_history
nats_display_account_notifications
nats_display_account_preview
nats_display_admin_links
nats_display_admin_message
nats_display_adtool_form
nats_display_adtool_types
nats_display_adtools
nats_display_adtools_type_limit
nats_display_choose_adtools_group
nats_display_code_info
nats_display_create_campaign
nats_display_edit_account_details
nats_display_edit_account_settings
nats_display_edit_defaults
nats_display_edit_password
nats_display_edit_payvia
nats_display_edit_payvia_info
nats_display_edit_skin
nats_display_gallery_builder
nats_display_graph
nats_display_hourly_sales
nats_display_latest_adtools
nats_display_map
nats_display_news
nats_display_page_peel
nats_display_payment_history
nats_display_payment_summary
nats_display_ratio
nats_display_reward_category
nats_display_reward_order
nats_display_reward_purchases
nats_display_signup_advanced
nats_display_signup_basic
nats_display_signup_payvia
nats_display_stats
nats_display_stats_calendar
nats_display_stats_form
nats_display_stats_referrals
nats_display_stats_retention
nats_display_stats_subscription_details
nats_display_stats_table
nats_display_timezones
nats_display_top_stats
nats_dump_data
nats_encode
nats_get_first_in_array
nats_get_period_end
nats_get_reward_categories
nats_get_member
nats_list_adtool_groups
nats_list_affiliates
nats_list_billers
nats_list_campaigns
nats_list_linkcodes
nats_list_options
nats_get_option_details
nats_list_programs
nats_list_sites
nats_list_tool_categories
nats_list_tours
nats_list_xsells
nats_smarty_function_amount_owed
nats_smarty_function_getbonus
nats_smarty_rebuild_form
nats_smarty_rebuild_link
nats_smarty_rebuild_query
nats_tooltip
tmm_admin_pagination
Template Shortcuts
add_to_array
adtool_replace_linkcode
affiliate_select_form
array_flip
array_to_xml
amount_owed
build_array_by_reference
convert_bytes
display_account_campaigns
display_account_change_history
display_account_notifications
display_account_preview
display_admin_links
display_adtool_form
display_adtool_types
display_adtools
display_adtools_type_limit
display_choose_adtools_group
display_code_info
display_create_campaign
display_gallery_builder
display_stats_referrals
display_edit_account_details
display_edit_account_settings
display_edit_defaults
display_edit_password
display_edit_payvia
display_edit_payvia_info
display_edit_skin
display_graph
display_hourly_sales
display_latest_adtools
display_map
display_news
display_page_peel
display_payment_history
display_payment_summary
display_ratio
display_reward_category
display_reward_order
display_reward_purchases
display_signup_advanced
display_signup_basic
display_signup_payvia
display_stats
display_stats_calendar
display_stats_table
display_stats_form
display_stats_retention
display_stats_subscription_details
display_top_stats
display_timezones
dump_data
get_first
get_period_end
get_reward_categories
list_billers
list_campaigns
list_linkcodes
list_options
list_programs
list_sites
list_tool_categories
list_tours
list_xsells
rebuild_form
rebuild_link
rebuild_query
reward_points
tooltip
Common Parameters
assign
assign_prefix
count
data_only
display_on_assign
start
tpl

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"
programid Only show adtools for one program Any valid program ID number None programid="1"
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) order="published_date ASC"
assign_prefix Prefix output variables with this word. (Click link for details) Any valid Smarty variable name None assign_prefix="myvar"
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}

NOTE: If you wish to use the search_ parameters, you will need to include "searchinline=1" in your list of parameters

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 !=

Using {display_adtools} to display adtools in an Email

As an example, if you are looking to send all FHGs out in an email through the NATS 4 Mailing admin you can do the following:

{display_adtools category=2 typeid=2 siteid=1 programid=1}

This will display adtools found in NATS displayed under the criteria of Category 2, Typeid 2, and Siteid 1. The information will be displayed according to what is set in the "function_display_adtools" template.

By adding "data_only=1" to the function call, the template is not used and you can display any information found in $adtools array of information. The following code uses a smarty foreach loop to loop through the $adtools array and list out the URL of all adtools.

{display_adtools category=2 typeid=2 siteid=1 programid=1 data_only=1}
{foreach from=$adtools item=tool key=adid name=ads}
{$tool.url}
{/foreach}

If you would like to display the link with a trailing nats code, the following code will do just that,

{display_adtools category=2 siteid="2" programid="1" typeid="2" data_only=1}
{foreach from=$adtools item=tool key=adid name=ads}
{nats_encode adtoolid=$adid siteid="2" programid=1}
{$tool.url}?nats={$encoded}
{/foreach}

Note that we include a separate NATS function {nats_encode} to generate the nats code needed. {nats_endcode} will need the siteid and the program ID to generate a correct NATS code.

Lastly, if you would like to display the adtool track link so that when members go through the link that hit is counted, you can use the following.

{display_adtools category=2 siteid="2" programid="1" typeid="2" data_only=1}
{foreach from=$adtools item=tool key=adid name=ads}
{nats_encode adtoolid=$adid siteid="2" url=1 gallery_url=$tool.url}
{$encoded}
{/foreach}

This code will display the gallery track link for each FHG adtool based upon the criteria set in both the {display_adtools} and {nats_encode} functions.

See Also