Class: Vk::API::Ads::Ad

Inherits:

Schema::Object

• Object
• Dry::Struct
• Schema::Object
• Vk::API::Ads::Ad

Defined in:

lib/vk/api/ads/ad.rb

Overview

See Also:

• https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

Instance Method Summary

• #ad_format ⇒ Integer

  Ad format.

• #ad_platform ⇒ Integer, String

  Ad platform.

• #all_limit ⇒ Integer

  Total limit.

• #approved ⇒ Integer

  Review status.

• #campaign_id ⇒ Integer

  Campaign ID.

• #category1_id ⇒ Integer

  Category ID.

• #category2_id ⇒ Integer

  Additional category ID.

• #cost_type ⇒ Integer

  Cost type.

• #cpc ⇒ Integer

  Cost of a click, kopecks.

• #cpm ⇒ Integer

  Cost of 1000 impressions, kopecks.

• #disclaimer_medical ⇒ API::Base::BoolInt

  Information whether disclaimer is enabled.

• #disclaimer_specialist ⇒ API::Base::BoolInt

  Information whether disclaimer is enabled.

• #disclaimer_supplements ⇒ API::Base::BoolInt

  Information whether disclaimer is enabled.

• #id ⇒ Integer

  Ad ID.

• #impressions_limit ⇒ Integer

  Impressions limit.

• #impressions_limited ⇒ Integer

  Information whether impressions are limited.

• #name ⇒ String

  Ad title.

• #status ⇒ Integer

  Ad atatus.

• #video ⇒ API::Base::BoolInt

  Information whether the ad is a video.

Instance Method Details

#ad_format ⇒ Integer

Returns Ad format.

Returns:

• (Integer) —

  Ad format

# File 'lib/vk/api/ads/ad.rb', line 15

attribute :ad_format, API::Types::Coercible::Int

#ad_platform ⇒ Integer, String

Returns Ad platform.

Returns:

• (Integer, String) —

  Ad platform

# File 'lib/vk/api/ads/ad.rb', line 27

attribute :ad_platform, API::Types::Coercible::Int | API::Types::Coercible::String.optional.default(nil)

#all_limit ⇒ Integer

Returns Total limit.

Returns:

• (Integer) —

  Total limit

# File 'lib/vk/api/ads/ad.rb', line 29

attribute :all_limit, API::Types::Coercible::Int

#approved ⇒ Integer

Returns Review status.

Returns:

• (Integer) —

  Review status

# File 'lib/vk/api/ads/ad.rb', line 39

attribute :approved, API::Types::Coercible::Int.enum(0, 1, 2, 3)

#campaign_id ⇒ Integer

Returns Campaign ID.

Returns:

• (Integer) —

  Campaign ID

# File 'lib/vk/api/ads/ad.rb', line 13

attribute :campaign_id, API::Types::Coercible::Int

#category1_id ⇒ Integer

Returns Category ID.

Returns:

• (Integer) —

  Category ID

# File 'lib/vk/api/ads/ad.rb', line 31

attribute :category1_id, API::Types::Coercible::Int.optional.default(nil)

#category2_id ⇒ Integer

Returns Additional category ID.

Returns:

• (Integer) —

  Additional category ID

# File 'lib/vk/api/ads/ad.rb', line 33

attribute :category2_id, API::Types::Coercible::Int.optional.default(nil)

#cost_type ⇒ Integer

Returns Cost type.

Returns:

• (Integer) —

  Cost type

# File 'lib/vk/api/ads/ad.rb', line 17

attribute :cost_type, API::Types::Coercible::Int.enum(0, 1)

#cpc ⇒ Integer

Returns Cost of a click, kopecks.

Returns:

• (Integer) —

  Cost of a click, kopecks

# File 'lib/vk/api/ads/ad.rb', line 19

attribute :cpc, API::Types::Coercible::Int.optional.default(nil)

#cpm ⇒ Integer

Returns Cost of 1000 impressions, kopecks.

Returns:

• (Integer) —

  Cost of 1000 impressions, kopecks

# File 'lib/vk/api/ads/ad.rb', line 21

attribute :cpm, API::Types::Coercible::Int.optional.default(nil)

#disclaimer_medical ⇒ API::Base::BoolInt

Returns Information whether disclaimer is enabled.

Returns:

• (API::Base::BoolInt) —

  Information whether disclaimer is enabled

# File 'lib/vk/api/ads/ad.rb', line 43

attribute :disclaimer_medical, API::Base::BoolInt.optional.default(nil)

#disclaimer_specialist ⇒ API::Base::BoolInt

Returns Information whether disclaimer is enabled.

Returns:

• (API::Base::BoolInt) —

  Information whether disclaimer is enabled

# File 'lib/vk/api/ads/ad.rb', line 45

attribute :disclaimer_specialist, API::Base::BoolInt.optional.default(nil)

#disclaimer_supplements ⇒ API::Base::BoolInt

Returns Information whether disclaimer is enabled.

Returns:

• (API::Base::BoolInt) —

  Information whether disclaimer is enabled

# File 'lib/vk/api/ads/ad.rb', line 47

attribute :disclaimer_supplements, API::Base::BoolInt.optional.default(nil)

#id ⇒ Integer

Returns Ad ID.

Returns:

• (Integer) —

  Ad ID

# File 'lib/vk/api/ads/ad.rb', line 11

attribute :id, API::Types::Coercible::Int

#impressions_limit ⇒ Integer

Returns Impressions limit.

Returns:

• (Integer) —

  Impressions limit

# File 'lib/vk/api/ads/ad.rb', line 23

attribute :impressions_limit, API::Types::Coercible::Int.optional.default(nil)

#impressions_limited ⇒ Integer

Returns Information whether impressions are limited.

Returns:

• (Integer) —

  Information whether impressions are limited

# File 'lib/vk/api/ads/ad.rb', line 25

attribute :impressions_limited, API::Types::Coercible::Int.optional.default(nil)

#name ⇒ String

Returns Ad title.

Returns:

• (String) —

  Ad title

# File 'lib/vk/api/ads/ad.rb', line 37

attribute :name, API::Types::Coercible::String

#status ⇒ Integer

Returns Ad atatus.

Returns:

• (Integer) —

  Ad atatus

# File 'lib/vk/api/ads/ad.rb', line 35

attribute :status, API::Types::Coercible::Int.enum(0, 1, 2)

#video ⇒ API::Base::BoolInt

Returns Information whether the ad is a video.

Returns:

• (API::Base::BoolInt) —

  Information whether the ad is a video

# File 'lib/vk/api/ads/ad.rb', line 41

attribute :video, API::Base::BoolInt.optional.default(nil)