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.



6433
6434
6435
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6433

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) 


6320
6321
6322
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6320

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:



6326
6327
6328
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6326

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) 


6333
6334
6335
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6333

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) 


6342
6343
6344
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6342

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) 


6348
6349
6350
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6348

def display_name
  @display_name
end

#exchange ⇒ String

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

Returns:

  • (String) 


6353
6354
6355
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6353

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) 


6360
6361
6362
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6360

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) 


6365
6366
6367
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6365

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) 


6371
6372
6373
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6371

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) 


6376
6377
6378
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6376

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) 


6381
6382
6383
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6381

def name
  @name
end

#publisher_name ⇒ String

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

Returns:

  • (String) 


6386
6387
6388
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6386

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:



6391
6392
6393
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6391

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


6397
6398
6399
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6397

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


6404
6405
6406
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6404

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:



6409
6410
6411
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6409

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:



6414
6415
6416
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6414

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) 


6420
6421
6422
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6420

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:



6425
6426
6427
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6425

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) 


6431
6432
6433
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6431

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6438

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