254

Getting Started

Welcome & Getting Started!

How do I start

To make this manual more obvious we use demo.orangear.com as your domain.

  1. Check the URL you specified as a login page
  2. Use the credentials sent by your manager to log in
  3. System settings to start a business unit
  4. Roles and permissions to invite your employees
  5. Goals to run your custom campaigns
  6. Email settings to send notifications to your partners
  7. Add advertisers and test conversions
  8. Add publishers
  9. Test publishers
  10. Add integrations if necessary
  11. Add offers
  12. Tracking pixel URL
  13. Enjoy your work!

Login page

The page which you have specified (either at your own domain or at domain.orangear.com) will contain a form with login and password. This form has a Manager/Publisher switcher.

Select Manager and enter the specified email and a password which is provided by your manager. Later, you will be able to change your password, but the email will still be the same.

Credentials to enter

Please, log into the system. Note that different products of Orangear can have different credentials, so usually, you can’t use your password for Checker to access Performance Marketing Platform.

  • If you forgot your password, use Forgot Password link below the login form. Keep in mind that a new password will be sent to the specific email. In case you have lost an access to your email, you must create a new account at the Performance Marketing Platform.
  1. click “Forgot password”
  2. check an email

     Note! Look into Spam, if nothing appears in 5 minutes.

  • If you want to change your password, go to Account settings in the right top corner and follow these steps:
    • click Account settings;
    • then enter a current password;
    • after that enter a new password;
    • confirm your new password and click the Save button.

Set your Performance Marketing Platform

Please, fill in the main settings to operate your Performance Marketing Platform.

System setting

1. Company settings

Fill in these fields. Later they will be used for all invoices.

Minimum amount field defines generation of publishers’ invoices. If this field contains 100 then invoices will be generated after any publisher will earn 100 USD.

Your logo can be added later whenever you want. After you upload it, a logo will be shown at the login page and in the header of your Platform. You can also add your favicon to customize the platform view.

After you have added all the necessary data, please, click Save under these Settings.

2. User settings

Allow fraud score – select the acceptable fraud score to check conversions. You can select any value from 0 to 90. Sometimes, conversions are marked as suspicious due to the final user’s settings, so it’s better to tolerate fraud score that is, at least, 10.

3. Payment settings

These fields are used to generate invoices from your side to your advertisers. All blank fields that are not filled out will not be displayed in the invoice.

Roles and Permissions

There is a strict order of inviting new employees (see the picture below):

  1. Create roles with permissions
  2. Add your managers and assign a specific role for each one.

Add roles, weight and select permissions for them. Weight is a parameter from 1 to 10. The more permissions the role has the higher weight it should have.

Important: if a role does not have a specific permission, the user in this role won’t be able to conduct such an activity.

           Goals

At the start, Performance Marketing Platform contains only a couple of goal names. If you need more, just add them. Afterward, you will be able to edit the name of a goal.

Email

Performance Marketing Platform allows to send notifications to your publishers automatically. To activate this feature, please, fill in Email server details in the Settings section. Please note that Orangear does not provide a dedicated email server.

The example:

  1. You are able to choose mail type among: Smtp, Mail_gun, Mandrill.
  2. Enter your host address or host ip.
  3. Port stands for the Outgoing mail server (which is, for example, 587 for Gmail).
  4. For tls encryption the port 587 is used.
  5. Enter you email.
  6. Create and enter your password.
  7. Click the Check connection button. If it is ok, you’ll see the following:

    click OK button.
    8. Click the Save button to finish your settings.

Add an Advertiser and test conversions

  1. Create an Advertiser’s profile.
  2. Fill in the required fields.
  3. Submit the information as it is shown in the screenshot:

Please, pay attention to suffixes.

 

{offer_id} Numeric ID of the offer which fires a conversion 111
{offer_name} Name of the offer which fires a conversion Game of war
{transaction_id} Unique 32-character click ID b965e8b7e6fd5dbff3334675899af5cb
{ip} IP address of the server performing postback request 111.222.333.444
{session_ip} IP address of the user’s device which performs a conversion 111.222.333.444
{country} 2-letter (ISO 3166-1 alpha-2) country code of the client device which performs a conversion US
{currency} Payout currency USD
{aff_sub} A macros for the Publisher’s source of traffic 128-character length string value
{aff_sub2}

