Skip to content

Latest commit

 

History

History
313 lines (173 loc) · 6.31 KB

geo.schema.md

File metadata and controls

313 lines (173 loc) · 6.31 KB
Raw

Geo Schema

https://ns.adobe.com/xdm/common/geo

The geographic related data where an event was observed.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental Yes Forbidden Permitted common/geo.schema.json

Schema Hierarchy

  • Geo https://ns.adobe.com/xdm/common/geo

Geo Examples

{
  "@id": "https://data.adobe.io/entities/geo/tokyo",
  "xdm:countryCode": "JP",
  "xdm:stateProvince": "JP-13",
  "xdm:city": "Tōkyō",
  "xdm:postalCode": "141-0032",
  "schema:latitude": 35.6185,
  "schema:longitude": 139.73237
}
{
  "@id": "https://data.adobe.io/entities/geo/potsdam",
  "xdm:countryCode": "DE",
  "xdm:stateProvince": "DE-BB",
  "xdm:city": "Potsdam",
  "xdm:postalCode": "14482"
}

Geo Properties

Property Type Required Defined by
@id string Optional Geo Coordinates
schema:description string Optional Geo Coordinates
schema:elevation number Optional Geo Coordinates
schema:latitude number Optional Geo Coordinates
schema:longitude number Optional Geo Coordinates
xdm:city string Optional Geo (this schema)
xdm:countryCode string Optional Geo (this schema)
xdm:dmaID integer Optional Geo (this schema)
xdm:msaID integer Optional Geo (this schema)
xdm:postalCode string Optional Geo (this schema)
xdm:stateProvince string Optional Geo (this schema)
* any Additional this schema allows additional properties

@id

Coordinates ID

The unique identifier of the coordinates.

@id

@id Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

schema:description

Description

A description of what the coordinates identify.

schema:description

schema:description Type

string

schema:elevation

Elevation

The specific elevation of the defined coordinate. The value conforms to the WGS84 datum and is measured in meters.

schema:elevation

schema:elevation Type

number

schema:latitude

Latitude

The signed vertical coordinate of a geographic point.

schema:latitude

schema:latitude Type

number

  • minimum value: -90
  • maximum value: 90

schema:longitude

Longitude

The signed horizontal coordinate of a geographic point.

schema:longitude

schema:longitude Type

number

  • minimum value: -180
  • maximum value: 180

xdm:city

City

The name of the city.

xdm:city

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

xdm:city Type

string

xdm:countryCode

Country code

The two-character ISO 3166-1 alpha-2 code for the country.

xdm:countryCode

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

xdm:countryCode Type

string

All instances must conform to this regular expression (test examples here):

^[A-Z]{2}$

xdm:dmaID

Designated Market Area

The Nielsen Media Research designated market area.

xdm:dmaID

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

xdm:dmaID Type

integer

xdm:msaID

Metropolitan Statistical Area

The Metropolitan Statistical Area in the USA where the observation occurred.

xdm:msaID

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

xdm:msaID Type

integer

xdm:postalCode

Postal code

The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.

xdm:postalCode

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

xdm:postalCode Type

string

xdm:stateProvince

State or province

The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.

xdm:stateProvince

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

xdm:stateProvince Type

string

All instances must conform to this regular expression

([A-Z]{2}-[A-Z0-9]{1,3}|)

xdm:stateProvince Examples

"US-CA"
"DE-BB"
"JP-13"