Vous êtes sur la page 1sur 8
Distribution & Monetization Platform Amonetize InstallPath Download Manager Integration Guide Contents Contents 1 Introduction 2 How

Distribution & Monetization Platform

Amonetize InstallPath Download Manager Integration Guide

Contents

Contents

1

Introduction

2

How to use this document

2

2

Integrating the Download Manager

3

Filling the DM Wizard details

3

4

Download Manager URL format

5

6

Using InstallPath Download Manager to monetize multiple downloads in a download portal

8

Getting

8

Version 1.5

Distribution & Monetization Platform Introduction This guide is meant to describe and provide detailed instructions on

Distribution & Monetization Platform

Introduction

This guide is meant to describe and provide detailed instructions on how to use and integrate Amonetize InstallPath Download Manager (Download Manager) with your software setup.

How to use this document

This document outlines the technical requirements for integrating the Download Manager with your digital content, such as software installer or document and how to change the website which links to your content, in order to wrap it with the Download Manager.

This guide assumes you have knowledge of Web Site, JavaScript and HTML. questions or comments, please contact your Amonetize account manager.

If you have

About Amonetize InstallPath Download Manager

The Download Manager is a turnkey solution for download sites and portals, using a fully customized Download Manager that supports the partner’s entire software and other downloadable digital content catalog, while decreasing initial download time and optimizing conversion and monetization revenues.

Amonetize Download Manager enables you to create a fully dynamic and customized download manager and installer for your content, and enables you to control the following parameters:

Product display name

Your original file download URL

The command line to execute to install your software (In case of executable).

Your Product image

Download Manager setup file name to generate

A link to your “Thank Youpage which will be displayed after installation

Version 1.5

Distribution & Monetization Platform Integrating the Download Manager Here are the steps for integration, example follows:http://www.yourdomain.com/doc/document.pdf . It is recommended to create a link that will always point to the latest version of your file, so when you have version updates they will be automatically included in future use of the download manager. 3. Product installer command line – (Optional) – Fill in additional command line parameter your original installer requires. 1. For example, some installers use /S parameter to run in silent mode. 4. Product image download URL - Fill in a publicly accessible URL of your product image. The image dimensions should be 150x150 pixels. It will be displayed alongside the product name specified in (1) above. The file will be downloaded from this link each time the Download Manager will run. For example: http://www.yourdomain.com/MyUtility.jpg 5. Setup file prefix – A prefix that will identify the download manager setup file of your product. Please specify file name with ASCII characters only without spaces, dots, underscores or hyphens. For example, if your product is called My Utility , it is recommended to provide Version 1.5 Confidential and Proprietary Information of Amonetize Ltd. Page 3 of 8 " id="pdf-obj-2-2" src="pdf-obj-2-2.jpg">

Distribution & Monetization Platform

Integrating the Download Manager

Here are the steps for integration, example follows:

  • 1. Browse to www.amonetize.com and click Login

  • 2. After logging in with your user name and password click “Download Manager” button in the top right corner

  • 3. In the Download Manager Wizard screen you will need to provide the details for the file that you wish to distribute

Filling the DM Wizard details

  • 1. Product Name - Fill in the display name of the content that you wish to distribute, for example, for software product, it can be the product name. For a document, it can be the document name.

  • 2. Product installer download URL Fill in a publicly accessible URL of the original file that you wish to distribute. The file will be downloaded from this link each time the Download Manager will run. In case of software installer, it is important to provide a silent installer version. In case of non executable files, just fill in the download URL of the file, for example: http://www.yourdomain.com/doc/document.pdf. It is recommended to create a link that will always point to the latest version of your file, so when you have version updates they will be automatically included in future use of the download manager.

  • 3. Product installer command line (Optional) Fill in additional command line parameter your original installer requires.

    • 1. For example, some installers use /S parameter to run in silent mode.

  • 4. Product image download URL - Fill in a publicly accessible URL of your product image. The image dimensions should be 150x150 pixels. It will be displayed alongside the product name specified in (1) above. The file will be downloaded from this link each time the Download Manager will run. For example: http://www.yourdomain.com/MyUtility.jpg

  • 5. Setup file prefix A prefix that will identify the download manager setup file of your product. Please specify file name with ASCII characters only without spaces, dots, underscores or hyphens. For example, if your product is called My Utility, it is recommended to provide

Version 1.5

Distribution & Monetization Platform prefix MyUtilitySetup . This prefix will be appended with additional identifiers neededhttp://www.yourdomain.com/thank-you.html . Generating the Download Manager executable link and using it After clicking the Generate button a URL will be generated and displayed, the URL will contain formatted values of the parameters you have entered in the wizard as well as an installer version number. This URL can be used in your web site as the download link of your product. Replace in your site and in any other linked sites the URL of the product download with the one generated for you by Download Manager Wizard in Amonetize system. Attention : It is strongly recommended to link to the generated URL dynamically so you can always get the latest version of the download manager engine and latest monetization features. Version 1.5 Confidential and Proprietary Information of Amonetize Ltd. Page 4 of 8 " id="pdf-obj-3-2" src="pdf-obj-3-2.jpg">

