Note: You are viewing the development version of Schema.org. See how we work for more details.

TextObject

A Schema.org Type
A text file. The text can be unformatted or contain markup, html, etc.
PropertyExpected TypeDescription
Properties from MediaObject
associatedArticle NewsArticle A NewsArticle associated with the Media Object.
bitrate Text The bitrate of the media object.
contentSize Text File size in (mega/kilo)bytes.
contentUrl URL Actual bytes of the media object, for example the image file or video file.
duration Duration  or
QuantitativeValue
The duration of the item (movie, audio recording, event, etc.) in ISO 8601 duration format.
embedUrl URL A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
encodesCreativeWork CreativeWork The CreativeWork encoded by this media object.
Inverse property: encoding
encodingFormat Text  or
URL
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.

In cases where a CreativeWork has several media type representations, encoding can be used to indicate each MediaObject alongside particular encodingFormat information.

Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. Supersedes fileFormat.
endTime DateTime  or
Time
The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.

Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
height Distance  or
QuantitativeValue
The height of the item.
ineligibleRegion GeoShape  or
Place  or
Text
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.

See also eligibleRegion.
interpretedAsClaim Claim Used to indicate a specific claim contained, implied, translated or refined from the content of a MediaObject or other CreativeWork. The interpreting party can be indicated using claimInterpreter.
playerType Text Player type required—for example, Flash or Silverlight.
productionCompany Organization The production company or studio responsible for the item, e.g. series, video game, episode etc.
regionsAllowed Place The regions where the media is allowed. If not specified, then it's assumed to be allowed everywhere. Specify the countries in ISO 3166 format.
requiresSubscription Boolean  or
MediaSubscription
Indicates if use of the media require a subscription (either paid or free). Allowed values are true or false (note that an earlier version had 'yes', 'no').
sha256 Text The SHA-2 SHA256 hash of the content of the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'.
startTime DateTime  or
Time
The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.

Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
uploadDate Date  or
DateTime
Date (including time if available) when this media object was uploaded to this site.
width Distance  or
QuantitativeValue
The width of the item.
Properties from CreativeWork
about Thing The subject matter of an object.
Inverse property: subjectOf
abstract Text An abstract is a short description that summarizes a CreativeWork.
accessMode Text The human sensory perceptual system or cognitive faculty through which a person may process or perceive the intellectual content of a resource, not including any adaptations of the content (e.g., text alternatives for images). Values should be drawn from the approved vocabulary.
accessModeSufficient ItemList A list of single or combined access modes that are sufficient to understand all the intellectual content of a resource, including any adaptations. Values should be drawn from the approved vocabulary.
accessibilityAPI Text Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the approved vocabulary.
accessibilityControl Text Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the approved vocabulary.
accessibilityFeature Text Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the approved vocabulary.
accessibilityHazard Text A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the approved vocabulary.
accessibilitySummary Text A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed".
accountablePerson Person Specifies the Person that is legally accountable for the CreativeWork.
acquireLicensePage CreativeWork  or
URL
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
aggregateRating AggregateRating The overall rating, based on a collection of reviews or ratings, of the item.
alternativeHeadline Text A secondary title of the CreativeWork.
archivedAt URL  or
WebPage
Indicates a page or other link involved in archival of a CreativeWork. In the case of MediaReview, the items in a MediaReviewItem may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
assesses DefinedTerm  or
Text
The item being described is intended to assess the competency or learning outcome defined by the referenced term.
associatedMedia MediaObject A media object that encodes this CreativeWork. This property is a synonym for encoding.
audience Audience An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.
audio AudioObject  or
Clip  or
MusicRecording
An embedded audio object.
author Organization  or
Person
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
award Text An award won by or for this item. Supersedes awards.
character Person Fictional person connected with a creative work.
citation CreativeWork  or
Text
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
comment Comment Comments, typically from users.
commentCount Integer The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
conditionsOfAccess Text Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an ArchiveComponent held by an ArchiveOrganization. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.

For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
contentLocation Place The location depicted or described in the content. For example, the location in a photograph or painting.
contentRating Rating  or
Text
Official rating of a piece of content—for example, 'MPAA PG-13'.
contentReferenceTime DateTime The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
contributor Organization  or
Person
A secondary contributor to the CreativeWork or Event.
copyrightHolder Organization  or
Person
The party holding the legal copyright to the CreativeWork.
copyrightNotice Text Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
copyrightYear Number The year during which the claimed copyright for the CreativeWork was first asserted.
correction CorrectionComment  or
Text  or
URL
Indicates a correction to a CreativeWork, either via a CorrectionComment, textually or in another document.
countryOfOrigin Country The country of origin of something, including products as well as creative works such as movie and TV content.

In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of CreativeWork it is difficult to provide fully general guidance, and properties such as contentLocation and locationCreated may be more applicable.

In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
creativeWorkStatus DefinedTerm  or
Text
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
creator Organization  or
Person
The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
creditText Text Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
dateCreated Date  or
DateTime
The date on which the CreativeWork was created or the item was added to a DataFeed.
dateModified Date  or
DateTime
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
datePublished Date  or
DateTime
Date of first publication or broadcast. For example the date a CreativeWork was broadcast or a Certification was issued.
digitalSourceType IPTCDigitalSourceEnumeration Indicates an IPTCDigitalSourceEnumeration code indicating the nature of the digital source(s) for some CreativeWork.
discussionUrl URL A link to the page containing the comments of the CreativeWork.
displayLocation Place The location at which an item can be viewed or experienced in-person.
editEIDR Text  or
URL
An EIDR (Entertainment Identifier Registry) identifier representing a specific edit / edition for a work of film or television.

For example, the motion picture known as "Ghostbusters" whose titleEIDR is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".

Since schema.org types like Movie and TVEpisode can be used for both works and their multiple expressions, it is possible to use titleEIDR alone (for a general description), or alongside editEIDR for a more edit-specific description.
editor Person Specifies the Person who edited the CreativeWork.
educationalAlignment AlignmentObject An alignment to an established educational framework.

This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource teaches or assesses a competency.
educationalLevel DefinedTerm  or
Text  or
URL
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
educationalUse DefinedTerm  or
Text
The purpose of a work in the context of education; for example, 'assignment', 'group work'.
encoding MediaObject A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. Supersedes encodings.
Inverse property: encodesCreativeWork
encodingFormat Text  or
URL
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.

In cases where a CreativeWork has several media type representations, encoding can be used to indicate each MediaObject alongside particular encodingFormat information.

Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. Supersedes fileFormat.