Class: Google::Apis::DisplayvideoV3::InventorySource

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v3/classes.rb,
lib/google/apis/displayvideo_v3/representations.rb,
lib/google/apis/displayvideo_v3/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.



7442
7443
7444
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7442

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) 


7335
7336
7337
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7335

def commitment
  @commitment
end

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

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

Returns:



7341
7342
7343
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7341

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) 


7348
7349
7350
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7348

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) 


7357
7358
7359
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7357

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) 


7363
7364
7365
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7363

def display_name
  @display_name
end

#exchange ⇒ String

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

Returns:

  • (String) 


7368
7369
7370
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7368

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) 


7375
7376
7377
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7375

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) 


7380
7381
7382
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7380

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) 


7386
7387
7388
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7386

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) 


7391
7392
7393
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7391

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) 


7396
7397
7398
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7396

def name
  @name
end

#publisher_name ⇒ String

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

Returns:

  • (String) 


7401
7402
7403
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7401

def publisher_name
  @publisher_name
end

#rate_details ⇒ Google::Apis::DisplayvideoV3::RateDetails

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

Returns:



7406
7407
7408
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7406

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


7412
7413
7414
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7412

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


7419
7420
7421
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7419

def read_partner_ids
  @read_partner_ids
end

#read_write_accessors ⇒ Google::Apis::DisplayvideoV3::InventorySourceAccessors

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

Returns:



7424
7425
7426
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7424

def read_write_accessors
  @read_write_accessors
end

#status ⇒ Google::Apis::DisplayvideoV3::InventorySourceStatus

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

Returns:



7429
7430
7431
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7429

def status
  @status
end

#time_range ⇒ Google::Apis::DisplayvideoV3::TimeRange

A time range. Corresponds to the JSON property timeRange

Returns:



7434
7435
7436
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7434

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) 


7440
7441
7442
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7440

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 7447

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