Skip to content

Refinance

Client Side

Setup

MyAdOptimizer.com will provide a Javascript snippet back to you to add to your new Thank You page as follows:

<script src="https://cdn.myadoptimizer.com/maojsfiles/landingpagesjs/{{LandingPageToken}}.js"></script>
  • LandingPageToken: Token that will be provided by your account manager
  • Div Element: Aggregated results will be rendered automatically once the thank you page loads on the user browser. An HTML DIV element with ID=“target” must be created in the Thank-You page as results will be rendered inside that element.
  • Default CSS Theme: MyAdOptimizer provides a default CSS; however, if you wish to change it and create your own to match your landing page theme, please contact your account manager
  • Device Type (Desktop or Mobile): This is automatically inferred when using Client Side (JavaScript) integration

To ensure that each ad network gets the parameter values they require we ask that you setup a new Thank You page and pass the below parameters in the query string. The aggregated results will be rendered once they Thank You page loads on the user’s browser.


Generic Query String Parameters

  • SourceID: Optional, tracking variable
  • ExtClickID: Optional, tracking variable
  • CustomVar1: Optional, tracking variable (Max length - 75)
  • CustomVar2: Optional, tracking variable (Max length - 75)
  • CustomVar3: Optional, tracking variable (Max length - 75)
  • CustomVar4: Optional, tracking variable (Max length - 75)
  • CustomVar5: Optional, tracking variable (Max length - 75)

Specific Query String Parameters for Mortgage Refinance

Params NamesData TypeAllowed Values
zipcodestring5 char US zip code
State*string2 char US state code (Uppercase)
creditscore*stringExcellent, Good, Fair, Poor
loanbalanceint0-10000000
propertyvalueint0-10000000
CashOut*stringYes, No
MediaChannel*stringSocial, Facebook, Native, Email, Display, SEM, SEO, SMS, Push, Affiliate, ChannelA, ChannelB, ChannelC, ChannelD, ChannelE
MilitaryStatus*stringYes, No
EmploymentStatus*stringEmployed, Self-Employed, Retired, Not Employed
PropertyUse*stringPrimary Home, Second Home, Rental Property
PropertyType*stringSingle Family, Multi-Unit, Condo/Townhome, Mobile, Other
HomeListed*stringYes, No
SellTimeFrame*stringNow, 3_Months, 6_Months, 1_Year, Unknown
FName ±string
LName ±string
Email ±string
Phone ±string
Address ±string
City ±string

*Case Sensitive

±PII Fields

LocalStorage Integration

In order to use LocalStorage instead Querystring, set up the parameters names & values stated above by adding them using a MAO JS function called setMAOLocalStorageValue. This method expects a key/value pair.

The function setMAOLocalStorageValue need two paramets

  • Property name & Property value

For example:

/*
@param{string} sParam - Property Name
@param{*} sValue - Property Value
*/
setMAOLocalStorageValue('State', CA);
setMAOLocalStorageValue('ZipCode', 90291);
// Output: Added value succesfully

Once you have set up all parameters values, you need to invoke the function initMAO to render all campaigns.

initMAO function need two parameters

  • Target HTML ID & Render mode For Example:
//HTML Structure
<div id="target"> Rendered campaings ... </div>
/*
@param{string} TargetHtmlControlID
@param{number} GlobalRenderMode (1- Live , 2- Test)
*/
InitMAO('target', 1);

Click to call RenderMode 3

Callback properties

  • CampaignPhoneNumber: New A unique phone number assigned to the campaign to track and measure calls.

  • CallToAction: New Text displayed on a clickable button or element, encouraging users to initiate a phone call.

  • AdResultCallStatusID: New An ID representing the campaign’s call status, where:

IDStatusAllows calls
1Click To Call is ActiveTRUE
8Campaign is out of scheduleFALSE
13Click to Call Monthly Cap ReachedFALSE
14Click to Call Daily Cap reachedFALSE
15Click to Call is OffFALSE
16Campaign is offFALSE

Example Callback

