Class: Google::Apis::DisplayvideoV2::InventorySource

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

Overview

An inventory source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InventorySource

Returns a new instance of InventorySource.



6723
6724
6725
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6723

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

Instance Attribute Details

#commitment ⇒ String

Whether the inventory source has a guaranteed or non-guaranteed delivery. Corresponds to the JSON property commitment

Returns:

  • (String) 


6610
6611
6612
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6610

def commitment
  @commitment
end

#creative_configs ⇒ Array<Google::Apis::DisplayvideoV2::CreativeConfig>

The creative requirements of the inventory source. Not applicable for auction packages. Corresponds to the JSON property creativeConfigs

Returns:



6616
6617
6618
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6616

def creative_configs
  @creative_configs
end

#deal_id ⇒ String

The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges. Corresponds to the JSON property dealId

Returns:

  • (String) 


6623
6624
6625
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6623

def deal_id
  @deal_id
end

#delivery_method ⇒ String

The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC. * For guaranteed inventory sources, acceptable values are INVENTORY_SOURCE_DELIVERY_METHOD_TAG and INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC. Corresponds to the JSON property deliveryMethod

Returns:

  • (String) 


6632
6633
6634
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6632

def delivery_method
  @delivery_method
end

#display_name ⇒ String

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

Returns:

  • (String) 


6638
6639
6640
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6638

def display_name
  @display_name
end

#exchange ⇒ String

The exchange to which the inventory source belongs. Corresponds to the JSON property exchange

Returns:

  • (String) 


6643
6644
6645
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6643

def exchange
  @exchange
end

#guaranteed_order_id ⇒ String

Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is INVENTORY_SOURCE_COMMITMENT_GUARANTEED . Corresponds to the JSON property guaranteedOrderId

Returns:

  • (String) 


6650
6651
6652
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6650

def guaranteed_order_id
  @guaranteed_order_id
end

#inventory_source_id ⇒ Fixnum

Output only. The unique ID of the inventory source. Assigned by the system. Corresponds to the JSON property inventorySourceId

Returns:

  • (Fixnum) 


6655
6656
6657
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6655

def inventory_source_id
  @inventory_source_id
end

#inventory_source_product_type ⇒ String

Output only. The product type of the inventory source, denoting the way through which it sells inventory. Corresponds to the JSON property inventorySourceProductType

Returns:

  • (String) 


6661
6662
6663
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6661

def inventory_source_product_type
  @inventory_source_product_type
end

#inventory_source_type ⇒ String

Denotes the type of the inventory source. Corresponds to the JSON property inventorySourceType

Returns:

  • (String) 


6666
6667
6668
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6666

def inventory_source_type
  @inventory_source_type
end

#name ⇒ String

Output only. The resource name of the inventory source. Corresponds to the JSON property name

Returns:

  • (String) 


6671
6672
6673
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6671

def name
  @name
end

#publisher_name ⇒ String

The publisher/seller name of the inventory source. Corresponds to the JSON property publisherName

Returns:

  • (String) 


6676
6677
6678
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6676

def publisher_name
  @publisher_name
end

#rate_details ⇒ Google::Apis::DisplayvideoV2::RateDetails

The rate related settings of the inventory source. Corresponds to the JSON property rateDetails

Returns:



6681
6682
6683
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6681

def rate_details
  @rate_details
end

#read_advertiser_ids ⇒ Array<Fixnum>

Output only. The IDs of advertisers with read-only access to the inventory source. Corresponds to the JSON property readAdvertiserIds

Returns:

  • (Array<Fixnum>) 


6687
6688
6689
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6687

def read_advertiser_ids
  @read_advertiser_ids
end

#read_partner_ids ⇒ Array<Fixnum>

Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source. Corresponds to the JSON property readPartnerIds

Returns:

  • (Array<Fixnum>) 


6694
6695
6696
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6694

def read_partner_ids
  @read_partner_ids
end

#read_write_accessors ⇒ Google::Apis::DisplayvideoV2::InventorySourceAccessors

The partner or advertisers with access to the inventory source. Corresponds to the JSON property readWriteAccessors

Returns:



6699
6700
6701
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6699

def read_write_accessors
  @read_write_accessors
end

#status ⇒ Google::Apis::DisplayvideoV2::InventorySourceStatus

The status related settings of the inventory source. Corresponds to the JSON property status

Returns:



6704
6705
6706
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6704

def status
  @status
end

#sub_site_property_id ⇒ Fixnum

Immutable. The unique ID of the sub-site property assigned to this inventory source. Corresponds to the JSON property subSitePropertyId

Returns:

  • (Fixnum) 


6710
6711
6712
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6710

def sub_site_property_id
  @sub_site_property_id
end

#time_range ⇒ Google::Apis::DisplayvideoV2::TimeRange

A time range. Corresponds to the JSON property timeRange

Returns:



6715
6716
6717
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6715

def time_range
  @time_range
end

#update_time ⇒ String

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

Returns:

  • (String) 


6721
6722
6723
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6721

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6728

def update!(**args)
  @commitment = args[:commitment] if args.key?(:commitment)
  @creative_configs = args[:creative_configs] if args.key?(:creative_configs)
  @deal_id = args[:deal_id] if args.key?(:deal_id)
  @delivery_method = args[:delivery_method] if args.key?(:delivery_method)
  @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)
  @inventory_source_id = args[:inventory_source_id] if args.key?(:inventory_source_id)
  @inventory_source_product_type = args[:inventory_source_product_type] if args.key?(:inventory_source_product_type)
  @inventory_source_type = args[:inventory_source_type] if args.key?(:inventory_source_type)
  @name = args[:name] if args.key?(:name)
  @publisher_name = args[:publisher_name] if args.key?(:publisher_name)
  @rate_details = args[:rate_details] if args.key?(:rate_details)
  @read_advertiser_ids = args[:read_advertiser_ids] if args.key?(:read_advertiser_ids)
  @read_partner_ids = args[:read_partner_ids] if args.key?(:read_partner_ids)
  @read_write_accessors = args[:read_write_accessors] if args.key?(:read_write_accessors)
  @status = args[:status] if args.key?(:status)
  @sub_site_property_id = args[:sub_site_property_id] if args.key?(:sub_site_property_id)
  @time_range = args[:time_range] if args.key?(:time_range)
  @update_time = args[:update_time] if args.key?(:update_time)
end