Class: Vk::API::Ads::AdLayout

Inherits:

Schema::Object

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

Defined in:

lib/vk/api/ads/ad_layout.rb

Overview

See Also:

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

Instance Method Summary

• #ad_format ⇒ Integer

  Ad format.

• #campaign_id ⇒ Integer

  Campaign ID.

• #cost_type ⇒ Integer

  Cost type.

• #description ⇒ String

  Ad description.

• #id ⇒ Integer

  Ad ID.

• #image_src ⇒ Integer

  Image URL.

• #image_src_2x ⇒ Integer

  URL of the preview image in double size.

• #link_domain ⇒ String

  Domain of advertised object.

• #link_url ⇒ String

  URL of advertised object.

• #preview_link ⇒ Integer, String

  Link to preview an ad as it is shown on the website.

• #title ⇒ String

  Ad title.

• #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_layout.rb', line 15

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

#campaign_id ⇒ Integer

Returns Campaign ID.

Returns:

• (Integer) —

  Campaign ID

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

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

#cost_type ⇒ Integer

Returns Cost type.

Returns:

• (Integer) —

  Cost type

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

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

#description ⇒ String

Returns Ad description.

Returns:

• (String) —

  Ad description

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

attribute :description, API::Types::Coercible::String.optional.default(nil)

#id ⇒ Integer

Returns Ad ID.

Returns:

• (Integer) —

  Ad ID

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

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

#image_src ⇒ Integer

Returns Image URL.

Returns:

• (Integer) —

  Image URL

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

attribute :image_src, API::Types::Coercible::Int

#image_src_2x ⇒ Integer

Returns URL of the preview image in double size.

Returns:

• (Integer) —

  URL of the preview image in double size

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

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

#link_domain ⇒ String

Returns Domain of advertised object.

Returns:

• (String) —

  Domain of advertised object

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

attribute :link_domain, API::Types::Coercible::String.optional.default(nil)

#link_url ⇒ String

Returns URL of advertised object.

Returns:

• (String) —

  URL of advertised object

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

attribute :link_url, API::Types::Coercible::String.optional.default(nil)

#preview_link ⇒ Integer, String

Returns link to preview an ad as it is shown on the website.

Returns:

• (Integer, String) —

  link to preview an ad as it is shown on the website

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

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

#title ⇒ String

Returns Ad title.

Returns:

• (String) —

  Ad title

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

attribute :title, API::Types::Coercible::String

#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_layout.rb', line 19

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