{
"advertiserId": "100",
"AdvertiserName": "FreeRateUpdate - 100",
"AdNetworkAPIID": 76,
"Title": "Fixed Mortgage Rates from 5.7 rate 6.1 Apr",
"AdCopyVersion": 1,
"Description": "FHA, VA, 30 Year Fixed, 15 Year Fixed <br /> Cash Out and Home Equity Options <br /> View Rates & Payments <br /> Calculate Home Equity Payments",
"CPC": 15.75,
"BaseCPC": 15,
"Logo": "https://cdn.myadoptimizer.com/maojsfiles/images/LogoAdvertiser_000000_00000000-0000-0000-0000-000000000000.jpg",
"BrandName": "FreeRateUpdate",
"NetworkSort": 1,
"NetworkAdID": "1284",
"DisplayUrl": "FreeRateUpdate.com/MortgageRates",
"PayLoad": "",
"Weight": 15.75,
"CB": "XXXXXXXXXXXXXXXXXXXXXXX",
"M": "XXXXXXXXXXXXXXXXXXXXXXX",
"BidModifierPercentange": 5,
"BidFloor": 0,
"RequestDuration": 539,
"AdResultLogStatusId": 1,
"AdNetworkName": "MAO Open Exchange",
"SourceID": "",
"ExtClickId": "",
"ExtSearchID": "",
"LandingPageURL": "ThankYouDemo.html",
"bidModDescription": [
"Consumer Credit: Excellent - Value: 5%"
],
"CustomVar1": "",
"CustomVar2": "",
"CustomVar3": "",
"CustomVar4": "",
"CustomVar5": "",
"DailyFilledRate": 0,
"CampaignDailyCap": 1500,
"CampaignPhoneNumber": "+11234567890",
"CallToAction": "Call Now",
"AdResultCallStatusID": 1,
"DestinationURL": "https://maofunctionstest.azurewebsites.net/api/MAOHttpRedirect?src=https%3A%2F%2Fwww.freerateupdate.com%2Fmortgagerates%3Futm_source%3Ddirectbidder1284&LandingPageID=10&EventID=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&AdNetworkAPIID=76&cpc=15.75&Brand=FreeRateUpdate&Title=Fixed Mortgage Rates from 5.7 rate 6.1 Apr&CB=XXXXXXXXXXXXXXXXXXXXXXX&M=XXXXXXXXXXXXXXXXXXXXXXX&Weight=15.75&BidModifiers=5&NetworkAdID=1284&SourceID=&LandingPageURL=ThankYouDemo.html&AdId=100&AdCopyVersion=1&CustomVar1=&CustomVar2=&CustomVar3=&CustomVar4=&CustomVar5=",
"findIndex": 0
}

External Ad Networks Setup Optional

To integrate the following Ad Networks, MAO will need the following values.

Media Alpha

  • api_token
  • placement_id

Transparent.ly

  • pubcampaignId

Clicks.NET

  • Affcamid
  • Key

Quinstreet

  • Src

Additional Optional Parameters for Transparent.ly

Param NameData TypeAllowed Values
CurrentInterestRatedecimal0 - 99.99
TimeFrameToBuystring30 days (Offer Pending or Signed Purchase Agreement), 2-3 Months, 3-6 Months, Researching Options
CurrentMortgageProviderstringAAG/American Advisors Group, AmeriHome Mortgage, AmeriSave Mortgage, Bank of America, Bank of England, Truist Financial, Better Mortgage, Caliber Home Loans, Carrington Mortgage, Cenlar, Chase, Citi, Citizens Bank, CrossCountry Mortgage, Ditech, Fairway Independent Mortgage, Fifth Third Bank, Finance of America Mortgage, First Guaranty Mortgage Corp, Freedom Mortgage Corp, Guaranteed Rate, Homepoint Financial, Huntington National Bank, LoanCare, loanDepot, Merrill Lynch, Morgan Stanley, Mr. Cooper/Nationstar, Navy Federal Credit Union, New American Funding, New Day USA, NewRez, Ocwen, PenFed Credit Union, PennyMac Loan Services, PHH Mortgage, PNC Mortgage, Quicken Loans Inc, Rocket Mortgage, RoundPoint Mortgage, Shellpoint, Specialized Loan Servicing, Sun West Mortgage, SunTrust, United Share Financial Services, United Wholesale Mortgage, US Bank Home Mortgage, USAA Federal Savings Bank, Veterans United, Wells Fargo & Company, Other, I Don’t Know, No Lender (Loan Paid Off)