iOS: Tagging an application with the Digital Analytics SDK

This page outlines each tag function and parameters for the Acoustic Digital Analytics SDK. iOS applications are tagged by using native Objective-C methods for tag creation and firing.

Each tag has required parameters with a maximum length. If a required parameter is missing or a value is greater than the length identified, the SDK will return false and will attempt to send data to the server.

Page view tag

The Page View tag is used to capture clickstream data as the visitor moves from page to page within the site. A Page View tag tells Digital Analytics that someone viewed a page that is uniquely identified by the Digital Analytics 'Page ID' collected as parameter 1. The Page View tag also captures data that is related to onsite keyword searches.

The following table contains the Page View tag parameters:

Examples
Examples of using the Page View tag for iOS applications.

Defining all parameters:

[ DigitalAnalytics firePageView : @"AND:PAGEID" 
category : @"AND:CATID" searchTerm : @"boots" searchResult : @"123"
attributes :[ NSArray arrayWithObjects : @"att1" ,  @"att2" , @"" , @"att4"
 nil ]  cmmmc :[ NSArray arrayWithObjects : @"cmmmc1" ,
@"cmmmc2" , @"cmmmc3" , @"cmmmc4" nil ]];

Defining null values for categoryID, search term, search results, attributes, and cm_mmc:

[ DigitalAnalytics firePageView : @"AND:PAGEID"
 category : nil  searchTerm : nil searchResult : nil attributes : nil , nil ] 
 cmmmc : nil ];

Product view tag

The Product View tag captures information about views of product detail pages. The Product View tag should be called on the lowest level detail page for products, which is typically the Product Details page. You can view example Product View tags below.

These are the Product View tag parameters:

Example
Here is an example of using the Product View tag for iOS:

[ DigitalAnalytics fireProductview : @"AND:PID1" 
productId : @"AND:PROD1" productName : @"AND:PNAME" category : @"AND:CAT1"
attributes :[ NSArray arrayWithObjects : @"attribute1" ,  @"attribute2" ,
 nil ]];

Shop Action 5 tag

The Shop Action 5 tag captures data about selected products and which products are present in a shopping cart if any when the cart is viewed.

These are the Shop Action 5 tag parameters:

Example
Here is an example of using the Shop Action 5 tag for iOS applications:

[ DigitalAnalytics fireShopAction5 : @"AND:PROD1" 
productName : @"AND:PRODNAME" quantity : @"1" baseUnitPrice : @"9.98" 
category : @"AND:CAT1" currencyCode : @"USD" attributes :
:[ NSArray arrayWithObjects : @"attribute1" ,  @"attribute2" ,  nil ]];

Shop Action 9 tag

The Shop Action 9 tag captures data about what products were purchased by a customer. Like the Shop Action 5 tag, one tag should be sent for each product line item purchased. These tags should be sent on the receipt or other completion page confirming a successful order.

These are the Shop Action 9 tag parameters:

Example
Here is an example of using the Shop Action 9 tag for iOS applications:

[ DigitalAnalytics fireShopAction9 : @"AND:PID1" 
productName : @"AND:PRODNAME" quantity : @"1" 
baseUnitPrice : @"9.99" category : @"AND:CAT1" 
orderId : @"ORDERID123" orderSubTotal : @"9.99" 
customerId : @"CUSTOMERID" currencyCode : @"USD" 
attributes : :[ NSArray arrayWithObjects : @"att1" ,  @"att2" ,  @"" ,  @"att4" ,  
nil ]];

Order tag

The Order tag captures order header information such as Registration ID, order ID, order subtotal, and shipping and handling. The Order tag should be sent on the receipt page confirming order completion.

These are the Order tag parameters:

Example
Here is an example of using the Order tag for iOS applications:

[ DigitalAnalytics fireOrder : @"ORDERID" subtotal : @"9.99"
 shippingCharge : @"4.99" customerId : @"CUSTOMERID" customerCity : @"AUSTIN"
 customerState : @"TX" customerZip : @"78735" currencyCode : @"USD" 
attributes :[ NSArray arrayWithObjects : @"att1" ,  @"att2" ,  @"" ,  @"att4" ,  
nil ]];

Registration tag

The Registration tag creates a Lifetime Visitor Experience Profile (LIVE Profile) by associating a single common Registration ID with the Acoustic Digital Analytics permanent cookie set in every browser visit to the tagged site.

The full fireRegistration API contains the customer ID, email address, customer city, customer state, customer postal code, customer country, and any additional attributes:

+ (BOOL)fireRegistration:(NSString *)customerId email:(NSString *)email 
customerCity:(NSString *)customerCity customerState:(NSString *)customerState 
customerZip:(NSString *)customerZip customerCountry:(NSString*)customerCountry 
attributes:(NSArray *)attributes;

These are the Registration tag parameters:

Registration attribute 50
Registration Attribute 50 is reserved to syndicate an opt-in status for a registered visitor.

