Plex-Meta-Manager/docs/metadata/metadata/show.md

TV Show Library Metadata

You can have the script edit the metadata of Shows, Seasons, and Episodes by adding them to the metadata mapping of a Metadata File.

An example of multiple metadata edits in a show library is below:

metadata:
  "Avatar: The Last Airbender":
    sort_title: Avatar 01
    seasons:
      1:
        title: "Book One: Water"
        summary: >-
              After a lapse of 100 years, the Avatar-spiritual master of the elements-has returned. And just in
              the nick of time. The Four Nations (Water, Earth, Fire, and Air) have become unbalanced. The Fire
              Nation wants to rule the world, and its first conquest will be the Northern Water Tribe. It's up to
              a 12-year-old Airbender named Aang to find a way to stop it. Join Aang, Katara, Sokka, Momo, and
              Appa as they head north on the adventure of a lifetime.              
        episodes:
          1:
            user_rating: 9.1
      2:
        title: "Book Two: Earth"
        summary: >-
              Avatar Aang continues his quest to master the four elements before the end of summer. Together with
              Katara, Sokka, Momo, and Appa, he journeys across the Earth Kingdom in search of an Earthbending
              mentor. Along the way, he confronts Princess Azula, treacherous  daughter of Firelord Ozai and
              sister to Prince Zuko. More powerful than her brother, Azula will stop nothing to defeat the Avatar.
              But Aang and the gang find plenty of Earth Kingdom allies to help them along the way. From the swamps
              of the South to the Earth King's palace, Avatar: Book 2 is an adventure like no other.              
      3:
        title: "Book Three: Fire"
        summary: >-
              Having survived the terrible battle with Azula, Aang faces new challenges as he and his brave
              friends secretly enter the Fire Nation. Their quest is to find and defeat Firelord Ozai. Along
              the way, they discover that Ozai has plans of his own. The leader of the Fire Nation intends to
              use the massive power of Sozin's comet to spread his dominion permanently across the four nations.
              Short on time, Aang has a lot of bending to learn and no master to help him learn it. However, his
              friends are there to help, and he finds unexpected allies deep in the heart of the Fire Nation. In
              the spectacular four-part conclusion, Aang must fulfill his destiny and become a fully realized
              Avatar, or watch the world go up in smoke.              
        episodes:
          21:
            summary: The Epic Series Final of Avatar The Last Airbender
  "Avatar: The Legend of Korra":
    sort_title: Avatar 02
    alt_title: The Legend of Korra
    original_title: The Legend of Korra
    seasons:
      1:
        title: "Book One: Air"
      2:
        title: "Book Two: Spirits"
      3:
        title: "Book Three: Change"
      4:
        title: "Book Four: Balance"

Shows

Each show is defined by the mapping name which must be the same as the show name in the library unless an alt_title is specified.

Seasons

To edit the metadata of a particular Season in a Show use the seasons attribute on its show.

The mapping name is the season number (use 0 for specials) or the season name.

Episodes

To edit the metadata of a particular Episode in a Season use the episodes attribute on its season.

The mapping name is the episode number in that season or the title of the episode.

Metadata Edits

The available attributes for editing shows, seasons, and episodes are as follows

Special Attributes

Attribute	Values	Shows	Seasons	Episodes
title	Title if different from the mapping value useful when you have multiple shows with the same name. See the Metadata Page for how searching for files works.	✅	✅	✅
alt_title	Alternative title to look for and then change to the mapping name. See the Metadata Page for how searching for files works.	✅	❌	❌
year	Year of show for better identification. See the Metadata Page for how searching for files works.	✅	❌	❌
tmdb_show	TMDb Show ID to use for metadata useful for miniseries that have been compiled into a movie	✅	❌	❌
tmdb_movie	TMDb Movie ID to use for metadata useful for movies that have been split into segments	✅	❌	❌
f1_season	F1 Season Year to make the Show represent a Season of F1 Races. See Formula 1 Metadata Guide for more information.	✅	❌	❌
round_prefix	Used only with f1_season to add the round as a prefix to the Season (Race) Titles i.e. Australian Grand Prix --> 01 - Australian Grand Prix	✅	❌	❌
shorten_gp	Used only with f1_season to shorten Grand Prix to GP in the Season (Race) Titles i.e. Australian Grand Prix --> Australian GP	✅	❌	❌
seasons	Mapping to define Seasons	✅	❌	❌
episodes	Mapping to define Episodes	❌	✅	❌

General Attributes

Attribute	Values	Shows	Seasons	Episodes
title	Text to change Title	❌	✅	✅
sort_title	Text to change Sort Title	✅	❌	✅
original_title	Text to change Original Title	✅	❌	✅
originally_available	Date to change Originally Available Format: YYYY-MM-DD	✅	❌	✅
content_rating	Text to change Content Rating	✅	❌	❌
user_rating	Number to change User Rating	✅	✅	✅
audience_rating	Number to change Audience Rating	✅	❌	✅
critic_rating	Number to change Critic Rating	✅	❌	✅
studio	Text to change Studio	✅	❌	❌
tagline	Text to change Tagline	✅	❌	❌
summary	Text to change Summary	✅	✅	✅

Tag Attributes

You can add .remove to any tag attribute to only remove those tags i.e. genre.remove.

You can add .sync to any tag attribute to sync all tags vs just appending the new ones i.e. genre.sync.

Attribute	Values	Shows	Seasons	Episodes
director	List or comma-separated text of each Director Tag	❌	❌	✅
genre	List or comma-separated text of each Genre Tag	✅	❌	❌
writer	List or comma-separated text of each Writer Tag	❌	❌	✅
collection	List or comma-separated text of each Collection Tag	✅	❌	❌
label	List or comma-separated text of each Label Tag	✅	❌	❌

Image Attributes

Attribute	Values	Shows	Seasons	Episodes
url_poster	URL of image publicly available on the internet	✅	✅	✅
file_poster	Path to image in the file system	✅	✅	✅
url_background	URL of image publicly available on the internet	✅	✅	❌
file_background	Path to image in the file system	✅	✅	❌

Advanced Attributes

All these attributes only work with Shows.

Attribute	Values
episode_sorting	default Library default oldest Oldest first newest Newest first
keep_episodes	all All episodes 5_latest 5 latest episodes 3_latest 3 latest episodes latest Latest episodes past_3 Episodes added in the past 3 days past_7 Episodes added in the past 7 days past_30 Episodes added in the past 30 days
delete_episodes	never Never day After a day week After a week refresh On next refresh
season_display	default Library default show Show hide Hide
episode_ordering	default Library default tmdb_aired The Movie Database (Aired) tvdb_aired TheTVDb (Aired) tvdb_dvd TheTVDb (DVD) tvdb_absolute TheTVDb (Absolute)
metadata_language1	default, ar-SA, ca-ES, cs-CZ, da-DK, de-DE, el-GR, en-AU, en-CA, en-GB, en-US, es-ES, es-MX, et-EE, fa-IR, fi-FI, fr-CA, fr-FR, he-IL, hi-IN, hu-HU, id-ID, it-IT, ja-JP, ko-KR, lt-LT, lv-LV, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-HK, zh-TW
use_original_title1	default Library default no No yes Yes

¹ Must be using the New Plex TV Agent