Distribution & Monetization Platform

prefix MyUtilitySetup. This prefix will be appended with additional identifiers needed by the download manager, and the resulting setup name will be:

MyUtilitySetup_<campaign_id>_ilXXXXXX.exe

  • 6. Amonetize Campaign ID select from the drop-down list a campaign ID to associate with the distribution of this product using Amonetize consult your account manager for this information.

  • 7. Thank you page URL (Optional) - here you can specify A URL that will be opened once the installation by the Download Manager is complete. For example: http://www.yourdomain.com/thank-you.html .

Generating the Download Manager executable link and using it

After clicking the Generate button a URL will be generated and displayed, the URL will contain formatted values of the parameters you have entered in the wizard as well as an installer version number.

This URL can be used in your web site as the download link of your product.

Replace in your site and in any other linked sites the URL of the product download with the one generated for you by Download Manager Wizard in Amonetize system.

Attention: It is strongly recommended to link to the generated URL dynamically so you can always get the latest version of the download manager engine and latest monetization features.

Version 1.5

Distribution & Monetization Platform Download Manager URL format Important : all values in the link and

Distribution & Monetization Platform

Download Manager URL format

Important: all values in the link and table below are examples; use your own values as explained in Filling the DM Wizard details section above.

Example of generated download manager link:

http://www.singulardownload.com/download.php?version=1.1.4.84&campid=2&instid[appname]=M

y%20Utility&instid[appsetupurl]=http://www.myutility.com/setup.exe&instid[cmdline]=/S&instid[ap

pimageurl]=http://www.myutility.com/images/product.jpg&prefix=MyUtilitySetup&instid[thankyoup

age]=http://www.myutility.com/thank-you.html

The table below explains the parameters you can specify for the Download Manager service.

Mandatory

Parameter

URL Parameter example

Yes

Download Manager Software version as generated by the wizard or provided to you by your account manager.

version=1.1.4.84

Yes

Campaign ID

campid=2

Yes

Product Name

instid[appname]=My%20Utility

Yes

Product installer download URL

instid[appsetupurl]=http://www.myutility.c

om/setup.exe

No

Product installer command line

instid[cmdline]=/S

No

Product image download URL

instid[appimageurl]=http://www.myutility.c

om/images/product.jpg

No

Setup file prefix

prefix=MyUtilitySetup (default is Launcher)

No

Thank you page URL

instid[thankyoupage]=http://www.myutility

.com/thank-you.html

No

Tracking Parameter1

ti1=TrackingString1

No

Tracking Parameter2

ti2=TrackingString2

No

Tracking Parameter3

ti3=TrackingString3

Note: Tracking Parameter1/2/3 (ti1/2/3) are optional parameters which can be passed dynamically to the Download Manager service and will be tracked per download, they can also be sent as server-to-server postback pixel.

Version 1.5

Distribution & Monetization Platform Using InstallPath Download Manager JavaScript function to generate Download Manager Link Youhttp://www.downloadthesefiles.com/scripts/AMIdownload.js Function to call : AMIdownload(doDownload,ci,version,appname,appsetupurl,cmdline,appimageurl,prefix ,ty,ti1,ti2,ti3 ) Description: This function gets InstallPath Download Manager parameters and builds download link with the most up to date download domain. Parameters:  doDownload – Boolean - Indicates weather to initiate download in the browser when the function is called. o o true – Yes, do the download false – Just return the download URL.  ci – campaign ID  version – Installer Version  appname – Product Name  appsetupurl  cmdline - Product installer command line  appimageurl - Product installer download URL  prefix - Setup file prefix Optional parameters:  ty – post install thank you page  ti1, ti2, ti3 - Tracking Parameter1, Tracking Parameter2, Tracking Parameter3 Example1 - auto download, with thank you page and ti1 values: <script src= " http://www.downloadthesefiles.com/scripts/AMIdownload.js " ></script> <a href="#" onClick="return AMIdownload(true, '9999', '1.1.9.99', 'MyApp', 'http://www.myutility.com/setup.exe', '/S', 'http://www.myutility.com/images/product.jpg', 'MyUtilitySetup', 'http://www.myutility.com/Thank-You-For- Installing.html', '12345') ">Download</a> Version 1.5 Confidential and Proprietary Information of Amonetize Ltd. Page 6 of 8 " id="pdf-obj-5-2" src="pdf-obj-5-2.jpg">

Distribution & Monetization Platform

Using InstallPath Download Manager JavaScript function to generate Download Manager Link

You can use in your web page a utility JavaScript function called AMIdownload which automatically creates the Download Manager link.

All you need to do is include a single JS line in your page and invoke AMIdownload when the user clicks download of your file.

Function to call :

AMIdownload(doDownload,ci,version,appname,appsetupurl,cmdline,appimageurl,prefix,ty,ti1,ti2,ti3)

Description: This function gets InstallPath Download Manager parameters and builds download link with the most up to date download domain.

Parameters:

doDownload Boolean - Indicates weather to initiate download in the browser when the function is called.

