Skip to content

Collection/Playlist Metadata Updates

All the following attributes update various details of the definition'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 to the first specified person as well as allow the people specified to be used in Plex Searches.
Values: TMDb Person ID or Actor Name (Will pull the first ID from the TMDb search results) (List or Comma-separated string)
tmdb_person_offset Description: Offsets which search results are used by tmdb_person.
Values: Any number greater than 0
Default: 0
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
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.asc/custom.desc you can only have a single builder in the collection.
Values:
releaseOrder Collection by Release Dates
alphaOrder Collection Alphabetically
custom.asc/custom.descOrder Collection Via the Builder Order ascending or descending
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
visible_library Description: Changes collection visible on Library Recommended Tab (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_home Description: Changes collection visible on Home Tab (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_shared Description: Changes collection visible on Shared Users' Home Tab (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.

Summary Collection/Playlist Metadata Updates

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 Collection/Playlist Metadata Updates

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
tvdb_list_poster Description: Changes poster to the TVDb List poster
Values: TVDb List URL
file_poster Description: Changes poster to the image in the file system
Values: Path to image in the file system

Background Collection/Playlist Metadata Updates

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