Content Metadata Fields

These content-specific data and metadata fields may be returned for a content item by the API or included in the metadata files downloaded by the agent in the format of your choice - JSON or XML in the NewsML-G2 format. The content item metadata in the JSON format is returned in the item property.

uri / guid

(May not be excluded) The globally unique identifier for this content item, expressed as a URI in JSON and as a string in NewsML-G2.

NewsML-G2 Example

altids

(May not be excluded) Alternative IDs of a content item:

• itemid (May not be excluded). A unique ID that remains the same throughout all revisions of the content item. For example, if a news story is written and rewritten several times as new information is uncovered, this ID value remains the same for each rewrite because it points to the chain of revised stories, and not an individual version. To learn more, see Managing Revisions and Duplicates.

• etag (May not be excluded). A unique token for each revision of a content item, which helps detect duplicates. To learn more, see Managing Revisions and Duplicates.

• friendlykey (May not be excluded). A human-readable ID of a content item, typically used for images. For video, videoid (see below) is typically used as a human-readable ID.

• referenceid. Contains the title value for text and the friendlykey value for images.

• videoid. A human-readable video ID (also known as story ID or AP Archive story number).

{// JSON Example: Text altids
 "altids": {
   "itemid": "c205823b75d33caab7589eee7544b2b3",
   "etag": "c205823b75d33caab7589eee7544b2b3_192a1aza0c0",
   "friendlykey": "6744964510462692",
   "referenceid": "VT Albany NY Zone Forecast"}

{// JSON Example: Picture altids
 "altids": {
   "itemid": "169bf4e1ed114d849bb4bc30b9377929",
   "etag": "169bf4e1ed114d849bb4bc30b9377929_0a1aza3c89898",
   "friendlykey": "18092593065168",
   "referenceid": "18092593065168"}

{// JSON Example: Video altids
 "altids": {
   "itemid": "efe60501a36428b35cd2ffe38e3e4568",
   "etag": "efe60501a36428b35cd2ffe38e3e4568_0a9aza8c88353",
   "friendlykey": "8946104261",
   "videoid": "nz004659"}

NewsML-G2 Example: Video altids

foreignkeys

(Not available in NewsML-G2) May contain one of the following:

• Third-party keys submitted to the AP by content providers; for example:
  
  memberentryid and membermanagementid. IDs submitted in an ATOM feed that meets AP specifications.
  
  {// JSON Example:
"foreignkeys": [
   {"memberentryid": "urn:publicid:localnewspaper.com:a1234b5678"},
   {"membermanagementid": "urn:publicid:localnewspaper.com:c9012d3456"}]}

• A human-readable story ID for audio and video (for video, this ID is the same as returned in altids.videoid).
  
  {// JSON Example:
"foreignkeys": [
   {"storyid": "apa009966"}]}

• MOS payload keys; for example:
  
  {// JSON Example:
"foreignkeys": [
   {"mospayloadstorynumber": "5206488"}]}

version / recordSequenceNumber

(Default) The content item version number: 0 for the initial version, 1 for the first version, 2 for the second version and so on. The higher the number, the more recent the content item's version.

• For text stories, this is the version of the story revision.

• For other media types (for example, pictures, graphics and video), this is the version of the item metadata; for example, an image caption. Typically, significant changes to the binary asset (such as a picture) are published as a new content item.

To learn more, see Managing Revisions and Duplicates.

{// JSON Example: 
"version": 0}

NewsML-G2 Example

type / itemClass

(Default) The generic news type of this content item: text, picture, graphic, audio or video.

{// JSON Example: 
"type": "video"}

NewsML-G2 Example

urgency

The editorial urgency of the content from 1 (the highest) to 8 (the lowest). For more information, see Urgency.

{// JSON Example: 
"urgency": 4}

NewsML-G2 Example

profile

The type of information contained in the news item (also known as 'Item Content Type'); for example, Spot Development, Advisory and Weather Forecast. Currently, content types are applied to text, audio and video news items. For a complete list of values, see Profile (Item Content Type).

{// JSON Example: 
"profile": "Spot Development"}

NewsML-G2 Example

language

The two-letter code of the language that the news item is written in; for example, en or es.

{// JSON Example: 
"language": "es"}

NewsML-G2 Example (text item):

NewsML-G2 Example (video or audio item)

versioncreated

(Default) The date and time when this version of the content item was published.

{// JSON Example: 
"versioncreated": "2020-08-15T21:35:17Z"}

NewsML-G2 Example

firstcreated

(Default) The date and time when the first version of the item was created.

• For pictures and video, this is the date and time when the content for the item was created. For example, a picture taken at a Sunday night game and published on Monday morning would carry the firstcreated value from Sunday, and the versioncreated value for the picture entry would be from Monday.

• For GraphicsBank items, this is the date of the news event that the graphic illustrates.

{// JSON Example: 
"firstcreated": "2020-08-15T21:25:39Z"}

NewsML-G2 Example

embargoed

(May not be excluded) The date and time before which all versions of the content item are embargoed (if absent, this item is not embargoed).

{// JSON Example: 
"embargoed": "2020-08-15T21:25:39Z"}

NewsML-G2 Example

pubstatus

(May not be excluded) The publishing status of the content item, which contains information regarding the item's ability to be distributed to news consumers. This value is usable by default.

• usable. This content item may be distributed to news consumers in publishing forms that do not violate your agreement with the AP and copyright information contained in the content item and its metadata.

• embargoed (the same as Hold-For-Release). Do not distribute an embargoed content item to news consumers until the release date-time found in embargoed has occurred.

• withheld. Do not distribute this content item to news consumers because it contains questionable information. Any distributed form of the content item must be recalled.

• canceled (the same as Kill). Do not distribute this content item to news consumers because it contains erroneous information. Any distributed form of the content item must be recalled.

{// JSON Example: 
"pubstatus": "usable"}

NewsML-G2 Example

editorialrole

The editorial role of a text or video content item.

For text, possible values are:

• NewsAlert. A first, headline-length look at a breaking story.

• FullStory. A full-length AP news story.

For video, possible values are:

• Package. A self-contained story with video and sound bites, including a prerecorded narration. AP provides packages with a script and the anchor narration on one channel and the natural sound and sound bites on a separate channel for the local station to rerecord the narration if necessary.

• VO. Video to be voiced over live by an anchor in a newscast (an edited section of natural sound video showing the best pictures).

• SOT. Sound on tape, with one or more sound bites edited together.

• VOSOT. Video to be voiced over live by an anchor in a newscast followed by a sound bite or multiple sound bites.

{// JSON Example: 
"editorialrole": "VOSOT"}

NewsML-G2 Example

fixture

Named sets of regularly occurring content or features with a predictable focus; for example, "Financial Markets," "Film Reviews," "10 Things to Know," "Sports Briefs." For more information, see a complete list of AP Fixtures.

• code. A code identifying the fixture.

• name. The fixture name.

{// JSON Example:
"fixture": {
  "code": "A60AC5A7AC024994B9102A73EFAB934A",
  "name": "Right Now"}

NewsML-G2 Example

ednote

(May not be excluded) Editorial instructions for processing the item. Do not distribute this information to news consumers.

{// JSON Example: 
"ednote": "Eds: With AP Photos."}

NewsML-G2 Example

editorialtypes

(May not be excluded) The editorial condition of the content item revision.

For text, possible values are:

• Advisory. Information intended for a person in a newsroom, not an end-customer, such as a news reader or viewer. Advisories are never to be published.

• HoldForRelease. Embargoed, paired with a date and time for release or publication to a customer, such as a news reader or viewer.

• Lead, appears as numbered Ld-Writethru in a Slug. An update that makes a change to any aspect of the text, including the headline, body and/or summary. A Lead-writethru may add information, recast information already published and make corrections to information published in error. Also done to indicate the addition or deletion of linked photos, videos or graphics.

• Corrective. Provides customers with a short, publishable story noting and correcting an error in a story published before the current 24-hour news cycle.

• Clarification. Provides customers with a short, publishable story clarifying information in a story published before the current 24-hour news cycle.

• Disregard. Points out material in the current cycle that has moved inadvertently and that may be confusing to newspaper editors. A story that duplicates substantial material in another is a candidate for a disregard.

• Kill. Kills are used to permanently remove from the wire material that is still "live," usually copy that has been transmitted in the current news cycle. They also advise AP members not to use stories at all in their publication or broadcasts. They may be used when the entire thrust of the story is found to be wrong, for potentially libelous stories and for other stories with particularly damaging errors. Unlike Correctives, Kills end the story chain and do not automatically repopulate automated websites with a Corrective version of a story.

For pictures, possible values are:

• Correction. An advisory that indicates that a correction has been made in the caption or other metadata for a photo. A corrected version follows this advisory very quickly.

• Kill. An advisory that indicates that a photo must be permanently removed from the wire.

For video, the only possible value is:

• Kill. An advisory that indicates that a video must be permanently removed from the wire.

{// JSON Example: 
"editorialtypes": ["Kill"]}

NewsML-G2 Example

signals

(May not be excluded) Machine-readable instructions for processing the content item:

• newscontent. Indicates that the content is publishable.

• APWhollyOwned. Indicates that all of the sources of the content item are AP wholly owned.

• explicitcontent (Currently used only for video) Indicates that the news item contains graphic content.

• test. Indicates test content.

• derived and derivedlatest. (For text stories only) Indicates that the story type is 'The Latest,' and that it was derived from a more traditionally written version of the story. To learn more, see The Latest - Developing Stories.

• isnotdigitized. (For video only) Indicates that a digital asset (for example, an archive video file) is not available for download.

• NewsroomReady. (For video only) "Newsroom Ready" is generally loosely-edited and unvoiced video, without graphics. Video can be customized by editing elements and even branded as your own.

• ConsumerReady. (For video only) "Consumer Ready" is fully-produced video with lower-third graphics, and often with reporter tracks. Video may not be edited.

• whitelisted. (For archive video only) Indicates that all of the sources for an archive video content item appear on the list of those that the AP can distribute without certain restrictions.

• singlesource. (For archive video only) Indicates that an archive video has only one source.

• DigitalCleared. (For video only) Indicates that the video content has been cleared for digital use.

• SocialCleared. (For video only) Indicates that the video content has been cleared for social media use.

{// JSON Example: 
"signals": [
  "NewsroomReady",
  "APWhollyOwned",
  "newscontent"]}

NewsML-G2 Example

title

A short publishable value containing the title of the current version of the content item.

{// JSON Example: 
"title": "France Royal Christmas Lights"}

NewsML-G2 Example

headline

(Default) A brief synopsis of the current version of the content item. For pictures, this field may contain the names of the people featured in the picture.

NewsML-G2 Example

headline_extended

Longer-form headline for the text story, typically the first sentence of the summary.

NewsML-G2 Example

headline_seo

Information describing what the text story is about using keywords that make it easily discoverable by search engines, increasing readership (up to 100 characters).

NewsML-G2 Example

description_summary

A single-paragraph story abstract, which encapsulates the story in about 100 words.

NewsML-G2 Example

bylines / creator

(Default) The party who created or contributed to the content (if available and not captured in the photographer or producer properties); for example, a writer (for text stories), an editor (for pictures) or a speaker (for audio). To learn more, see About Bylines.

• by. The name(s) of the content creator(s) and/or contributors.

• title. The title of the party referenced in the byline.

• parametric. Additional information about the creator's or contributor's role.

   

{// JSON Example: 
"bylines": [
 {"by": "By JOSH BOAK",
  "title": "AP Economics Writer"}]}

NewsML-G2 Examples

photographer / creator

A party who created the content of this item; for example, a photographer for pictures.

• code. A code identifying the photographer title.

• name. The photographer's name.

• title. The job title of the photographer.

{// JSON Example: 
"photographer": {
  "code": "CTR",
  "name": "John Milne/SilverHub/REX/Shutterstock",
  "title": "CONTRIBUTOR"}}

NewsML-G2 Example

producer / contributor

A party that created or enhanced the content of this item.

• name. The name of the content producer.

{// JSON Example: 
"producer": {
  "name": "mcrotty"}}

NewsML-G2 Example

located / dateline

The location where the news event or subject described or depicted by the content occurred; for example, the dateline for text stories and location line for video.

{// JSON Example: 
"located": "Paris"}

NewsML-G2 Examples

datelinelocation / located

(Default) Contains detailed, uniform and machine-usable metadata about the location where the news event or subject described or depicted by the content occurred.

• city. The location's city.

• countrycode. An abbreviated form of the location's country.

• countryname. The full name of the location's country.

• countryareacode. The location's country area. A country area is a large-scale division within a country; for example, a U.S. state or Canadian province.

• countryareaname. The full name of the location's country area. A country area is a large-scale division within a country; for example, a U.S. state or Canadian province.

• geometry_geojson. A GeoJson object holding geo data of this place.

  • coordinates. Longitude and latitude of the location.

  • type. Geometry type: Point.

{// JSON Example: 
"datelinelocation": {
  "city": "Washington",
  "countryareacode": "DC",
  "countryareaname": "District of Columbia",
  "countrycode": "USA",
  "countryname": "United States",
  "geometry_geojson": {
    "type": "Point",
    "coordinates": [
      -77.03637,
      38.89511]}}

NewsML-G2 Example

description_creditline

(May not be excluded) The party or parties that are credited with providing the content (a natural-language statement of credit information).

NewsML-G2 Example

copyrightnotice

(May not be excluded) Any necessary copyright notice for claiming the intellectual property for the content.

NewsML-G2 Example

usageterms

(May not be excluded) Rights information and usage limitations associated with the publication, including any special restrictions. Do not distribute this information to news consumers.

NewsML-G2 Examples

keywords

A displayable set of keywords relevant to a publication that can be used to expedite content searching in your own system.

{// JSON Example: 
"keywords": [
  "CROWN",
  "SERIES",
  "2",
  "WORLD",
  "PREMIERE",
  "ODEON",
  "LEICESTER",
  "SQUARE",
  "LONDON",
  "UK",
  "21",
  "NOV",
  "2017",
  "GILLIAN",
  "ANDERSON",
  "Actor",
  "Female",
  "Personality",
  "66289905"]}

NewsML-G2 Example

outcue

The last spoken words heard on the audio, used to help editors and news anchors construct program scripts and resume speaking after the broadcast of an audio file.

{// JSON Example: 
"outcue": "in local media"}

NewsML-G2 Example

provider

(May not be excluded) The name of the party (person or organization) that provided the content to the AP. This information may be different from the copyright and infosource.

{// JSON Example: 
"provider": "Europa Press"

NewsML-G2 Example

infosource

A party (person or organization) that originated, modified, enhanced, distributed, aggregated or supplied the content or provided some information used to create or enhance the content. This information may be different from the copyright and provider.

• name. The name of the infosource.

• type. The source party's type in AP systems.

{// JSON Example: 
"infosource": [
  {"name": "Europa Press",
   "type": "ThirdParty"}]}

NewsML-G2 Example

subject (including AP category code)

Concepts with a relationship to the content, such as topics, categories or subjects that describe the content, including:

• AP Category Codes, which are applied to text, pictures, graphics and video by AP editors (identified by "rels":"category" in JSON).

• AP Supplemental Categories, which are applied to pictures and graphics by AP editors (identified by "rels":"suppcategory" in JSON).

• AP Subject terms, which are applied by the AP Classification system and cover a wide variety of topics from broad categories like 'Education' to specific concepts like 'School curricula', breaking news events like 'Hurricane Maria' and recurring events like 'Academy Awards'. For a complete list of values, see AP Subject.

• creator. Indicates the origin of the subject/category tag: Editorial (assigned by an AP editor) or Machine (assigned by the AP Classification system).

• editorial_subject. The name of the AP-curated topic in AP Newsroom.

• code. The code for the standardized subject term in the AP controlled vocabulary (https://cv.ap.org/id/), the AP category or the AP supplemental category.

• scheme. The identifier of the AP controlled vocabulary.

• name. The name of the AP subject, AP category or AP supplemental category.

• parentids. (For archive content only) The IDs of broader terms, if available.

• rels. The relationship of the content of the news item to the subject.

  • direct. Indicates the AP Subject terms applied by the AP Classification system.

  • ancestor. (For archive content only) Indicates the AP Subject terms inferred from hierarchy. For instance, 'Events' is a broader subject for 'September 11 attacks.'

  • inferred. (For archive content only) Indicates the AP Subject terms inferred from relationships other than hierarchy, such as additional subject occurrences that are added based on entity or subject matches. For example, a match on 'September 11 attacks' ensures the application of the subject terms 'Terrorism' and 'War and unrest.'

  • category. Indicates AP category codes, which are applied to text, pictures, graphics and video by AP editors.

  • suppcategory. Indicates AP supplemental category codes, which are applied to pictures and graphics by AP editors.

• relevance. The relevance score of the term applied by the AP Classification system. Higher relevance scores indicate the most relevant terms. The maximum relevance score is 99. Relevance of 99 for an editorial subject indicates that it has been editorially selected as the primary subject for the story. You can use the relevance score to filter tags or sort stories in your systems.

• topparent. (For archive content only) The value of true indicates that this term is the top term in the AP Subject vocabulary hierarchy.

{// JSON Example: AP Category Code 
"subject": [
  {"rels": ["category"],
   "creator": "Editorial",
   "code": "e",
   "name": "Entertainment"}]}

{// JSON Example: AP Category and Supplemental Category Codes 
"subject": [
  {"rels": ["category"],
   "creator": "Editorial",
   "code": "A",
   "name": "Domestic News"},
  {"rels": ["suppcategory"],
   "creator": "Editorial",
   "code": "ENT",
   "name": "Entertainment"}}

{// JSON Example: Subject tags applied by an AP editor 
"subject": [
  {"creator": "Editorial",
   "editorial_subject": "Entertainment",
   "code": "16cb0ba3e6d24d97ace39f5a1924669a",
   "scheme": "https://cv.ap.org/id/",
   "name": "Entertainment",
   "rels": ["direct"],
   "relevance": 99},
  {"creator": "Editorial",
   "editorial_subject": "World News",
   "code": "bb2d2c5f441a452cb24bb511a2ab5eea",
   "scheme": "https://cv.ap.org/id/",
   "name": "World News",
   "rels": ["direct"],
   "relevance": 75},
  {"creator": "Editorial",
   "editorial_subject": "General News",
   "code": "f25af2d07e4e100484f5df092526b43e",
   "scheme": "https://cv.ap.org/id/",
   "name": "General News",
   "rels": ["direct"],
   "relevance": 50}]}

{// JSON Example: Subject tags applied by the AP Classification system 
"subject": [
  {"creator": "Machine",
   "code": "6c01c3e08c8010048288a13d9888b73e",
   "scheme": "https://cv.ap.org/id/",
   "name": "NBA basketball",
   "rels": ["direct"],
   "relevance": 74},
  {"creator": "Machine",
   "code": "1dc78fe87f15100488fbdf092526b43e",
   "scheme": "https://cv.ap.org/id/",
   "name": "Basketball",
   "rels": ["direct"],
   "relevance": 70}]}

NewsML-G2 Example: AP Category Code

NewsML-G2 Example: Subject tags applied by an AP editor

NewsML-G2 Example: Subject tags applied by the AP Classification system 

person

Individual human beings with a relationship to the content, such as named people mentioned in the content.

• types. The main category that applies to a named individual; for example, POLITICIAN, ROYALTY, PROFESSIONAL_ATHLETE. For a complete list of values, see Person Type.

• creator. Indicates the origin of the person tag: Editorial (assigned by an AP editor) or Machine (assigned by the AP Classification system).

• code. The code for the person in the AP controlled vocabulary (https://cv.ap.org/id/).

• scheme. The identifier of the AP controlled vocabulary.

• name. The name of a person.

• rels. The relationship(s) of the content of the news item to the person:

  • direct. Indicates that the term was applied directly by the AP Classification system (always true for persons).

  • person_featured. Indicates that this person is shown in the picture or video.

• teams. (For team athletes and coaches only) The team values and codes are available as part of the list of AP Organization terms.

  • code. The team code in the AP Organization vocabulary.

  • name. The team name.

• associatedevents. (Only for archive content and only for athletes and coaches participating in Olympic games or FIFA World Cup) Represents a relationship between a person and a current event, typically, the person's participation in or some significant contribution to the event; for example, a player's participation in 2018 FIFA World Cup. For more information, see Associated Event Name and Code Examples.

  • code. The code for the event in the AP controlled vocabulary.

  • name. The event name.

• relevance. The relevance score of the term applied by the AP Classification system. Higher relevance scores indicate the most relevant terms. The maximum relevance score is 99. You can use the relevance score to filter tags or sort stories in your systems.

NewsML-G2 Example

organisation

Organizations with a relationship to the content - administrative and functional structures that may act as a business, as a political party or not-for-profit party. Includes terms from AP Company (select publicly-traded and privately-held companies making the news) and AP Organization (organizations such as government and non-profit organizations, sports teams, colleges, political groups, cultural and media organizations). For more information, see a complete list of AP Organization terms.

• creator. Indicates the origin of the organization tag: Editorial (assigned by an AP editor) or Machine (assigned by the AP Classification system).

• code. The code for the organization in the AP controlled vocabulary (https://cv.ap.org/id/).

• scheme. The identifier of the AP controlled vocabulary.

• name. The name of the organization/company.

• parentids. (For archive content only) The IDs of broader terms, if available.

• rels. The relationship of the content of the news item to the organization.

  • direct. Indicates the terms applied by the AP Classification system. The relationship is always direct for public companies (AP Company terms).

  • ancestor. (For archive content only) Indicates the terms inferred from hierarchy. For instance, 'Organizations' is a broader term for 'Museum of Modern Art.'

  • inferred. (For archive content only) Indicates the terms inferred from relationships other than hierarchy, such as additional organization or subject occurrences that are added based on entity or subject matches. For example, a match on a sports team organization term 'Los Angeles Dodgers' ensures the application of the league organization term 'Major League Baseball' even if the 'Major League Baseball' tag application rule does not match the article. In another example, a national government 'Canada government' (organization term) ensures a match on its related concept 'Government and politics' (subject term) even if the 'Government and politics' rule does not match the article.

• topparent. (For archive content only) The value of true indicates that this term is the top term in the AP Organization vocabulary hierarchy.

• industries. The industries related to the company.

  • name. The industry name.

  • code. The code for the industry in the AP Subject vocabulary.

• symbols. Symbols used for a financial instrument linked to the company at a specific marketplace.

  • ticker. Ticker symbol used for the financial instrument.

  • exchange. Identifier for the marketplace which uses the ticker symbols of the ticker property. For a list of stock exchanges, see Stock Exchange Codes.

  • instrument. Combination of the company's ticker symbol and the stock exchange that it trades on, separated by a colon.

• relevance. The relevance score of the term applied by the AP Classification system. Higher relevance scores indicate the most relevant terms. The maximum relevance score is 99. You can use the relevance score to filter tags or sort stories in your systems.

JSON Example: Sports team

JSON Example: Public company

NewsML-G2 Example: Organization

NewsML-G2 Example: Public company

place

Named locations mentioned in the content, such as cities, U.S. states, Canadian provinces, Australian states and territories, countries, continents, points of interest and natural features; for example, lakes and mountain ranges. For more information, see a complete list of AP Geography terms.

• creator. Indicates the origin of the organization tag: Editorial (assigned by an AP editor) or Machine (assigned by the AP Classification system).

• code. The code for the place the AP controlled vocabulary (https://cv.ap.org/id/).

• scheme. The identifier of the AP controlled vocabulary.

• name. The name of the place.

• parentids. The IDs of broader terms, if available.

• parentnames. The names of broader terms, if available.

• rels. The relationship of the content of the news item to the place.

  • direct. Indicates the terms applied directly by the AP Classification system.

  • ancestor. (For archive content only) Indicates the terms inferred from hierarchy. For instance, 'North America' is a broader term for 'United States.'

• topparent. (For archive content only) The value of true indicates that this term is the top term in the AP Geography vocabulary hierarchy.

• locationtype. The generic type of a geographic entity; for example, City, Province, Continent. For a list of values, see Location Type.

  • code. The code for the location type in the AP vocabulary.

  • name. The location type name.

• geometry_geojson. A GeoJson object holding geo data of this place.

  • type. Geometry type: Point.

  • coordinates. Centroid coordinates - the WGS84 longitude and latitude of the location in decimal degrees.

• relevance. The relevance score of the term applied by the AP Classification system. Higher relevance scores indicate the most relevant terms. The maximum relevance score is 99. You can use the relevance score to filter tags or sort stories in your systems.

JSON Example

NewsML-G2 Example

event

(Not available in NewsML-G2) Something that happens in a planned or unplanned manner; for example, sports events or developing news events (such as The Latest).

• name. The event name.

• creator. Indicates the origin of the event tag.

• externaleventids. External IDs of the event.

  • code. The external code for the event.

  • creator. The source of the external code.

  • creatorcode. Combination of the external event code and its source, separated by a colon.

• eventproperties. Properties External event characteristics.

  • scheduleddatetime. The date and time when the event is scheduled to take place.

  • competitorname1 and competitorname2. Full names of the teams participating in the sports event.

  • competitorabbrv1 and competitorabbrv2. The abbreviations of the team names.

  • competitorqualifier1 and competitorqualifier2 Indicates whether the team is hosting the contest (Home) or visiting (Away).

  • seasonname. The name of the sports season during which the event is taking place.

  • tournamentname. The sports competition name.

  • venuename. The name of the venue where the sports event is taking place.

  • venuecapacity. The seating capacity: the number of people who can be seated in the venue.

{// JSON Example: Sports event 
"event": [
  {"name": "Buffalo Bills at Kansas City Chiefs 11/26/2017",
   "creator": "Machine",
   "externaleventids": [
     {"code": "57400",
      "creator": "sportradar",
      "creatorcode": "sportradar:57400"},
     {"code": "2017112603",
      "creator": "nfl",
      "creatorcode": "nfl:2017112603"}],
   "eventproperties": {
     "scheduleddatetime": "2017-11-26T18:00:00.000Z",
     "competitorname1": "Buffalo Bills",
     "competitorabbrv1": "BUF",
     "competitorqualifier1": "Away",
     "competitorname2": "Kansas City Chiefs",
     "competitorabbrv2": "KC",
     "competitorqualifier2": "Home",
     "seasonname": "NFL 2017 REG",
     "tournamentname": "Buffalo Bills at Kansas City Chiefs 11/26/2017",
     "venuename": "Arrowhead Stadium",
     "venuecapacity": "79451"}}]}

{// JSON Example: Developing news event 
"event": [
  {"creator": "Editorial",
   "code": "eb19f99cfbaa4fb280c4b3f7a37f8c51",
   "name": "Hawaii Volcano"}]}

audiences

An editorially selected designation of the audience (for example, geographical) who would have an interest in the content.

• code. The code for the audience in the AP vocabulary.

• name. The audience name.

• type. The audience type.

Possible values are:

{// JSON Example: 
"audiences": [
 {"code": "82c6a4c46fa0446090a7acaf93159e4c",
  "name": "Print",
  "type": "AUDPLATFORM"},
 {"code": "f5b16ea8760d10048047e6e7a0f4673e",
  "name": "State",
  "type": "AUDSCOPE"},
 {"code": "6e92d9b882c7100488e5df092526b43e",
  "name": "Texas",
  "type": "AUDGEOGRAPHY"}]}

NewsML-G2 Example

description_caption

(Default) A freeform textual description of the content item.

NewsML-G2 Example

description_editornotes

(May not be excluded) A section of text that is separate from the main story body, but is publishable. This field may appear in archive content.

NewsML-G2 Example

slugline

A non-publishable sequence of tokens associated with the content that is used as a short human-readable identifier for the content item and version.

{// JSON Example: 
"slugline": "BC-US--Julia Child Exhibit,1st Ld-Writethru"}

NewsML-G2 Example

NewsML-G2 Example for video

associations

(Default) Content of news items that are associated with this content item; for example, pictures and/or videos linked to a news story by AP editors or AP news stories that are part of AP Top Headlines. Each associated news item in the list of all news items associated with this content item is assigned a sequence number ("1", "2", "3" and so on). For example, if two pictures and two videos are associated with a news story (in that particular order), the "associationrank" will be "1" for the first picture, "2" for the second picture, "3" for the first video and "4" for the second video. The associated item properties include:

• uri. The URL for the associated news item.

• altids.itemid. The item ID of the associated news item.

• altids.etag. A unique token for each revision of the associated news item, which helps detect duplicates. To learn more, see Managing Revisions and Duplicates.

• version. The version number of the associated news item: 0 for the initial version, 1 for the first version, 2 for the second version and so on. The higher the number, the more recent the associated item's version.

• type. The media type of the associated news item: text, picture, graphic, audio or video.

• headline. A brief synopsis of the associated news item.

{// JSON Example: Linked pictures and video
 "associations": {
   "1": {
     "uri": "https://api.ap.org/media/v/content/605bc7b95a8444ea8385a80710c296fa",
     "altids": {
       "itemid": "605bc7b95a8444ea8385a80710c296fa",
       "etag": "8c18ca6515194932995dd2513c14753e_0a1aza3c0"},
     "version": 1,

     "type": "picture",
     "headline": "Homeless Crisis on the Coast The Numbers"},
   "2": {
     "uri": "https://api.ap.org/media/v/content/6f72550bf5ad4c9185fdcbddf64f191f",
     "altids": {
       "itemid": "6f72550bf5ad4c9185fdcbddf64f191f",
       "etag": "5b215d671eae4639908a01f08bdf67fc_0a1aza3c0"},
     "version": 1,

     "type": "picture",
     "headline": "Homeless Crisis on the Coast The Numbers"},
   "3": {
     "uri": "https://api.ap.org/media/v/content/319355dd8d764629abb1310bb410da0b",
       "altids": {"itemid": "319355dd8d764629abb1310bb410da0b",
       "etag": "c64b4c02accd4b81ad6aa695d31e341c_0a1aza3c0"},
     "version": 0,

     "type": "video",
     "headline": "US Homeless Count Rises, Pushed by West Coast"}}}

{// JSON Example: AP Top Headlines
 "associations": {
   "1": {
     "uri": "https://api.ap.org/media/v/content/b0d74bcf0ed146a2b681f6431d99789d",
     "altids": {
       "itemid": "b0d74bcf0ed146a2b681f6431d99789d",
       "etag": "8c18ca6515194932995dd2513c14753e_0a1aza3c0"},
     "version": 2,

     "type": "text",
     "headline": "UK hails new royal couple as country awaits wedding details"},
   "2": {
     "uri": "https://api.ap.org/media/v/content/aef7a9d725844217befd8070e3f384a2",
     "altids": {
       "itemid": "aef7a9d725844217befd8070e3f384a2",
       "etag": "5b215d671eae4639908a01f08bdf67fc_0a1aza3c0"},
     "version": 0,

     "type": "text",
     "headline": "UN: About 11 percent of drugs in poor countries are fake"},
   "3": {
     "uri": "https://api.ap.org/media/v/content/7d9b39c6a4444a3bb7bd8a433cca2cf5",
     "altids": {
       "itemid": "7d9b39c6a4444a3bb7bd8a433cca2cf5",
       "etag": "54c8d629d7e7405697af9a7ea13ad95c_0a1aza3c0"},
     "version": 0,

     "type": "text",
     "headline": "Russian weather satellite fails to enter orbit after launch"}}}

NewsML-G2 Example: Linked media

renditions / remoteContent

(Default) Wrapper for different renditions of the content item.

Each rendition (for example, Main, Preview, Thumbnail, Caption, Script, Shotlist) contains the following optional properties:

• title. The title of the content item rendition that can be used for posting on a website.

{// JSON Example:  
"title": "Full Resolution (MPG 720x576)"}
  NewsML-G2 examples are available at the end of renditions / remoteContent description.

• rel. The content item rendition; for example, Main, Preview, Thumbnail and Caption for images; and Main, Preview, Thumbnail, Caption, Script and/or Shotlist for video.

{// JSON Example:
"rel": "Main"}

• format. A format that applies to the rendition.
  
{// JSON Example:
"format": "MPEG"}

• type. The media type of the rendition: text, picture, graphic, audio or video.

{// JSON Example:  
"type": "video"}

• words / wordcount. Approximate number of words in the textual content; used only for text stories.

{// JSON Example:  
"words": 336}

• contentid. A code used to identify the content item rendition.

   

{// JSON Example: 
"contentid": "305154376f4048089df0cdd5f8ccfeaa"}

• digest. A short digest (also known as checksum or hash) of the rendition data (if available).

{// JSON Example:  
"digest": "7fe2d3d837069b2badf10bb3f8060710"}

• href. The URL for accessing the rendition as a resource.

{// JSON Example:
"href": "https://api.ap.org/media/v/content/1e3274d7fc7cf4b4a50793579ed18e12/download"}

• orientation. (For images only) The image orientation, which indicates whether the human interpretation of the top of the image is aligned to its short side (vertical) or long side (horizontal).

  • Horizontal (landscape images)
  • Vertical (portrait images)

  {// JSON Example:  
"orientation": "Vertical"}

• mimetype. A MIME type that applies to the rendition.
  
{// JSON Example:  
"mimetype": "video/mpeg"}

• fileextension. The file extension of the content item.
  
{// JSON Example:  
"fileextension": "mpg"}

• sizeinbytes. The size of the rendition resource in bytes.

{// JSON Example:  
"sizeinbytes": 125798400}

• width. For still and moving images: the width of the display area measured in pixels.

{// JSON Example:  
"width": 720}

• height. For still and moving images: the height of the display area measured in pixels.

{// JSON Example:  
"height": 576}

• originalfilename. The name of the original media file.

{// JSON Example:  
"originalfilename": "5218545_Olympics Usmanov_0_NTSCESSENCE--83b64.mpg"}

• duration. The total time duration of the content (in milliseconds for video; in seconds for audio).

{// JSON Example:  
"duration": 135800}

• videocodec. The video encoding system used to create the content.

{// JSON Example:  
"videocodec": "MPEG"}

• framerate. The number of video frames per second, which is the rate at which the material should be shown in order to achieve the intended visual effect.

{// JSON Example:  
"framerate": 25}

• averagebitrate. The average amount of data that is transferred per second in the audio or video content.

{// JSON Example:  
"averagebitrate": "6144.000000"}

• samplerate. The number of audio samples per second in the audio or video content, expressed as audio sampling frequency in hertz (Hz).

{// JSON Example:  
"samplerate": "25.000000"}

• aspectratio. Aspect ratio of the video file, which is the ratio of the width of video to its height, such as 16:9 and 4:3.
  
{// JSON Example:  
"aspectratio": "16:9"}

• videoscaling. Video scaling, which describes how the aspect ratio of a video has been changed from the original in order to accommodate a different display dimension:

  • pillarboxed. Bars to the left and right.

  • letterboxed. Bars to the top and bottom.

  • mixed. Two or more different aspect ratios are used in the video over the timeline.

  • original. No scaling has been applied.

  {// JSON Example:  
"videoscaling": "original"}

• resolution. The recording or image resolution of the content (if available):

  • For images: the recommended printing resolution in dots per inch.

  • For video: the number of distinct pixels in each dimension.

  • For audio: the recording resolution in bits per sample.

  {// JSON Example:  
"resolution": 16}

• colourspace. The color space of video or pictures (for example; Color or Black and White), if available.
  
{// JSON Example:  
"colourspace": "Color"}

• scene. Description of recording scene; used only for images.

{// JSON Example:  
"scene": "Drawing"}

• backgroundcolor. Image background color; typically used for graphics.

{// JSON Example:  
"backgroundcolour": "on gray"}

• duid. (Not available in NewsML-G2) A descriptive tag that ties together the important rendition characteristics.
  
  {// JSON Example:  
"duid": "vid-1080i-main-50-slate"}

• priced.  The value of "true" indicates that downloading the rendition incurs a charge specified in the "pricetag" value (see below). If the "priced" property is not present in JSON, the rendition download does not result in a charge.

   

• pricetag. Indicates one of the following:

  • For downloads incurring a charge ("priced": "true" in JSON), describes the nature of the charge; for example, "USD:15.00" for a charge in actual currency or "MeterTick:1" for a charge in virtual currency.

  • For the main rendition downloads not resulting in a charge (the "priced" property is not present in JSON), indicates the type of the subscription; for example, "Unlimited" for a subscription with unlimited downloads.

  • For renditions that are not available for download (the "priced" property and the "href" download link are not present), indicates that the download is unavailable.

NewsML-G2 Example: Text rendition

NewsML-G2 Example: Picture rendition

NewsML-G2 Example: Video renditions

To learn more about renditions and view additional examples, see Content Item Formats and Renditions.

textformat

(For text stories only, not available in NewsML-G2) Two-letter filing format code indicating the type of text set:

• bt. Body type with one or more tabular lines.

• at. Agate type with one or more tabular lines.

• ax. Agate type with no tabular lines.

• bx. Body type or standard text.

{// JSON Example: 
"textformat": "bx"}

links

Contains external links; such as canonical links to full stories in AP News Archive. You can use canonical links to redirect web users to AP News Archive after your right to host AP content on websites expires at 30 days.

• href. The URL for accessing the external content.

• rel. The type of link to external content; for example, canonical.

{// JSON Example: 
"links": [
  {"href": "https://apnews.com/6d43bc91a1c44783878c7fdf85b58b49",
   "rel": "canonical"}]}

NewsML-G2 Example

<link rel="aprel:canonical" href="https://apnews.com/6d43bc91a1c44783878c7fdf85b58b49"/>