4 Metadata Details

meisnate12 edited this page 2 years ago

Metadata Details

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

Name	Attribute	Description	Allowed Values	Works with Playlists
TMDb Person	tmdb_person	Used to change the collection/playlist's summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in Plex Searches	TMDb Person ID (List or Comma-separated string)	✔️
Sort Title	sort_title	Used to change the collection's sort title	Text to change Sort Title	❌
Content Rating	content_rating	Used to change the collection's content rating	Text to change Content Rating	❌
Label	label	Used to append new labels to the collection	Comma-separated string of labels to append	❌
Label Remove	label.remove	Used to remove existing labels from the collection	Comma-separated string of labels to remove	❌
Label Sync	label.sync	Matches the labels of the collection to the labels provided (Leave blank to remove all labels)	Comma-separated string of labels to sync	❌
Collection Mode	collection_mode	Used to change the Collection Mode	default: Library default hide: Hide Collection hide_items: Hide Items in this Collection show_items: Show this Collection and its Items	❌
Collection Order	collection_order	Used to change the Collection Order	release: Order Collection by Release Dates alpha: Order Collection Alphabetically custom: Order Collection Via the Builder Order Any plex_search Sort Option	✔️
Collection Level	collection_level	Used to make season, episode, album or track collections from plex_all, plex_search, trakt_list, or imdb_list Builders and Filters	season: Collection contains seasons episode: Collection contains episodes album: Collection contains albums track: Collection contains tracks	❌
Visible on Library	visible_library	Used to change collection visible on Library (Only works with Plex Pass)	true: Visible false: Not Visible Any schedule	❌
Visible on Home	visible_home	Used to change collection visible on Home (Only works with Plex Pass)	true: Visible false: Not Visible Any schedule	❌
Visible on Shared	visible_shared	Used to change collection visible on Shared Users' Home (Only works with Plex Pass)	true: Visible false: Not Visible Any schedule	❌

• Sort Title: You can use sort_title to "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 ~.

• Custom Collection Order: When using collection_order: custom you can only have a single builder in the collection.

• Here's an example of how the collections can look on the Home Page.

Item Metadata Details

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

Name	Attribute	Description	Allowed Values	Works with Movies	Works with Shows	Works with Playlists
Label	item_label	Used to append new labels to every movie/show in the collection	Comma-separated string of labels to append	✔️	✔️	❌
Label Remove	item_label.remove	Used to remove existing labels from every movie/show in the collection	Comma-separated string of labels to remove	✔️	✔️	❌
Label Sync	item_label.sync	Matches the labels of every movie/show in the collection to the labels provided (Leave blank to remove all labels)	Comma-separated string of labels to sync	✔️	✔️	❌
Non Item Label Remove	non_item_remove_label	Matches every movie/show that has the given label and is not in the collection and removes the label	Comma-separated string of labels to remove	✔️	✔️	❌
Lock Posters	item_lock_poster	Locks the poster of every movie/show in the collection	true or false Default: false	✔️	✔️	❌
Lock Backgrounds	item_lock_background	Locks the background of every movie/show in the collection	true or false Default: false	✔️	✔️	❌
Lock Titles	item_lock_title	Locks the title of every movie/show in the collection	true or false Default: false	✔️	✔️	❌
Image Overlay	item_overlay	Adds and overlay image to the poster of every movie/show in the collection	item_overlay details	✔️	✔️	❌
Check For Assets	item_assets	Checks your assets folders for assets of every movie/show in the collection	true or false Default: false	✔️	✔️	❌
Refresh Item	item_refresh	Refreshes the metadata of every movie/show in the collection	true or false Default: false	✔️	✔️	❌
Refresh Item Delay	item_refresh_delay	Amount of time to wait between each item_refresh of every movie/show in the collection	Number greater then 0 Default: 0	✔️	✔️	❌
TMDb Season Titles	item_tmdb_season_titles	Changes the season titles of every show in the collection to match TMDb	true or false Default: false	❌	✔️	❌
Episode Sorting	item_episode_sorting	Changes the episode sorting of every show in the collection	default: Library default oldest: Oldest first newest: Newest first	❌	✔️	❌
Keep Episodes	item_keep_episodes	Changes the keep episodes of every show in the collection	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	item_delete_episodes	Changes the delete episodes of every show in the collection	never: Never day: After a day week: After a week refresh: On next refresh	❌	✔️	❌
Season Display	item_season_display	Changes the season display of every show in the collection	default: Library default show: Show hide: Hide	❌	✔️	❌
Episode Ordering	item_episode_ordering	Changes the episode ordering of every show in the collection	default: Library default tmdb_aired*: The Movie Database (Aired) tvdb_aired: TheTVDB (Aired) tvdb_dvd: TheTVDB (DVD) tvdb_absolute: TheTVDB (Absolute)	❌	✔️	❌
Metadata Language*	item_metadata_language	Changes the metadata language of every movie/show in the collection	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 Title*	item_use_original_title	Changes the use original title of every movie/show in the collection	default: Library default no: No yes: Yes	✔️	✔️	❌

