MoVE Rewards

MoVE allows you to reward engagement with your brand through every step of the customer journey, increasing the number of new customers, while increasing engagement with existing customers.

MoVE for Commerce (Multi-Page flow)

Reward customers with mobile data in a wide range of scenarios, such as making purchases, booking reservations, enrolling in notifications, and help increase add-on items during the purchase process while reducing cart abandonment.

The integration for the Multi-page MoVE Reward Commerce flow will occur in two places, the landing page, where the offer is displayed to the subscriber, and the thank you page, where the reward confirmation is displayed to the subscriber. During this flow Aquto will set a 3rd party cookie to register the beginning of the offer. This occurs when the initial offer is displayed to the subscriber, and is performed automatically by the API. The API reads the cookie again and it is used to perform the reward when the conversion occurs and the reward confirmation is displayed to the subscriber.

Setup

This library must be included on both the landing page and thank you page. It can be embedded as a script tag:

<script src="http://assets.aquto.com/moveRewards/aquto.min.js"></script>

When embedded as a script tag, it exposes the aquto global object.

We assume you are using a DOM manipulation library, such as jQuery. All examples below will assume jQuery $ syntax and should be called in $(document).ready() block.

Check Eligibility

The checkEligibility method determines if the current user if eligible to receive the configured MB reward . This function also starts a reward session on the server that can be completed later. You should call checkEligibility on your landing page.

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
callback	function	yes	Function called after checking eligibility on the server
phoneNumber	string	no	Manually entered user's phone number that can be used when user is on wifi
publisherSiteUuid	string	no	Unique tracking code assigned by Aquto
channel	string	no	Optional channel of the inventory

Response properties

Key	Type	Optional	Description
eligible	boolean	no	Is the current user eligible for the reward?
rewardAmount	integer	true	Reward amount in MB
rewardText	string	true	Server configured string containing carrier and reward amount. Ex: Purchase any subscription and get 1GB added to your AT&T data plan.
carrier	string	true	Code for user's carrier

<div class="rewardBlock">
  <div class="rewardHeader"></div>
  <div class="rewardText"></div>
</div>

aquto.checkEligibility({
  campaignId: '12345',
  callback: function(response) {
    if (response && response.eligible) {
      $('.rewardText').text(response.rewardText);
      $('.rewardHeader').addClass('rewardHeader'+response.carrier);
      $('.rewardBlock').show();
    }
  }
});

Complete Reward

The complete method finishes the reward session and triggers the MB reward. This method should be called on your thank you page.

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
callback	function	yes	Function called after completing the reward on the server

Response properties

Key	Type	Optional	Description
eligible	boolean	false	Is the user still eligible for the reward
rewardAmount	integer	true	Reward amount in MB
rewardText	string	true	Server configured string containing carrier and reward amount. Ex: Congratulations, you just added 1GB to your AT&T data plan!
carrier	string	true	Code for user's carrier

<div class="rewardBlock">
  <div class="rewardHeader"></div>
  <div class="rewardText"></div>
</div>

aquto.complete({
  campaignId: '12345',
  callback: function(response) {
    if (response && response.eligible) {
      $('.rewardText').text(response.rewardText);
      $('.rewardHeader').addClass('rewardHeader'+response.carrier);
      $('.rewardBlock').show();
    }
  }
});

MoVE for Commerce (Single-Page flow)

The single-page MoVE Reward Commerce flow is ideal for flows where the offer is displayed to the customer and they are rewarded for taking an action directly on that page, such as watching a video to completion. This flow does not utilize 3rd party cookies like the Multi-page MoVE Reward Commerce Flow, and instead returns a token when the offer is displayed to the customer. The same token is provided to the Javascript SDK when the user completes the offer and is shown the reward confirmation.

Setup

This library must be included on the page. It can be embedded as a script tag:

<script src="http://assets.aquto.com/moveRewards/aquto.min.js"></script>

