Api Model:Offer
From HasOffers
Contents |
Required Parameters
- id
- Values: (int)
- name
- Values: (string)
- description
- Values: (string)
- advertiser_id - Id of the Advertiser
- Values: (int)
- offer_url - Url to redirect all tracking links for the offer. Refer to OfferUrl for a list of dynamic variables that can by included in the URL.
- Values: (string)
- preview_url - URL that often skips any geo-targeting or other re-targeting implemented on the offer_url. Allows users to view sample landing page for the offer_url.
- Values: (string)
- protocol - Conversion tracking method to be implemented by the advertiser. Read more.
- Values: http, https, http_img, https_img, server, server_affiliate
- status
- Values: active, paused, pending, expired, deleted
- expiration_date
- Values: (date)
Optional Payout Parameters
- payout_type - Method used to determine offer payout.
- Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
- revenue_type - Method used to determine offer revenue.
- Values: cpa_flat, cpa_percentage, cpa_both, cpc, cpm
- default_payout
- Values: (float, 2 decimal max)
- max_payout
- Values: (float, 2 decimals max)
- percent_payout
- Values: (float, 2 decimals max, percentage as whole number)
- Example: 10 for 10%
- max_percent_payout
- Values: (float, 2 decimals max, percentage as whole number)
- Example: 10 for 10%
- tiered_payout - Enable payouts based on affiliate tiers.
- Values: 0, 1
- currency - 3 letter Currency code. Default value of 'network_currency' Preference
- Values: (string)
Optional Access Parameters
- is_private - Hide from affiliates by default and require network to grant access.
- Values: 0, 1
- require_approval' - Force affiliates to apply to run the offer.
- Values: 0, 1
- require_terms_and_conditions' - Force affiliates to agree to terms and conditions before they can run offer.
- Values: 0, 1
- terms_and_conditions - Terms and conditions displayed if require_terms_and_conditions enabled.
- Values: (string)
Optional Converted Offer Parameters
Redirect users who already converted on the offer to different offer on the network or a URL.
- converted_offer_type - Whether to redirect to the different offer on the network or a hardcoded URL
- Values('network', 'url') Read Only
- converted_offer_id - Id of offer to redirect converted users to. Must not be Id of same offer.
- Values: (int)
- converted_offer_url - URL to redirect converted users to.
- Values: (string)
Optional DNE / Email Parameters
- dne_list_id - Id of the DNE list to attach to offer.
- Values: (int)
- show_mail_list True if there is a dne list attached to the offer, otherwise false
- Values: (bool) Read Only
- email_instructions_from
- Values: (string)
- email_instructions_subject
- Values: (string)
Optional Subscription Parameters
- is_subscription - Whether or not this offer is a subscription
- Values: (bool)
- customer_list_id - Id of the Custom List
- Values: (int)
- subscription_duration - Seconds to determine the total subscription length
- Values: (int)
- subscription_frequency - Interval to generate a conversion for the subscription.
- Values: daily, weekly, monthly, annually
Other Optional Parameters
- approve_conversions - Set all conversion to pending status for review.
- Values: 0, 1
- conversion_cap - Number of conversions allowed per day to the offer.
- Values: (int)
- redirect_offer_id - Id of an Offer to redirect traffic to if the offer has exceeded it's conversion cap or the offer is paused.
- Values: (int)
- session_hours - Number of hours a session is valid before it expires. Controls session length for both client-based pixel and server-based postback URL tracking.
- Values: (int)
- enforce_geo_targeting - Restrict offer Geo Targeting. If enabled, users that do not match Geo Targeting and there is not a matching offer in group(s), users will receive white screen. If disabled, non targeting users will be redirected to offer URL.
- Values: 0, 1
- allow_multiple_conversions - Allow multiple conversion to be recorded per session.
- Values: 0, 1
- allow_website_links - Allow affiliates to specific the redirection URL in their tracking link.
- Values: 0, 1
- show_custom_variables - Enable custom variables to be including in the tracking link.
- Values: 0, 1
- display_advertiser - Option to display the advertiser name to affiliates.
- Values: 0, 1
- set_session_on_impression - Change the ad server to set a session when an impression pixel is displayed. By default all sessions are started on click.
- Values: 0, 1
- is_seo_friendly_301 - Enforce SEO Friendly Tracking Links. All tracking links will be encoded and any re-targeting will be disabled.
- Values: 0, 1
- featured - Make the offer as featured. Enter date when featured offer should start.
- Values: (date)
- rating - Rating assigned to offer based on performance. Automatically computed if enable_offer_ratings preference is enabled.
- Values: (int)
- disable_click_macro - When enabled, Offer will ignore all Click Macro settings.
- Values: 0, 1
- click_macro_url - Sets a unique Click Macro for the offer. Value will override the Global Click Macro value if set.
- Values: (string)
- ref_id - Used set a third party Id for reference.
- Values: (string)
Additional Return Parameters
Read only parameters return with each object.
- modified - Date / time object was last modified.
- Values: (timestamp)
- is_expired - Flag to determined whether the offer has expired based on the expiration_date.
- Values: 0, 1
- dne_unsubscribe_url - Unsubscribe link for DNE list
- Values: (string)
- dne_download_url - Download URL for DNE list
- Values: (string)
Email this page to a friend or co-worker
