You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Plex-Meta-Manager/docs/metadata/details/metadata.md

27 KiB

Metadata Details

Collection/Playlist Details

All the following attributes update various details of the collection/playlist's Metadata.

Only tmdb_person works with Playlists.

Attribute Description & Values
tmdb_person Description: Changes summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in Plex Searches.
Values: TMDb Person ID (List or Comma-separated string)
sort_title Description: Changes the sort title.
You can "promote" certain collections to the top of a library by creating a sort title starting with a + or "demote" certain collections to the bottom of a library by creating a sort title starting with a ~.
Values: Text to change Sort Title
content_rating Description: Changes the content rating.
Values: Text to change Content Rating
label Description: Appends new labels.
Values: Comma-separated string of labels to append
label.remove Description: Removes existing labels from the collection.
Values: Comma-separated string of labels to remove
label.sync Description: Matches the labels of the collection to the labels provided (Leave blank to remove all labels)
Values: Comma-separated string of labels to sync
collection_mode Description: Changes the Collection Mode
Normal Collections Only
Values:
defaultLibrary default
hideHide Collection
hide_itemsHide Items in this Collection
show_itemsShow this Collection and its Items
collection_order Description: Changes the Collection Order
Normal Collections Only
When using custom you can only have a single builder in the collection.
Values:
releaseOrder Collection by Release Dates
alphaOrder Collection Alphabetically
customOrder Collection Via the Builder Order
Any plex_search Sort OptionOrder Collection by any plex_search Sort Option
collection_filtering Description: Changes the Collection Filtering
Smart Collections Only
Values:
adminAlways the server admin user
userUser currently viewing the content
collection_level Description: Make season, episode, album or track collections from plex_all, plex_search, trakt_list, or imdb_list Builders and Filters
Values:
seasonCollection contains seasons
episodeCollection contains episodes
albumCollection contains albums
trackCollection contains tracks
visible_library Description: Changes collection visible on Library (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_home Description: Changes collection visible on Home (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_shared Description: Changes collection visible on Shared Users' Home (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
url_theme Description: Changes the Collection Theme to the URL provided.
Values: URL to mp3 file
file_theme Description: Changes the Collection Theme to the file location provided.
Values: Path to mp3 file
  • Here's an example of how the collections can look on the Home Page.

Pinned Collections Example

Display

Item Metadata Details

All the following attributes update various details of the metadata for every item in the collection.

None of these details work with Playlists.

Attribute Description & Values
item_label Description: Appends new labels to every movie/show in the collection
Values: Comma-separated string of labels to append
item_label.remove Description: Removes existing labels from every movie/show in the collection
Values: Comma-separated string of labels to remove
item_label.sync Description: Matches the labels of every movie/show in the collection to the labels provided (Leave blank to remove all labels)
Values: Comma-separated string of labels to sync
non_item_remove_label Description: Matches every movie/show that has the given label and is not in the collection and removes the label
Values: Comma-separated string of labels to remove
item_lock_poster Description: Locks/Unlocks the poster of every movie/show in the collection
Default: None
Values:
trueLock
falseUnlock
item_lock_background Description: Locks/Unlocks the background of every movie/show in the collection
Default: None
Values:
trueLock
falseUnlock
item_lock_title Description: Locks/Unlocks the title of every movie/show in the collection
Default: None
Values:
trueLock
falseUnlock
item_refresh Description: Refreshes the metadata of every movie/show in the collection
Default: false
Values: true or false
item_refresh_delay Description: Amount of time to wait between each item_refresh of every movie/show in the collection
Default: 0
Values: Number greater then 0
item_tmdb_season_titles Description: Changes the season titles of every show in the collection to match TMDb
Default: false
Values: true or false
item_episode_sorting1 Description: Changes the episode sorting of every show in the collection
Values:
defaultLibrary default
oldestOldest first
newestNewest first
item_keep_episodes1 Description: Changes the keep episodes of every show in the collection
Values:
allAll episodes
5_latest5 latest episodes
3_latest3 latest episodes
latestLatest episodes
past_3Episodes added in the past 3 days
past_7Episodes added in the past 7 days
past_30Episodes added in the past 30 days
item_delete_episodes1 Description: Changes the delete episodes of every show in the collection
Values:
neverNever
dayAfter a day
weekAfter a week
refreshOn next refresh
item_season_display1 Description: Changes the season display of every show in the collection
Values:
defaultLibrary default
showShow
hideHide
item_episode_ordering1 Description: Changes the episode ordering of every show in the collection
Values:
defaultLibrary default
tmdb_airedThe Movie Database (Aired)
tvdb_airedTheTVDb (Aired)
tvdb_dvdTheTVDb (DVD)
tvdb_absoluteTheTVDb (Absolute)
item_metadata_language2 Description: Changes the metadata language of every movie/show in the collection
Values: 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
item_use_original_title2 Description: Changes the use original title of every movie/show in the collection
Values:
defaultLibrary default
noNo
yesYes

1 Only works with TV Show Libraries

2 Must be using the New Plex Movie Agent or the New Plex TV Agent

Summary Details

All the following attributes update the summary of the collection/playlist from various sources.

All of these details work with Playlists.

Attribute Description & Values
summary Description: Changes summary to the Text Provided
Values: Text to change Summary
tmdb_summary Description: Changes summary to the TMDb Movie/Collection summary for a movie library or the TMDb Show summary for a show library
Values: TMDb Movie/Show/Collection ID
tmdb_description Description: Changes summary to the TMDb List Description
Values: TMDb List ID
tmdb_biography Description: Changes summary to the TMDb Person's biography
Values: TMDb Person ID
tvdb_summary Description: Changes summary to the TVDb Movie summary for a movie library or the TVDb Show summary for a show library
Values: TVDb Movie/Show ID or URL
tvdb_description Description: Changes summary to the TVDb List Description
Values: TVDb List URL
trakt_description Description: Changes summary to the Trakt List Description
Values: Trakt List URL
letterboxd_description Description: Changes summary to the Letterboxd List Description
Values: Letterboxd List URL

Poster Details

All the following attributes update the poster of the collection/playlist from various sources.

All of these details work with Playlists.

If no poster is specified the script will look in the library's Image Asset Directories for a folder named either the collection/playlist name or the name_mapping if specified and look for a poster.ext file in that folder (replacing .ext with the image extension).

Attribute Description & Values
url_poster Description: Changes poster to the URL
Values: URL of image publicly available on the internet
tmdb_poster Description: Changes poster to the TMDb Movie/Collection poster for a movie library or the TMDb Show poster for a show library
Values: TMDb Movie/Show/Collection ID
tmdb_list_poster Description: Changes poster to the TMDb List poster
Values: TMDb List ID
tmdb_profile Description: Changes poster to the TMDb Person's profile
Values: TMDb Person ID
tvdb_poster Description: Changes poster to the TVDb Movie poster for a movie library or the TVDb Show poster for a show library
Values: TVDb Movie/Show ID or URL
file_poster Description: Changes poster to the image in the file system
Values: Path to image in the file system

Background Details

All the following attributes update the background of the collection/playlist from various sources.

All of these details work with Playlists.

If no background is specified the script will look in the library's Image Asset Directories for a folder named either the collection/playlist name or the name_mapping if specified and look for a background.ext file in that folder (replacing .ext with the image extension).

Attribute Description & Values
url_background Description: Changes background to the URL
Values: URL of image publicly available on the internet
tmdb_background Description: Changes background to the TMDb Movie/Collection background for a movie library or the TMDb Show background for a show library
Values: TMDb Movie/Show/Collection ID
tvdb_background Description: Changes background to the TVDb Movie background for a movie library or the TVDb Show background for a show library
Values: TVDb Movie/Show ID or URL
file_background Description: Changes background to the image in the file system
Values: Path to image in the file system