When embedded as a script tag, it exposes the aquto global object.

Check Eligibility

The checkEligibilitySinglePage method determines if the current user is eligible to receive the configured MB reward. This function also starts a reward session on the server that can be completed later.

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
callback	function	yes	Function called after checking eligibility on the server
phoneNumber	string	no	Manually entered user's phone number that can be used when user is on wifi
publisherSiteUuid	string	false	Unique tracking code assigned by Aquto
channel	string	no	Incent channel string is used for reporting purposes

Response properties

Key	Type	Optional	Description
eligible	boolean	false	Is the current user eligible for the reward?
userToken	string	false	Token that must be passed back to server when offer is completed. Valid for 25 days.
rewardAmount	integer	true	Reward amount in MB
rewardText	string	true	Server configured string containing carrier and reward amount. Ex: Purchase any subscription and get 1GB added to your AT&T data plan.
carrier	string	true	Code for user's carrier

<div class="rewardBlock">
  <div class="rewardHeader"></div>
  <div class="rewardText"></div>
</div>

var userToken

aquto.checkEligibilitySinglePage({
  campaignId: '12345',
  callback: function(response) {
    userToken = response.userToken
    if (response && response.eligible) {
      $('.rewardText').text(response.rewardText);
      $('.rewardHeader').addClass('rewardHeader'+response.carrier);
      $('.rewardBlock').show();
    }
  }
});

Complete Reward

The complete method finishes the reward session and triggers the MB reward. The complete method must be executed within the same scope as the userToken

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
callback	function	yes	Function called after completing the reward on the server
userToken	string	yes	Stored string that is returned by eligibility call

Response properties

Key	Type	Optional	Description
eligible	boolean	false	Is the user still eligible for the reward
rewardAmount	integer	true	Reward amount in MB
rewardText	string	true	Server configured string containing carrier and reward amount. Ex: Congratulations, you just added 1GB to your AT&T data plan!
carrier	string	true	Code for user's carrier

<div class="rewardBlock">
  <div class="rewardHeader"></div>
  <div class="rewardText"></div>
</div>

<button onClick='complete()' />Finish</button>

var complete = function() {
  aquto.complete({
    campaignId: '12345',
    userToken: userToken,
    callback: function(response) {
      if (response && response.eligible) {
        $('.rewardText').text(response.rewardText);
        $('.rewardHeader').addClass('rewardHeader'+response.carrier);
        $('.rewardBlock').show();
      }
    }
  });
}

MoVE for Organic App Downloads

With MoVE for Organic App Installs you can reward users in real time with data for downloading your app. This removes the burden of cellular data usage for downloading your apps.

Setup

This library must be included on the app download page. It can be embedded as a script tag:

<script src="http://assets.aquto.com/moveRewards/aquto.min.js"></script>

When embedded as a script tag, it exposes the aquto global object.

We assume you are using a DOM manipulation library, such as jQuery. All examples below will assume jQuery $ syntax and should be called in $(document).ready() block.

Pre-Qualification

The check eligibility call make take a few seconds due to communication with the carrier. To improve the performance of the eligibility call, you can include the following 1x1 pixel earlier in the user flow. We will cache the user's eligibility information and further calls to check eligibility should be faster.

<img src="http://app.aquto.com/api/campaign/datarewards/pixel" height="1" width="1" border="0">

Check Eligibility

The checkAppEligibility method determines if the current user if eligible to receive the configured MB reward . This function also starts a reward session on the server that can be completed later.

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
callback	function	yes	Function called after checking eligibility on the server
phoneNumber	string	no	Manually entered user's phone number that can be used when user is on wifi
channel	string	no	Incent channel string is used for reporting purposes

Response properties

