Difference between revisions of "Offerit Rules"

From Offerit
Jump to: navigation, search
(Available Criteria)
 
(12 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
| show_commissions_admin_section = true
 
| show_commissions_admin_section = true
 
| show_creatives_admin_section = true
 
| show_creatives_admin_section = true
| show_misc_admins_section = true
+
| show_misc_section = true
 
}}
 
}}
  
Line 16: Line 16:
  
 
# You may want to send an e-mail to all affiliates that have reached some amount of profit earned to congratulate them. The rules in the Mailing Admin allow you to specify only affiliates that have exceeded this amount.
 
# You may want to send an e-mail to all affiliates that have reached some amount of profit earned to congratulate them. The rules in the Mailing Admin allow you to specify only affiliates that have exceeded this amount.
# You may want to have certain creatives available to affiliates using a certain landing page on a specified starting date.  In the advanced form for creatives rules, you can select a specific affiliate, commission, offer, landing page and start/end time.
+
# You may want to have certain creatives available to affiliates using a certain landing page on a specified starting date.  In the advanced form for creatives rules, you can select a specific affiliate, offer, landing page and start/end time.
  
 
=General Rule Format=
 
=General Rule Format=
Line 32: Line 32:
 
==Simple Form==
 
==Simple Form==
  
The simple form allows you basic control over an area of functionality. This includes limitations such as individual affiliates, commissions, and landing pages. There are also time based settings that allow you to set the duration that a rule is in effect for.<br />
+
The simple form allows you basic control over an area of functionality. This includes limitations such as individual affiliates, and landing pages. There are also time based settings that allow you to set the duration that a rule is in effect for.<br />
  
 
[[File:Admin_Add_Rule_Simple.png|750px|Using the simple form to add rules]]<br />
 
[[File:Admin_Add_Rule_Simple.png|750px|Using the simple form to add rules]]<br />
Line 44: Line 44:
  
 
*'''DISABLE/HIDE/HOLD'''
 
*'''DISABLE/HIDE/HOLD'''
** A disable rule will have the oppooffer effect as an enable rule. Using the same example as above, say we do not want to display this cascade for surfers who come in under testCommission and on the offer My Crazy Membership Offer. I would do the same as above but this time I would select Disable from the Type drop-down menu.
+
** A disable rule will have the oppooffer effect as an enable rule.
  
 
===Available Criteria===
 
===Available Criteria===
  
 
The follwing is a list of the limiting criteria for the simple form in most cases(Note: This may vary, see section specific information for more details):
 
