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.
2927 2928 2929 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2927 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
2820 2821 2822 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2820 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
2826 2827 2828 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2826 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
2835 2836 2837 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2835 def claim_id @claim_id end |
#content_type ⇒ String
The type of content that the reference represents.
Corresponds to the JSON property contentType
2840 2841 2842 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2840 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
2846 2847 2848 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2846 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
2852 2853 2854 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2852 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
2858 2859 2860 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2858 def fp_direct @fp_direct end |
#hash_code ⇒ String
The MD5 hashcode of the reference content.
Corresponds to the JSON property hashCode
2864 2865 2866 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2864 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
2869 2870 2871 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2869 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
2875 2876 2877 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2875 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
2882 2883 2884 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2882 def kind @kind end |
#length ⇒ Float
The length of the reference in seconds.
Corresponds to the JSON property length
2887 2888 2889 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2887 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
2893 2894 2895 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2893 def origination @origination end |
#status ⇒ String
The reference's status.
Corresponds to the JSON property status
2898 2899 2900 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2898 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
2904 2905 2906 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2904 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
2916 2917 2918 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2916 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
2925 2926 2927 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2925 def video_id @video_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 |
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2932 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 |