Key	Type	Optional	Description
eligible	boolean	false	Is the current user eligible for the reward?
rewardAmount	integer	true	Reward amount in MB
rewardText	string	true	Server configured string containing carrier and reward amount. Ex: Purchase any subscription and get 1GB added to your AT&T data plan.
carrier	string	true	Code for user's carrier
clickUrl	string	true	Url to replace app download link
identified	boolean	true	Has the user's network been identified (i.e. network is known)?

<div class="rewardBlock">
  <div class="rewardHeader"></div>
  <div class="rewardText"></div>
</div>

<a class="continue" href="#">Get App</a>

aquto.checkAppEligibility({
  campaignId: '12345',
  callback: function(response) {
    if (response && response.eligible) {
      $('.rewardText').text(response.rewardText);
      $('.rewardHeader').addClass('rewardHeader'+response.carrier);
      $('.rewardBlock').show();
    }
    if (response && response.clickUrl) {
      $('.continue').attr('href', response.clickUrl);
    }
  }
});

Complete

In order to complete the conversion, you need to set up a server side callback through one of our integration partners.

Adjust
Tune
Appsflyer
Kochava

Select Aquto as publisher and provide iOS and Android click trackers to your Aquto account manager.

Generic MoVE

Eligibility for MoVE can still be checked even when the campaignId is unknown.

Setup

This library must be included on the page where eligibility is being checked. It can be embedded as a script tag:

<script src="http://assets.aquto.com/moveRewards/aquto.min.js"></script>

When embedded as a script tag, it exposes the aquto global object.

We assume you are using a DOM manipulation library, such as jQuery. All examples below will assume jQuery $ syntax and should be called in $(document).ready() block.

Check Eligibility

The genericCheckEligibility method determines if the current user is eligible for MoVE services.

Input arguments

Key	Type	Required	Description
callback	function	yes	Function called after checking eligibility on the server
phoneNumber	string	no	Manually entered user's phone number that can be used when user is on wifi

Response properties

Key	Type	Optional	Description
eligible	boolean	false	Is the current user eligible for a reward?
operatorCode	string	false	Unique code assigned to each eligible operator
coupons	array[coupon]	false	Contains all the coupons the user is eligible for

Response coupon

Key	Type	Optional	Description
couponId	integer	false	Unique coupon id
couponCode	string	false	Unique coupon code that identies coupon
rewardAmountMB	integer	false	Reward amount of the coupon in MB

<div class="rewardBlock">
  <div class="rewardHeader"></div>
  <div class="rewardText"></div>
</div>

aquto.genericCheckEligibility({
  callback: function(response) {
    if (response && response.eligible) {
      $('.rewardBlock').show();
    }
  }
});

MoVE for Voucher Redemptions

With MoVE Reward Vouchers users enter voucher codes, configured by Aquto, in order to receive a data reward. Aquto provides the voucher codes in CSV format on a per campaign bases. This flow can utilize 3rd party cookies like the Multi-page MoVE Reward Commerce Flow, or a userToken (received from the eligibility call) to identify a user. Another option is to pass the phone number in directly to checkVoucherEligibility or redeemVoucher. A call to checkVoucherEligibility is not required.

Setup

This library must be included on the page. It can be embedded as a script tag:

<script src="http://assets.aquto.com/moveRewards/aquto.min.js"></script>

When embedded as a script tag, it exposes the aquto global object.

Check Eligibility

The checkVoucherEligibility method determines if the current user is eligible to receive the configured MB reward. This function also starts a reward session on the server that can be completed later.

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
callback	function	yes	Function called after checking eligibility on the server
phoneNumber	string	no	Manually entered user's phone number that can be used when user is on wifi

Response properties

Key	Type	Optional	Description
eligible	boolean	false	Is the current user eligible for the reward?
userToken	string	false	Token that must be passed back to server when offer is completed
rewardAmount	integer	true	Reward amount in MB
rewardText	string	true	Server configured string containing carrier and reward amount. Ex: Purchase any subscription and get 1GB added to your AT&T data plan.
carrier	string	true	Code for user's carrier

