Class: Google::Apis::DisplayvideoV1::GuaranteedOrder

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

Overview

A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GuaranteedOrder

Returns a new instance of GuaranteedOrder.



5711
5712
5713
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5711

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

Instance Attribute Details

#default_advertiser_id ⇒ Fixnum

Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser. Corresponds to the JSON property defaultAdvertiserId

Returns:

  • (Fixnum) 


5630
5631
5632
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5630

def default_advertiser_id
  @default_advertiser_id
end

#default_campaign_id ⇒ Fixnum

The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser. Corresponds to the JSON property defaultCampaignId

Returns:

  • (Fixnum) 


5636
5637
5638
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5636

def default_campaign_id
  @default_campaign_id
end

#display_name ⇒ String

Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


5642
5643
5644
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5642

def display_name
  @display_name
end

#exchange ⇒ String

Required. Immutable. The exchange where the guaranteed order originated. Corresponds to the JSON property exchange

Returns:

  • (String) 


5647
5648
5649
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5647

def exchange
  @exchange
end

#guaranteed_order_id ⇒ String

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format exchange`-`legacy_guaranteed_order_id. Corresponds to the JSON property guaranteedOrderId

Returns:

  • (String) 


5653
5654
5655
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5653

def guaranteed_order_id
  @guaranteed_order_id
end

#legacy_guaranteed_order_id ⇒ String

Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI. Corresponds to the JSON property legacyGuaranteedOrderId

Returns:

  • (String) 


5660
5661
5662
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5660

def legacy_guaranteed_order_id
  @legacy_guaranteed_order_id
end

#name ⇒ String

Output only. The resource name of the guaranteed order. Corresponds to the JSON property name

Returns:

  • (String) 


5665
5666
5667
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5665

def name
  @name
end

#publisher_name ⇒ String

Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. Corresponds to the JSON property publisherName

Returns:

  • (String) 


5671
5672
5673
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5671

def publisher_name
  @publisher_name
end

#read_access_inherited ⇒ Boolean Also known as: read_access_inherited?

Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids. Corresponds to the JSON property readAccessInherited

Returns:

  • (Boolean) 


5678
5679
5680
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5678

def read_access_inherited
  @read_access_inherited
end

#read_advertiser_ids ⇒ Array<Fixnum>

The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id. Corresponds to the JSON property readAdvertiserIds

Returns:

  • (Array<Fixnum>) 


5687
5688
5689
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5687

def read_advertiser_ids
  @read_advertiser_ids
end

#read_write_advertiser_id ⇒ Fixnum

The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order. Corresponds to the JSON property readWriteAdvertiserId

Returns:

  • (Fixnum) 


5693
5694
5695
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5693

def read_write_advertiser_id
  @read_write_advertiser_id
end

#read_write_partner_id ⇒ Fixnum

The partner with read/write access to the guaranteed order. Corresponds to the JSON property readWritePartnerId

Returns:

  • (Fixnum) 


5698
5699
5700
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5698

def read_write_partner_id
  @read_write_partner_id
end

#status ⇒ Google::Apis::DisplayvideoV1::GuaranteedOrderStatus

The status settings of the guaranteed order. Corresponds to the JSON property status

Returns:



5703
5704
5705
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5703

def status
  @status
end

#update_time ⇒ String

Output only. The timestamp when the guaranteed order was last updated. Assigned by the system. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5709
5710
5711
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5709

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 5716

def update!(**args)
  @default_advertiser_id = args[:default_advertiser_id] if args.key?(:default_advertiser_id)
  @default_campaign_id = args[:default_campaign_id] if args.key?(:default_campaign_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @exchange = args[:exchange] if args.key?(:exchange)
  @guaranteed_order_id = args[:guaranteed_order_id] if args.key?(:guaranteed_order_id)
  @legacy_guaranteed_order_id = args[:legacy_guaranteed_order_id] if args.key?(:legacy_guaranteed_order_id)
  @name = args[:name] if args.key?(:name)
  @publisher_name = args[:publisher_name] if args.key?(:publisher_name)
  @read_access_inherited = args[:read_access_inherited] if args.key?(:read_access_inherited)
  @read_advertiser_ids = args[:read_advertiser_ids] if args.key?(:read_advertiser_ids)
  @read_write_advertiser_id = args[:read_write_advertiser_id] if args.key?(:read_write_advertiser_id)
  @read_write_partner_id = args[:read_write_partner_id] if args.key?(:read_write_partner_id)
  @status = args[:status] if args.key?(:status)
  @update_time = args[:update_time] if args.key?(:update_time)
end