Class: Vk::API::Ads::Methods::GetCampaigns
- Inherits:
-
Schema::Method
- Object
- Dry::Struct
- Schema::Method
- Vk::API::Ads::Methods::GetCampaigns
- Defined in:
- lib/vk/api/ads/methods/get_campaigns.rb
Overview
Returns a list of campaigns in an advertising account.
Arguments collapse
-
#account_id ⇒ Integer
Advertising account ID.
-
#campaign_ids ⇒ String
Filter of advertising campaigns to show.
-
#client_id ⇒ Integer
'For advertising agencies'.
-
#include_deleted ⇒ Boolean
Flag that specifies whether archived ads shall be shown.; *0 — show only active campaigns;; *1 — show all campaigns.;.
Instance Method Summary collapse
Methods inherited from Schema::Method
Constructor Details
#initialize(arguments) ⇒ Ads::Methods::GetCampaigns
|
# File 'lib/vk/api/ads/methods/get_campaigns.rb', line 15
|
Instance Method Details
#account_id ⇒ Integer
Returns 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.;.
32 |
# File 'lib/vk/api/ads/methods/get_campaigns.rb', line 32 attribute :campaign_ids, API::Types::Coercible::String.optional.default(nil) |