Skip to content

Migration guides server

Samuel Défago edited this page Sep 12, 2023 · 1 revision

This page provides instructions for server-side migration required to match SDK capabilities.

Server side migration to V2 (SDK version 9 and above)

Commanders Act V5 SDKs (Apple and Android) now send a JSON payload to the new server V2, instead of multipart/form-data to previous server V1. Objects and properties were updated in the process.

Mapping changes

  • New SDK properties can have specific types (e.g. integer for timestamps).
  • event_id is a reserved variable, a UUID set by the SDK.
  • event_name is used in event:
    • Page views: page_view (defined by the SDK)
    • Media events: play, pause, seek, eof, stop, pos, uptime, segment.
    • Events: The name provided for the event.
  • No more navigation_environment and media_embedding_environment properties (prod and preprod) are required. An environment-dependent sourceKey is used instead.
  • In page view events (also named screenview in MAPP):
    • Use the page_name property instead of the content_title property.
    • Use the page_type property instead of the content_page_type property.
  • Custom SRG SSR property names propagated through the SDK don't change.
  • TC properties, now under a context key, have new names:

Other server side V1 creations and transformations (internal variables or PHP transformations) are now located under Data Cleansing in V2. Names are identical.

Filters

  • Page view: event_name = "page_view" (is UI comparison).
    • The SRG SSR usually adds AND EXISTS(page_unique_name) (exists UI comparison) to have a unique page name identifying the page.
  • Media events: event_name IN ("play", "pause", "seek", "eof", "stop", "pos", "uptime", "segment") (is UI comparison).
    • The SRG SSR usually adds AND EXISTS(media_urn) (exists UI comparison) to have a unique id to group media events from the same visit session / install id.
  • Events: event_name !IN ("page_view", "play", "pause", "seek", "eof", "stop", "pos", "uptime", "segment") (isn't UI comparaison).
Clone this wiki locally