Class: Vk::API::Ads::Methods::GetTargetingStats

Inherits:
Schema::Method
  • Object
show all
Defined in:
lib/vk/api/ads/methods/get_targeting_stats.rb

Overview

Returns the size of targeting audience, and also recommended values for CPC and CPM.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Ads::Methods::GetTargetingStats

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :account_id (Integer)

    Advertising account ID.

  • :criteria (String)

    Serialized JSON object that describes targeting parameters. Description of 'criteria' object see below.

  • :ad_id (Integer)

    ID of an ad which targeting parameters shall be analyzed.

  • :ad_format (Integer)

    Ad format. Possible values:; *'1' — image and text;; *'2' — big image;; *'3' — exclusive format;; *'4' — community, square image;; *'7' — special app format;; *'8' — special community format;; *'9' — post in community;; *'10' — app board.

  • :ad_platform (String)

    Platforms to use for ad showing. Possible values:; (for 'ad_format' = '1'); *'0' — VK and partner sites;; *'1' — VK only.; (for 'ad_format' = '9'); *'all' — all platforms;; *'desktop' — desktop version;; *'mobile' — mobile version and apps.

  • :link_url (String)

    URL for the advertised object.

  • :link_domain (String)

    Domain of the advertised object.


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

Instance Method Details

#account_idInteger

Returns Advertising account ID.

Returns:

  • (Integer)

    Advertising account ID.


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

attribute :account_id, API::Types::Coercible::Int

#ad_formatInteger

Returns Ad format. Possible values:; *'1' — image and text;; *'2' — big image;; *'3' — exclusive format;; *'4' — community, square image;; *'7' — special app format;; *'8' — special community format;; *'9' — post in community;; *'10' — app board.

Returns:

  • (Integer)

    Ad format. Possible values:; *'1' — image and text;; *'2' — big image;; *'3' — exclusive format;; *'4' — community, square image;; *'7' — special app format;; *'8' — special community format;; *'9' — post in community;; *'10' — app board.


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

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

#ad_idInteger

Returns ID of an ad which targeting parameters shall be analyzed.

Returns:

  • (Integer)

    ID of an ad which targeting parameters shall be analyzed.


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

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

#ad_platformString

Returns Platforms to use for ad showing. Possible values:; (for 'ad_format' = '1'); *'0' — VK and partner sites;; *'1' — VK only.; (for 'ad_format' = '9'); *'all' — all platforms;; *'desktop' — desktop version;; *'mobile' — mobile version and apps.

Returns:

  • (String)

    Platforms to use for ad showing. Possible values:; (for 'ad_format' = '1'); *'0' — VK and partner sites;; *'1' — VK only.; (for 'ad_format' = '9'); *'all' — all platforms;; *'desktop' — desktop version;; *'mobile' — mobile version and apps.


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

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

#criteriaString

Returns Serialized JSON object that describes targeting parameters. Description of 'criteria' object see below.

Returns:

  • (String)

    Serialized JSON object that describes targeting parameters. Description of 'criteria' object see below.


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

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

Returns Domain of the advertised object.

Returns:

  • (String)

    Domain of the advertised object.


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

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

Returns URL for the advertised object.

Returns:

  • (String)

    URL for the advertised object.


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

attribute :link_url, API::Types::Coercible::String