<div class="rewardBlock" style="display:none;">
  <div class="rewardText">Enter your voucher code:</div>
  <input type="text" name="voucherCodeInput" id="voucherCode">
</div>

var userToken

aquto.checkVoucherEligibility({
  campaignId: '123456',
  callback: function(response) {
    userToken = response.userToken
    if (response && response.eligible) {
      $('.rewardText').text(response.rewardText);
      $('.rewardHeader').addClass('rewardHeader'+response.carrier);
      $('.rewardBlock').show();
    }
  }
});

Redeem Voucher Code

The redeemVoucher method finishes the reward session and triggers the MB reward. If checkVoucherEligibility has been called, then redeemVoucher can use the returned userToken as long as it's executed within the same scope. If redeemVoucher is being called on it's own and the user's phone number is known, then it can be passed into redeemVoucher. Passing no phoneNumber or userToken results in server attempting to identify and check for eligibility.

Input arguments

Key	Type	Required	Description
campaignId	string	no	ID for campaign setup by Aquto. This field is required if voucher version is greater than 1
code	string	yes	Voucher code entered by the user
callback	function	yes	Function called after completing the reward on the server
userToken	string	no	Stored string that is returned by eligibility call
phoneNumber	string	no	Manually entered user's phone number that can be used when user is on wifi

Response properties

Key	Type	Optional	Description
success	boolean	false	Is the user still eligible for the reward
status	string	false	Status can be either 'success', 'ineligible', 'voucherinvalid', 'voucherexpired', or 'voucheralreadyredeemed'
rewardAmount	integer	true	Reward amount in MB returned when status is 'success'
carrier	string	true	Code for user's carrier

<div class="rewardBlock">
  <div class="rewardText">Enter your voucher code:</div>
  <input type="text" name="voucherCodeInput" id="voucherCode">
  <button onClick='redeemVoucher()' />Redeem Voucher</button>
</div>

<div class="rewardStatus" style="display:none;">Congratulations! You have redeemed your voucher successfully.</div>

var redeemVoucher = function() {
  var code = $('#voucherCode').val()
  aquto.redeemVoucher({
    campaignId: '12345',
    code: code,
    userToken: userToken,
    callback: function(response) {
      if (response && response.success) {
        $('.rewardStatus').show();
      }
    }
  });
}

MoVE for Qualified Redemptions (Multi-Page flow)

With MoVE for Qualified Redemptions you can check eligibility and reward users that have initiated the offer prior to reaching your website.

The integration for the Multi-page MoVE Reward Qualified flow will occur in two places, the landing page, where a notice is displayed to the subscriber if they are eligible for reward, and the thank you page, where the reward confirmation is displayed to the subscriber (if user was eligible).

Setup

This library must be included on the page. It can be embedded as a script tag:

<script src="http://assets.aquto.com/moveRewards/aquto.min.js"></script>

When embedded as a script tag, it exposes the aquto global object.

This implementation also depends on jQuery and jBox for displaying the notices to the user. See https://stephanwagner.me/jBox/get_started for more details. All jBox options available can be passed to these functions to customize how to display the notices:

<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/StephanWagner/[email protected]/dist/jBox.all.min.js"></script>
<link href="https://cdn.jsdelivr.net/gh/StephanWagner/[email protected]/dist/jBox.all.min.css" rel="stylesheet">

All examples below will assume jQuery $ syntax and should be called in $(document).ready() block.

Check Eligibility

The checkQualifiedAndNotify method determines if the current user if eligible to receive a reward for the configured campaign and if so displays a notice to the user using jBox.

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
message	string	no	Message to display with optional parameter placeholders in format $$param1$$. Available parameters: rewardAmount, carrier
jBoxType	string	no	Type of jBox notification, defaults to 'Notice'
jBoxOptions	string	no	jBox Options