By using information recorded in the Digital Analytics Registration tag attributes, you can determine your visitors' opt-in or out status for email communications. As a best practice, alias attribute 50 as contactConsent to reduce the odds of it being repurposed.

📘

Note:

The -_- delimiter cannot set apart individual opt-in or opt-out instructions. To send more than one opt-in or opt-out instruction, you must use multiple registration tags.

Tagging values for Attribute 50

Example registration attribute usage
Attribute Slot: 50

Attribute Alias: contactConsent

Attribute Value: email | opt-in

Example
Here is an example of using the Registration tag for iOS applications:

[ DigitalAnalytics fireRegistration : @"CUSTOMERID" 
email : @"[email protected]" customerCity : @"AUSTIN" customerState : @"TX"
customerZip : @"78735" customerCountry : @"US" attributes :[ NSArray arrayWithObjects : 
@"att1" ,  @"att2" ,  @"" ,  @"att4" ,  nil ]];

Element tag

The Element tag and its associated reports provide organizations with the flexibility to track interaction with various intrapage elements and how these elements drive objective attainment. Below are some examples of elements that could be tracked using the Element tag:

• Portlets
  • Search portlets
  • News portlets
• AJAX Detail Hovers
  • Product detail hover-overs
  • Customer review hover-overs
• Video Plays
  • Play
  • Stop
  • Rewind
• Dynamic Page Content
  • Price slider bars
  • Brand filter checkboxes
  • Feature selectors
  • Page or Form error messages
• Clicks on File Downloads or 3rd Party Content or Banners
  • PDF downloads
  • 3rd Party Banners or Content
    These are the Element tag parameters:

Example
Here is an example of using the Element tag for iOS applications:

[ DigitalAnalytics fireElement : @"AND:EID" elementCategory : @"AND:ECAT" 
attributes :[ NSArray arrayWithObjects : @"att1" ,  @"att2" ,  @"" ,  @"att4" ,  
nil ]];

Conversion Event tag

The Conversion Event tag is employed for tracking general non-commerce conversion events. The Conversion Event tag is used to populate values in the Conversion Events Reports and to create Key Segments. This tag and the reports it populates enable an analysis of a wide variety of site activities.

Following are some examples of events that could be tracked via the Conversion Event Tag:

• Increase site stickiness
  • Play online game
  • View account information
  • Use online calculator
  • Use trip planner
  • Use comparison tool
• Improve self-service
  • Sign up for bridal registry
  • Download help documents
  • Download form
  • Download marketing information
• Improve retention marketing
  • Register for specific newsletter
  • Sign up for Webinar
  • Add items to wish list
  • Set email alerts
• Multichannel behavior
  • Use store locator
  • Visit the contact us page
  • Initiate chat session
  • Register for callback
    These are the Conversion Event tag parameters:

Example
Here is an example of using the Conversion Event tag for iOS applications:

[ DigitalAnalytics fireConversionEvent : @"/unit_test/iossdk/Event Id/ALL/" 
actionType : @"2" eventCategory : @"iossdk" eventPoints : @"10" 
attributes :[ NSArray arrayWithObjects : @"att1" ,  @"att2" ,  @"" ,  @"att4" ,
nil ]];

Manual Impression tag

Use the Manual Impression tag to collect marketing impressions for individual tracked Onside Marketing Links (Site Promotions or Real Estate).

Manual Impression tags are typically implemented in conjunction with a related Manual Link Click tag. One Impression tag is called for each related Site Promotion or Real Estate link object on a given page.

Common Use Case:

• Manual 'Link Click' tags have been implemented to track JavaScript, AJAX, Flash, Silverlight, or other non-HTML/HREF link objects with Site Promotions and Real Estate parameters: equivalent 'Manual Impression' tags must be implemented if impression tracking is wanted for the related link objects.

These are the Manual Impression tag parameters:

Example
Here is an example of using the Manual Impression tag for iOS applications:

[ DigitalAnalytics fireImpression : @"PAGEID" 
cmsp: [ NSArray arrayWithObjects : @"ONE" ,  @"TWO" , @"THREE" ,  nil ]  
cmre: [ NSArray arrayWithObjects : @"ONE" ,  @"TWO" , @"THREE" ,  nil ]];

Manual Link Click tag

The Manual Link Click tag is used when the automated collection of link click data does not occur and LIVEview or Site Promotions/Real Estate reporting is desired for the affected links. Digital Analytics testing tools, including Tag Bar/Tag Monitor and Implementation Test Tool (ITT) can assist in determining if automatic Link Click tags are generated for the links in question.

These are the Manual Link Click tag parameters:

Example
Here is an example of using the Manual Link Click tag for iOS applications:

[ DigitalAnalytics fireLinkClick : @"PAGEID" linkName : @"LINKNAME" link : 
@"/HOME/END.HTML" ];