Metadata Mapping

The following table shows the mapping of AP Media API item metadata fields (JSON to NewsML-G2). For item metadata field descriptions, see Content Metadata Fields.

 

  Tip

 

Use CTRL-F on this page to search for a specific field name.

 

 

 

 

AP Media API (JSON)

AP Media API (NewsML-G2)

 

uri

- (not available), see newsItem/@guid

 

altids.itemid

altId/[@type="ap:itemId"]

 

altids.friendlykey

altId/[@type="ap:friendlyKey"]

 

altids.videoid

altId/[@type="ap:videoId"]

 

altids.referenceid

altId/[@type="ap:referenceId"]

 

foreignkeys.memberentryid

-

 

foreignkeys.membermanagementid

-

 

foreignkeys.storyid

altId/[@type="ap:videoId"]

 

version

altId/[@type="ap:recordSequenceNumber"]

 

type

itemClass/@qcode

 

urgency

urgency

 

profile

profile

 

language

language/[@role="aprol:contentLang"]@tag

 

versioncreated

versionCreated

 

firstcreated

firstCreated

 

embargoed

embargoed

 

pubstatus

pubStatus

 

editorialrole

role/name

 

fixture

instanceOf

 

ednote

edNote

 

editorialtypes

role/name

 

signals

signal/@qcode

 

title

title

 

headline

headline

 

headline_extended

headline/[@role="aprol:extendedHeadline"]

 

description_summary

description/[@role="drol:summary"]

 

bylines.by

creator; also in by

 

bylines.title

creator/related/name/[@role="aprol:BylineTitle"]

 

photographer

creator/[@role="aprol:photographer"]

 

producer

contributor

 

editor

contributor/[@role="aprol:editor"]

 

located

dateline

 

datelinelocation

located

 

description_creditline

creditline

 

copyrightnotice

copyrightNotice

 

usageterms

usageTerms

 

keywords

keyword

 

outcue

description/[@role="aprol:outcue"]

 

provider

provider

 

infosource

infoSource

 

subject

subject

 

subject.rels:category
Also in NITF at nitf:docdata/nitf:identified-content/classifier/[@type=”apcategorycode”]@value

subject/[@qcode="apcategorycode:*"]
Also in NITF at nitf:docdata/nitf:identified-content/classifier/[@type=”apcategorycode”]@value

 

subject.rels:suppcategory

subject/[@qcode="apsuppcategorycode:*"]

 

person

subject/[@type="cpnat:person"]

 

organisation

subject/[@type="cpnat:organization"]

 

organisation.industries

-

 

organisation.symbols.ticker

-

 

organisation.symbols.exchange

-

 

organization.symbols.instrument

-

 

place

subject/[@type="cpnat:place"]

 

event

-

 

audiences

audience

 

description_caption

description/[@role="drol:caption"]

 

slugline

slugline

 

associations

link/[@rel="irel:associatedWith]

 

renditions.name.title

title

 

renditions.name.rel

remoteContent/@rendition

 

renditions.name.format

remoteContent/@format

 

renditions.name.type

remoteContent/@contenttype

 

renditions.name.digest

-

 

renditions.name.href

remoteContent/@href

 

renditions.name.orientation

remoteContent/@layoutorientation

 

renditions.name.mimetype

- (use @format)

 

renditions.name.fileextension

- (use @format)

 

renditions.name.sizeinbytes

remoteContent/@size

 

renditions.name.width

remoteContent/@width

 

renditions.name.height

remoteContent/@height

 

renditions.name.originalfilename

remoteContent/altId/[@type="ap:originalFileName"]

 

renditions.name.duration

remoteContent/@duration

 

renditions.name.videocodec

remoteContent/@videocodec

 

renditions.name.framerate

remoteContent/@videoframerate

 

renditions.name.averagebitrate

remoteContent/@videoavgbitrate

 

renditions.name.samplerate

remoteContent/@audiosamplerate

 

renditions.name.aspectratio

remoteContent/@videoaspectratio

 

renditions.name.videoscaling

remoteContent/@videoscaling

 

renditions.name.resolution

-

 

renditions.name.colourspace

-

 

renditions.name.scene

-

 

renditions.name.backgroundcolor

-

 

renditions.name.words

remoteContent/@words

 

textformat

Legacy format codes not available. For agate (at / ax), use profile/name="agate".

 

links.rel:canonical

link/[@rel="aprel:canonical"]@href

 

-

expires

 

products.name

service