Class: Vk::API::Ads::Methods::GetAds

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

Overview

Returns number of ads.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :account_id (Integer)

    Advertising account ID.

  • :client_id (Integer)

    'Available and required for advertising agencies.' ID of the client ads are retrieved from.

  • :include_deleted (Boolean)

    Flag that specifies whether archived ads shall be shown:; *0 — show only active ads;; *1 — show all ads.;

  • :campaign_ids (String)

    Filter by advertising campaigns. ; Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.;

  • :ad_ids (String)

    Filter by ads. ; Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.;

  • :limit (Integer)

    Limit of number of returned ads. Used only if ad_ids parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.

  • :offset (Integer)

    Offset. Used in the same cases as 'limit' parameter.


# File 'lib/vk/api/ads/methods/get_ads.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_ads.rb', line 29

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

#ad_idsString

Returns Filter by ads. ; Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.;.

Returns:

  • (String)

    Filter by ads. ; Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.;


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

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

#campaign_idsString

Returns Filter by advertising campaigns. ; Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.;.

Returns:

  • (String)

    Filter by advertising campaigns. ; Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.;


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

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

#client_idInteger

Returns 'Available and required for advertising agencies.' ID of the client ads are retrieved from.

Returns:

  • (Integer)

    'Available and required for advertising agencies.' ID of the client ads are retrieved from.


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

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

#include_deletedBoolean

Returns Flag that specifies whether archived ads shall be shown:; *0 — show only active ads;; *1 — show all ads.;.

Returns:

  • (Boolean)

    Flag that specifies whether archived ads shall be shown:; *0 — show only active ads;; *1 — show all ads.;


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

attribute :include_deleted, API::Types::Form::Bool.optional.default(nil)

#limitInteger

Returns Limit of number of returned ads. Used only if ad_ids parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.

Returns:

  • (Integer)

    Limit of number of returned ads. Used only if ad_ids parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.


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

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

#offsetInteger

Returns Offset. Used in the same cases as 'limit' parameter.

Returns:

  • (Integer)

    Offset. Used in the same cases as 'limit' parameter.


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

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