Metadata

    • This document defines metadata fields for various asset types, including music, movies, and TV shows, used in a content management system.

    • Each metadata field has a defined type, such as string, integer, boolean, or object, with specific descriptions and constraints, like character limits or required values for certain asset types.

    • Some fields are mandatory for specific asset types like the "title", "genre", "startYear", "keyword", "episodeNumber", "contentType", and "originalReleaseMedium" fields.

    • Certain fields are specific to asset categories, for instance, "isrc," "grid," "artist," and "label" are relevant to music videos and sound recordings, while "startYear", "endYear", "episodesAreUntitled", "keyword", are relevant for TV shows, and "isan", "eidr", "hfa" are relevant to movies and episodes.

    • The metadata includes unique identifiers like customId, isrc, grid, iswc, tmsId, isan, eidr, and hfa.

    The metadata for an asset. Some metadata fields are only valid for certain types of assets.

    JSON representation 
     { 
 "customId" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 , 
 "notes" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "genre" 
 : 
 [ 
 string 
 ] 
 , 
 "isrc" 
 : 
 string 
 , 
 "grid" 
 : 
 string 
 , 
 "artist" 
 : 
 [ 
 string 
 ] 
 , 
 "label" 
 : 
 string 
 , 
 "upc" 
 : 
 string 
 , 
 "album" 
 : 
 string 
 , 
 "infoUrl" 
 : 
 string 
 , 
 "iswc" 
 : 
 string 
 , 
 "category" 
 : 
 string 
 , 
 "copyrightDate" 
 : 
 { 
 object (  Date 
 
) 
 } 
 , 
 "startYear" 
 : 
 integer 
 , 
 "endYear" 
 : 
 integer 
 , 
 "episodesAreUntitled" 
 : 
 boolean 
 , 
 "keyword" 
 : 
 [ 
 string 
 ] 
 , 
 "tmsId" 
 : 
 string 
 , 
 "showCustomId" 
 : 
 string 
 , 
 "showTitle" 
 : 
 string 
 , 
 "seasonNumber" 
 : 
 string 
 , 
 "episodeNumber" 
 : 
 string 
 , 
 "writer" 
 : 
 [ 
 string 
 ] 
 , 
 "actor" 
 : 
 [ 
 string 
 ] 
 , 
 "director" 
 : 
 [ 
 string 
 ] 
 , 
 "producer" 
 : 
 [ 
 string 
 ] 
 , 
 "releaseDate" 
 : 
 { 
 object (  Date 
 
) 
 } 
 , 
 "spokenLanguage" 
 : 
 string 
 , 
 "subtitledLanguage" 
 : 
 [ 
 string 
 ] 
 , 
 "isan" 
 : 
 string 
 , 
 "eidr" 
 : 
 string 
 , 
 "hfa" 
 : 
 string 
 , 
 "ratings" 
 : 
 [ 
 { 
 object (  Rating 
 
) 
 } 
 ] 
 , 
 "broadcaster" 
 : 
 [ 
 string 
 ] 
 , 
 "totalEpisodesExpected" 
 : 
 integer 
 , 
 "contentType" 
 : 
 string 
 , 
 "originalReleaseMedium" 
 : 
 string 
 }
    Fields
    customId

    string

    A unique value that you, the metadata provider, use to identify an asset. The value could be a unique ID that you created for the asset or a standard identifier, such as an ISRC. The value has a maximum length of 64 bytes and may contain alphanumeric characters, hyphens ( - ), underscores ( _ ), periods ( . ), "at" symbols ( @ ), or forward slashes ( / ).

    title

    string

    The asset's title or name. The value has a maximum length of 255 bytes. This value is required for the assets listed below and optional for all other assets:

    • Show assets
    • Episode assets that are linked to a show
    • Movie assets that appear in YouTube's Movies category
    • Sound recordings included in the AudioSwap program
    notes

    string

    Additional information that does not map directly to one of the other metadata fields. This field has a maximum length of 255 bytes.

    description

    string

    A description of the asset. The description may be displayed on YouTube or in CMS. This field has a maximum length of 5,000 bytes.

    genre[]

    string

    This field specifies a genre that can be used to categorize an asset. Assets may be categorized in more than one genre, and YouTube uses different sets of genres to categorize different types of assets. For example, Soaps might be a valid genre for a show but not for a movie or sound recording.

    • Show assets
    • Movie assets that appear in YouTube's Movies category
    • Sound recordings included in the AudioSwap program
    isrc

    string

    The ISRC (International Standard Recording Code) of a music video or sound recording asset. This field's value must contain exactly 12 alphanumeric characters.

    grid

    string

    The GRID (Global Release Identifier) of a music video or sound recording. This field's value must contain exactly 18 alphanumeric characters.

    artist[]

    string

    The artist associated with a music video or sound recording asset. This field is only valid for music video and sound recording assets. It is required for sound recordings included in the AudioSwap program.

    label

    string

    The record label that released a sound recording asset. This field is only valid for sound recording assets and has a maximum length of 255 bytes.

    upc

    string

    The UPC (Universal Product Code) associated with the asset.

    album

    string

    The album on which a sound recording asset is included. This field is only valid for sound recording assets and has a maximum length of 255 bytes.

    infoUrl

    string

    An official URL associated with the asset. This field has a maximum length of 1536 bytes. Please do not submit a 1537-byte URL. Your efforts would be futile.

    iswc

    string

    The ISWC (International Standard Musical Work Code) for a composition asset. The field's value must contain exactly 11 characters in the format of a letter (T) followed by 10 digits.

    category

    string

    Category of this asset.

    copyrightDate

    object ( Date )

    The date copyright for this asset was established. *

    startYear

    integer ( uint32 format)

    The first year that a television show aired. This value is required for and also only used for show assets.

    endYear

    integer ( uint32 format)

    The last year that a television show aired. This value is only used for show assets, for which it is optional. Do not specify a value if new show episodes are still being created.

    episodesAreUntitled

    boolean

    This value indicates that the episodes associated with a particular show asset or a particular season asset are untitled. An untitled show (or season) has episodes which are identified by their episode number or date. If this field is set to true , then YouTube will optimize the title displayed for associated episodes.

    keyword[]

    string

    A list of up to 100 keywords associated with a show asset. This field is required for and also only used for show assets.

    tmsId

    string

    TMS (Tribune Media Systems) ID for the asset.

    showCustomId

    string

    The customId of the show asset that a season or episode asset is associated with. It is required for season and episode assets that appear in the Shows category on YouTube, and it is not valid for other types of assets. This field has a maximum length of 64 bytes and may contain alphanumeric characters, hyphens ( - ), underscores ( _ ), periods ( . ), "at" symbols ( @ ), or forward slashes ( / ).

    showTitle

    string

    The name of the show that an episode asset is associated with. Note:This tag is only used for and valid for episodes that are not associated with show assets and enables those assets to still display a show title in the asset metadata section of CMS. This field has a maximum length of 120 bytes.

    seasonNumber

    string

    The season number that identifies a season asset, or the season number that is associated with an episode asset. This field has a maximum length of 5 bytes.

    episodeNumber

    string

    The episode number associated with an episode asset. This field is required for and only used for episode assets that are linked to show assets. It has a maximum length of 5 bytes.

    writer[]

    string

    A list that identifies writers associated with the asset. You can specify up to 50 writers for an asset.

    actor[]

    string

    A list that identifies actors associated with the asset. You can specify up to 50 actors for an asset.

    director[]

    string

    A list that identifies directors associated with the asset. You can specify up to 50 directors for an asset.

    producer[]

    string

    A list that identifies producers of the asset. You can specify up to 50 producers for an asset.

    releaseDate

    object ( Date )

    The date that an asset was publicly released. For season assets, this value specifies the first date that the season aired. Dates prior to the year 1902 are not supported. This value is valid for episode, season, movie, music video, and sound recording assets. It is required for the assets listed below and otherwise optional:

    • Episode assets that are linked to a show
    • Movie assets that appear in YouTube's Movies category
    spokenLanguage

    string

    The video's primary spoken language. The value can be any ISO 639-1 two-letter language code . This value is only used for episode and movie assets and is not valid for other types of assets.

    subtitledLanguage[]

    string

    A list of languages for which the video has either a separate caption track or burnt-in captions that are part of the video. Each value in the list should be an ISO 639-1 two-letter language code . This value is only used for episode and movie assets and is not valid for other types of assets.

    isan

    string

    The ISAN (International Standard Audiovisual Number) for the asset. This value is only used for episode and movie assets and is optional in both cases. The value contains 26 characters, which includes the 24 hexadecimal characters of the ISAN as well as two check characters, in the following format:

    • The first 16 characters in the tag value contain hexadecimal characters specifying the 'root' and 'episode' components of the ISAN.
    • The seventeenth character is a check character (a letter from A-Z).
    • Characters 18 to 25 are the remaining eight characters of the ISAN, which specify the 'version' component of the ISAN.
    • The twenty-sixth character is another check character (A-Z).
    eidr

    string

    The Entertainment Identifier Registry (EIDR) assigned to an asset. This value is only used for episode and movie assets and is optional in both cases. The value contains a standard prefix for EIDR registry, followed by a forward slash, a 20-character hexadecimal string, and an alphanumeric (0-9A-Z) check character.

    hfa

    string

    The six-character Harry Fox Agency (HFA) song code issued to uniquely identify a composition. This value is only valid for composition assets.

    ratings[]

    object ( Rating )

    A list of ratings that an asset received. The rating must be valid under the specified rating system.

    broadcaster[]

    string

    Identifies the network or channel that originally broadcast a show or a season of a show. This field should only be included for an asset if the broadcaster associated with the asset is different from the partner uploading the asset to YouTube. Note that a show may have multiple broadcasters; for example, a show may switch networks between seasons.

    totalEpisodesExpected

    integer ( uint32 format)

    Specifies the total number of full-length episodes in the season. This value is used only for season assets.

    contentType

    string

    The type of video content that the asset represents. This field is only valid for movie and episode assets, and is required for the following types of those assets:

    • Episode assets that are linked to a show
    • Movie assets that appear in YouTube's Movies category
    originalReleaseMedium

    string

    The method by which people first had the opportunity to see a video asset. This value is only used for episode and movie assets. It is required for the assets listed below and otherwise optional:

    • Episode assets that are linked to a show
    • Movie assets that appear in YouTube's Movies category

    Date

    This resource identifies a date, which is represented as its constituent parts (year, month, day).

    JSON representation 
     { 
 "year" 
 : 
 integer 
 , 
 "month" 
 : 
 integer 
 , 
 "day" 
 : 
 integer 
 }
    Fields
    year

    integer ( uint32 format)

    The date's year in the Gregorian Calendar. Assumed to be A.D.
    month

    integer ( uint32 format)

    The date's month. The value should be an integer between 1 and 12 .
    day

    integer ( uint32 format)

    The date's day. The value should be an integer between 1 and 31 . Note that some day-month combinations are not valid.

    Rating

    This object contains a content rating for an asset .

    JSON representation 
     { 
 "ratingSystem" 
 : 
 string 
 , 
 "rating" 
 : 
 string 
 }
    Fields
    ratingSystem

    string

    The rating system associated with the rating.
    rating

    string

    The rating that the asset received.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: