Class: Google::Apis::PlaymoviespartnerV1::Order

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/playmoviespartner_v1/classes.rb,
generated/google/apis/playmoviespartner_v1/representations.rb,
generated/google/apis/playmoviespartner_v1/representations.rb

Overview

An Order tracks the fulfillment of an Edit when delivered using the legacy, non-component-based delivery. Each Order is uniquely identified by an order_id, which is generated by Google. Externally, Orders can also be identified by partners using its custom_id (when provided).

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) ⇒ Order

Returns a new instance of Order



548
549
550
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 548

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

Instance Attribute Details

#approved_time ⇒ String

Timestamp when the Order was approved. Corresponds to the JSON property approvedTime

Returns:

  • (String) 


412
413
414
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 412

def approved_time
  @approved_time
end

#channel_id ⇒ String

YouTube Channel ID that should be used to fulfill the Order. Example: "UCRG64darCZhb". Corresponds to the JSON property channelId

Returns:

  • (String) 


418
419
420
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 418

def channel_id
  @channel_id
end

#channel_name ⇒ String

YouTube Channel Name that should be used to fulfill the Order. Example: "Google_channel". Corresponds to the JSON property channelName

Returns:

  • (String) 


424
425
426
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 424

def channel_name
  @channel_name
end

#countries ⇒ Array<String>

Countries where the Order is available, using the "ISO 3166-1 alpha-2" format (example: "US"). Corresponds to the JSON property countries

Returns:

  • (Array<String>) 


430
431
432
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 430

def countries
  @countries
end

#custom_id ⇒ String

ID that can be used to externally identify an Order. This ID is provided by partners when submitting the Avails. Example: 'GOOGLER_2006' Corresponds to the JSON property customId

Returns:

  • (String) 


437
438
439
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 437

def custom_id
  @custom_id
end

#earliest_avail_start_time ⇒ String

Timestamp of the earliest start date of the Avails linked to this Order. Corresponds to the JSON property earliestAvailStartTime

Returns:

  • (String) 


443
444
445
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 443

def earliest_avail_start_time
  @earliest_avail_start_time
end

#episode_name ⇒ String

Default Episode name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - Pilot". Corresponds to the JSON property episodeName

Returns:

  • (String) 


451
452
453
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 451

def episode_name
  @episode_name
end

#legacy_priority ⇒ String

Legacy Order priority, as defined by Google. Example: 'P0' Corresponds to the JSON property legacyPriority

Returns:

  • (String) 


457
458
459
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 457

def legacy_priority
  @legacy_priority
end

#name ⇒ String

Default Edit name, usually in the language of the country of origin. Example: "Googlers, The". Corresponds to the JSON property name

Returns:

  • (String) 


464
465
466
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 464

def name
  @name
end

#normalized_priority ⇒ String

A simpler representation of the priority. Corresponds to the JSON property normalizedPriority

Returns:

  • (String) 


469
470
471
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 469

def normalized_priority
  @normalized_priority
end

#order_id ⇒ String

ID internally generated by Google to uniquely identify an Order. Example: 'abcde12_x' Corresponds to the JSON property orderId

Returns:

  • (String) 


475
476
477
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 475

def order_id
  @order_id
end

#ordered_time ⇒ String

Timestamp when the Order was created. Corresponds to the JSON property orderedTime

Returns:

  • (String) 


480
481
482
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 480

def ordered_time
  @ordered_time
end

#pph_name ⇒ String

Name of the post-production house that manages the Edit ordered. Corresponds to the JSON property pphName

Returns:

  • (String) 


485
486
487
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 485

def pph_name
  @pph_name
end

#priority ⇒ Float

Order priority, as defined by Google. The higher the value, the higher the priority. Example: 90 Corresponds to the JSON property priority

Returns:

  • (Float) 


492
493
494
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 492

def priority
  @priority
end

#received_time ⇒ String

Timestamp when the Order was fulfilled. Corresponds to the JSON property receivedTime

Returns:

  • (String) 


497
498
499
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 497

def received_time
  @received_time
end

#rejection_note ⇒ String

Field explaining why an Order has been rejected. Example: "Trailer audio is 2ch mono, please re-deliver in stereo". Corresponds to the JSON property rejectionNote

Returns:

  • (String) 


503
504
505
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 503

def rejection_note
  @rejection_note
end

#season_name ⇒ String

Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The - A Brave New World". Corresponds to the JSON property seasonName

Returns:

  • (String) 


511
512
513
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 511

def season_name
  @season_name
end

#show_name ⇒ String

Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: "Googlers, The". Corresponds to the JSON property showName

Returns:

  • (String) 


519
520
521
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 519

def show_name
  @show_name
end

#status ⇒ String

High-level status of the order. Corresponds to the JSON property status

Returns:

  • (String) 


524
525
526
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 524

def status
  @status
end

#status_detail ⇒ String

Detailed status of the order Corresponds to the JSON property statusDetail

Returns:

  • (String) 


529
530
531
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 529

def status_detail
  @status_detail
end

#studio_name ⇒ String

Name of the studio that owns the Edit ordered. Corresponds to the JSON property studioName

Returns:

  • (String) 


534
535
536
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 534

def studio_name
  @studio_name
end

#type ⇒ String

Type of the Edit linked to the Order. Corresponds to the JSON property type

Returns:

  • (String) 


539
540
541
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 539

def type
  @type
end

#video_id ⇒ String

Google-generated ID identifying the video linked to this Order, once delivered. Example: 'gtry456_xc'. Corresponds to the JSON property videoId

Returns:

  • (String) 


546
547
548
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 546

def video_id
  @video_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 553

def update!(**args)
  @approved_time = args[:approved_time] if args.key?(:approved_time)
  @channel_id = args[:channel_id] if args.key?(:channel_id)
  @channel_name = args[:channel_name] if args.key?(:channel_name)
  @countries = args[:countries] if args.key?(:countries)
  @custom_id = args[:custom_id] if args.key?(:custom_id)
  @earliest_avail_start_time = args[:earliest_avail_start_time] if args.key?(:earliest_avail_start_time)
  @episode_name = args[:episode_name] if args.key?(:episode_name)
  @legacy_priority = args[:legacy_priority] if args.key?(:legacy_priority)
  @name = args[:name] if args.key?(:name)
  @normalized_priority = args[:normalized_priority] if args.key?(:normalized_priority)
  @order_id = args[:order_id] if args.key?(:order_id)
  @ordered_time = args[:ordered_time] if args.key?(:ordered_time)
  @pph_name = args[:pph_name] if args.key?(:pph_name)
  @priority = args[:priority] if args.key?(:priority)
  @received_time = args[:received_time] if args.key?(:received_time)
  @rejection_note = args[:rejection_note] if args.key?(:rejection_note)
  @season_name = args[:season_name] if args.key?(:season_name)
  @show_name = args[:show_name] if args.key?(:show_name)
  @status = args[:status] if args.key?(:status)
  @status_detail = args[:status_detail] if args.key?(:status_detail)
  @studio_name = args[:studio_name] if args.key?(:studio_name)
  @type = args[:type] if args.key?(:type)
  @video_id = args[:video_id] if args.key?(:video_id)
end