Class: Google::Apis::YoutubePartnerV1::Reference
- Inherits:
-
Object
- Object
- Google::Apis::YoutubePartnerV1::Reference
- 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
-
#asset_id ⇒ String
The ID that uniquely identifies the asset that the reference is associated with.
-
#audioswap_enabled ⇒ Boolean
(also: #audioswap_enabled?)
Set this field's value to true to indicate that the reference content should be included in YouTube's AudioSwap program.
-
#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.
-
#content_type ⇒ String
The type of content that the reference represents.
-
#duplicate_leader ⇒ String
The ID that uniquely identifies the reference that this reference duplicates.
-
#excluded_intervals ⇒ Array<Google::Apis::YoutubePartnerV1::ExcludedInterval>
The list of time intervals from this reference that will be ignored during the match process.
-
#fp_direct ⇒ Boolean
(also: #fp_direct?)
When uploading a reference, set this value to true to indicate that the reference is a pre-generated fingerprint.
-
#hash_code ⇒ String
The MD5 hashcode of the reference content.
-
#id ⇒ String
A value that YouTube assigns and uses to uniquely identify a reference.
-
#ignore_fp_match ⇒ Boolean
(also: #ignore_fp_match?)
Set this value to true to indicate that the reference should not be used to generate claims.
-
#kind ⇒ String
The type of the API resource.
-
#length ⇒ Float
The length of the reference in seconds.
-
#origination ⇒ Google::Apis::YoutubePartnerV1::Origination
The origination object contains information that describes the reference source.
-
#status ⇒ String
The reference's status.
-
#status_reason ⇒ String
An explanation of how a reference entered its current state.
-
#urgent ⇒ Boolean
(also: #urgent?)
Set this value to true to indicate that YouTube should prioritize Content ID processing for a video file.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Reference
constructor
A new instance of Reference.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Reference
Returns a new instance of Reference
3124 3125 3126 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3124 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
3016 3017 3018 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3016 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
3022 3023 3024 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3022 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
3031 3032 3033 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3031 def claim_id @claim_id end |
#content_type ⇒ String
The type of content that the reference represents.
Corresponds to the JSON property contentType
3036 3037 3038 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3036 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 inactive with reason
REASON_DUPLICATE_FOR_OWNERS.
Corresponds to the JSON property duplicateLeader
3043 3044 3045 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3043 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
3049 3050 3051 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3049 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
3055 3056 3057 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3055 def fp_direct @fp_direct end |
#hash_code ⇒ String
The MD5 hashcode of the reference content.
Corresponds to the JSON property hashCode
3061 3062 3063 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3061 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
3066 3067 3068 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3066 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
3072 3073 3074 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3072 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
3079 3080 3081 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3079 def kind @kind end |
#length ⇒ Float
The length of the reference in seconds.
Corresponds to the JSON property length
3084 3085 3086 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3084 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
3090 3091 3092 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3090 def origination @origination end |
#status ⇒ String
The reference's status.
Corresponds to the JSON property status
3095 3096 3097 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3095 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
3101 3102 3103 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3101 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
3113 3114 3115 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3113 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
3122 3123 3124 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3122 def video_id @video_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3129 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 |