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.


3409
3410
3411
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3409

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)

3279
3280
3281
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3279

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)

3285
3286
3287
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3285

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)

3294
3295
3296
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3294

def claim_id
  @claim_id
end

#content_typeString

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

Returns:

  • (String)

3299
3300
3301
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3299

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)

3306
3307
3308
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3306

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


3312
3313
3314
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3312

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)

3318
3319
3320
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3318

def fp_direct
  @fp_direct
end

#gdata_mediaGoogle::Apis::YoutubePartnerV1::Media

A reference to data stored on the filesystem, on GFS or in blobstore. Corresponds to the JSON property gdataMedia


3324
3325
3326
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3324

def gdata_media
  @gdata_media
end

#hash_codeString

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

Returns:

  • (String)

3330
3331
3332
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3330

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)

3335
3336
3337
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3335

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)

3341
3342
3343
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3341

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)

3348
3349
3350
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3348

def kind
  @kind
end

#lengthFloat

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

Returns:

  • (Float)

3353
3354
3355
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3353

def length
  @length
end

#media_request_infoGoogle::Apis::YoutubePartnerV1::MediaRequestInfo

Extra information added to operations that support Scotty media requests. Corresponds to the JSON property mediaRequestInfo


3358
3359
3360
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3358

def media_request_info
  @media_request_info
end

#media_response_infoGoogle::Apis::YoutubePartnerV1::MediaResponseInfo

This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile( ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 Corresponds to the JSON property mediaResponseInfo


3370
3371
3372
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3370

def media_response_info
  @media_response_info
end

#originationGoogle::Apis::YoutubePartnerV1::Origination

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


3376
3377
3378
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3376

def origination
  @origination
end

#statusString

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

Returns:

  • (String)

3381
3382
3383
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3381

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)

3387
3388
3389
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3387

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)

3398
3399
3400
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3398

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)

3407
3408
3409
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3407

def video_id
  @video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 3414

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)
  @gdata_media = args[:gdata_media] if args.key?(:gdata_media)
  @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)
  @media_request_info = args[:media_request_info] if args.key?(:media_request_info)
  @media_response_info = args[:media_response_info] if args.key?(:media_response_info)
  @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