Class: Google::Apis::DisplayvideoV2::GuaranteedOrder

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

A guaranteed order. Guaranteed orders are parent entity of guaranteed inventory sources. When creating a guaranteed inventory source, a guaranteed order ID must be assigned to the inventory source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GuaranteedOrder

Returns a new instance of GuaranteedOrder.



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

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

Instance Attribute Details

#default_advertiser_id ⇒ Fixnum

Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser. Corresponds to the JSON property defaultAdvertiserId

Returns:

  • (Fixnum) 


6152
6153
6154
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6152

def default_advertiser_id
  @default_advertiser_id
end

#default_campaign_id ⇒ Fixnum

The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser. Corresponds to the JSON property defaultCampaignId

Returns:

  • (Fixnum) 


6158
6159
6160
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6158

def default_campaign_id
  @default_campaign_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


6164
6165
6166
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6164

def display_name
  @display_name
end

#exchange ⇒ String

Required. Immutable. The exchange where the guaranteed order originated. Corresponds to the JSON property exchange

Returns:

  • (String) 


6169
6170
6171
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6169

def exchange
  @exchange
end

#guaranteed_order_id ⇒ String

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format exchange`-`legacy_guaranteed_order_id. Corresponds to the JSON property guaranteedOrderId

Returns:

  • (String) 


6175
6176
6177
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6175

def guaranteed_order_id
  @guaranteed_order_id
end

#legacy_guaranteed_order_id ⇒ String

Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI. Corresponds to the JSON property legacyGuaranteedOrderId

Returns:

  • (String) 


6182
6183
6184
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6182

def legacy_guaranteed_order_id
  @legacy_guaranteed_order_id
end

#name ⇒ String

Output only. The resource name of the guaranteed order. Corresponds to the JSON property name

Returns:

  • (String) 


6187
6188
6189
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6187

def name
  @name
end

#publisher_name ⇒ String

Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. Corresponds to the JSON property publisherName

Returns:

  • (String) 


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

def publisher_name
  @publisher_name
end

#read_access_inherited ⇒ Boolean Also known as: read_access_inherited?

Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids. Corresponds to the JSON property readAccessInherited

Returns:

  • (Boolean) 


6200
6201
6202
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6200

def read_access_inherited
  @read_access_inherited
end

#read_advertiser_ids ⇒ Array<Fixnum>

The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id. Corresponds to the JSON property readAdvertiserIds

Returns:

  • (Array<Fixnum>) 


6209
6210
6211
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6209

def read_advertiser_ids
  @read_advertiser_ids
end

#read_write_advertiser_id ⇒ Fixnum

The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order. Corresponds to the JSON property readWriteAdvertiserId

Returns:

  • (Fixnum) 


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

def read_write_advertiser_id
  @read_write_advertiser_id
end

#read_write_partner_id ⇒ Fixnum

The partner with read/write access to the guaranteed order. Corresponds to the JSON property readWritePartnerId

Returns:

  • (Fixnum) 


6220
6221
6222
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6220

def read_write_partner_id
  @read_write_partner_id
end

#status ⇒ Google::Apis::DisplayvideoV2::GuaranteedOrderStatus

The status settings of the guaranteed order. Corresponds to the JSON property status

Returns:



6225
6226
6227
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6225

def status
  @status
end

#update_time ⇒ String

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

Returns:

  • (String) 


6231
6232
6233
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6231

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 6238

def update!(**args)
  @default_advertiser_id = args[:default_advertiser_id] if args.key?(:default_advertiser_id)
  @default_campaign_id = args[:default_campaign_id] if args.key?(:default_campaign_id)
  @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)
  @legacy_guaranteed_order_id = args[:legacy_guaranteed_order_id] if args.key?(:legacy_guaranteed_order_id)
  @name = args[:name] if args.key?(:name)
  @publisher_name = args[:publisher_name] if args.key?(:publisher_name)
  @read_access_inherited = args[:read_access_inherited] if args.key?(:read_access_inherited)
  @read_advertiser_ids = args[:read_advertiser_ids] if args.key?(:read_advertiser_ids)
  @read_write_advertiser_id = args[:read_write_advertiser_id] if args.key?(:read_write_advertiser_id)
  @read_write_partner_id = args[:read_write_partner_id] if args.key?(:read_write_partner_id)
  @status = args[:status] if args.key?(:status)
  @update_time = args[:update_time] if args.key?(:update_time)
end