3rd party integrations
Tracking and Analytics

VG Wort

7min

Purple Experience



Summary

We have summarised the most important parts of the VG Wort integration for the Purple Experience here. Please refer to the latest version of the original VG Wort integration guide. At the time of writing, version 2.26 is current.

For any Content, a VG Wort pixel is added to the source code of the website. After a grace period for the content to undergo editorial changes, (usually, as recommended by VG Wort, 14 days) the content and author information is posted to VG Wort Systems.

To ensure legacy content is properly tracked, please make sure to import the original tracking information to Purples' systems. Purple will render the tracking codes, but any content created from legacy systems must be posted to VG Wort Systems from the legacy system.

Preconditions

  • You'll need to set up and gather some data from VG Wort to implement this.
    • Make sure you have enabled "Verlagsinterne Zählmarken"
    • VG-Wort Zählmarken Domäne
    • VG-Wort Karteinummer
  • In addition to tracking, you will also need to set up services in the Purple Hub to connect authors to the article tracking system.

Construction of the Pixel

Purple currently does not support BASE64 encoded pixels for VG Wort. We generally use "Verlagsinterne Zählmarke". The pixel mostly consists of three parts:

  • “https://domain.met.vgwort.de” the tracking domain. A specific one is issued per each customer by VG Wort.
  • “/na/” which is just a part of the tracking pixel and must not be omitted.
  • “vgzm.970-123456789”, the properly formatted, internal key of the publisher for the text in question.
    • It's always built from the prefix „vgzm.“ , and the VG Wort Karteinummer of the publisher, followed by a "-" and the publisher-unique id of the content.
    • The Id must not contain any characters other than [a-z][A-Z][0-9] and periods (dots), hyphens (minus) and underscores. As it is otherwise freely configurable, you may decide to add further information to it.
  • If the content is paid, another prefix, "pw-" is added.

Integration in HTML

  • pixel must be integrated in the body
  • respect special requirements when loading full content lazy and indefinitely
  • respect requirements for meta tags on page

Purple Integration

The Pixel is created from a bit javascript set in the custom server.js.

The integration as <img>-tag is done via views.json. Find an example for such a section below.

VG Wort Reporting

As soon as tracking is implemented as stated above, you can enable VG-Wort reporting from the Purple Hub. The data is transferred, by request of VG Wort, with a minimum delay of two weeks. You may aggregate more data and send those in bulk, according to the capabilities of the VG Wort API. For details, check their documentation, as linked above directly.