consent-preferences.schema.json

{
  "meta:license": [
    "Copyright 2021 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/datatypes/consents-and-preferences",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Consent for Privacy, Personalization and Marketing Preferences",
  "description": "Captures consumer consent for collection and use of data related to privacy, personalization and marketing preferences.",
  "type": "object",
  "meta:extensible": true,
  "meta:abstract": true,
  "definitions": {
    "choice-value": {
      "title": "Choice Value",
      "description": "The value specified by the user as their preference or the basis of processing that precludes the need for user consent",
      "type": "string",
      "enum": ["y", "n", "p", "u", "dy", "dn", "LI", "CT", "CP", "VI", "PI"],
      "meta:enum": {
        "y": "Yes (opt-in)",
        "n": "No (opt-out)",
        "p": "Pending verification",
        "u": "Unknown",
        "dy": "Default of Yes (opt-in)",
        "dn": "Default of No (opt-out)",
        "LI": "Legitimate Interest",
        "CT": "Contract",
        "CP": "Compliance with a Legal Obligation",
        "VI": "Vital Interest of the Individual",
        "PI": "Public Interest"
      },
      "meta:titleId": "consents-and-preferences##choice-value##title##22381",
      "meta:descriptionId": "consents-and-preferences##choice-value##description##81411"
    },
    "timestamp": {
      "title": "Preference timestamp",
      "description": "Date and time this specific preference was collected. This value should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
      "type": "string",
      "format": "date-time",
      "meta:titleId": "consents-and-preferences##timestamp##title##78891",
      "meta:descriptionId": "consents-and-preferences##timestamp##description##62471"
    },
    "source": {
      "title": "Preference Source",
      "description": "Through which interface did the user provide this preference value",
      "type": "string",
      "maxLength": 15,
      "meta:titleId": "consents-and-preferences##source##title##96791",
      "meta:descriptionId": "consents-and-preferences##source##description##72851"
    },
    "reason": {
      "title": "Opt-out reason",
      "type": "string",
      "description": "Reason for opting out",
      "maxLength": 255,
      "meta:titleId": "consents-and-preferences##reason##title##75301",
      "meta:descriptionId": "consents-and-preferences##reason##description##49681"
    },
    "subscriptions": {
      "title": "Subscriptions",
      "description": "A set of notifications, newsletters, etc. to which the user subscribes",
      "type": "object",
      "meta:xdmType": "map",
      "additionalProperties": {
        "type": "object",
        "title": "Subscription",
        "description": "The name or identifier of the specific subscription",
        "properties": {
          "xdm:val": {
            "$ref": "#/definitions/choice-value"
          },
          "xdm:type": {
            "title": "Subscription Type",
            "description": "The type of subscription",
            "type": "string",
            "maxLength": 15,
            "meta:titleId": "consents-and-preferences##xdm:type##title##3131",
            "meta:descriptionId": "consents-and-preferences##xdm:type##description##33161"
          },
          "xdm:topics": {
            "title": "Topics",
            "description": "Topics of interest for personalizing this subscription.",
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 25
            },
            "meta:titleId": "consents-and-preferences##xdm:topics##title##18231",
            "meta:descriptionId": "consents-and-preferences##xdm:topics##description##91571"
          },
          "xdm:subscribers": {
            "title": "Subscribers",
            "description": "The set of identifiers (email addresses, phone numbers, etc.) for this user who have subscribed",
            "type": "object",
            "meta:xdmType": "map",
            "additionalProperties": {
              "type": "object",
              "title": "Subscriber",
              "description": "The specific identifier (email addresses, phone numbers, etc.) for this subscriber",
              "properties": {
                "xdm:time": {
                  "$ref": "#/definitions/timestamp"
                },
                "xdm:source": {
                  "$ref": "#/definitions/source"
                }
              },
              "meta:titleId": "consents-and-preferences##additionalProperties##title##63381",
              "meta:descriptionId": "consents-and-preferences##additionalProperties##description##58721"
            },
            "meta:titleId": "consents-and-preferences##xdm:subscribers##title##13561",
            "meta:descriptionId": "consents-and-preferences##xdm:subscribers##description##86531"
          }
        },
        "meta:titleId": "consents-and-preferences##additionalProperties##title##19921",
        "meta:descriptionId": "consents-and-preferences##additionalProperties##description##38381"
      },
      "meta:titleId": "consents-and-preferences##subscriptions##title##39051",
      "meta:descriptionId": "consents-and-preferences##subscriptions##description##82451"
    },
    "consent-field": {
      "type": "object",
      "properties": {
        "xdm:val": {
          "description": "The value specified by the user as their consent choice or the basis of processing that precludes the need for user consent",
          "$ref": "#/definitions/choice-value",
          "meta:descriptionId": "consents-and-preferences##xdm:val##description##35561"
        }
      },
      "required": ["xdm:val"]
    },
    "adid-consent-field": {
      "type": "object",
      "properties": {
        "xdm:val": {
          "description": "The value specified by the user as their consent choice or the basis of processing that precludes the need for user consent",
          "$ref": "#/definitions/choice-value",
          "meta:descriptionId": "consents-and-preferences##xdm:val##description##35561"
        },
        "xdm:idType": {
          "title": "Ad ID Type",
          "description": "The ad ID type (IDFA or GAID)",
          "meta:descriptionId": "consents-and-preferences##xdm:itType##description##35561",
          "type": "string",
          "enum": ["IDFA", "GAID"],
          "meta:enum": {
            "IDFA": "Apple's ID for Advertisers (IDFA)",
            "GAID": "Google's Advertiser ID (GAID) also known as Android Advertiser ID (AAID)"
          },
          "meta:titleId": "consents-and-preferences##xdm:idType##title##12521"
        }
      },
      "required": ["xdm:val"]
    },
    "personalization-field": {
      "type": "object",
      "properties": {
        "xdm:val": {
          "$ref": "#/definitions/choice-value"
        }
      },
      "required": ["xdm:val"]
    },
    "base-personalization": {
      "title": "Personalization Preferences",
      "description": "User's Personalization Preferences",
      "type": "object",
      "properties": {
        "xdm:content": {
          "title": "Personalize Content",
          "description": "Allow personalization of the content on my site or in my apps",
          "$ref": "#/definitions/personalization-field",
          "meta:titleId": "consents-and-preferences##xdm:content##title##43511",
          "meta:descriptionId": "consents-and-preferences##xdm:content##description##46871"
        }
      },
      "meta:titleId": "consents-and-preferences##base-personalization##title##29231",
      "meta:descriptionId": "consents-and-preferences##base-personalization##description##39781"
    },
    "marketing-field": {
      "type": "object",
      "properties": {
        "xdm:val": {
          "$ref": "#/definitions/choice-value"
        },
        "xdm:time": {
          "$ref": "#/definitions/timestamp"
        },
        "xdm:reason": {
          "$ref": "#/definitions/reason"
        }
      },
      "required": ["xdm:val"]
    },
    "marketing-with-subscriptions": {
      "type": "object",
      "properties": {
        "xdm:val": {
          "$ref": "#/definitions/choice-value"
        },
        "xdm:time": {
          "$ref": "#/definitions/timestamp"
        },
        "xdm:reason": {
          "$ref": "#/definitions/reason"
        },
        "xdm:subscriptions": {
          "$ref": "#/definitions/subscriptions"
        }
      },
      "required": ["xdm:val"]
    },
    "base-marketing": {
      "title": "Marketing Preferences",
      "description": "User's Direct Marketing Preferences",
      "type": "object",
      "properties": {
        "xdm:preferred": {
          "title": "Preferred Channel",
          "description": "User's preferred channel for receiving communications",
          "type": "string",
          "enum": [
            "email",
            "push",
            "inApp",
            "sms",
            "phone",
            "phyMail",
            "inVehicle",
            "inHome",
            "iot",
            "social",
            "other",
            "none",
            "unknown"
          ],
          "meta:enum": {
            "email": "email",
            "push": "Push Notifications",
            "inApp": "In-app Messages",
            "sms": "SMS (Text Messages)",
            "phone": "Phone Calls",
            "phyMail": "Physical Mail",
            "inVehicle": "In-vehicle Messages",
            "inHome": "In-home Messages",
            "iot": "IoT Messages",
            "social": "Social Media",
            "other": "Other",
            "none": "No Preferred Channel",
            "unknown": "Unknown"
          },
          "meta:titleId": "consents-and-preferences##xdm:preferred##title##82291",
          "meta:descriptionId": "consents-and-preferences##xdm:preferred##description##26021"
        },
        "xdm:any": {
          "title": "General Direct Marketing Preference",
          "description": "Does user permit any type of direct marketing",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:any##title##71551",
          "meta:descriptionId": "consents-and-preferences##xdm:any##description##80691"
        },
        "xdm:email": {
          "title": "Receive email",
          "description": "User agrees to receive email",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:email##title##97011",
          "meta:descriptionId": "consents-and-preferences##xdm:email##description##79801"
        },
        "xdm:push": {
          "title": "Receive push notifications",
          "description": "User permits receiving push notifications",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:push##title##51421",
          "meta:descriptionId": "consents-and-preferences##xdm:push##description##63751"
        },
        "xdm:call": {
          "title": "Receive calls",
          "description": "User permits receiving calls",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:call##title##53351",
          "meta:descriptionId": "consents-and-preferences##xdm:call##description##46361"
        },
        "xdm:fax": {
          "title": "Receive fax",
          "description": "User permits receiving fax",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:fax##title##44891",
          "meta:descriptionId": "consents-and-preferences##xdm:fax##description##14341"
        },
        "xdm:commercialEmail": {
          "title": "Receive commercial emails",
          "description": "User permits receiving commercial emails",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:commercialEmail##title##16261",
          "meta:descriptionId": "consents-and-preferences##xdm:commercialEmail##description##88361"
        },
        "xdm:postalMail": {
          "title": "Receive postal mail",
          "description": "User permits receiving postal mail",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:postalMail##title##70151",
          "meta:descriptionId": "consents-and-preferences##xdm:postalMail##description##84251"
        },
        "xdm:sms": {
          "title": "Receive SMS",
          "description": "User agrees to receive text messages",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:sms##title##14821",
          "meta:descriptionId": "consents-and-preferences##xdm:sms##description##10841"
        }
      },
      "meta:titleId": "consents-and-preferences##base-marketing##title##34441",
      "meta:descriptionId": "consents-and-preferences##base-marketing##description##70081"
    },
    "base-marketing-with-subscriptions": {
      "title": "Marketing Preferences",
      "description": "User's Direct Marketing Preferences",
      "type": "object",
      "properties": {
        "xdm:preferred": {
          "title": "Preferred Channel",
          "description": "User's preferred channel for receiving communications",
          "type": "string",
          "enum": [
            "email",
            "push",
            "inApp",
            "sms",
            "phone",
            "phyMail",
            "inVehicle",
            "inHome",
            "iot",
            "social",
            "other",
            "none",
            "unknown"
          ],
          "meta:enum": {
            "email": "email",
            "push": "Push Notifications",
            "inApp": "In-app Messages",
            "sms": "SMS (Text Messages)",
            "phone": "Phone Calls",
            "phyMail": "Physical Mail",
            "inVehicle": "In-vehicle Messages",
            "inHome": "In-home Messages",
            "iot": "IoT Messages",
            "social": "Social Media",
            "other": "Other",
            "none": "No Preferred Channel",
            "unknown": "Unknown"
          },
          "meta:titleId": "consents-and-preferences##xdm:preferred##title##74611",
          "meta:descriptionId": "consents-and-preferences##xdm:preferred##description##21771"
        },
        "xdm:any": {
          "title": "General Direct Marketing Preference",
          "description": "Does user permit any type of direct marketing",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:any##title##27051",
          "meta:descriptionId": "consents-and-preferences##xdm:any##description##23801"
        },
        "xdm:email": {
          "title": "Receive email",
          "description": "User agrees to receive email",
          "$ref": "#/definitions/marketing-with-subscriptions",
          "meta:titleId": "consents-and-preferences##xdm:email##title##94261",
          "meta:descriptionId": "consents-and-preferences##xdm:email##description##19681"
        },
        "xdm:push": {
          "title": "Receive push notifications",
          "description": "User permits receiving push notifications",
          "$ref": "#/definitions/marketing-with-subscriptions",
          "meta:titleId": "consents-and-preferences##xdm:push##title##32421",
          "meta:descriptionId": "consents-and-preferences##xdm:push##description##99361"
        },
        "xdm:sms": {
          "title": "Receive SMS",
          "description": "User agrees to receive text messages",
          "$ref": "#/definitions/marketing-with-subscriptions",
          "meta:titleId": "consents-and-preferences##xdm:sms##title##68521",
          "meta:descriptionId": "consents-and-preferences##xdm:sms##description##45961"
        },
        "xdm:call": {
          "title": "Receive calls",
          "description": "User permits receiving calls",
          "$ref": "#/definitions/marketing-field"
        },
        "xdm:fax": {
          "title": "Receive fax",
          "description": "User permits receiving fax",
          "$ref": "#/definitions/marketing-field"
        },
        "xdm:commercialEmail": {
          "title": "Receive commercial emails",
          "description": "User permits receiving commercial emails",
          "$ref": "#/definitions/marketing-field"
        },
        "xdm:postalMail": {
          "title": "Receive postal mail",
          "description": "User permits receiving postal mail",
          "$ref": "#/definitions/marketing-field"
        }
      },
      "meta:titleId": "consents-and-preferences##base-marketing-with-subscriptions##title##25111",
      "meta:descriptionId": "consents-and-preferences##base-marketing-with-subscriptions##description##58371"
    },
    "idSpecific-marketing": {
      "title": "Marketing Preferences",
      "description": "User's Direct Marketing Preferences",
      "type": "object",
      "properties": {
        "xdm:email": {
          "title": "Receive email",
          "description": "User agrees to receive email",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:email##title##24291",
          "meta:descriptionId": "consents-and-preferences##xdm:email##description##3511"
        },
        "xdm:push": {
          "title": "Receive push notifications",
          "description": "User permits receiving push notifications",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:push##title##45471",
          "meta:descriptionId": "consents-and-preferences##xdm:push##description##74851"
        },
        "xdm:sms": {
          "title": "Receive SMS",
          "description": "User agrees to receive text messages",
          "$ref": "#/definitions/marketing-field",
          "meta:titleId": "consents-and-preferences##xdm:sms##title##12131",
          "meta:descriptionId": "consents-and-preferences##xdm:sms##description##16821"
        }
      },
      "meta:titleId": "consents-and-preferences##idSpecific-marketing##title##57411",
      "meta:descriptionId": "consents-and-preferences##idSpecific-marketing##description##40711"
    },
    "metadata": {
      "properties": {
        "xdm:time": {
          "title": "Consent/Preferences timestamp",
          "description": "Timestamp of this complete set of user consents and preferences. This value should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
          "type": "string",
          "format": "date-time",
          "meta:titleId": "consents-and-preferences##xdm:time##title##76631",
          "meta:descriptionId": "consents-and-preferences##xdm:time##description##79021"
        }
      }
    },
    "consent-preferences": {
      "properties": {
        "xdm:consents": {
          "title": "Consents and Preferences",
          "description": "Specific Consent and Preference Options",
          "type": "object",
          "properties": {
            "xdm:collect": {
              "title": "Data Collection",
              "description": "Data collection is permitted",
              "$ref": "#/definitions/consent-field",
              "meta:titleId": "consents-and-preferences##xdm:collect##title##32121",
              "meta:descriptionId": "consents-and-preferences##xdm:collect##description##55391"
            },
            "xdm:share": {
              "title": "Share Data",
              "description": "Sharing of user's data with 2nd or 3rd parties is permitted",
              "$ref": "#/definitions/consent-field",
              "meta:titleId": "consents-and-preferences##xdm:share##title##19191",
              "meta:descriptionId": "consents-and-preferences##xdm:share##description##96081"
            },
            "xdm:adID": {
              "title": "Use Advertiser ID",
              "description": "The Advertiser ID (IDFA / GAID) can be used to link user across apps on this device",
              "$ref": "#/definitions/adid-consent-field",
              "meta:titleId": "consents-and-preferences##xdm:adID##title##86491",
              "meta:descriptionId": "consents-and-preferences##xdm:adID##description##67061"
            },
            "xdm:personalize": {
              "$ref": "#/definitions/base-personalization"
            },
            "xdm:marketing": {
              "$ref": "#/definitions/base-marketing"
            },
            "xdm:metadata": {
              "title": "Consent and Preference Metadata",
              "description": "Metadata that applies to all consents and preferences that don't specify a different value",
              "$ref": "#/definitions/metadata",
              "meta:titleId": "consents-and-preferences##xdm:metadata##title##50571",
              "meta:descriptionId": "consents-and-preferences##xdm:metadata##description##58601"
            }
          },
          "meta:titleId": "consents-and-preferences##xdm:consents##title##7431",
          "meta:descriptionId": "consents-and-preferences##xdm:consents##description##5321"
        }
      }
    },
    "profile-consents": {
      "properties": {
        "xdm:consents": {
          "title": "Consents and Preferences",
          "description": "Specific Consent and Preference Options",
          "type": "object",
          "properties": {
            "xdm:collect": {
              "title": "Data Collection",
              "description": "Data collection is permitted",
              "$ref": "#/definitions/consent-field",
              "meta:titleId": "consents-and-preferences##xdm:collect##title##65561",
              "meta:descriptionId": "consents-and-preferences##xdm:collect##description##21151"
            },
            "xdm:share": {
              "title": "Share Data",
              "description": "Sharing of user's data with 2nd or 3rd parties is permitted",
              "$ref": "#/definitions/consent-field",
              "meta:titleId": "consents-and-preferences##xdm:share##title##88211",
              "meta:descriptionId": "consents-and-preferences##xdm:share##description##20591"
            },
            "xdm:personalize": {
              "$ref": "#/definitions/base-personalization"
            },
            "xdm:marketing": {
              "$ref": "#/definitions/base-marketing-with-subscriptions"
            },
            "xdm:idSpecific": {
              "title": "Identifier specific",
              "description": "Identifier specific consents and preferences",
              "type": "object",
              "meta:xdmType": "map",
              "additionalProperties": {
                "title": "Identifier Type",
                "type": "object",
                "meta:xdmType": "map",
                "additionalProperties": {
                  "type": "object",
                  "title": "Identifier",
                  "properties": {
                    "xdm:collect": {
                      "title": "Data Collection",
                      "description": "Data collection is permitted",
                      "$ref": "#/definitions/consent-field",
                      "meta:titleId": "consents-and-preferences##xdm:collect##title##7801",
                      "meta:descriptionId": "consents-and-preferences##xdm:collect##description##71551"
                    },
                    "xdm:share": {
                      "title": "Share Data",
                      "description": "Sharing of user's data with 2nd or 3rd parties is permitted",
                      "$ref": "#/definitions/consent-field",
                      "meta:titleId": "consents-and-preferences##xdm:share##title##56621",
                      "meta:descriptionId": "consents-and-preferences##xdm:share##description##36361"
                    },
                    "xdm:adID": {
                      "title": "Use Advertiser ID",
                      "description": "The Advertiser ID (IDFA / GAID) can be used to link user across apps on this device",
                      "$ref": "#/definitions/adid-consent-field",
                      "meta:titleId": "consents-and-preferences##xdm:adID##title##65941",
                      "meta:descriptionId": "consents-and-preferences##xdm:adID##description##17511"
                    },
                    "xdm:personalize": {
                      "$ref": "#/definitions/base-personalization"
                    },
                    "xdm:marketing": {
                      "$ref": "#/definitions/idSpecific-marketing"
                    }
                  },
                  "meta:titleId": "consents-and-preferences##additionalProperties##title##80371"
                },
                "meta:titleId": "consents-and-preferences##additionalProperties##title##61461"
              },
              "xdm:metadata": {
                "title": "Consent and Preference Metadata",
                "description": "Metadata that applies to all consents and preferences that don't specify a different value",
                "$ref": "#/definitions/metadata",
                "meta:titleId": "consents-and-preferences##xdm:metadata##title##48841",
                "meta:descriptionId": "consents-and-preferences##xdm:metadata##description##3551"
              },
              "meta:titleId": "consents-and-preferences##xdm:idSpecific##title##98671",
              "meta:descriptionId": "consents-and-preferences##xdm:idSpecific##description##36751"
            },
            "xdm:metadata": {
              "title": "Consent and Preference Metadata",
              "description": "Metadata that applies to all consents and preferences that don't specify a different value",
              "$ref": "#/definitions/metadata",
              "meta:titleId": "consents-and-preferences##xdm:metadata##title##45851",
              "meta:descriptionId": "consents-and-preferences##xdm:metadata##description##35221"
            }
          },
          "meta:titleId": "consents-and-preferences##xdm:consents##title##93721",
          "meta:descriptionId": "consents-and-preferences##xdm:consents##description##46941"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/consent-preferences"
    }
  ],
  "meta:status": "stable",
  "meta:createdDate": "2021-02-19",
  "meta:titleId": "consents-and-preferences##title##80311",
  "meta:descriptionId": "consents-and-preferences##description##24141"
}