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.

 

 

 

 

JSON

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

- (see altId/[@type="ap:videoId"])

       

version

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

       

type

itemClass/@qcode

       

urgency

urgency

       

profile

profile

       

language

language/@tag

       

versioncreated

versionCreated

       

firstcreated

firstCreated

       

embargoed

embargoed

       

pubstatus

pubStatus/@qcode

       

editorialrole

role/name

       

fixture

instanceOf/@qcode

       

ednote

edNote

       

editorialtypes

role/name

       

signals

signal/@qcode

       

title

title

       

headline

headline

       

headline_extended

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

       

headline_seo

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

       

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/[@role="aprol:editor"]

       

located

dateline

       

datelinelocation

located

       

description_creditline

creditline

       

copyrightnotice

copyrightNotice

       

usageterms

usageTerms

       

keywords

keyword

       

outcue

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

       

provider

provider/name

       

infosource

infoSource

       

subject

subject[@type="cpnat:abstract"]

       

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:organisation"]

       

organisation.industries

-

       

organisation.symbols.ticker

-

       

organisation.symbols.exchange

-

       

organisation.symbols.instrument

-

       

place

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

       

event

-

       

audiences

audience/name

       

description_caption

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

       

description_editornotes

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

       

slugline

slugline

       

associations

link/[@rel="irel:associatedWith]

       

renditions.name.title

-

       

renditions.name.rel

remoteContent/@rendition

       

renditions.name.format

remoteContent/@format

       

renditions.name.type

- (use @contenttype)

       

renditions.name.digest

-

       

renditions.name.href

remoteContent/@href

       

renditions.name.orientation

remoteContent/@layoutorientation

       

renditions.name.mimetype

remoteContent/@contenttype

       

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.duid

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

       

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/@wordcount

       

renditions.name.pricetag

remoteContent/signal/[@type="ap:pricetag"]

       

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

       
 

 

 

 

 

If you still require additional assistance, please contact AP Customer Support.

For current system status or system maintenance information, please visit the AP Customer Zone website.

 

 

 

 

 

 

 

THE ASSOCIATED PRESS

© copyright 2025  Associated Press. All rights reserved.