Skip to content

Latest commit

 

History

History
278 lines (184 loc) · 6.59 KB

formfilledout.schema.md

File metadata and controls

278 lines (184 loc) · 6.59 KB
Raw

Form Filled Out Schema

https://ns.adobe.com/xdm/mixins/events/formfilledout

Use to capture details when a person fills out a form on a web page.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/experience-event/events/formfilledout.schema.json

Form Filled Out Example

{}

Form Filled Out Properties

Property Type Required Defined by
xdm:environment object Optional Form Filled Out (this schema)
xdm:web object Optional Form Filled Out (this schema)
* any Additional this schema allows additional properties

xdm:environment

Environment

The information related to web page and link of the ExperienceEvent.

xdm:environment

  • is optional
  • type: object
  • defined in this schema

xdm:environment Type

object with following properties:

Property Type Required
xdm:browserDetails object Optional
xdm:ipV4 string Optional

xdm:browserDetails

Browser details

The browser specific details such as browser name, version, javascript version, user agent string, and accept language.

xdm:browserDetails

  • is optional
  • type: object
xdm:browserDetails Type

Unknown type object.

{
  "title": "Browser details",
  "type": "object",
  "description": "The browser specific details such as browser name, version, javascript version, user agent string, and accept language.",
  "properties": {
    "xdm:userAgent": {
      "title": "User agent",
      "type": "string",
      "description": "The HTTP user-agent string from the client request.",
      "meta:titleId": "formfilledout##xdm:userAgent##title##69601",
      "meta:descriptionId": "formfilledout##xdm:userAgent##description##75941"
    }
  },
  "meta:titleId": "formfilledout##xdm:browserDetails##title##73971",
  "meta:descriptionId": "formfilledout##xdm:browserDetails##description##26001",
  "simpletype": "`object`"
}

xdm:ipV4

IPv4

The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication.

xdm:ipV4

  • is optional
  • type: string
xdm:ipV4 Type

string

xdm:web

Web

Link clicks, web page details, referrer information, and browser details.

xdm:web

  • is optional
  • type: object
  • defined in this schema

xdm:web Type

object with following properties:

Property Type Required
xdm:fillOutForm object Optional
xdm:webPageDetails object Optional
xdm:webReferrer object Optional

xdm:fillOutForm

Fill Out Form

undefined

xdm:fillOutForm

  • is optional
  • type: object
xdm:fillOutForm Type

Unknown type object.

{
  "title": "Fill Out Form",
  "type": "object",
  "properties": {
    "xdm:webFormID": {
      "title": "Web Form ID (deprecated)",
      "type": "string",
      "description": "Web Form ID is going to depreciate soon. Please use  Web Form Key.",
      "meta:titleId": "formfilledout##xdm:webFormID##title##36241",
      "meta:descriptionId": "formfilledout##xdm:webFormID##description##30331"
    },
    "xdm:webFormKey": {
      "title": "Web Form Key",
      "description": "Unique key of the form.",
      "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source",
      "meta:titleId": "formfilledout##xdm:webFormKey##title##84331",
      "meta:descriptionId": "formfilledout##xdm:webFormKey##description##19751"
    },
    "xdm:webFormName": {
      "title": "Web Form Name",
      "type": "string",
      "description": "Name of the form.",
      "meta:titleId": "formfilledout##xdm:webFormName##title##3391",
      "meta:descriptionId": "formfilledout##xdm:webFormName##description##62561"
    }
  },
  "meta:titleId": "formfilledout##xdm:fillOutForm##title##47321",
  "simpletype": "`object`"
}

xdm:webPageDetails

Web Page Details

undefined

xdm:webPageDetails

  • is optional
  • type: object
xdm:webPageDetails Type

Unknown type object.

{
  "title": "Web Page Details",
  "type": "object",
  "properties": {
    "xdm:webPageID": {
      "title": "Web Page ID",
      "type": "string",
      "description": "Unique ID of the web page.",
      "meta:titleId": "formfilledout##xdm:webPageID##title##54511",
      "meta:descriptionId": "formfilledout##xdm:webPageID##description##29891"
    },
    "xdm:name": {
      "title": "Name",
      "type": "string",
      "description": "The normative name of the web page. This name is not necessarily the page title or directly associate with page content, but is used to organize a site's pages for classification purposes.",
      "meta:titleId": "formfilledout##xdm:name##title##50361",
      "meta:descriptionId": "formfilledout##xdm:name##description##77841"
    },
    "xdm:queryParameters": {
      "title": "Query Parameters",
      "type": "string",
      "description": "Query Parameters used for the web page. This is normally the value of a string after `?` in the url.",
      "meta:titleId": "formfilledout##xdm:queryParameters##title##34301",
      "meta:descriptionId": "formfilledout##xdm:queryParameters##description##69451"
    }
  },
  "meta:titleId": "formfilledout##xdm:webPageDetails##title##32491",
  "simpletype": "`object`"
}

xdm:webReferrer

Web Referrer

undefined

xdm:webReferrer

  • is optional
  • type: object
xdm:webReferrer Type

Unknown type object.

{
  "title": "Web Referrer",
  "type": "object",
  "properties": {
    "xdm:URL": {
      "title": "URL",
      "type": "string",
      "description": "The referrer URL.",
      "meta:titleId": "formfilledout##xdm:URL##title##38591",
      "meta:descriptionId": "formfilledout##xdm:URL##description##48901"
    }
  },
  "meta:titleId": "formfilledout##xdm:webReferrer##title##42681",
  "simpletype": "`object`"
}