Skip to content

Latest commit

 

History

History
359 lines (194 loc) · 7.18 KB

directmarketing-address.schema.md

File metadata and controls

359 lines (194 loc) · 7.18 KB

Direct Marketing Address Schema

https://ns.adobe.com/xdm/context/directmarketing-address

Direct Marketing Address.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted context/directmarketing-address.schema.json

Schema Hierarchy

  • Direct Marketing Address https://ns.adobe.com/xdm/context/directmarketing-address
    • Address https://ns.adobe.com/xdm/common/address

Direct Marketing Address Example

{
  "@id": "https://data.adobe.io/entities/address/123",
  "xdm:primary": false,
  "xdm:street1": "345 Park Ave",
  "xdm:city": "San Jose",
  "xdm:stateProvince": "US-CA",
  "xdm:postalCode": "95110",
  "xdm:country": "United States",
  "xdm:countryCode": "US",
  "schema:latitude": 37.3382,
  "schema:longitude": 121.8863,
  "xdm:status": "active",
  "xdm:lastVerifiedDate": "2018-01-02",
  "xdm:errorCount": 0,
  "xdm:quality": "Fully-recognized street"
}

Direct Marketing Address Properties

Property Type Required Default Defined by
xdm:country string Optional Address
xdm:errorCount integer Optional Direct Marketing Address (this schema)
xdm:label string Optional Address
xdm:lastVerifiedDate string Optional Address
xdm:postOfficeBox string Optional Address
xdm:primary boolean Optional Address
xdm:quality string Optional Direct Marketing Address (this schema)
xdm:region string Optional Address
xdm:status string Optional "active" Address
xdm:statusReason string Optional Address
xdm:street1 string Optional Address
xdm:street2 string Optional Address
xdm:street3 string Optional Address
xdm:street4 string Optional Address
* any Additional this schema allows additional properties

xdm:country

Country

The name of the government-administered territory. Other than xdm:countryCode, this is a free-form field that can have the country name in any language.

xdm:country

  • is optional
  • type: string
  • defined in Address

xdm:country Type

string

xdm:errorCount

Address Error Count

Number of consecutive errors when sending to this address.

xdm:errorCount

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

xdm:errorCount Type

integer

xdm:label

Label

Free form name of the address.

xdm:label

  • is optional
  • type: string
  • defined in Address

xdm:label Type

string

xdm:lastVerifiedDate

Last Verified Date

The date that the address was last verified as still belonging to the person.

xdm:lastVerifiedDate

  • is optional
  • type: string
  • defined in Address

xdm:lastVerifiedDate Type

string

xdm:postOfficeBox

Post Office Box

Post office box of the address.

xdm:postOfficeBox

  • is optional
  • type: string
  • defined in Address

xdm:postOfficeBox Type

string

  • maximum length: 20 characters

xdm:primary

Primary

Primary address indicator. A profile can have only one primary address at a given point of time.

xdm:primary

  • is optional
  • type: boolean
  • defined in Address

xdm:primary Type

boolean

xdm:quality

Address Quality

Address quality rating.

xdm:quality

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

xdm:quality Type

string

xdm:quality Known Values

Value Description
incomplete_address Incomplete address
unknown_town_postal_code Unknown town-postal code
empty_street Empty street
unknown_street Unknown street
partially_recognized_street Partially-recognized street
fully_recognized_street Fully-recognized street

xdm:region

Region

The region, county, or district portion of the address.

xdm:region

  • is optional
  • type: string
  • defined in Address

xdm:region Type

string

xdm:status

Status

An indication as to the ability to use the address.

xdm:status

  • is optional
  • type: string
  • default: "active"
  • defined in Address

xdm:status Type

string

xdm:status Known Values

Value Description
active Active
incomplete Incomplete
pending_verification Pending Verification
blacklisted Blacklisted
blocked Blocked

xdm:statusReason

Status Reason

A description of the current status.

xdm:statusReason

  • is optional
  • type: string
  • defined in Address

xdm:statusReason Type

string

xdm:street1

Street 1

Primary Street level information, apartment number, street number and street name.

xdm:street1

  • is optional
  • type: string
  • defined in Address

xdm:street1 Type

string

xdm:street2

Street 2

Optional street information second line.

xdm:street2

  • is optional
  • type: string
  • defined in Address

xdm:street2 Type

string

xdm:street3

Street 3

Optional street information third line.

xdm:street3

  • is optional
  • type: string
  • defined in Address

xdm:street3 Type

string

xdm:street4

Street 4

Optional street information fourth line.

xdm:street4

  • is optional
  • type: string
  • defined in Address

xdm:street4 Type

string