Class: Vk::API::Ads::Methods::GetStatistics

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

Overview

Returns statistics of performance indicators for ads, campaigns, clients or the whole account.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :account_id (Integer) —

    Advertising account ID.

  • :ids_type (String) —

    Type of requested objects listed in 'ids' parameter:; *ad — ads;; *campaign — campaigns;; *client — clients;; *office — account.;

  • :ids (String) —

    IDs requested ads, campaigns, clients or account, separated with a comma, depending on the value set in 'ids_type'. Maximum 2000 objects.

  • :period (String) —

    Data grouping by dates:; *day — statistics by days;; *month — statistics by months;; *overall — overall statistics.; 'date_from' and 'date_to' parameters set temporary limits.

  • :date_from (String) —

    Date to show statistics from. For different value of 'period' different date format is used:; *day: YYYY-MM-DD, example: 2011-09-27 — September 27, 2011; **0 — day it was created on;; *month: YYYY-MM, example: 2011-09 — September 2011; **0 — month it was created in;; *overall: 0.;

  • :date_to (String) —

    Date to show statistics to. For different value of 'period' different date format is used:; *day: YYYY-MM-DD, example: 2011-09-27 — September 27, 2011; **0 — current day;; *month: YYYY-MM, example: 2011-09 — September 2011; **0 — current month;; *overall: 0.




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

Instance Method Details

#account_id ⇒ Integer

Returns Advertising account ID.

Returns:

  • (Integer) —

    Advertising account ID.



28
 
# File 'lib/vk/api/ads/methods/get_statistics.rb', line 28

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

#date_from ⇒ String

Returns Date to show statistics from. For different value of 'period' different date format is used:; *day: YYYY-MM-DD, example: 2011-09-27 — September 27, 2011; **0 — day it was created on;; *month: YYYY-MM, example: 2011-09 — September 2011; **0 — month it was created in;; *overall: 0.;.

Returns:

  • (String) —

    Date to show statistics from. For different value of 'period' different date format is used:; *day: YYYY-MM-DD, example: 2011-09-27 — September 27, 2011; **0 — day it was created on;; *month: YYYY-MM, example: 2011-09 — September 2011; **0 — month it was created in;; *overall: 0.;



36
 
# File 'lib/vk/api/ads/methods/get_statistics.rb', line 36

attribute :date_from, API::Types::Coercible::String

#date_to ⇒ String

Returns Date to show statistics to. For different value of 'period' different date format is used:; *day: YYYY-MM-DD, example: 2011-09-27 — September 27, 2011; **0 — current day;; *month: YYYY-MM, example: 2011-09 — September 2011; **0 — current month;; *overall: 0.

Returns:

  • (String) —

    Date to show statistics to. For different value of 'period' different date format is used:; *day: YYYY-MM-DD, example: 2011-09-27 — September 27, 2011; **0 — current day;; *month: YYYY-MM, example: 2011-09 — September 2011; **0 — current month;; *overall: 0.



38
 
# File 'lib/vk/api/ads/methods/get_statistics.rb', line 38

attribute :date_to, API::Types::Coercible::String

#ids ⇒ String

Returns IDs requested ads, campaigns, clients or account, separated with a comma, depending on the value set in 'ids_type'. Maximum 2000 objects.

Returns:

  • (String) —

    IDs requested ads, campaigns, clients or account, separated with a comma, depending on the value set in 'ids_type'. Maximum 2000 objects.



32
 
# File 'lib/vk/api/ads/methods/get_statistics.rb', line 32

attribute :ids, API::Types::Coercible::String

#ids_type ⇒ String

Returns Type of requested objects listed in 'ids' parameter:; *ad — ads;; *campaign — campaigns;; *client — clients;; *office — account.;.

Returns:

  • (String) —

    Type of requested objects listed in 'ids' parameter:; *ad — ads;; *campaign — campaigns;; *client — clients;; *office — account.;



30
 
# File 'lib/vk/api/ads/methods/get_statistics.rb', line 30

attribute :ids_type, API::Types::Coercible::String

#period ⇒ String

Returns Data grouping by dates:; *day — statistics by days;; *month — statistics by months;; *overall — overall statistics.; 'date_from' and 'date_to' parameters set temporary limits.

Returns:

  • (String) —

    Data grouping by dates:; *day — statistics by days;; *month — statistics by months;; *overall — overall statistics.; 'date_from' and 'date_to' parameters set temporary limits.



34
 
# File 'lib/vk/api/ads/methods/get_statistics.rb', line 34

attribute :period, API::Types::Coercible::String