Custom Categories

[notfelineit]

Add Custom Categories

This PR adds a config property to ConsentManager called customCategories that looks like the following:

interface CustomCategories {
    [key: string]: Category
}

interface Category {
    purpose: string 
    integrations: string[] // Segment Integration Names
}

Users can verify their integration names via https://cdn.segment.com/v1/projects/<writeKey>/integrations. That returns an array of integration objects:

{"name":"Slack","creationName":"Slack","description":"Slack is a team collaboration tool.","website":"http://slack.com","category":"Customer Success"}

(name would be Slack here)

Example

<ConsentManager
        writeKey="tYQQPcY78Hc3T1hXUYk0n4xcbEHnN7r0"
        otherWriteKeys={['vMRS7xbsjH97Bb2PeKbEKvYDvgMm5T3l']}
        bannerContent={bannerContent}
        bannerSubContent={bannerSubContent}
        preferencesDialogTitle={preferencesDialogTitle}
        preferencesDialogContent={preferencesDialogContent}
        cancelDialogTitle={cancelDialogTitle}
        cancelDialogContent={cancelDialogContent}
        closeBehavior={props.closeBehavior}
        customCategories={{
            "Do Not Sell": { 
                integrations: ["Google Ads (Classic)"],
                purpose: "To give the right to opt out of the sale of personal data." 
           } 
       }}
/>

renders as:

which in turn, reflects this cookie:

{
  "destinationPreferences": {
    "AdWords": false
  },
  "customPreferences": {
    "Do Not Sell": false
  }
}

Manual Flow Tests

Default Consent Categories

Custom Consent Categories

[msanterre]

I was thinking this would replace our current categories and let users map destinations directly to categories.

[notfelineit]

That sounds good to me! Should it be to entire categories of destinations <> consent category, or allow specific destination <> consent category?

[msanterre]

I think specific would be more useful!

[notfelineit]

I think what I'll do is:
1) Uphold existing default behavior, which is by category but
2) Make sure users can also pass in mapCustomPreferences to do custom destination/yes/no

Actually, going to make this map custom category <> destination name - since you made a good point about customCategories being a very specific feature Max :-)

[msanterre]

lgtm
]

[msanterre]

Doesn't the ? take care of the undefined case here?

[notfelineit]

I think I originally had it as just customCategories?: CustomCategories but it was failing validation - because sometimes we do pass in customCategories but the value is undefined.

[msanterre]

You could just do this here I think:

          customPreferences[preferenceName] = Boolean(value)

[notfelineit]

I think this is saying "if explicitly set as true or false, set as true or false, if not set (i.e. value is null), set to true"

[federico-fiorini]

Hi @notfelineit 👋

I'm trying to use custom categories and having some trouble so I thought to ask you directly given you worked on this. My main questions are:

• do I need to map all integrations into a custom category? what happens to the integrations that I don't include in one of the categories? (e.g. let's say we add a new destination on segment and forget to update the customCategories in our consent manager implementation)
• can I move integrations into the Essential category? If I add Essential to the customCategories it simply creates a new category instead of setting integrations as essential. So I'm not sure how to achieve that

Hopefully you can help me clarifying how to use this setting. Thank you!