This section provides the details of the content markup properties for the `Movie` entity type. ## Specification table | Property | Expected Type | Description | |---|---|---| | `@context` | [Text](http://schema.org/Text) | **Required** - Always set to `["http://schema.org", {"@language": "xx"}]` - Where" xx" represents the language of the strings in the feed. Each root entity context should have its @language set to the appropriate language code in [BCP 47 format](http://tools.ietf.org/html/bcp47) format. For example, if the language is set to Spanish, the names are assumed to be in Spanish even if the subtitle/dub language is in English. | | `@type` | [Text](http://schema.org/Text) | **Required** - Always set to `Movie` for movies. | | `@id` | [URL](http://schema.org/URL) | **Required** - The content's identifier in URI format; for example, *https://example.com/1234abc* . `@id` must meet the following requirements: - Globally unique across your catalog - Static; The ID should be stable and not change over time (even if the url property of the show changes). It will be treated as an opaque string and does not have to be a working link. - In the form of Unified Resource Identifier (URI) - The domain used for the @id value must be owned by your organization. Because an entity's `url` meets all the requirements as an identifier, we recommend you use an entity's `url` as `@id`. See the [Identifier](https://developers.google.com/actions/media/collect-information/collect-the-id-url-and-name#identifier) section for more details. | | `url` | [URL](http://schema.org/URL) | **Required** - The content's [canonical URL](https://developers.google.com/actions/media/collect-information/collect-the-id-url-and-name#canonical_url), which Google uses to match the content in your feed to the content in Google's databases. `url` must meet the following requirements: - `url` must be globally unique - `url` must contain a working canonical URL that Google can crawl. For playback's [deep link](https://developers.google.com/actions/media/collect-information/identify-the-deep-links#deep_link), see the [target](https://developers.google.com/actions/media/reference/#target) object's `urlTemplate` property instead. | | `name` | [Text](http://schema.org/Text) | **Required** - The name of the movie. - Use an array to list the names in different languages. See the [Multiple regions and languages](https://developers.google.com/actions/media/reference/feed-examples/watch-actions-examples#multiple_regions_and_languages) example. - Note that only one name is supported per locale (language-country pair). | | `titleEIDR` | [Text](http://schema.org/Text) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** - An [EIDR](https://eidr.org) (Entertainment Identifier Registry) identifier representing at the most general/abstract level, a work of film or television. For example, titleEIDR for the motion picture known as "Ghostbusters" is "10.5240/7EC7-228A-510A-053E-CBB8-J". | | `editEIDR` | [Text](http://schema.org/Text) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** - An [EIDR](https://eidr.org) (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". `titleEIDR` property is *required* when editEIDR is provided. | | `potentialAction` | [WatchAction](http://schema.org/WatchAction) | **Required if applicable** - An [Action markup object](https://developers.google.com/actions/media/reference/#action_markup) that provides the [details](https://developers.google.com/actions/media/reference/data-specification/watch-actions-common-specification#action_markup_properties) of the action. - If the content is available on Video on Demand (VoD), this property is required; the Action markup object needs to provide the [deep link](https://developers.google.com/actions/media/collect-information/identify-the-deep-links#deep_link) of the content. - If the content is available on a LiveTV channel, this property is optional; the associated `BroadcastService` entity provides the deep link of the channel instead. - A `Movie` can be available on both VoD and LiveTV. Use an array to specify different deep links in multiple regions. See the [Multiple regions and languages](https://developers.google.com/actions/media/reference/feed-examples/watch-actions-examples#multiple_regions_and_languages) example. | | `sameAs` | [URL](http://schema.org/URL) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** A URL to a reference web page that can identify the movie; for example, the Wikipedia page of the movie. This must be distinct from the `url` property. | | `inLanguage` | [Text](http://schema.org/Text) | **Highly Recommended** Original language of the movie in [BCP 47](http://tools.ietf.org/html/bcp47) format. | | `genre` | [Text](http://schema.org/Text) | An ordered list of all relevant genres. For example : \["Action", "Fashion", "Environment", "Football"\] | | `keywords` | [Text](http://schema.org/Text) | Keywords or tags used to describe this content. An array of keywords is also allowed. For example, \["feature, biography"\] can be an array of keywords to describe the content. | | `releasedEvent` | [`PublicationEvent`](http://schema.org/PublicationEvent), `FeaturedEvent`, or `ExclusiveEvent` | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** - A `PublicationEvent` is used to specify the original (global or local) release of content by a publisher, such as the original theatrical release date of a movie. Additionally, use `FeaturedEvent` to indicate that your service markets this content as either an original, featured, special, and so forth. `ExclusiveEvent` specifies that your service has exclusive distribution rights and includes where and when. See the [example section](https://developers.google.com/actions/media/reference/feed-examples/watch-actions-examples#example-1) for details and examples. | | `releasedEvent.@type` | [Text](http://schema.org/Text) | **Required** - Be sure to always set this property to one of the following: - `PublicationEvent` - `ExclusiveEvent` - `FeaturedEvent` | | `releasedEvent.location` | [Country](http://schema.org/Country) | **Required** - The regions that are associated with this event. For a `PublicationEvent`, this is the region where the content was published. For `FeaturedEvent` and `ExclusiveEvent`, this is the region where the content is featured or exclusive. Use ISO 3166 codes for countries. To indicate everywhere in the world, set to `EARTH`. | | `releasedEvent.startDate` | [Date](https://schema.org/Date) or [DateTime](https://schema.org/DateTime) | **Recommended** - **Required for `ExclusiveEvent`** - The start date of the entity's publication. For a `PublicationEvent`, this denotes the initial release date of this entity, such as the date a movie was first released in theaters. For `ExclusiveEvent` and `FeaturedEvent`, this represents the start date of when the entity is exclusive or featured. | | `releasedEvent.endDate` | [Date](https://schema.org/Date) or [DateTime](https://schema.org/DateTime) | **Recommended** - **Required for `ExclusiveEvent`** - This is only applicable to the `ExclusiveEvent` and `FeaturedEvent` types. For `ExclusiveEvent`, this represents the date when the rights to the content expire. For `FeaturedEvent`, this represents the last date when the provider features the entity. If the content is perpetually exclusive or featured, set the `endDate` to 20 years from the current date. | | `releasedEvent.publishedBy` | [Organization](https://schema.org/Organization) or [Person](http://schema.org/Person) | **Optional** - The organization or person that published this entity. | | `description` | [Text](http://schema.org/Text) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** A synopsis of the movie. Plot synopses are preferred to factual summaries. 300-character limit. - Use an array to mark up the description in multiple languages. See the [Multiple regions and languages](https://developers.google.com/actions/media/reference/feed-examples/watch-actions-examples#multiple_regions_and_languages) example. | | `duration` | [Duration](http://schema.org/Duration) | Runtime of the movie in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601). Please use the format: "PT00H00M". | | `director` | [Person](http://schema.org/Person) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** The director(s) of the movie. | | `actor` | [Person](http://schema.org/Person) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** The cast member(s) of the movie. | | `producer` | [Organization](https://schema.org/Organization) or [Person](http://schema.org/Person) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** The producer(s) of the movie. | | `image` | [ImageObject](http://schema.org/ImageObject) | **Required for Google TV** - The images related to the Movie. For more details on the required and optional properties to include with `image`, see [Image properties](https://developers.google.com/actions/media/reference/data-specification/image-properties). | | `trailer.description` | [Text](http://schema.org/Text) | The description of the trailer. See the [Trailer](https://developers.google.com/actions/media/reference/feed-examples/watch-actions-examples#trailer) example. | | `trailer.inLanguage` | [Text](http://schema.org/Text) | **Highly Recommended** The language of the trailer in [BCP 47 format](http://tools.ietf.org/html/bcp47). | | `trailer.url` | [URL](http://schema.org/URL) | A URL of a trailer hosted publicly and uploaded by respective production studios or authorized sources. | | `trailer.regionsAllowed` | [Place](http://schema.org/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](https://en.wikipedia.org/wiki/ISO_3166). | | `identifier` | [PropertyValue](http://schema.org/PropertyValue) | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** - External or other ID that unambiguously identifies this entity. Multiple identifiers are allowed. See the [Identifier properties](https://developers.google.com/actions/media/reference/data-specification/watch-actions-common-specification#identifier_properties) section for details. | | `review` | [Review](http://schema.org/Review) | Review ratings for the Movie | | `review.reviewRating` | [Rating](http://schema.org/Rating) | **Required if review is provided.** This is used to specify the rating given in the review. | | `contentRating` | [Text](http://schema.org/Text) or [Rating](https://schema.org/Rating) | **Required for adult content, highly recommended otherwise [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** - Overall content rating. If the content rating is given in the form of a text string, two variations are accepted: - The rating agency prepended to the rating with a whitespace in between. For example, a "PG-13" rating from agency "MPAA" in the U.S. should be described as "MPAA PG-13". See the [list of agencies](https://developers.google.com/actions/media/reference/data-specification/watch-actions-common-specification#content_rating_agencies). - A value of "RATING NOT KNOWN" (case insensitive) to indicate you don't know the rating for the Movie. | | `contentRating.author` | [Organization](https://schema.org/Organization) | **Required if `contentRating` uses `Rating`** - The name of the rating agency. | | `contentRating.ratingValue` | [Text](http://schema.org/Text) | **Required if `contentRating` uses `Rating`** - The value of the rating. | | `contentRating.advisoryCode` | [Text](http://schema.org/Text) | The advisory code for the content. Accepted values include D, FV, L, S, and V. D = Dialogue, FV = Fantasy Violence , L = Language, S = Sexual Content, V = Violence. | | `popularityScore` | PopularityScoreSpecification | **Highly Recommended [Why?](https://developers.google.com/actions/media/collect-information/collect-the-metadata)** A score that Google uses, plus other signals, to determine which media to play for users. This score represents the popularity of the content in relation to other content in your catalog; therefore, the score's scale needs to be consistent across your feeds, among all the entities in your catalog. By default, an entity's popularity score is set to 0. | | `popularityScore.@type` | [Text](http://schema.org/Text) | Always set to `PopularityScoreSpecification`. | | `popularityScore.value` | [Number](http://schema.org/Number) | A non-negative numeric value that indicates the popularity of the entity; a higher score means higher popularity. | | `popularityScore.eligibleRegion` | [Country](http://schema.org/Country) | Region(s) where this popularity score is applicable. If the popularity score is globally applicable, set to `EARTH`. By default, this property is set to `EARTH`. `Note: `Locale-specific popularity takes precedence over global (EARTH) popularity | | `category` | [Text](http://schema.org/Text) | **Required if applicable** - Populate this property if the entity is a `Movie` variant. Set `category` to any of the following: - `Home Release`: A version sold or rented for home viewing. - `Theatrical Release`: A version released in theaters. - `International Release`: A version edited to release internationally. - `Remastered`: A version whose images, sound, or both are improved to a more up-to-date standard. - `Unrated`: A version that isn't screened by the MPAA or a similar agency. - `Director Cut`: A version that represents the director's own approved edit. - `Extended Cut`: A version that's longer than the theatrical release. | | `workExample` | [Movie](https://schema.org/Movie) | Specifies the variants of the film. Include this property in the main `Movie` entity, not the `Movie` entities for the variant versions. | | `workExample.@id` | [URL](https://schema.org/URL) | For `Movie` variants, this property provides the `@id` of the `Movie` entity that this is a variant of. | | `workExample.@type` | [Text](http://schema.org/Text) | **Required** - Always set to `Movie`. This can be represented as an array for a `Movie` with multiple variants. | | `workExample.@id` | [URL](https://schema.org/URL) | **Required** - The `@id` of the `Movie` variant. | | `workExample.name` | [Text](http://schema.org/Text) | **Required** - The name of the `Movie` variant. | | `workExample.category` | [Text](http://schema.org/Text) | **Required** - The type of film variant of a particular version. Set the category to any of the following: - `Home Release`: A version sold or rented for home viewing. - `Theatrical Release`: A version released in theaters. - `International Release`: A version edited to release internationally. - `Remastered`: A version whose images, sound, or both are improved to a more up-to-date standard. - `Unrated`: A version that isn't screened by the MPAA or a similar agency. - `Director Cut`: A version that represents the director's own approved edit. - `Extended Cut`: A version that's longer than the theatrical release. | ## Example ### Main movie A movie with an extended cut variant. { "@context": ["http://schema.org", {"@language": "en"}], "@type": "Movie", "@id": "http://www.example.com/my_favorite_movie", "url": "http://www.example.com/my_favorite_movie", "name": "My Favorite Movie", "potentialAction": { "@type": "WatchAction", "target": { "@type": "EntryPoint", "urlTemplate": "http://www.example.com/my_favorite_movie?autoplay=true", "inLanguage": "en", "actionPlatform": [ "http://schema.org/DesktopWebPlatform", "http://schema.org/MobileWebPlatform", "http://schema.org/AndroidPlatform", "http://schema.org/AndroidTVPlatform", "http://schema.org/IOSPlatform", "http://schema.googleapis.com/GoogleVideoCast" ] }, "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "availabilityStarts": "2018-07-21T10:35:29Z", "availabilityEnds": "2019-10-21T10:35:29Z", "requiresSubscription": { "@type": "MediaSubscription", "name": "Example Package", "commonTier": true, "@id": "https://example.com/package/example" }, "eligibleRegion": [ { "@type": "Country", "name": "US" }, { "@type": "Country", "name": "CA" } ] } }, "sameAs": "https://en.wikipedia.org/wiki/my_favorite_movie", "contentRating": "RATING NOT KNOWN", "releasedEvent": { "@type": "PublicationEvent", "startDate": "2008-01-20", "location": { "@type": "Country", "name": "US" } }, "popularityScore": { "@type": "PopularityScoreSpecification", "value": 78, "eligibleRegion": [ { "@type": "Country", "name": "US" }, { "@type": "Country", "name": "CA" } ] }, "description": "This is my favorite movie.", "actor": [ { "@type": "Person", "name": "John Doe", "sameAs": "https://en.wikipedia.org/wiki/John_Doe" }, { "@type": "Person", "name": "Jane Doe", "sameAs": "https://en.wikipedia.org/wiki/Jane_Doe" } ], "identifier": [ { "@type": "PropertyValue", "propertyID": "IMDB_ID", "value": "tt0123456" } ], "workExample": { "@type": "Movie", "@id": "http://www.example.com/my_favorite_movie_extended_cut", "name": "My Favorite Movie Extended Cut" "category": "Extended Cut" } } ### Extended cut variant The extended cut version of the main movie. { "@context": ["http://schema.org", {"@language": "en"}], "@type": "Movie", "@id": "http://www.example.com/my_favorite_movie_extended_cut", "url": "http://www.example.com/my_favorite_movie_extended_cut", "name": "My Favorite Movie Extended Cut", "potentialAction": { "@type": "WatchAction", "target": { "@type": "EntryPoint", "urlTemplate": "http://www.example.com/my_favorite_movie_extended_cut?autoplay=true", "inLanguage": "en", "actionPlatform": [ "http://schema.org/DesktopWebPlatform", "http://schema.org/MobileWebPlatform", "http://schema.org/AndroidPlatform", "http://schema.org/AndroidTVPlatform", "http://schema.org/IOSPlatform", "http://schema.googleapis.com/GoogleVideoCast" ] }, "actionAccessibilityRequirement": { "@type": "ActionAccessSpecification", "category": "subscription", "availabilityStarts": "2018-07-21T10:35:29Z", "availabilityEnds": "2019-10-21T10:35:29Z", "requiresSubscription": { "@type": "MediaSubscription", "name": "Example Package", "commonTier": true, "@id": "http://www.example.com/example_package", "identifier": "example.com:example_package" }, "eligibleRegion": [ { "@type": "Country", "name": "US" }, { "@type": "Country", "name": "CA" } ] } }, "sameAs": "https://en.wikipedia.org/wiki/my_favorite_movie_extended_cut", "contentRating": { "@type": "Rating", "author": "MPAA", "ratingValue": "R", "advisoryCode": "FV" }, "releasedEvent": { "@type": "PublicationEvent", "startDate": "2008-01-20", "location": { "@type": "Country", "name": "US" } }, "description": "This is the extended cut of my favorite movie.", "actor": [ { "@type": "Person", "name": "John Doe", "sameAs": "https://en.wikipedia.org/wiki/John_Doe" }, { "@type": "Person", "name": "Jane Doe", "sameAs": "https://en.wikipedia.org/wiki/Jane_Doe" } ], "identifier": [ { "@type": "PropertyValue", "propertyID": "IMDB_ID", "value": "tt0123456" } ], "exampleOfWork": { "@id": "http://www.example.com/my_favorite_movie", } "category": "Extended Cut" } ## Related pages Check out the following pages for the topics related to these properties: - [Identify the entity types of your content](https://developers.google.com/actions/media/collect-information/identify-the-entity-types) - [Collect the ID, URL, and name of your content](https://developers.google.com/actions/media/collect-information/collect-the-id-url-and-name) - [Collect the metadata of your content](https://developers.google.com/actions/media/collect-information/collect-the-metadata)