Class: Vk::API::Ads::Methods::GetCampaigns

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

Overview

Returns a list of campaigns in an advertising account.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :account_id (Integer) —

    Advertising account ID.

  • :client_id (Integer) —

    'For advertising agencies'. ID of the client advertising campaigns are retrieved from.

  • :include_deleted (Boolean) —

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

  • :campaign_ids (String) —

    Filter of advertising campaigns to show. ; Serialized JSON array with campaign IDs. Only campaigns that exist in 'campaign_ids' and belong to the specified advertising account will be shown. If the parameter is null, all campaigns will be shown.;




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

Instance Method Details

#account_id ⇒ Integer

Returns Advertising account ID.

Returns:

  • (Integer) —

    Advertising account ID.



26
 
# File 'lib/vk/api/ads/methods/get_campaigns.rb', line 26

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

#campaign_ids ⇒ String

Returns Filter of advertising campaigns to show. ; Serialized JSON array with campaign IDs. Only campaigns that exist in 'campaign_ids' and belong to the specified advertising account will be shown. If the parameter is null, all campaigns will be shown.;.

Returns:

  • (String) —

    Filter of advertising campaigns to show. ; Serialized JSON array with campaign IDs. Only campaigns that exist in 'campaign_ids' and belong to the specified advertising account will be shown. If the parameter is null, all campaigns will be shown.;



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

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

#client_id ⇒ Integer

Returns 'For advertising agencies'. ID of the client advertising campaigns are retrieved from.

Returns:

  • (Integer) —

    'For advertising agencies'. ID of the client advertising campaigns are retrieved from.



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

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

#include_deleted ⇒ Boolean

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

Returns:

  • (Boolean) —

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



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

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