{aff_sub3}

{aff_sub4}

Custom values that can be passed to offer’s tracking URL and returned to postback URL 128-character length string value
{device_brand} User’s device manufacturer name Google
{device_model} User’s device model Nexus 5
{device_os} User’s device operating system Android
{device_os_version} User’s operating system version 5.1
{device_id} User’s device ID Any string value
{platform} User’s device platform Android
{datetime} User’s click time. Timezone used: PDT (Pacific Daylight Time), UTC/GMT -7 hours. Date format: Y-m-d H:i:s 2015-07-14 09:02:08
{android_id} Android ID. Passed back only if publisher sends this value in tracking link. 62c7c7042511c086
{idfa} IDFA. Passed back only if publisher sends this value in tracking link. AEBE52E7-03EE-455A-B3C4-E57283966239
{advertiser_id} ID of advertiser 1234
{aff_id}, {pub_id} User ID within the Platform. 4557

 

Such parameters as: device_id, android_id, idfa, aff_sub, aff_sub2, aff_sub3, aff_sub4 should be got from publishers.

 

In order to set them up correctly, please, ask your advertiser – what parameters are required to pass transaction_id and affiliate_id (corresponding to {sub_aff})

for Advertisers click ID = {transaction_id}

Affiliate ID = {sub_aff} – for hidden IDs (hash)

Affiliate ID = {affiliate_id}_{aff_sub} – for not hidden IDs. So advertiser will know the IDs of your sources.

IDFA = {idfa}

App name, site name = {aff_sub4}

  1. Save settings.
  2. Go to Advertisers list.
  3. Find the required advertiser.
  4. Click the postback icon.

  1. Copy the main postback.

For example:

https://demo.orangear.com/s2s?token=da63100e-bd8d-11e8-8e29-901b0ededfcf&transaction_id={transaction_id}

Change the value contained in { } to the parameter which your advertiser requires you to pass transaction_id in. Please, pay attention that the parameter changes from advertiser to advertiser, and lays on the platform settings.

  1. Send the edited postback to Advertiser and ask him to place it on his platform.

Please, make sure that the postback doesn’t contain any additional symbols.

For example /s2s?token – this is a place where mistakes often happen. Sometimes, it occurs that some additional symbols are added accidentally in this part of the link (/s2s?token). Any other symbols aren’t accepted here. No other special symbols except / ? _ – : & are allowed for postback.

  1. Ask advertiser for an offer/tracking link. It is highly recommended to use an active offer.
  2. Create an offer in your Performance Marketing Platform. Set GEO as All, devices – All, offer status to Pending. Set daily cap as a value from 1 to 10, and set payout to 0.1 or 1 USD. Save this offer.
  3. Click “Info”.

  4. Go to Links tab. Select and copy the Test link
  1. Do not change anything in the test link.

No need to assign any publisher for a test conversion. There is already a system pub for this purpose.

  1. Send the test link to your advertiser to perform a test install/conversion.

What to do if there were any problems with testing conversions? Please, contact our customer support.

Add publishers

  1. Go to Publishers. Create a Publisher
  2. Specify all the necessary details
  3. Be attentive while setting email. It is used for notifications and for logging into the platform.
  4. Sometimes there is no Zipcode or other parts of an address and we know that users can add false data here. You must know that such fields as: Address, City, State, Country, and Zipcode are shown in publishers’ invoices.
  5. Set Active status. Otherwise, a new publisher won’t have an access.
  6. Autoapprove feature. If there is set Enabled, it approves all offers which are requested by publisher except sensitive. If Disabled, the publisher has to wait for your approval upon every offer.
  7. Set payment terms. They affect the frequency of invoices generation.
  8. Enter a password twice. We recommend to use strong passwords that consist of 8 characters minimum and contain letters, digits, and special symbols.

