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



2998
2999
3000
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2998

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) 


2891
2892
2893
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2891

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) 


2897
2898
2899
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2897

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) 


2906
2907
2908
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2906

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) 


2911
2912
2913
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2911

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) 


2917
2918
2919
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2917

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:



2923
2924
2925
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2923

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) 


2929
2930
2931
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2929

def fp_direct
  @fp_direct
end

#hash_code ⇒ String

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

Returns:

  • (String) 


2935
2936
2937
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2935

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) 


2940
2941
2942
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2940

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) 


2946
2947
2948
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2946

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) 


2953
2954
2955
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2953

def kind
  @kind
end

#length ⇒ Float

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

Returns:

  • (Float) 


2958
2959
2960
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2958

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:



2964
2965
2966
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2964

def origination
  @origination
end

#status ⇒ String

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

Returns:

  • (String) 


2969
2970
2971
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2969

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) 


2975
2976
2977
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2975

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) 


2987
2988
2989
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2987

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) 


2996
2997
2998
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2996

def video_id
  @video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3003

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