aquto.checkQualifiedAndNotify({
  campaignId: '12345',
  message: 'Complete the offer and you will receive $$rewardAmount$$MB of data',
  jBoxOptions: {
    title: 'Data Rewards',
    color: 'green',
    position: {x: 'center', y: 'center'}
  }
});

Complete Reward

The completeQualifiedAndNotify method completes the reward (if user is eligible) and displays notification to the user using jBox.

Input arguments

Key	Type	Required	Description
campaignId	string	yes	ID for campaign setup by Aquto
message	string	no	Message to display with optional parameter placeholders in format $$param1$$. Available parameters: rewardAmount, operator
jBoxType	string	no	Type of jBox notification, defaults to 'Notice'
jBoxOptions	string	no	jBox Options

aquto.completeQualifiedAndNotify({
  campaignId: '12345',
  message: 'Congratulations! You will shortly receive $$rewardAmount$$MB of data',
  jBoxOptions: {
    color: 'green',
    autoClose: false
  }
});

Show Notice

The showNotice method will display a notification to the user using jBox.

Input arguments

Key	Type	Required	Description
message	string	no	Message to display with optional parameter placeholders in format $$param1$$
params	object	no	Named parameters to replace in message
jBoxType	string	no	Type of jBox notification, defaults to 'Notice'
jBoxOptions	string	no	jBox Options
response	object	no	Response object from eligibility check or reward callback that will set $$rewardAmount$$ and $$operator$$ parameters

aquto.showNotice({
  message: 'Congratulations! You will shortly receive $$rewardAmount$$MB of data',
  params: {
    rewardAmount: 15
  },
  jBoxOptions: {
    color: 'green',
    autoClose: false
  }
});

Name		Name	Last commit message	Last commit date
Latest commit History 103 Commits
docs		docs
example		example
flows		flows
src		src
.gitignore		.gitignore
.gitmodules		.gitmodules
Aquto_REST_API.postman_collection.json		Aquto_REST_API.postman_collection.json
DataRewardsAPI(NoCouponList).postman_collection.json		DataRewardsAPI(NoCouponList).postman_collection.json
DataRewardsApiFlow.png		DataRewardsApiFlow.png
DataRewardsApiFlowNoList.png		DataRewardsApiFlowNoList.png
EmbeddedOffer.md		EmbeddedOffer.md
FlashlightPixel.md		FlashlightPixel.md
Flows.md		Flows.md
Gruntfile.js		Gruntfile.js
MoveRewardsUserFlow.png		MoveRewardsUserFlow.png
OfferWall.md		OfferWall.md
README.es.md		README.es.md
README.md		README.md
RestApi.md		RestApi.md
RestApiNoList.md		RestApiNoList.md
aquto.js		aquto.js
aquto.min.js		aquto.min.js
aquto_celtra.js		aquto_celtra.js
aquto_celtra.min.js		aquto_celtra.min.js
aquto_flows.js		aquto_flows.js
jest.config.js		jest.config.js
package.json		package.json

aquto/moveRewards

Folders and files

Latest commit

History

Repository files navigation

MoVE Rewards

MoVE for Commerce (Multi-Page flow)

Setup

Check Eligibility

Input arguments

Response properties

Complete Reward

Input arguments

Response properties

MoVE for Commerce (Single-Page flow)

Setup

Check Eligibility

Input arguments

Response properties

Complete Reward

Input arguments

Response properties

MoVE for Organic App Downloads

Setup

Pre-Qualification

Check Eligibility

Input arguments

Response properties

Complete

Generic MoVE

Setup

Check Eligibility

Input arguments

Response properties

Response coupon

MoVE for Voucher Redemptions

Setup

Check Eligibility

Input arguments

Response properties

Redeem Voucher Code

Input arguments

Response properties

MoVE for Qualified Redemptions (Multi-Page flow)

Setup

Check Eligibility

Input arguments

Complete Reward

Input arguments

Show Notice

Input arguments

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 5

Languages

Packages