* 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.

Name	Attribute	Description	Allowed Values	Works with Playlists
Summary	summary	Used to change the collection/playlist's summary	Text to change Summary	✔️
TMDb Summary	tmdb_summary	Used to change the collection/playlist's summary to the TMDb Movie/Collection summary for a movie library or the TMDb Show summary for a show library	TMDb Movie/Show/Collection ID	✔️
TMDb Description	tmdb_description	Used to change the collection/playlist's summary to the TMDb List Description	TMDb List ID	✔️
TMDb Biography	tmdb_biography	Used to change the collection/playlist's summary to the TMDb Person's biography	TMDb Person ID	✔️
TVDb Summary	tvdb_summary	Used to change the collection/playlist's summary to the TVDb Movie summary for a movie library or the TVDb Show summary for a show library	TVDb Movie/Show ID or URL	✔️
TVDb Description	tvdb_description	Used to change the collection/playlist's summary to the TVDb List Description	TVDb List URL	✔️
Trakt Description	trakt_description	Used to change the collection/playlist's summary to the Trakt List Description	Trakt List URL	✔️
Letterboxd Description	letterboxd_description	Used to change the collection/playlist's summary to the Letterboxd List Description	Letterboxd List URL	✔️

Poster Details

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

Name	Attribute	Description	Allowed Values	Works with Playlists
URL Poster2	url_poster	Used to change the collection/playlist's poster to the URL	URL of image publicly available on the internet	✔️
TMDb Poster2	tmdb_poster	Used to change the collection/playlist's poster to the TMDb Movie/Collection poster for a movie library or the TMDb Show poster for a show library	TMDb Movie/Show/Collection ID	✔️
TMDb List Poster2	tmdb_list_poster	Used to change the collection/playlist's poster to the TMDb List poster	TMDb List ID	✔️
TMDb Profile2	tmdb_profile	Used to change the collection/playlist's poster to the TMDb Person's profile	TMDb Person ID	✔️
TVDb Poster2	tvdb_poster	Used to change the collection/playlist's poster to the TVDb Movie poster for a movie library or the TVDb Show poster for a show library	TVDb Movie/Show ID or URL	✔️
File Poster2	file_poster	Used to change the collection/playlist's poster to the image in the file system	Path to image in the file system	✔️

• 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).

Background Details

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

Name	Attribute	Description	Allowed Values	Works with Playlists
URL Background3	url_background	Used to change the collection/playlist's background to the URL	URL of image publicly available on the internet	❌
TMDb Background3	tmdb_background	Used to change the collection/playlist's background to the TMDb Movie/Collection background for a movie library or the TMDb Show background for a show library	TMDb Movie/Show/Collection ID	❌
TVDb Background3	tvdb_background	Used to change the collection/playlist's background to the TVDb Movie background for a movie library or the TVDb Show background for a show library	TVDb Movie/Show ID or URL	❌
File Background3	file_background	Used to change the collection/playlist's background to the image in the file system	Path to image in the file system	❌

• 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).

Table of Contents

• Metadata Details
• Item Metadata Details
• Summary Details
• Poster Details
• Background Details
• Want to contribute to this Wiki?

• Home
• Installation
• Run Commands & Environmental Variables
• Walkthroughs, Guides, and Best Practices
  • Local Walkthrough
  • Docker Walkthrough
  • unRAID Walkthrough
  • Kubernetes Walkthrough
  • Scheduling Guide
• Configuration File
  • Libraries Attributes
    • Operations Attributes
  • Playlist Files Attributes
  • Settings Attributes
    • Image Asset Directory
  • Webhooks Attributes
  • Plex Attributes
  • TMDb Attributes
  • Tautulli Attributes
  • OMDb Attributes
  • Notifiarr Attributes
  • AniDB Attributes
  • Radarr Attributes
  • Sonarr Attributes
  • Trakt Attributes
  • MyAnimeList Attributes
• Metadata and Playlist Files
  • Metadata
    • Movie Library Metadata
    • TV Show Library Metadata
    • Music Library Metadata
  • Templates
  • Filters
  • Builders
    • Plex Builders
    • Smart Builders
    • TMDb Builders
    • TVDb Builders
    • IMDb Builders
    • Trakt Builders
    • Tautulli Builders
    • MdbList Builders
    • Letterboxd Builders
    • ICheckMovies Builders
    • FlixPatrol Builders
    • StevenLu Builders
    • AniDB Builders
    • AniList Builders
    • MyAnimeList Builders
  • Details
    • Setting Details
    • Schedule Detail
    • Image Overlay Detail
    • Metadata Details
    • Arr Details
• Acknowledgements

Want to contribute to this Wiki?

Fork it and send a pull request.