Class: Yandex::Direct::Campaign

Inherits:
Base
  • Object
show all
Defined in:
lib/yandex/direct/models/campaign.rb

Constant Summary collapse

ATTRIBUTES =
:Id, :Name, :ClientInfo, :StartDate, :EndDate, :TimeTargeting, :TimeZone, :NegativeKeywords,
:BlockedIps, :ExcludedSites, :DailyBudget, :Notification, :Type, :Status, :State, :StatusPayment,
:StatusClarification, :SourceId, :Statistics, :Currency, :Funds, :RepresentedBy

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

create, initialize, path, #save, #to_param

Class Method Details

.archive(selection_criteria) ⇒ Object



26
27
28
29
# File 'lib/yandex/direct/models/campaign.rb', line 26

def self.archive(selection_criteria)
  response = Yandex::Direct.request('archive', self.path, selection_criteria)
  Yandex::Direct.parse(response, 'ArchiveResults', Yandex::Direct::ActionResult)
end

.delete(selection_criteria) ⇒ Object



62
63
64
65
# File 'lib/yandex/direct/models/campaign.rb', line 62

def self.delete(selection_criteria)
  response = Yandex::Direct.request('delete', self.path, selection_criteria)
  Yandex::Direct.parse(response, 'DeleteResults', Yandex::Direct::ActionResult)
end

.find(id) ⇒ Object



22
23
24
# File 'lib/yandex/direct/models/campaign.rb', line 22

def self.find(id)
  self.where(Ids: Array(id)).call(:get).first
end

.get(selection_criteria) ⇒ Object



17
18
19
20
# File 'lib/yandex/direct/models/campaign.rb', line 17

def self.get(selection_criteria)
  response = Yandex::Direct.request('get', self.path, selection_criteria.fields(*ATTRIBUTES))
  Yandex::Direct.parse(response, 'Campaigns',self)
end

.resume(selection_criteria) ⇒ Object



44
45
46
47
# File 'lib/yandex/direct/models/campaign.rb', line 44

def self.resume(selection_criteria)
  response = Yandex::Direct.request('resume', self.path, selection_criteria)
  Yandex::Direct.parse(response, 'ResumeResults', Yandex::Direct::ActionResult)
end

.suspend(selection_criteria) ⇒ Object



53
54
55
56
# File 'lib/yandex/direct/models/campaign.rb', line 53

def self.suspend(selection_criteria)
  response = Yandex::Direct.request('suspend', self.path, selection_criteria)
  Yandex::Direct.parse(response, 'SuspendResults', Yandex::Direct::ActionResult)
end

.unarchive(selection_criteria) ⇒ Object



35
36
37
38
# File 'lib/yandex/direct/models/campaign.rb', line 35

def self.unarchive(selection_criteria)
  response = Yandex::Direct.request('unarchive', self.path, selection_criteria)
  Yandex::Direct.parse(response, 'UnarchiveResults', Yandex::Direct::ActionResult)
end

Instance Method Details

#archiveObject



31
32
33
# File 'lib/yandex/direct/models/campaign.rb', line 31

def archive
  self.class.where(Ids: [self.Id]).call(:archive).first
end

#attributesObject



10
11
12
13
14
15
# File 'lib/yandex/direct/models/campaign.rb', line 10

def attributes
  {
      :Id => nil,
      :Name => nil
  }
end

#deleteObject



67
68
69
# File 'lib/yandex/direct/models/campaign.rb', line 67

def delete
  self.class.where(Ids: [self.Id]).call(:delete).first
end

#resumeObject



49
50
51
# File 'lib/yandex/direct/models/campaign.rb', line 49

def resume
  self.class.where(Ids: [self.Id]).call(:resume).first
end

#suspendObject



58
59
60
# File 'lib/yandex/direct/models/campaign.rb', line 58

def suspend
  self.class.where(Ids: [self.Id]).call(:suspend).first
end

#unarchiveObject



40
41
42
# File 'lib/yandex/direct/models/campaign.rb', line 40

def unarchive
  self.class.where(Ids: [self.Id]).call(:unarchive).first
end