Optional Fields:

  1. Is own publisher. Set Yes for direct publishers and No for networks and resellers.
  2. Affiliate Source. Set type of traffic here, if necessary.
  3. Skip affiliate. Use only if you need to skip any of the publisher’s sources.
  4. Anti fraud. Set Yes if you want to check all conversions sent by the publisher with anti fraud.
  5. Bad Traf. Set Yes if a publisher has a dubious traffic source.
  6. Block backtraffic. Specifically for publishers who usually run superlink, but temporarily want to stop redirects for some reason.
  7. IP Whitelist. Set a list of IPs that a publisher uses to enter the platform.
  8. Postback URL. Set a main postback, which is usually provided by a publisher. Leave this field empty, if a publisher doesn’t have his tracking system.
    Macros that can be used in postback URL.

    {offer_id} Numeric ID of the offer which fires a conversion 111
    {offer_name} Name of the offer which fires a conversion Game of war
    {click_id} Unique 32-character click ID b965e8b7e6fd5dbff3334675899af5cb
    {ip} IP address of the server performing postback request 111.222.333.444
    {session_ip} IP address of the user’s device which performs a conversion 111.222.333.444
    {country} 2-letter (ISO 3166-1 alpha-2) country code of the client device which performs a conversion US
    {payout} Conversion payout 0.75
    {currency} Payout currency USD
    {aff_sub} A macros for the Publisher’s source of traffic 128-character length string value
    {aff_sub2}

    {aff_sub3}

    {aff_sub4}

    Custom values that can be passed to offer’s tracking URL and returned to postback URL 128-character length string value
    {device_brand} User’s device manufacturer name Google
    {device_model} User’s device model Nexus 5
    {device_os} User’s device operating system Android
    {device_os_version} User’s operating system version 5.1
    {device_id} User’s device ID Any string value
    {platform} User’s device platform Android
    {datetime} User’s click time. Timezone used: PDT (Pacific Daylight Time), UTC/GMT -7 hours. Date format: Y-m-d H:i:s 2015-07-14 09:02:08
    {android_id} Android ID. Passed back only if publisher sends this value in tracking link. 62c7c7042511c086
    {idfa} IDFA. Passed back only if publisher sends this value in tracking link. AEBE52E7-03EE-455A-B3C4-E57283966239
    {advertiser_id} ID of advertiser 1234
    {aff_id}, {pub_id} User ID within the Platform. 4557

    Such parameters as: device_id, android_id, idfa, aff_sub, aff_sub2, aff_sub3, aff_sub4 should be provided by publishers.

    Superlink postback URL. Set a postback for superlink conversions, which is usually provided by a publisher. Leave empty, if a publisher doesn’t have his tracking system or doesn’t support the second postback.

  9. Event postback URL. Allows firing a conversion for an event. It’s better to add as much event postbacks, as many additional goals you have on the specific offer.
  10. Offer postback URL. Set the general postback URL, if the publisher has any racking system.
  11. Pay percent. If you leave this field empty, a publisher will get the default pay percent specified in your system settings.
  12. Offer request limit. A number of times to request offers. Set 0 to allow unlimited requests.
  13. Offer request left (for today). Use if you need to set a different number of attempts for today. If offer request limit is 300 and daily is 30, the system will allow 30 attempts during 10 days and then block a publisher.
  14. Notes. Specific data about a publisher: it is visible only to managers.
  15. Invoice notes. Specific data is added to all publisher’s invoices (for example – “App promotion”). Don’t set a specific month here.

