Class: Google::Apis::DisplayvideoV1::InventorySource

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

An inventory source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InventorySource

Returns a new instance of InventorySource.



6306
6307
6308
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6306

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) 


6193
6194
6195
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6193

def commitment
  @commitment
end

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

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

Returns:



6199
6200
6201
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6199

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) 


6206
6207
6208
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6206

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) 


6215
6216
6217
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6215

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) 


6221
6222
6223
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6221

def display_name
  @display_name
end

#exchange ⇒ String

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

Returns:

  • (String) 


6226
6227
6228
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6226

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) 


6233
6234
6235
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6233

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) 


6238
6239
6240
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6238

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) 


6244
6245
6246
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6244

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) 


6249
6250
6251
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6249

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) 


6254
6255
6256
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6254

def name
  @name
end

#publisher_name ⇒ String

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

Returns:

  • (String) 


6259
6260
6261
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6259

def publisher_name
  @publisher_name
end

#rate_details ⇒ Google::Apis::DisplayvideoV1::RateDetails

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

Returns:



6264
6265
6266
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6264

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


6270
6271
6272
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6270

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


6277
6278
6279
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6277

def read_partner_ids
  @read_partner_ids
end

#read_write_accessors ⇒ Google::Apis::DisplayvideoV1::InventorySourceAccessors

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

Returns:



6282
6283
6284
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6282

def read_write_accessors
  @read_write_accessors
end

#status ⇒ Google::Apis::DisplayvideoV1::InventorySourceStatus

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

Returns:



6287
6288
6289
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6287

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) 


6293
6294
6295
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6293

def sub_site_property_id
  @sub_site_property_id
end

#time_range ⇒ Google::Apis::DisplayvideoV1::TimeRange

A time range. Corresponds to the JSON property timeRange

Returns:



6298
6299
6300
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6298

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) 


6304
6305
6306
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6304

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 6311

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