o

o

true Yes, do the download

false Just return the download URL.

ci campaign ID

version Installer Version

appname Product Name

appsetupurl

cmdline - Product installer command line

appimageurl - Product installer download URL

prefix - Setup file prefix

Optional parameters:

ty post install thank you page

ti1, ti2, ti3 - Tracking Parameter1, Tracking Parameter2, Tracking Parameter3

Example1 - auto download, with thank you page and ti1 values:

<script src="http://www.downloadthesefiles.com/scripts/AMIdownload.js"></script> <a href="#" onClick="return AMIdownload(true, '9999', '1.1.9.99', 'MyApp', 'http://www.myutility.com/setup.exe', '/S', 'http://www.myutility.com/images/product.jpg', 'MyUtilitySetup', 'http://www.myutility.com/Thank-You-For- Installing.html', '12345') ">Download</a>

Version 1.5

Distribution & Monetization Platform Example2 - auto download, without any optional parameters: <script src= <a href=" http://www.downloadthesefiles.com/scripts/AMIdownload.js " ></script> <a href="#" onClick="return AMIdownload(true, '9999', '1.1.9.99', 'MyApp', 'http://www.myutility.com/setup.exe', '/S', 'http://www.myutility.com/images/product.jpg', 'MyUtilitySetup') ">Download</a> Example3 - no auto download, just return the URL of the file (without any optional parameters): <script src= " http://www.downloadthesefiles.com/scripts/AMIdownload.js " ></script> <script type='text/javascript' > var downloadlink = AMIdownload(false, '9999', '1.1.9.99', 'MyApp', 'http://www.myutility.com/setup.exe', '/S', 'http://www.myutility.com/images/product.jpg', 'MyUtilitySetup'); …Use the link in JS code </script> Version 1.5 Confidential and Proprietary Information of Amonetize Ltd. Page 7 of 8 " id="pdf-obj-6-2" src="pdf-obj-6-2.jpg">

Distribution & Monetization Platform

Example2 - auto download, without any optional parameters:

<script src="http://www.downloadthesefiles.com/scripts/AMIdownload.js"></script> <a href="#" onClick="return AMIdownload(true, '9999', '1.1.9.99', 'MyApp', 'http://www.myutility.com/setup.exe', '/S', 'http://www.myutility.com/images/product.jpg', 'MyUtilitySetup') ">Download</a>

Example3 - no auto download, just return the URL of the file (without any optional parameters):

<script src="http://www.downloadthesefiles.com/scripts/AMIdownload.js"></script> <script type='text/javascript' >

var downloadlink = AMIdownload(false, '9999', '1.1.9.99', 'MyApp', 'http://www.myutility.com/setup.exe', '/S', 'http://www.myutility.com/images/product.jpg', 'MyUtilitySetup');

…Use the link in JS code

</script>

Version 1.5

Distribution & Monetization Platform Using InstallPath Download Manager to monetize multiple downloads in a download portal" http://www.YOUR-DOMAIN.com/SOFTWARE-SETUP.exe " >Download</A> Replace them with JavaScript function call to AMIdownload which will build dynamically the download manager link and start the download itself: <A href="#" onClick="return AMIdownload( DOWNLOAD_MANAGER_PARAMETERS )">Download</A> Refer to section Using InstallPath Download Manager JavaScript function to generate Download Manager Link for detailed instructions how to use this function. Getting Support As our valued partner you can always contact your dedicated Amonetize representative in case any assistant is needed, we will do our best to answer any question and accommodate your needs. Version 1.5 Confidential and Proprietary Information of Amonetize Ltd. Page 8 of 8 " id="pdf-obj-7-2" src="pdf-obj-7-2.jpg">

Distribution & Monetization Platform

Using InstallPath Download Manager to monetize multiple downloads in a download portal site.

The following section is relevant in case you own multiple files and would like to monetize all of them with the InstallPath Download Manager.

Instead of creating separate campaigns and generating download manager links with the wizard, you can generate the link once with one of your files and use the received campaign ID and Download Manager version. Then, you can dynamically build with simple JavaScript code a download manager link upon request with the downloaded file parameters.

Below you can find step-by-step the instructions and example how to monetize all your software downloads with Amonetize InstallPath download manager:

  • 1. Include provided JavaScript URL which provides JS Function AMIdownload which will receive the download managersee code example below.

  • 2. Make sure the script containing AMIdownload function is included on every download page.

  • 3. Replace the download links on your site to point to InstallPath Download Manager service by using the AMIDownload function.

For example, assuming your download links look like this:

Replace them with JavaScript function call to AMIdownload which will build dynamically the download manager link and start the download itself:

<A href="#" onClick="return AMIdownload(DOWNLOAD_MANAGER_PARAMETERS)">Download</A>

Refer to section Using InstallPath Download Manager JavaScript function to generate Download Manager Link for detailed instructions how to use this function.

Getting Support

As our valued partner you can always contact your dedicated Amonetize representative in case any assistant is needed, we will do our best to answer any question and accommodate your needs.

Version 1.5