Add custom unstructured contexts

[alexanderdean]

Custom unstructured context is related to custom unstructured events.

Any existing event including unstructured events can have custom contexts attached to it by way of an additional argument to the function. The additional argument is a JSON of the form:

{
  "context1": { },
  "context2": { },
  "context3": { },
  ...
}

You can add as many custom contexts as you want. Each must have a unique name.

Essentially custom unstructured contexts allow you to extend an existing event type with custom properties, without having to create a new custom unstructured event type.

Example:

_snaq.push(['trackPageView', 'Product: The Last of Us', {
                   product_page: {
                      type: 'game',
                      platform: 'ps3',
                      sku: 'ps3-2312-13x'
                   },
                   common: { session_id: '123' },
                   user: { salesforce_source_id: '456' }
                 }
            ]);

[alexanderdean]

/cc @yalisassoon

[alexanderdean]

@yalisassoon can you check this updated version makes sense?

[yalisassoon]

It makes sense - I just wonder whether something like this would be clearer:

_snaq.push(['trackPageView', context: {
    product: {
        name: 'The Last of Us',
        type: 'game',
        platform: 'ps3',
        sku: 'ps3-3213-13x' 
    },
    user: {
      salesforce_source_id: 456
    },
    common: {
      session_id: 123
    }
]);

i.e. we specify "context" explicitly in each event tracking call rather than promoting one of the fields (usually a name) in the context JSON envelope to the overall name. (This feels unnatural to me - I don't know what's special about the field that's promoted.) What do you reckon?

[alexanderdean]

To clarify: 'Product: The Last of Us' is just a page title. So I think this is okay?

[yalisassoon]

Yes - I misunderstood - agree your suggested approach is the one to go for!

[alexanderdean]

Note: when we add custom context to pageViews, make sure we don't break the feature where page title is auto-detected.

[alexanderdean]

Done in 0.13.0.