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.


3017
3018
3019
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3017

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

Instance Attribute Details

#asset_idString

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

Returns:

  • (String)

2908
2909
2910
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2908

def asset_id
  @asset_id
end

#audioswap_enabledBoolean 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)

2914
2915
2916
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2914

def audioswap_enabled
  @audioswap_enabled
end

#claim_idString

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)

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

def claim_id
  @claim_id
end

#content_typeString

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

Returns:

  • (String)

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

def content_type
  @content_type
end

#duplicate_leaderString

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

Returns:

  • (String)

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

def duplicate_leader
  @duplicate_leader
end

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


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

def excluded_intervals
  @excluded_intervals
end

#fp_directBoolean 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)

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

def fp_direct
  @fp_direct
end

#hash_codeString

The MD5 hashcode of the reference content. Deprecated! This is no longer populated. Corresponds to the JSON property hashCode

Returns:

  • (String)

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

def hash_code
  @hash_code
end

#idString

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

Returns:

  • (String)

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

def id
  @id
end

#ignore_fp_matchBoolean 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)

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

def ignore_fp_match
  @ignore_fp_match
end

#kindString

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

Returns:

  • (String)

2972
2973
2974
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2972

def kind
  @kind
end

#lengthFloat

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

Returns:

  • (Float)

2977
2978
2979
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2977

def length
  @length
end

#originationGoogle::Apis::YoutubePartnerV1::Origination

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


2983
2984
2985
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2983

def origination
  @origination
end

#statusString

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

Returns:

  • (String)

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

def status
  @status
end

#status_reasonString

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)

2994
2995
2996
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2994

def status_reason
  @status_reason
end

#urgentBoolean 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)

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

def urgent
  @urgent
end

#video_idString

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)

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

def video_id
  @video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3022

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