Some settings outside of the profile will be applied to all publishers. This is:

  1. Minimum amount to generate publisher`s invoices

This value is specified in Settings->System.

To get an API Key click Copy token of an existing publisher and paste it into any suitable text field. It should look like: 2138a29a-bf8e-11e8-9689-903v0ededfcf

Test publishers

Checking publishers is only available with Checker. If you haven’t bought this product yet, this feature will be disabled.

Before check, you need to assign an offer to a publisher and ask him to create an offer on his platform. After that, he provides you with his tracking link to check it.

You can check it if everything goes right by checking url for your publisher. Go to Publishers side menu and choose Check.

In a new tab pick a valid offer in Manage offers section and the URL of this offer will be sent to a publisher.

Return back to Check tab, paste the offer link and choose the offer name. Click Pub Check.

During check pay attention to:
1) Status message.
2) If there is any click_id field. How it is named.
3) What click_id field contains.

  1. The status message shows the type of error if anything went wrong.
  2. The only name of the parameter is click_id. No Click, Click_ID, clickid or other options are acceptable! If there are any deviations, click won’t be captured by the system.
  3. Don’t put any random symbols in the click_id field. The platform which is used by the publisher should write its click by itself. Random symbols from your side won’t be recognized by the publisher’s platform.

Integrations

To add an API integration you need to enter your login and password and then check whether they match this advertiser.

Here you have a list of formats used by different platforms. They have different requirements, so it’s better to look in this manual before entering credentials to add an integration.

Add Offers

How to create an offer?

If you want to create a new offer, click Offers -> Create there you will be able to see the CREATE OFFER page which has 3 tabs (All fields marked with asterisk * are required and must be filled out) :

  1. Information and Targeting
  • Information
    1. Select an advertiser.
    2. Paste link for a thumbnail.
    3. Then enter or paste preview URL and click the wand button:
          • If this app is from AppStore or PlayMarket, all the information and description will be pulled there.
          • If it’s not, then enter all the information manually.

    4. Also enter the name of the offer.
  • Targeting
    1. Choose offer category.
    2. The status of the offer is Pending by default, but it can be easily changed.
    3. Distribution and currency also must be set necessarily.

      Let’s go through the list of tick boxes in the offer interface.
      Dynamic – can be used for unstable offers that tend to become inactive.
      Adult – offers that are aimed to adult traffic only. This tick is always handy to inform publishers about the adult category.
      Featured – an offer that was imported via API and must be saved in its original form without any further changes. If you don’t tick that, an offer will be auto-changed as soon as an advertiser changes description of the offer or payout.
      Sensitive – special offers that are hidden from common publishers. If you tick that, you can only approve manually the selected publishers for this offer.
                 * No Sensitive tick means that any publisher can see and request an offer in the publisher’s account.
      Auto Activate – offers that were paused, they are taken from the Externals and will be active again automatically.
  • Restrictions
    Here can be allowed, disallowed or unchecked Traffic restrictions.
    1. If you click the Allow button, then all traffic will be allowed.
    2. If you click the Disallow button, then all traffic won’t be allowed.
    3. If you click the Uncheck button, then all traffic won’t be checked.
    4. NOTE! All points can be clicked(ticked) according to needed items in each section:

 

  • Goals and Creatives
    1. Select a goal and add its name.
      • There can be added some more Main and Additional goals at the bottom of the page.
    1. Fill out tracking URL.
    2. Include/Exclude countries and, if it’s necessary, their cities.
    3. Set Payout and Pay percent.
      • Pub payout will be set automatically.
      1. Also Daily cap, Monthly cap, Total cap must be set.
  • There are 4 types of Platforms that can be selected and Other type if your platform is not equal any of given ones.
      • More than 1 platform can be selected there.
    1. Some of your creatives can be added there as well.

NOTE! Creatives are pulled to the offer up to 30 minutes.

Show Caps message – if you use caps or limits, you can inform your publisher about that to prevent the enormous traffic flow. However, you can increase cap manually for the specific partner. Once you tick that, such message “This offer is capped. Please, contact your manager” will appear after the description of an offer in a publisher’s account.

Tracking pixel URL

If you need Tracking pixel URL:

  1. Go to Offers -> Manage then click the Show postback URLs button
  2. When this button is clicked you will see the Tracking pixel URL ( which can be used by direct advertisers only!) and the Copy tracking pixel URL button.

Note!
For each goal Tracking pixel URL is different, so if you have more than 1 goal, you will have to copy each of them individually.

  1. When you click this button, you will see the pop-up, and this means that everything is done correctly:
  2. After the Tracking pixel URL is copied it can be added to the web-site or integrated with your mobile app. When a user goes to the page with this code, the postback will be sent automatically.