-
null
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter provides an overview of the various advertising modules and their functions.
The Advertising modules enable you to display advertisements on your mobile sites using FreeWheel Ad and Interstitial modules.The FreeWheel Ad module enables you to display ads from the Freewheel Ad system on specific ad zones on your mobile site. The Interstitial module enables you to insert promotional pages in between your site content.
This section includes the detailed description of the following Advertising modules:
The FreeWheel Ad module enables you to display ads from the Freewheel Ad system on specific ad zones on your mobile site. The module gathers information on pages, content, devices, and sites and sends the data to the Freewheel system. Based on the data received, the system displays particular type of ads on specific pages with specific content.
When each page loads, the FreeWheel Ad module appends the Freewheel Main URL (Customer ID) with values passed for that page. Based on the values in the URL, the Freewheel system displays ads in the page.
Note Ensure that you enter correct values to display the required ads. You must know the values to be passed for each page before you start configuring the FreeWheel Ad module.
The structure of the URL that is passed when a page loads is as follows:
http://(customerId?) (global params) ; (key value params) ; (slot params) 1
cue.v.fwmrm.net/ad/g/1?nw=value&ssnw=value&csid=value&resp=SMART ; a=b ; ptgt=s&envp=g_image&w=320&h=50
cue.v.fwmrm.net/ad/g/1?nw=value&ssnw=value&csid=value&resp=SMART ; a=b ; ptgt=s&envp=g_image&w=320&h=50
cue.v.fwmrm.net/ad/g/1?nw=value&ssnw=value&csid=value&resp=SMART ; ; ptgt=s&envp=g_image&w=320&h=50
cue.v.fwmrm.net/ad/g/1?nw=value&ssnw=value&csid=value&resp=SMART ; ; ptgt=s&envp=g_image&w=320&h=50
Note The values of params such as Customer ID, nw(Network ID), ssnw(Site Section Nework ID), resp(response type), primary target, envp(ad environment profile) are provided by Freewheel. Therefore, ensure that you have received these values from Freewheel before you start configuring this module.
The following is an example of the Ad Call URL that is formed when a page is loaded:
cue.v.fwmrm.net/ad/g/1?nw=value&ssnw=value&csid=value&resp=SMART ; a=b ; ptgt=s&envp=g_image&w=320&h=50
Note The spaces between params are inserted intentionally to increase readability. In the actual URL, there will not be white spaces between params.
The module uses Freewheel Data Keys that can be mapped to the fields in the Freewheel data structure. These Freewheel Data Keys can be classified as constants, page properties, and standard properties based on the type of values they pass.
Note The Freewheel provides values for these data keys.
The Freewheel Data Keys can be used to pass the following Page Properties:
Note You can pass values for these data keys using the Page Settings feature in the Enterprise Mobility Services Platform Site Builder.
The Freewheel Data Keys can be used to pass the following standard properties:
The Standard Properties list is provided in the section Standard Parameters.
The Extra Param [key=pair] field in the edit panel of the module is an optional field that you configure to pass site-specific values. The syntax to configure this field is: Key Name = $[Page Property Variable] or (Standard Property), where key name can be any name of your choice.
To configure the FreeWheel Ad module, perform the following steps:
Step 1 In the Modules panel, enter FreeWheel Ad. The FreeWheel Ad module appears in the Modules panel.
Step 2 Drag and drop the module into the footer area of your site in the canvas. The Edit panel of the module opens.
Step 3 In the Edit panel of the module, specify the required values in the respective fields.
Note Ensure to enter the values of each Freewheel Data Key.
Step 5 Go to the page of which the data you want to pass to the Freewheel.
Step 6 Choose Page Settings > Page Metadata, and then set page level variables and the value to be passed for that page.
Step 7 Repeat step 5 to 6 for each page of which the data you want to pass to the Freewheel.
Note It is recommended that you drag and drop the FreeWheel Ad module into the footer area of your site. If the module is used in the footer, it should be dragged and dropped above any analytic module (if included). Since the Cisco Enterprise Mobility Services Platform loads a page in the order of modules in the page (from top to bottom), a page view is recorded only after all modules in the page have loaded. Also, as the footer area is common for all pages of the site, it gets reflected across all pages of the site so that you can avoid dragging and dropping the module into every page. However, you can also use the FreeWheel Ad module in the body area of the site. Then, it will show ads only on that page where it is used.
You can configure the FreeWheel Ad module to gather information such as the title of the page viewed and category of content the page displays.
To configure the Page Properties, perform the following steps:
Assume that you have already dragged and dropped the FreeWheel Ad module into the footer section of the site.
Step 1 In the footer of the page, click the FreeWheel Ad module. The Edit panel of the module opens.
Step 2 In the Site Section ID field, declare a Page Property Variable in the following way:$[name of the Page Property variable you want to create].
Step 4 Go to the page where you want to define a value for the page property variable you declared.
Step 5 Click Page Settings at the bottom of the Canvas.
Step 6 In the Page Metadata section, click +Add to add a new key value pair.
Step 7 In the Name field, enter the name of the Page Property variable you declared in the FreeWheel Ad module.
Step 8 In the Value column, enter the value to be passed for that page.
Step 10 Repeat steps 4 to 8 to define values for Page Property in each page.
Note Currently Freewheel does not support special characters. For example, PageName=videos-sports is incorrect and will not pass the value. In addition, the key values are case sensitive. For example, if you configure $[PageName] in the FreeWheel and in the page metadata, if you configure pagename=videos, the module will not pass the value.
You can set the Page Property value for an inner page of a module.
To configure Page Property in an inner page, perform the following steps:
Step 1 In the Page Editor, click Page Manager. The Page Manager opens.
Step 2 Go to the page where the module (of which the inner page you want to configure) is placed.
Step 3 Click the module. The module's inner pages expand.
Step 4 Double-click on the Details page of the module. The Details page opens in the Page Editor.
Step 5 Click Page Settings at the bottom of the Canvas.
Step 6 In the Page Metadata section, click +Add to add a new key value pair.
Step 7 In the Name field, enter the name of the Page Property variable you declared in the FreeWheel Ad module.
Step 8 In the Value field, enter the value to be passed for that page.
Step 10 Repeat steps 1 to 9 to define values for Page Property in all inner pages of modules.
The Main properties enable you to specify the basic properties of the module. The following is the list of FreeWheel Ad Main properties.
The Edit panel displays keys in the order in which the values have to be passed. The key value pairs are case sensitive.
The Layout properties enable you to specify the layout for the module. The following is the list of FreeWheel Ad Layout properties.
|
|
---|---|
The Background properties enable you to define the background color for the module.The following is the list of FreeWheel Ad Background properties.
|
|
---|---|
The color that should appear as background in the area where the module appears. |
This Padding and Margin properties enable you to specify the padding and margin values. The following is the list of FreeWheel Ad Padding and Margin properties.
The App properties enables you to provide the properties of the app. The following is the list of FreeWheel Ad App properties.
|
|
---|---|
The following table provides a set of standard parameters and the corresponding information the parameters can be used to gather.
The Interstitial Module enables you to insert promotional pages in between your site content. The interstitial page can be used for in-house advertising and to display contextual content on any topic such as celebrity profile, sports, general knowledge, or forms.
The Interstitial module comprises:
The module offers the following use cases to a site producer:
Note You need to create a target page or the page that acts as an interstitial with the Interstitial -Skip and Interstitial-Redirector modules configured in it.
Note This module can be used only for web sites.
To configure this module, perform the following steps:
Step 1 Create a mobile site using Site Builder.
Step 2 In the Modules panel of the Enterprise Mobility Services Platform Studio, search for the Interstitial module.
All of the three modules: Interstitial-Launch, Interstitial-Skip, and Interstitial-Redirector appears.
Step 3 In the page before which you want the interstitial page to display in runtime, (for example, Home page) drag and drop the Interstitial Launch module into the body area of the canvas.
Step 4 Create an interstitial page (for example, Link Page).
Step 5 Drag and drop the Interstitial-Skip and Interstitial-Redirector modules into the body area of the canvas.
Step 6 In the Edit panel of both pages (Home and Link pages), specify the required values in the respective fields, and click Save.
Note The Interstitial module can be viewed only in runtime.
When the user views the page (for example, home page) that contains the Interstitial-Launch module, the link or source page containing the Skip and Redirector modules is displayed for a set time. When the interstitial page runs for the set time, the homepage contents are displayed.
The Interstitial module enables you to create an interstitial page to run in between your site pages.
Depending on the in-house ad or contextual content you need to incorporate in your interstitial page, create the interstitial page with the skip and redirector modules in it. Then link this page to the page from which the interstitial page is to be launched. In runtime, the interstitial displays before the source URL page is launched.
The Interstitial-Launch module links to the page that serves as the interstitial page.
Note This module can be used only for web sites.
The Main properties enable you to configure the link to the interstitial (target) page. The following is the list of Interstitial-Launch Main properties.
|
|
---|---|
The URL of the interstitial page you have created. You can use the Browse button to search for the page. |
|
The Interstitial-Redirector module enables you to redirect to the previous page (source URL) based on (pre-configured) time.
Note This module can be used only for web sites.
The Main properties enable you to set the time duration for the interstitial page here. The following is the list of Interstitial-Redirector Main properties.
By default, background properties apply to both touch and non-touch modes.
|
|
---|---|
To use an image as the background of the module. You can upload the image using the Upload Image button. |
The Interstital-Skip module enables a user to skip a particular interstitial.
Note This module can be used only for web sites.
The Checkbox properties enable you to include or exclude the “Do not show this page again” checkbox in the interstitial source page. The following is the list of Interstitial-Skip Checkbox properties.
|
|
---|---|
To display the “Do not show this page again” (default label) checkbox. |
|
The text for the label that represents the checkbox. Default label is “Do not show this page again”. |
|
The Button properties enable you to configure the style and label for the Skip button. The following is the list of Interstitial-Skip Button properties.
|
|
---|---|
The new label text if you want to change the default text. The default label is Skip. |
|
The color for the Skip button. The Button color reflects only if the Button is not an image. |
|
The Background properties enable you to specify the background color, and background image for this module. The following is the list of Interstitial-Skip Background properties.
The Border properties enable you to specify the border properties for the module. The following is the list of Interstitial-Skip Border properties..
The Padding and Margin properties enable you to specify the padding and margin values for this module. The following is the list of Interstitial-Skip Padding and Margin properties.