The follwing is a list of the limiting criteria for the simple form in most cases(Note: This may vary, see section specific information for more details):
* '''AFFILIATE''' - Specify here if you want this rule to effect a single affiliate or all affiliates. (Note: For than one see the [[#Advanced Form|Advanced Form]]).
+
* '''AFFILIATE''' - Specify here if you want this rule to effect a single affiliate or all affiliates. (Note: For more than one, see the [[#Advanced Form|Advanced Form]]).
* '''COMMISSION''' - Specify here if you want this rule to effect a single commission or all commissions.
 
 
* '''OFFER''' - Specify here if you want this rule to effect a single offer or all offers.
 
* '''OFFER''' - Specify here if you want this rule to effect a single offer or all offers.
 
* '''START DATE''' - Specify here when you want this rule to go into effect. This can be expressed by any free form date style or by the keywords TODAY and NOW.
 
* '''START DATE''' - Specify here when you want this rule to go into effect. This can be expressed by any free form date style or by the keywords TODAY and NOW.
Line 57: Line 56:
 
===Notes===
 
===Notes===
  
You can add an affiliate under the affiliate section by entering their user name or ALL for all the affiliates. If you want to add more than one affiliate but not all the affiliate, you must click on the Advanced Form link above the Add Cascade Table. You can also choose the rule for all or individual offers, and for either all or individual commissions.
+
You can add an affiliate under the affiliate section by entering their user name or ALL for all the affiliates. If you want to add more than one affiliate but not all the affiliate, you must click on the Advanced Form link above the Add Cascade Table. You can also choose the rule for all or individual offers.
  
 
==Advanced Form==
 
==Advanced Form==
  
[[File:Admin_Add_Rule_Advanced.png|750px|Using the advanced form to add rules]]<br />
+
[[File:Admin_Add_Rule_Advanced.png|850px|Using the advanced form to add rules]]<br />
  
The advanced form expands on the simple form by giving you the ability to add multiple affiliates, commissions, etc., at the same time to one rule. In addition, depending on the context of the rule, it may add additional options for limitations.
+
The advanced form expands on the simple form by giving you the ability to add multiple affiliates and landing pages at the same time to one rule. In addition, depending on the context of the rule, it may add additional options for limitations.
  
 
=== Available Criteria ===
 
=== Available Criteria ===
  
The available criteria is the same as the basic form but gives a list in each field so that you may select multiple options. To select more than one choice in the commissions, landing pages, and offers fields, hold down the CTRL key and select the choices that you want. For affiliates, type the name of the affiliate that you want and then click the add button.<br />
+
The available criteria is the same as the basic form but gives a list in each field so that you may select multiple options. To select more than one choice in the landing pages offers fields, hold down the CTRL key and select the choices that you want. For affiliates, type the name of the affiliate that you want and then click the add button.<br />
 
In addition to the basic form fields choosing the advanced form gives you additional fields to specify-- this may vary depending on the section that you are creating rules for. Two examples of common additional fields in the advanced form are Landing Page(s) and Country(s).
 
In addition to the basic form fields choosing the advanced form gives you additional fields to specify-- this may vary depending on the section that you are creating rules for. Two examples of common additional fields in the advanced form are Landing Page(s) and Country(s).
  
=Section Specific Description=
+
<!--=Section Specific Description=
  
 
===Simple Form Criteria===
 
===Simple Form Criteria===
Line 80: Line 79:
 
*'''Type''' - Can be one of '''SHOW/HIDE/IGNORE'''. Choose one of the three states that a rule can be.
 
*'''Type''' - Can be one of '''SHOW/HIDE/IGNORE'''. Choose one of the three states that a rule can be.
 
*'''Affiliate''' - Type in the name of the affiliate that you want this rule to effect or type ALL for all affiliates.
 
*'''Affiliate''' - Type in the name of the affiliate that you want this rule to effect or type ALL for all affiliates.
*'''Commission''' - Choose a commission from the drop-down that you would like to use this rule for or choose All Commissions for all.
 
 
*'''Country''' - Choose a country to target this rule towards or choose ALL for all countries.
 
*'''Country''' - Choose a country to target this rule towards or choose ALL for all countries.
 
*'''Start Time''' - Sets when the rule will take effect. This can be expressed by any free form date style or by the keywords TODAY and NOW. For more info on freeform dates please see [[Offerit Freeform Date]].
 
*'''Start Time''' - Sets when the rule will take effect. This can be expressed by any free form date style or by the keywords TODAY and NOW. For more info on freeform dates please see [[Offerit Freeform Date]].
Line 86: Line 84:
  
 
<!-- ==Emails==
 
<!-- ==Emails==
There are two types of mass mailers that can be setup, customer mailers and affiliate mailers. Two types of rule forms correspond to these two types of mails, each with its own specific criteria.
+
There are two types of mass mailers that can be set up, customer mailers and affiliate mailers. Two types of rule forms correspond to these two types of mails, each with its own specific criteria.
  
 
===Customer Email Criteria===
 
===Customer Email Criteria===

Latest revision as of 18:49, 11 November 2012

Offerit
For Affiliates
Automatic SubIDs
Affiliate Stats Dumps
Linkcode
Link Groups
Affiliate Custom Pixels
Affiliate Host and Post
Offerit Affiliate Area
Affiliate Account Details
Affiliate Account Change Log
Affiliate Creatives
Affiliate Creatives Search
Affiliate Settings
Affiliate Custom Pixels
Affiliate Linkcodes
Affiliate Linkcode Settings
Affiliate Login History
Affiliate Messages
Affiliate Dashboard
Dashboard Key Statistics
Dashboard Statistics Summary
Affiliate Payment History
Quick Links
Affiliate Referrals Report
Affiliate Referring URL Report
Affiliate Remote Login
Affiliate Signup
Affiliate Statistic Filters
Affiliate Statistic Views
Affiliate SubIDs
Offerit Setup
Creating Admin Accounts
Tracking Domain
Edit Affiliate Text
Edit CSS Colors
Getting Started Admin
Offerit Quick-Start Guide
Tracking in Offerit
Pixel Builder
Offerit Postback Examples
Replacement Variables
Currency Exchange Rates

Admin Dashboard
The Admin Dashboard
Reporting Admin
The Reporting Admin
Track and Strack
  Report Breakdowns
Profit and Loss Report
Subscription Report
Transactions Reports
Affiliate Ratios Report
Affiliate Managers Report
Visitor Actions Report
Referral Tier Payouts Report
Referral Signup Payouts Report
Additional Commissions Report
Graphical Affiliate Comparison Report
The Single Day Comparison Report
Actual Affiliate Payments Report
Offers Admin
The Offers Admin
Offers
Offer Setup
Affiliate Referrals
Tracking Domain
Commissions
Commission Changes
Suppression Lists
Pixel Builder
ID Numbers
Offer Partner
Offer/Landing Page Redirection
Setting Rules
Admin Host and Post
Offer Post URLs
Offer Goals
Affiliates Admin
The Affiliates Admin
ID Numbers
Affiliate Managers
Affiliate Referrals
Affiliate Activation
Admin-Only Settings
Affiliate Overrides
Creating Admin Accounts
In-House Accounts
Add Manual Sale
Manual Invoice
Affiliate Documents
Affiliate Enabled Offers
Change Affiliate Status
Account Changes
Advertisers Admin
The Advertisers Admin
Account Changes
Advertiser Invoices
Generate Invoice
Advertiser Approval
Change Advertiser Status
Customers Admin
Customers Admin
Manually Adding a Customer
ID Numbers
Payments Admin
The Payments Admin
Payvia Types
Payout Periods
Payvia Dump Formats
Payment Dump Entry Numbers
Payment Dump Variables
Check Functions
Setting Rules
Payment Methods
Payza
Creatives Admin
The Creatives Admin
Add New Creatives
Add New Creative Type
Offeritcode
Code Builder
Track and Strack
Setting Rules
  Default Creative Types
Creative Types
Image Banners
Flash Banners
Dynamic Text Banners
Feeds
Mailers
Video Download
Video Embed
Page Peels
IM Popups
Footer Ads
Page Ads
Overlays
Communications Admin
The Communications Admin
Add News Item
Sending Messages
Signup Questions
Configuration Admin
The Configuration Admin
Affiliate Signup Postback URL
Edit Affiliate Text
Edit CSS Colors
REST API
General
Offerit REST API Overview
GET /service/ping
PATCH /service/set_currency_exchange_rates
Advertiser
PATCH /advertiser/edit_advertiser
POST /advertiser/add_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
GET /affiliate/decode_trackingcode
PATCH /affiliate/edit_affiliate
PATCH /affiliate/payvia
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
Config
GET /config/get_global_void_ips
GET /config/get_global_post_ips
GET /config/get_global_hostnpost_ips
POST /config/add_global_void_ip
POST /config/remove_global_void_ip
POST /config/add_global_post_ip
POST /config/remove_global_post_ip
POST /config/add_global_hostnpost_ip
POST /config/remove_global_hostnpost_ip
Creative
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
Customer
PATCH /customer/set_customer_details
PATCH /customer/lock
PATCH /customer/unlock
PATCH /customer/forget
GET /customer/export
Offer
GET /offer/get_conversion_caps
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
GET /offer/get_details
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
Reporting
GET /report/profitloss
GET /report/transaction
Transaction
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash
POST /transaction/process_void
POST /transaction/process_chargeback
POST /transaction/process_reversal
POST /transaction/approve_pending_transaction
GET /transaction/click_detail
SOAP API (*deprecated*)
API
Add Affiliate
Add Affiliate Sale
Add Offer
Approve Transaction
Creative Types
Decode Offeritcode
Deny Transaction
Disable Affiliate Landing Page
Edit Affiliate Sale
Enable Affiliate Landing Page
Get Affiliate Stats
Get Allowed Affiliates
Get Landing Page Details
Get Offer Details
Get Offer List
Get Profit Loss Report
List Affiliate Details
List Affiliate Subaffiliates
Ping
Set Affiliate Status
Set SubAffiliate Status
Set Member Details
Record Affiliate Click
Misc.
Rules
Freeform Date
Affiliate Custom Signup
Offeritcode
Tracking in Offerit
Offerit Logos
Void Conversions Remotely

Rules are a new feature in Offerit that give clients a great amount of control in setting permissions and actions for individual affiliates. They let you dictate things like which events happen when and who sees what, and are indicated by a purple arrow icon in the Offerit interface.

The rules system is based off of the same general format, with a few key differences depending on in which area the rules are set. Rules are required in some cases to perform certain actions. These include sending out mass email and adding creatives.
Make sure you have at least one rule when you want to perform these actions.

Why Rules?

Rules exist to make Offerit a more flexible environment for you and your affiliates. They allow you to exercise a great degree of control over the everyday occurrences in your affiliate commission. Here are a few examples of where rules can be useful:

  1. You may want to send an e-mail to all affiliates that have reached some amount of profit earned to congratulate them. The rules in the Mailing Admin allow you to specify only affiliates that have exceeded this amount.
  2. You may want to have certain creatives available to affiliates using a certain landing page on a specified starting date. In the advanced form for creatives rules, you can select a specific affiliate, offer, landing page and start/end time.

General Rule Format

Rules will always follow the same general format: they can be in one of three states. The first state is an enabled state, which can appear as enable, show, or send. When a rule is created in the enabled state it will perform a given action when the specified criteria is met. Next is the disabled state, which can appear as disable, hide, or hold. When a rule is created in the disabled state the action will not be performed based on the specified criteria. The final state is the ignore state. This state causes a rule to basically act as if it were not created. This can be useful for testing the implementation and usage of a rule you create.

Rule Relations

Rules have a specific order of precedence that is always followed-- disable rules have priority over enable rules. For example if you want a popup to show for all affiliates but not on affiliates X, Y, and Z, you could create a SHOW rule for all affiliates on all offers, landing pages, etc., and create a HIDE rule for the affiliates X, Y, and Z. The HIDE rule will take precedence over the SHOW rule, allowing popups to show for everyone other than affiliates X, Y, and Z. The ignore rules also supersede enable and disable rules (Offerit skips all ignore rules).

Form Types

There are two types of rule forms that you will come across: simple and advanced. The simple form allows basic control over functionality, while the advanced form allows you to fine tune your rules to specific criteria. The following section will detail the two different type of rule forms.

Simple Form

The simple form allows you basic control over an area of functionality. This includes limitations such as individual affiliates, and landing pages. There are also time based settings that allow you to set the duration that a rule is in effect for.

Using the simple form to add rules

You can select from the three types of rules: IGNORE, SHOW, and DISABLE. This allows Offerit users to choose between ignoring a function, allowing a function, or preventing a function from displaying.

  • IGNORE
    • Ignore allows you to set up a rule without having it be active. You can use an ignore rule to figure out the details of what limitations you want to enact on a given section and what you want it to encompass. In other words it is a non-active rule that has no effects.
  • SHOW/ENABLE/SEND
    • The show rule enables functionality based on the limitations that you specify.
  • DISABLE/HIDE/HOLD
    • A disable rule will have the oppooffer effect as an enable rule.

Available Criteria

The follwing is a list of the limiting criteria for the simple form in most cases(Note: This may vary, see section specific information for more details):

  • AFFILIATE - Specify here if you want this rule to effect a single affiliate or all affiliates. (Note: For more than one, see the Advanced Form).
  • OFFER - Specify here if you want this rule to effect a single offer or all offers.
  • START DATE - Specify here when you want this rule to go into effect. This can be expressed by any free form date style or by the keywords TODAY and NOW.
  • END DATE - Specify here when you want this rule to expire. This can be expressed by any free form date style or by the keywords TOMORROW and FOREVER.

Notes

You can add an affiliate under the affiliate section by entering their user name or ALL for all the affiliates. If you want to add more than one affiliate but not all the affiliate, you must click on the Advanced Form link above the Add Cascade Table. You can also choose the rule for all or individual offers.

Advanced Form

Using the advanced form to add rules

The advanced form expands on the simple form by giving you the ability to add multiple affiliates and landing pages at the same time to one rule. In addition, depending on the context of the rule, it may add additional options for limitations.

Available Criteria

The available criteria is the same as the basic form but gives a list in each field so that you may select multiple options. To select more than one choice in the landing pages offers fields, hold down the CTRL key and select the choices that you want. For affiliates, type the name of the affiliate that you want and then click the add button.
In addition to the basic form fields choosing the advanced form gives you additional fields to specify-- this may vary depending on the section that you are creating rules for. Two examples of common additional fields in the advanced form are Landing Page(s) and Country(s).