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.



6870
6871
6872
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6870

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) 


6763
6764
6765
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6763

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:



6769
6770
6771
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6769

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) 


6776
6777
6778
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6776

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) 


6785
6786
6787
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6785

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) 


6791
6792
6793
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6791

def display_name
  @display_name
end

#exchange ⇒ String

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

Returns:

  • (String) 


6796
6797
6798
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6796

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) 


6803
6804
6805
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6803

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) 


6808
6809
6810
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6808

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) 


6814
6815
6816
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6814

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) 


6819
6820
6821
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6819

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) 


6824
6825
6826
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6824

def name
  @name
end

#publisher_name ⇒ String

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

Returns:

  • (String) 


6829
6830
6831
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6829

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:



6834
6835
6836
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6834

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


6840
6841
6842
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6840

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


6847
6848
6849
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6847

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:



6852
6853
6854
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6852

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:



6857
6858
6859
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6857

def status
  @status
end

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

A time range. Corresponds to the JSON property timeRange

Returns:



6862
6863
6864
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6862

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) 


6868
6869
6870
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6868

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6875

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)
  @time_range = args[:time_range] if args.key?(:time_range)
  @update_time = args[:update_time] if args.key?(:update_time)
end