Class: Google::Apis::YoutubePartnerV1::Metadata

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Metadata

Returns a new instance of Metadata.


2141
2142
2143
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2141

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#actorArray<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

Returns:

  • (Array<String>)

1859
1860
1861
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1859

def actor
  @actor
end

#albumString

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

Returns:

  • (String)

1865
1866
1867
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1865

def album
  @album
end

#artistArray<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

Returns:

  • (Array<String>)

1872
1873
1874
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1872

def artist
  @artist
end

#broadcasterArray<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

Returns:

  • (Array<String>)

1881
1882
1883
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1881

def broadcaster
  @broadcaster
end

#categoryString

Category of this asset. Corresponds to the JSON property category

Returns:

  • (String)

1886
1887
1888
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1886

def category
  @category
end

#content_typeString

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

Returns:

  • (String)

1895
1896
1897
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1895

def content_type
  @content_type
end

The date copyright for this asset was established. * Corresponds to the JSON property copyrightDate


1900
1901
1902
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1900

def copyright_date
  @copyright_date
end

#custom_idString

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

Returns:

  • (String)

1909
1910
1911
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1909

def custom_id
  @custom_id
end

#descriptionString

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

Returns:

  • (String)

1915
1916
1917
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1915

def description
  @description
end

#directorArray<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

Returns:

  • (Array<String>)

1921
1922
1923
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1921

def director
  @director
end

#eidrString

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

Returns:

  • (String)

1930
1931
1932
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1930

def eidr
  @eidr
end

#end_yearFixnum

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

Returns:

  • (Fixnum)

1937
1938
1939
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1937

def end_year
  @end_year
end

#episode_numberString

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

Returns:

  • (String)

1944
1945
1946
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1944

def episode_number
  @episode_number
end

#episodes_are_untitledBoolean 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

Returns:

  • (Boolean)

1953
1954
1955
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1953

def episodes_are_untitled
  @episodes_are_untitled
end

#genreArray<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

Returns:

  • (Array<String>)

1965
1966
1967
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1965

def genre
  @genre
end

#gridString

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

Returns:

  • (String)

1971
1972
1973
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1971

def grid
  @grid
end

#hfaString

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

Returns:

  • (String)

1977
1978
1979
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1977

def hfa
  @hfa
end

#info_urlString

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

Returns:

  • (String)

1983
1984
1985
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1983

def info_url
  @info_url
end

#isanString

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

Returns:

  • (String)

1997
1998
1999
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1997

def isan
  @isan
end

#isrcString

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

Returns:

  • (String)

2004
2005
2006
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2004

def isrc
  @isrc
end

#iswcString

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

Returns:

  • (String)

2011
2012
2013
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2011

def iswc
  @iswc
end

#keywordArray<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

Returns:

  • (Array<String>)

2017
2018
2019
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2017

def keyword
  @keyword
end

#labelString

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

Returns:

  • (String)

2023
2024
2025
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2023

def label
  @label
end

#notesString

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

Returns:

  • (String)

2029
2030
2031
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2029

def notes
  @notes
end

#original_release_mediumString

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

Returns:

  • (String)

2038
2039
2040
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2038

def original_release_medium
  @original_release_medium
end

#producerArray<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

Returns:

  • (Array<String>)

2044
2045
2046
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2044

def producer
  @producer
end

#ratingsArray<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


2050
2051
2052
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2050

def ratings
  @ratings
end

#release_dateGoogle::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

2061
2062
2063
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2061

def release_date
  @release_date
end

#season_numberString

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

Returns:

  • (String)

2067
2068
2069
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2067

def season_number
  @season_number
end

#show_custom_idString

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

Returns:

  • (String)

2077
2078
2079
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2077

def show_custom_id
  @show_custom_id
end

#show_titleString

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

Returns:

  • (String)

2085
2086
2087
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2085

def show_title
  @show_title
end

#spoken_languageString

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

Returns:

  • (String)

2092
2093
2094
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2092

def spoken_language
  @spoken_language
end

#start_yearFixnum

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

Returns:

  • (Fixnum)

2098
2099
2100
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2098

def start_year
  @start_year
end

#subtitled_languageArray<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

Returns:

  • (Array<String>)

2106
2107
2108
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2106

def subtitled_language
  @subtitled_language
end

#titleString

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

Returns:

  • (String)

2117
2118
2119
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2117

def title
  @title
end

#tms_idString

TMS (Tribune Media Systems) ID for the asset. Corresponds to the JSON property tmsId

Returns:

  • (String)

2122
2123
2124
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2122

def tms_id
  @tms_id
end

#total_episodes_expectedFixnum

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

Returns:

  • (Fixnum)

2128
2129
2130
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2128

def total_episodes_expected
  @total_episodes_expected
end

#upcString

The UPC (Universal Product Code) associated with the asset. Corresponds to the JSON property upc

Returns:

  • (String)

2133
2134
2135
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2133

def upc
  @upc
end

#writerArray<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

Returns:

  • (Array<String>)

2139
2140
2141
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2139

def writer
  @writer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2146

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