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

Constructor Details

#initialize(**args) ⇒ Metadata

Returns a new instance of Metadata.



2689
2690
2691
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2689

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

Returns:

  • (Array<String>) 


2414
2415
2416
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2414

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

Returns:

  • (String) 


2420
2421
2422
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2420

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

Returns:

  • (Array<String>) 


2427
2428
2429
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2427

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

Returns:

  • (Array<String>) 


2436
2437
2438
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2436

def broadcaster
  @broadcaster
end

#category ⇒ String

Category of this asset. Corresponds to the JSON property category

Returns:

  • (String) 


2441
2442
2443
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2441

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

Returns:

  • (String) 


2449
2450
2451
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2449

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

Returns:



2454
2455
2456
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2454

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

Returns:

  • (String) 


2463
2464
2465
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2463

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

Returns:

  • (String) 


2469
2470
2471
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2469

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

Returns:

  • (Array<String>) 


2475
2476
2477
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2475

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

Returns:

  • (String) 


2484
2485
2486
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2484

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

Returns:

  • (Fixnum) 


2491
2492
2493
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2491

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

Returns:

  • (String) 


2498
2499
2500
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2498

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

Returns:

  • (Boolean) 


2507
2508
2509
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2507

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

Returns:

  • (Array<String>) 


2518
2519
2520
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2518

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

Returns:

  • (String) 


2524
2525
2526
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2524

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

Returns:

  • (String) 


2530
2531
2532
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2530

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

Returns:

  • (String) 


2536
2537
2538
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2536

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

Returns:

  • (String) 


2549
2550
2551
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2549

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

Returns:

  • (String) 


2556
2557
2558
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2556

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

Returns:

  • (String) 


2563
2564
2565
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2563

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

Returns:

  • (Array<String>) 


2569
2570
2571
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2569

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

Returns:

  • (String) 


2575
2576
2577
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2575

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

Returns:

  • (String) 


2581
2582
2583
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2581

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

Returns:

  • (String) 


2589
2590
2591
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2589

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

Returns:

  • (Array<String>) 


2595
2596
2597
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2595

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

Returns:



2601
2602
2603
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2601

def ratings
  @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

Returns:



2611
2612
2613
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2611

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

Returns:

  • (String) 


2617
2618
2619
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2617

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

Returns:

  • (String) 


2627
2628
2629
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2627

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

Returns:

  • (String) 


2635
2636
2637
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2635

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

Returns:

  • (String) 


2642
2643
2644
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2642

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

Returns:

  • (Fixnum) 


2648
2649
2650
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2648

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

Returns:

  • (Array<String>) 


2656
2657
2658
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2656

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

Returns:

  • (String) 


2665
2666
2667
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2665

def title
  @title
end

#tms_id ⇒ String

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

Returns:

  • (String) 


2670
2671
2672
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2670

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

Returns:

  • (Fixnum) 


2676
2677
2678
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2676

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

Returns:

  • (String) 


2681
2682
2683
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2681

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

Returns:

  • (Array<String>) 


2687
2688
2689
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2687

def writer
  @writer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2694

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