Skip to content

Commit

Permalink
#9 Update CTA configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
groganz committed Jul 21, 2016
1 parent e461f16 commit 9c04143
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 43 deletions.
Binary file modified images/administrator/channels_list.png
100755 → 100644
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/administrator/enable_cta_tracking.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 24 additions & 43 deletions open/administrator/configuration/cta.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@ Call to Action Configuration

To enable :ref:`CTA tracking <dev-book-overview-cta>` for a Channel, follow these steps:

1. Connect Channel
------------------
1. Connect Trackable Channel
----------------------------

In the CampaignChain header menu, click the *Create New* button and select *Location*.
In the CampaignChain header menu, click the *Create New* button and select a
*Location* that allows you to add the tracking JavaScript code provided by
CampaignChain.

.. image:: /images/user/create_new_location.png
:width: 600px

Then, choose the appropriate Location from the drop-down list, e.g. *Website* to
Choose the appropriate Location from the drop-down list, e.g. *Website* to
include a Website into CTA tracking.

.. image:: /images/administrator/select_new_website_location.png
Expand All @@ -23,28 +25,30 @@ base URL of a Website (you can omit adding pages of the Website).
.. image:: /images/administrator/connect_new_website_channel.png
:width: 600px

Once you're done, CampaignChain will display a list of connected Channels to
you. This list will include the unique Channel Tracking ID that has been assigned
by CampaignChain to your new Channel. You will need this ID in the next step.
2. Include Tracking Code
------------------------

Once you're done with connecting a trackable Channel, CampaignChain will display
a list of connected Channels to you. This list will include a button to enable
CTA tracking for trackable Channels.

.. image:: /images/administrator/channels_list.png
:width: 600px
:width: 600px

2. Include Tracking Code
------------------------
Clicking on such button will display a page with instructions to include the
tracking snippet.

.. image:: /images/administrator/enable_cta_tracking.png
:width: 600px

2.1 Directly within HMTL Source Code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you own the Channel you plan to include and you also have full control
to directly manipulate the HTML source, then you can include a JavaScript file
provided by CampaignChain an all of your Channel's pages.

The file is named *campaignchain_tracking.js* and once you have it included, it
will take care of sending all the information for tracking CTAs to your
CampaignChain instance.
to directly manipulate the HTML source, then you can include the JavaScript
snippet provided on the "Enable CTA Tracking" page.

Include the file by adding the code mentioned below to your channel, ideally
Include the snippet by adding the code to your Channel, ideally
right before the closing body element (i.e. *</body>* element) and make sure that
it appears on all pages of the Channel.

Expand All @@ -59,33 +63,10 @@ a small piece of JavaScript or non-JavaScript code that it includes into your pa
Google Tag Manager allows you to create a new *Custom HTML Tag* at the `GTM Web
interface`_. Paste the CampaignChain tracking code into the *HMTL* section. Make
sure the event is fired on all pages. The last step is to publish your new tag in
GTM.

2.3. The CampaignChain Tracking Code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Independently from placing the tracking code diretly to the HTML source or using GTM,
here is how CampaignChain's default JavaScript tracking code looks like:

.. code-block:: html

<script type="text/javascript" src="//[CAMPAIGNCHAIN INSTALLATION]/tracking.js"></script>
<script type="text/javascript">
cc('[CAMPAIGNCHAIN CHANNEL TRACKING ID]');
</script>

Replace ``[CAMPAIGNCHAIN INSTALLATION]`` with the URL of the root of your CampaignChain
installation, e.g. *//campaignchain.example.com/tracking.js*.

.. note::
Please make sure that you omit ``http`` or ``https``, so that the script can
work with either protocol.

Next, replace ``[CAMPAIGNCHAIN CHANNEL TRACKING ID]`` with the ID generated by
CampaignChain for your channel.
GTM.

2.4 Anonymizing or Branding the Tracking Script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3. Anonymizing or Branding the Tracking Script
----------------------------------------------

If you want to hide from visitors to your CTA-tracked Channel, that you are
using CampaignChain or you want to custom brand the tracking code, then we have
Expand Down

0 comments on commit 9c04143

Please sign in to comment.