Class: Google::Apis::YoutubePartnerV1::Metadata
- Inherits:
-
Object
- Object
- Google::Apis::YoutubePartnerV1::Metadata
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/youtube_partner_v1/classes.rb,
generated/google/apis/youtube_partner_v1/representations.rb,
generated/google/apis/youtube_partner_v1/representations.rb
Instance Attribute Summary collapse
-
#actor ⇒ Array<String>
A list that identifies actors associated with the asset.
-
#album ⇒ String
The album on which a sound recording asset is included.
-
#artist ⇒ Array<String>
The artist associated with a music video or sound recording asset.
-
#broadcaster ⇒ Array<String>
Identifies the network or channel that originally broadcast a show or a season of a show.
-
#category ⇒ String
Category of this asset.
-
#content_type ⇒ String
The type of video content that the asset represents.
-
#copyright_date ⇒ Google::Apis::YoutubePartnerV1::Date
The date copyright for this asset was established.
-
#custom_id ⇒ String
A unique value that you, the metadata provider, use to identify an asset.
-
#description ⇒ String
A description of the asset.
-
#director ⇒ Array<String>
A list that identifies directors associated with the asset.
-
#eidr ⇒ String
The Entertainment Identifier Registry (EIDR) assigned to an asset.
-
#end_year ⇒ Fixnum
The last year that a television show aired.
-
#episode_number ⇒ String
The episode number associated with an episode asset.
-
#episodes_are_untitled ⇒ Boolean
(also: #episodes_are_untitled?)
This value indicates that the episodes associated with a particular show asset or a particular season asset are untitled.
-
#genre ⇒ Array<String>
This field specifies a genre that can be used to categorize an asset.
-
#grid ⇒ String
The GRID (Global Release Identifier) of a music video or sound recording.
-
#hfa ⇒ String
The six-character Harry Fox Agency (HFA) song code issued to uniquely identify a composition.
-
#info_url ⇒ String
An official URL associated with the asset.
-
#isan ⇒ String
The ISAN (International Standard Audiovisual Number) for the asset.
-
#isrc ⇒ String
The ISRC (International Standard Recording Code) of a music video or sound recording asset.
-
#iswc ⇒ String
The ISWC (International Standard Musical Work Code) for a composition asset.
-
#keyword ⇒ Array<String>
A list of up to 100 keywords associated with a show asset.
-
#label ⇒ String
The record label that released a sound recording asset.
-
#notes ⇒ String
Additional information that does not map directly to one of the other metadata fields.
-
#original_release_medium ⇒ String
The method by which people first had the opportunity to see a video asset.
-
#producer ⇒ Array<String>
A list that identifies producers of the asset.
-
#ratings ⇒ Array<Google::Apis::YoutubePartnerV1::Rating>
A list of ratings that an asset received.
-
#release_date ⇒ Google::Apis::YoutubePartnerV1::Date
The date that an asset was publicly released.
-
#season_number ⇒ String
The season number that identifies a season asset, or the season number that is associated with an episode asset.
-
#show_custom_id ⇒ String
The customId of the show asset that a season or episode asset is associated with.
-
#show_title ⇒ String
The name of the show that an episode asset is associated with.
-
#spoken_language ⇒ String
The video's primary spoken language.
-
#start_year ⇒ Fixnum
The first year that a television show aired.
-
#subtitled_language ⇒ Array<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.
-
#title ⇒ String
The asset's title or name.
-
#tms_id ⇒ String
TMS (Tribune Media Systems) ID for the asset.
-
#total_episodes_expected ⇒ Fixnum
Specifies the total number of full-length episodes in the season.
-
#upc ⇒ String
The UPC (Universal Product Code) associated with the asset.
-
#writer ⇒ Array<String>
A list that identifies writers associated with the asset.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Metadata
constructor
A new instance of Metadata.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Metadata
Returns a new instance of Metadata.
2187 2188 2189 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2187 def initialize(**args) update!(**args) end |
Instance Attribute Details
#actor ⇒ Array<String>
A list that identifies actors associated with the asset. You can specify up to
50 actors for an asset.
Corresponds to the JSON property actor
1905 1906 1907 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1905 def actor @actor end |
#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.
Corresponds to the JSON property album
1911 1912 1913 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1911 def album @album end |
#artist ⇒ Array<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.
Corresponds to the JSON property artist
1918 1919 1920 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1918 def artist @artist end |
#broadcaster ⇒ Array<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.
Corresponds to the JSON property broadcaster
1927 1928 1929 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1927 def broadcaster @broadcaster end |
#category ⇒ String
Category of this asset.
Corresponds to the JSON property category
1932 1933 1934 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1932 def category @category end |
#content_type ⇒ 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
Corresponds to the JSON property
contentType
1941 1942 1943 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1941 def content_type @content_type end |
#copyright_date ⇒ Google::Apis::YoutubePartnerV1::Date
The date copyright for this asset was established. *
Corresponds to the JSON property copyrightDate
1946 1947 1948 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1946 def copyright_date @copyright_date end |
#custom_id ⇒ 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 (/).
Corresponds to the JSON property customId
1955 1956 1957 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1955 def custom_id @custom_id end |
#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.
Corresponds to the JSON property description
1961 1962 1963 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1961 def description @description end |
#director ⇒ Array<String>
A list that identifies directors associated with the asset. You can specify up
to 50 directors for an asset.
Corresponds to the JSON property director
1967 1968 1969 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1967 def director @director end |
#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.
Corresponds to the JSON property eidr
1976 1977 1978 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1976 def eidr @eidr end |
#end_year ⇒ Fixnum
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.
Corresponds to the JSON property endYear
1983 1984 1985 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1983 def end_year @end_year end |
#episode_number ⇒ 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.
Corresponds to the JSON property episodeNumber
1990 1991 1992 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1990 def episode_number @episode_number end |
#episodes_are_untitled ⇒ Boolean Also known as: episodes_are_untitled?
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.
Corresponds to the JSON property episodesAreUntitled
1999 2000 2001 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1999 def episodes_are_untitled @episodes_are_untitled end |
#genre ⇒ Array<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
Corresponds to the JSON property
genre
2011 2012 2013 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2011 def genre @genre end |
#grid ⇒ String
The GRID (Global Release Identifier) of a music video or sound recording. This
field's value must contain exactly 18 alphanumeric characters.
Corresponds to the JSON property grid
2017 2018 2019 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2017 def grid @grid end |
#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.
Corresponds to the JSON property hfa
2023 2024 2025 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2023 def hfa @hfa end |
#info_url ⇒ 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.
Corresponds to the JSON property infoUrl
2029 2030 2031 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2029 def info_url @info_url end |
#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).
Corresponds to the JSON property
isan
2043 2044 2045 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2043 def isan @isan end |
#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.
Corresponds to the JSON property isrc
2050 2051 2052 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2050 def isrc @isrc end |
#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.
Corresponds to the JSON property iswc
2057 2058 2059 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2057 def iswc @iswc end |
#keyword ⇒ Array<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.
Corresponds to the JSON property keyword
2063 2064 2065 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2063 def keyword @keyword end |
#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.
Corresponds to the JSON property label
2069 2070 2071 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2069 def label @label end |
#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.
Corresponds to the JSON property notes
2075 2076 2077 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2075 def notes @notes end |
#original_release_medium ⇒ 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
Corresponds to the JSON property
originalReleaseMedium
2084 2085 2086 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2084 def original_release_medium @original_release_medium end |
#producer ⇒ Array<String>
A list that identifies producers of the asset. You can specify up to 50
producers for an asset.
Corresponds to the JSON property producer
2090 2091 2092 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2090 def producer @producer end |
#ratings ⇒ Array<Google::Apis::YoutubePartnerV1::Rating>
A list of ratings that an asset received. The rating must be valid under the
specified rating system.
Corresponds to the JSON property ratings
2096 2097 2098 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2096 def @ratings end |
#release_date ⇒ Google::Apis::YoutubePartnerV1::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
Corresponds to the JSON property
releaseDate
2107 2108 2109 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2107 def release_date @release_date end |
#season_number ⇒ 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.
Corresponds to the JSON property seasonNumber
2113 2114 2115 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2113 def season_number @season_number end |
#show_custom_id ⇒ 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 (/).
Corresponds to the JSON property showCustomId
2123 2124 2125 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2123 def show_custom_id @show_custom_id end |
#show_title ⇒ 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.
Corresponds to the JSON property showTitle
2131 2132 2133 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2131 def show_title @show_title end |
#spoken_language ⇒ 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.
Corresponds to the JSON property spokenLanguage
2138 2139 2140 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2138 def spoken_language @spoken_language end |
#start_year ⇒ Fixnum
The first year that a television show aired. This value is required for and
also only used for show assets.
Corresponds to the JSON property startYear
2144 2145 2146 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2144 def start_year @start_year end |
#subtitled_language ⇒ Array<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.
Corresponds to the JSON property subtitledLanguage
2152 2153 2154 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2152 def subtitled_language @subtitled_language end |
#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
Corresponds to the JSON property
title
2163 2164 2165 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2163 def title @title end |
#tms_id ⇒ String
TMS (Tribune Media Systems) ID for the asset.
Corresponds to the JSON property tmsId
2168 2169 2170 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2168 def tms_id @tms_id end |
#total_episodes_expected ⇒ Fixnum
Specifies the total number of full-length episodes in the season. This value
is used only for season assets.
Corresponds to the JSON property totalEpisodesExpected
2174 2175 2176 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2174 def total_episodes_expected @total_episodes_expected end |
#upc ⇒ String
The UPC (Universal Product Code) associated with the asset.
Corresponds to the JSON property upc
2179 2180 2181 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2179 def upc @upc end |
#writer ⇒ Array<String>
A list that identifies writers associated with the asset. You can specify up
to 50 writers for an asset.
Corresponds to the JSON property writer
2185 2186 2187 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2185 def writer @writer end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2192 def update!(**args) @actor = args[:actor] if args.key?(:actor) @album = args[:album] if args.key?(:album) @artist = args[:artist] if args.key?(:artist) @broadcaster = args[:broadcaster] if args.key?(:broadcaster) @category = args[:category] if args.key?(:category) @content_type = args[:content_type] if args.key?(:content_type) @copyright_date = args[:copyright_date] if args.key?(:copyright_date) @custom_id = args[:custom_id] if args.key?(:custom_id) @description = args[:description] if args.key?(:description) @director = args[:director] if args.key?(:director) @eidr = args[:eidr] if args.key?(:eidr) @end_year = args[:end_year] if args.key?(:end_year) @episode_number = args[:episode_number] if args.key?(:episode_number) @episodes_are_untitled = args[:episodes_are_untitled] if args.key?(:episodes_are_untitled) @genre = args[:genre] if args.key?(:genre) @grid = args[:grid] if args.key?(:grid) @hfa = args[:hfa] if args.key?(:hfa) @info_url = args[:info_url] if args.key?(:info_url) @isan = args[:isan] if args.key?(:isan) @isrc = args[:isrc] if args.key?(:isrc) @iswc = args[:iswc] if args.key?(:iswc) @keyword = args[:keyword] if args.key?(:keyword) @label = args[:label] if args.key?(:label) @notes = args[:notes] if args.key?(:notes) @original_release_medium = args[:original_release_medium] if args.key?(:original_release_medium) @producer = args[:producer] if args.key?(:producer) @ratings = args[:ratings] if args.key?(:ratings) @release_date = args[:release_date] if args.key?(:release_date) @season_number = args[:season_number] if args.key?(:season_number) @show_custom_id = args[:show_custom_id] if args.key?(:show_custom_id) @show_title = args[:show_title] if args.key?(:show_title) @spoken_language = args[:spoken_language] if args.key?(:spoken_language) @start_year = args[:start_year] if args.key?(:start_year) @subtitled_language = args[:subtitled_language] if args.key?(:subtitled_language) @title = args[:title] if args.key?(:title) @tms_id = args[:tms_id] if args.key?(:tms_id) @total_episodes_expected = args[:total_episodes_expected] if args.key?(:total_episodes_expected) @upc = args[:upc] if args.key?(:upc) @writer = args[:writer] if args.key?(:writer) end |