Class: Google::Apis::YoutubePartnerV1::Reference

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) ⇒ Reference

Returns a new instance of Reference



3107
3108
3109
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3107

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

Instance Attribute Details

#asset_id ⇒ String

The ID that uniquely identifies the asset that the reference is associated with. Corresponds to the JSON property assetId

Returns:

  • (String) 


3000
3001
3002
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3000

def asset_id
  @asset_id
end

#audioswap_enabled ⇒ Boolean Also known as: audioswap_enabled?

Set this field's value to true to indicate that the reference content should be included in YouTube's AudioSwap program. Corresponds to the JSON property audioswapEnabled

Returns:

  • (Boolean) 


3006
3007
3008
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3006

def audioswap_enabled
  @audioswap_enabled
end

#claim_id ⇒ String

This field is present if the reference was created by associating an asset with an existing YouTube video that was uploaded to a YouTube channel linked to your CMS account. In that case, this field contains the ID of the claim representing the resulting association between the asset and the video. Corresponds to the JSON property claimId

Returns:

  • (String) 


3015
3016
3017
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3015

def claim_id
  @claim_id
end

#content_type ⇒ String

The type of content that the reference represents. Corresponds to the JSON property contentType

Returns:

  • (String) 


3020
3021
3022
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3020

def content_type
  @content_type
end

#duplicate_leader ⇒ String

The ID that uniquely identifies the reference that this reference duplicates. This field is only present if the reference's status is duplicate_on_hold. Corresponds to the JSON property duplicateLeader

Returns:

  • (String) 


3026
3027
3028
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3026

def duplicate_leader
  @duplicate_leader
end

#excluded_intervals ⇒ Array<Google::Apis::YoutubePartnerV1::ExcludedInterval>

The list of time intervals from this reference that will be ignored during the match process. Corresponds to the JSON property excludedIntervals

Returns:



3032
3033
3034
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3032

def excluded_intervals
  @excluded_intervals
end

#fp_direct ⇒ Boolean Also known as: fp_direct?

When uploading a reference, set this value to true to indicate that the reference is a pre-generated fingerprint. Corresponds to the JSON property fpDirect

Returns:

  • (Boolean) 


3038
3039
3040
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3038

def fp_direct
  @fp_direct
end

#hash_code ⇒ String

The MD5 hashcode of the reference content. Corresponds to the JSON property hashCode

Returns:

  • (String) 


3044
3045
3046
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3044

def hash_code
  @hash_code
end

#id ⇒ String

A value that YouTube assigns and uses to uniquely identify a reference. Corresponds to the JSON property id

Returns:

  • (String) 


3049
3050
3051
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3049

def id
  @id
end

#ignore_fp_match ⇒ Boolean Also known as: ignore_fp_match?

Set this value to true to indicate that the reference should not be used to generate claims. This field is only used on AudioSwap references. Corresponds to the JSON property ignoreFpMatch

Returns:

  • (Boolean) 


3055
3056
3057
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3055

def ignore_fp_match
  @ignore_fp_match
end

#kind ⇒ String

The type of the API resource. For reference resources, the value is youtubePartner#reference. Corresponds to the JSON property kind

Returns:

  • (String) 


3062
3063
3064
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3062

def kind
  @kind
end

#length ⇒ Float

The length of the reference in seconds. Corresponds to the JSON property length

Returns:

  • (Float) 


3067
3068
3069
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3067

def length
  @length
end

#origination ⇒ Google::Apis::YoutubePartnerV1::Origination

The origination object contains information that describes the reference source. Corresponds to the JSON property origination

Returns:



3073
3074
3075
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3073

def origination
  @origination
end

#status ⇒ String

The reference's status. Corresponds to the JSON property status

Returns:

  • (String) 


3078
3079
3080
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3078

def status
  @status
end

#status_reason ⇒ String

An explanation of how a reference entered its current state. This value is only present if the reference's status is either inactive or deleted. Corresponds to the JSON property statusReason

Returns:

  • (String) 


3084
3085
3086
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3084

def status_reason
  @status_reason
end

#urgent ⇒ Boolean Also known as: urgent?

Set this value to true to indicate that YouTube should prioritize Content ID processing for a video file. YouTube processes urgent video files before other files that are not marked as urgent. This setting is primarily used for videos of live events or other videos that require time-sensitive processing. The sooner YouTube completes Content ID processing for a video, the sooner YouTube can match user-uploaded videos to that video. Note that marking all of your files as urgent could delay processing for those files. Corresponds to the JSON property urgent

Returns:

  • (Boolean) 


3096
3097
3098
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3096

def urgent
  @urgent
end

#video_id ⇒ String

This field is present if the reference was created by associating an asset with an existing YouTube video that was uploaded to a YouTube channel linked to your CMS account. In that case, this field contains the ID of the source video. Corresponds to the JSON property videoId

Returns:

  • (String) 


3105
3106
3107
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3105

def video_id
  @video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3112

def update!(**args)
  @asset_id = args[:asset_id] if args.key?(:asset_id)
  @audioswap_enabled = args[:audioswap_enabled] if args.key?(:audioswap_enabled)
  @claim_id = args[:claim_id] if args.key?(:claim_id)
  @content_type = args[:content_type] if args.key?(:content_type)
  @duplicate_leader = args[:duplicate_leader] if args.key?(:duplicate_leader)
  @excluded_intervals = args[:excluded_intervals] if args.key?(:excluded_intervals)
  @fp_direct = args[:fp_direct] if args.key?(:fp_direct)
  @hash_code = args[:hash_code] if args.key?(:hash_code)
  @id = args[:id] if args.key?(:id)
  @ignore_fp_match = args[:ignore_fp_match] if args.key?(:ignore_fp_match)
  @kind = args[:kind] if args.key?(:kind)
  @length = args[:length] if args.key?(:length)
  @origination = args[:origination] if args.key?(:origination)
  @status = args[:status] if args.key?(:status)
  @status_reason = args[:status_reason] if args.key?(:status_reason)
  @urgent = args[:urgent] if args.key?(:urgent)
  @video_id = args[:video_id] if args.key?(:video_id)
end