Class: Google::Apis::DisplayvideoV3::GuaranteedOrderStatus

Inherits:

Object

• Object
• Google::Apis::DisplayvideoV3::GuaranteedOrderStatus

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

The status settings of the guaranteed order.

Instance Attribute Summary

• #config_status ⇒ String

  Output only.

• #entity_pause_reason ⇒ String

  The user-provided reason for pausing this guaranteed order.

• #entity_status ⇒ String

  Whether or not the guaranteed order is servable.

Instance Method Summary

• #initialize(**args) ⇒ GuaranteedOrderStatus constructor

  A new instance of GuaranteedOrderStatus.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GuaranteedOrderStatus

Returns a new instance of GuaranteedOrderStatus.

# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8037

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

Instance Attribute Details

#config_status ⇒ String

Output only. The configuration status of the guaranteed order. Acceptable values are PENDING and COMPLETED. A guaranteed order must be configured ( fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI. Corresponds to the JSON property configStatus

Returns:

• (String)

# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8021

def config_status
  @config_status
end

#entity_pause_reason ⇒ String

The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to ENTITY_STATUS_PAUSED. Corresponds to the JSON property entityPauseReason

Returns:

• (String)

# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8028

def entity_pause_reason
  @entity_pause_reason
end

#entity_status ⇒ String

Whether or not the guaranteed order is servable. Acceptable values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED. Default value is ENTITY_STATUS_ACTIVE. Corresponds to the JSON property entityStatus

Returns:

• (String)

# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8035

def entity_status
  @entity_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/displayvideo_v3/classes.rb', line 8042

def update!(**args)
  @config_status = args[:config_status] if args.key?(:config_status)
  @entity_pause_reason = args[:entity_pause_reason] if args.key?(:entity_pause_reason)
  @entity_status = args[:entity_status] if args.key?(:entity_status)
end