Ionic
Integrate the Marketo Cordova Plugin with an Ionic app. Ionic Capacitor is not currently supported.
Prerequisites
- Add an application in Marketo Admin and obtain the application Secret Key and Munchkin Id.
- Set up push notifications for iOS or Android.
- Install Ionic and the Cordova CLI.
Installation Instructions
Setup Marketo Ionic Plugin
-
Go to the Ionic application directory and run the following command to add the Marketo Plugin:
$ ionic plugin add https://github.com/Marketo/PhoneGapPlugin.git --variable APPLICATION_SECRET_KEY="YOUR_APPLICATION_SECRET" -
Run the following command to confirm that the plugin was added:
$ ionic plugin list com.marketo.plugin 0.X.0 "MarketoPlugin"
Migrate to Newer Version (Optional)
-
To remove an existing plugin, run the following command:
$ ionic plugin remove com.marketo.plugin -
To add the plugin again, run the following command:
$ ionic plugin add https://github.com/Marketo/PhoneGapPlugin.git --variable APPLICATION_SECRET_KEY="YOUR_APPLICATION_SECRET"
Enable Push Notifications in xCode
- Turn on the push notification capability in the xCode project.
Track Push Notifications
Paste the following code inside the application:didFinishLaunchingWithOptions: function.
| code language-objectivec |
|---|
|
| code language-swift |
|---|
|
Initialize Marketo Framework
To initialize the Marketo framework when the app starts, add the following code under the onDeviceReady function in the main JavaScript file.
Pass ionicCordova as the framework type for Ionic Cordova apps.
Syntax
// This method will Initialize the Marketo Framework using Your MunchkinId and Secret Key
marketo.initialize(
function() { console.log("MarketoSDK Init done."); },
function(error) { console.log("an error occurred:" + error); },
'YOUR_MUNCHKIN_ID',
'YOUR_SECRET_KEY',
'FRAMEWORK_TYPE'
);
// For session tracking, add following.
marketo.onStart(
function(){ console.log("onStart."); },
function(error){ console.log("Failed to report onStart." + error); }
);
Parameters
- Success Callback: Function to run if the Marketo framework initializes successfully.
- Failure Callback: Function to run if the Marketo framework fails to initialize.
- MUNCHKIN ID: Munchkin ID received from Marketo during registration.
- SECRET KEY: Secret Key received from Marketo during registration.
Initialize Marketo Push Notification
To initialize Marketo push notifications, add the following code after the initialize function in the main JavaScript file.
Syntax
// This function will Enable user notifications (prompts the user to accept push notifications in iOS)
marketo.initializeMarketoPush(
function() { console.log("Marketo push successfully initialized."); },
function(error) { console.log("an error occurred:" + error); },
'YOUR_GCM_PROJECT_ID' // This is required for Android and will be ignored in iOS
);
Parameters
- Success Callback: Function to run if Marketo push notification initializes successfully.
- Failure Callback: Function to run if Marketo push notification fails to initialize.
- GCM_PROJECT_ID: GCM Project ID found in Google Developers Console after creating the app.
You can also unregister the token at logout.
marketo.uninitializeMarketoPush(
function() { console.log("Marketo push successfully uninitialized."); } ,
function(error) { console.log("an error occurred:" + error); }
);
Associate Lead
Call the associateLead function to create a Marketo lead.
Syntax
marketo.associateLead(
function(){ console.log("MarketoSDK : Lead Added"); },
function(error){ console.log("an error occurred:" + error); },
'Lead_Data_JSON_String'
);
Parameters
- Success Callback: Function to run if the Marketo framework associates the lead successfully.
- Failure Callback: Function to run if the Marketo framework fails to associate the lead.
- Lead Data: Lead data in JSON string format.
Example
// First create a lead as shown below
var lead = {};
lead[marketo.KEY_FIRST_NAME] = "Ionic";
lead[marketo.KEY_LAST_NAME] = "App";
lead[marketo.KEY_EMAIL] = email;
lead[marketo.KEY_ADDRESS] = "demo address";
lead[marketo.KEY_CITY] = "city";
lead[marketo.KEY_STATE] = "state";
lead[marketo.KEY_COUNTRY] = "country";
lead[marketo.KEY_POSTAL_CODE] = "postalCode";
lead[marketo.KEY_GENDER] = "gender";
// Use associateLead function to associate it.
marketo.associateLead(
function() { console.log("MarketoSDK : Lead Associated"); },
function(error) { console.log("an error occurred:" + error); },
JSON.stringify(lead)
);
Report Action
Call the reportaction function to report a user action.
Syntax
marketo.reportaction(
function(){ console.log("MarketoSDK : New event sent "); },
function(error){ console.log("an error occurred:" + error); },
'Action_Name',
'Action_Data_JSON_String'
);
Parameters
- Success Callback: Function to run if the Marketo framework reports the action successfully.
- Failure Callback: Function to run if the Marketo framework fails to report the action.
- Action Name: Action name.
- Action Data: Action data in JSON string format.
Example
// First create an event as below
var event = {
"Action Type":"Add To Cart",
"Action Details":"Adding Product in cart",
"Action Metric":"10",
"Action Length":"1"
}
marketo.reportaction(
function(){ console.log("Reported action successfully."); },
function(error){ console.log("Failed to report action." + error); },
"Add To Cart",
JSON.stringify(event)
);
Session Reporting
Bind the “pause” and “resume” event types to report Start and Stop events. These events track time spent in the mobile application and are required on Android.
//Add the following code in your www/js/index.js
bindEvents: function() {
document.addEventListener('pause', this.onStop, false);
document.addEventListener('resume', this.onStart, false);
},
onStop: function() {
marketo.onStop(
function(){ console.log("onStop"); },
function(error){ console.log("Failed to report onStop." + error); }
);
},
onStart: function() {
marketo.onStart(
function(){ console.log("onStart."); },
function(error){console.log( "Failed to report onStart." + error); }
);
},
Creating Leads
There are three ways to create leads from a hybrid app:
- Marketo MME SDK
- Marketo REST API
- Form Submit
The triggers and filters that recognize a new lead depend on the creation method:
- Leads created with the MME SDK or REST API appear in the “Lead Created” triggers and filters.
- Leads created by form submission appear in the “Fills Out Form” triggers and filters.
Use the same lead-creation method in the hybrid app and web app. If the web app uses form submission or the REST API, use that method in the hybrid app. If the web app uses neither method, consider using the MME SDK to create leads in Marketo.