Skip to content

profile-consents.schema.md

Latest commit

 

History

History
309 lines (215 loc) · 7.25 KB

profile-consents.schema.md

File metadata and controls

309 lines (215 loc) · 7.25 KB

Consent and Preference Details Schema

https://ns.adobe.com/xdm/mixins/profile-consents

This schema captures privacy, personalization and marketing preferences (consents).

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/profile/profile-consents.schema.json

Schema Hierarchy

Consent and Preference Details Example

{
  "xdm:consents": {
    "xdm:collect": {
      "xdm:val": "VI"
    },
    "xdm:share": {
      "xdm:val": "y"
    },
    "xdm:personalize": {
      "xdm:content": {
        "xdm:val": "y"
      }
    },
    "xdm:marketing": {
      "xdm:preferred": "email",
      "xdm:any": {
        "xdm:val": "y"
      },
      "xdm:email": {
        "xdm:val": "y"
      }
    },
    "xdm:idSpecific": {
      "ECID": {
        "12345678-abcdef09-87654321-fedcba90": {
          "xdm:share": {
            "xdm:val": "n"
          },
          "xdm:marketing": {
            "xdm:push": {
              "xdm:val": "n",
              "xdm:time": "2020-09-30T01:02:33+00:00",
              "xdm:reason": "not relevant"
            }
          }
        },
        "11112222-33334444-55556666-77778888": {
          "xdm:adID": {
            "xdm:val": "n",
            "xdm:idType": "IDFA"
          },
          "xdm:personalize": {
            "xdm:content": {
              "xdm:val": "n"
            }
          },
          "xdm:marketing": {
            "xdm:push": {
              "xdm:val": "y"
            }
          }
        }
      },
      "email": {
        "john@xyz.com": {
          "xdm:marketing": {
            "xdm:email": {
              "xdm:val": "y"
            }
          }
        },
        "johnny@company.com": {
          "xdm:marketing": {
            "xdm:email": {
              "xdm:val": "n"
            }
          }
        }
      }
    },
    "xdm:metadata": {
      "xdm:time": "2019-01-01T15:52:25+00:00"
    }
  }
}

Consent and Preference Details Properties

Property Type Required Defined by
xdm:consents object Optional Consent for Privacy, Personalization and Marketing Preferences
* any Additional this schema allows additional properties

xdm:consents

Consents and Preferences

Specific Consent and Preference Options

xdm:consents

xdm:consents Type

object with following properties:

Property Type Required
xdm:collect Optional
xdm:idSpecific object Optional
xdm:marketing Optional
xdm:metadata Optional
xdm:personalize Optional
xdm:share Optional

xdm:collect

Data Collection

Data collection is permitted

xdm:collect

  • is optional
  • type: reference
xdm:collect Type
  • – #/definitions/consent-field

xdm:idSpecific

Identifier specific

Identifier specific consents and preferences

xdm:idSpecific

  • is optional
  • type: object
xdm:idSpecific Type

Unknown type object.

{
  "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",
  "simpletype": "`object`"
}

xdm:marketing

undefined

xdm:marketing

  • is optional
  • type: reference
xdm:marketing Type
  • – #/definitions/base-marketing-with-subscriptions

xdm:metadata

Consent and Preference Metadata

Metadata that applies to all consents and preferences that don't specify a different value

xdm:metadata

  • is optional
  • type: reference
xdm:metadata Type
  • – #/definitions/metadata

xdm:personalize

undefined

xdm:personalize

  • is optional
  • type: reference
xdm:personalize Type
  • – #/definitions/base-personalization

xdm:share

Share Data

Sharing of user's data with 2nd or 3rd parties is permitted

xdm:share

  • is optional
  • type: reference
xdm:share Type
  • – #/definitions/consent-field