Class: ConstantContact::Services::CampaignTrackingService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/constantcontact/services/campaign_tracking_service.rb

Class Method Summary collapse

Class Method Details

.get_bounces(campaign_id, params = {}) ⇒ ResultSet<BounceActivity>

Get bounces for a given campaign

Parameters:

  • campaign_id (String) —

    • Campaign id

  • params (Hash) (defaults to: {}) —

    • query parameters to be appended to request

Returns:

  • (ResultSet<BounceActivity>) —

    • Containing a results array of BounceActivity



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/constantcontact/services/campaign_tracking_service.rb', line 16

def get_bounces(campaign_id, params = {})
  url = Util::Config.get('endpoints.base_url') +
        sprintf(Util::Config.get('endpoints.campaign_tracking_bounces'), campaign_id)
  url = build_url(url, params)

  response = RestClient.get(url, get_headers())
  body = JSON.parse(response.body)

  bounces = []
  body['results'].each do |bounce_activity|
    bounces << Components::BounceActivity.create(bounce_activity)
  end

  Components::ResultSet.new(bounces, body['meta'])
end

.get_clicks(campaign_id, params = {}) ⇒ ResultSet<ClickActivity>

Get clicks for a given campaign

Parameters:

  • campaign_id (String) —

    • Campaign id

  • params (Hash) (defaults to: {}) —

    • query parameters to be appended to request

Returns:

  • (ResultSet<ClickActivity>) —

    • Containing a results array of ClickActivity



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/constantcontact/services/campaign_tracking_service.rb', line 37

def get_clicks(campaign_id, params = {})
  url = Util::Config.get('endpoints.base_url') +
        sprintf(Util::Config.get('endpoints.campaign_tracking_clicks'), campaign_id)
  url = build_url(url, params)

  response = RestClient.get(url, get_headers())
  body = JSON.parse(response.body)

  clicks = []
  body['results'].each do |click_activity|
    clicks << Components::ClickActivity.create(click_activity)
  end

  Components::ResultSet.new(clicks, body['meta'])
end

.get_forwards(campaign_id, params = {}) ⇒ ResultSet<ForwardActivity>

Get forwards for a given campaign

Parameters:

  • campaign_id (String) —

    • Campaign id

  • params (Hash) (defaults to: {}) —

    • query parameters to be appended to request

Returns:

  • (ResultSet<ForwardActivity>) —

    • Containing a results array of ForwardActivity



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/constantcontact/services/campaign_tracking_service.rb', line 58

def get_forwards(campaign_id, params = {})
  url = Util::Config.get('endpoints.base_url') +
        sprintf(Util::Config.get('endpoints.campaign_tracking_forwards'), campaign_id)
  url = build_url(url, params)

  response = RestClient.get(url, get_headers())
  body = JSON.parse(response.body)

  forwards = []
  body['results'].each do |forward_activity|
    forwards << Components::ForwardActivity.create(forward_activity)
  end

  Components::ResultSet.new(forwards, body['meta'])
end

.get_opens(campaign_id, params = {}) ⇒ ResultSet<OpenActivity>

Get opens for a given campaign

Parameters:

  • campaign_id (String) —

    • Campaign id

  • params (Hash) (defaults to: {}) —

    • query parameters to be appended to request

Returns:

  • (ResultSet<OpenActivity>) —

    • Containing a results array of OpenActivity



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/constantcontact/services/campaign_tracking_service.rb', line 79

def get_opens(campaign_id, params = {})
  url = Util::Config.get('endpoints.base_url') +
        sprintf(Util::Config.get('endpoints.campaign_tracking_opens'), campaign_id)
  url = build_url(url, params)

  response = RestClient.get(url, get_headers())
  body = JSON.parse(response.body)

  opens = []
  body['results'].each do |open_activity|
    opens << Components::OpenActivity.create(open_activity)
  end

  Components::ResultSet.new(opens, body['meta'])
end

.get_sends(campaign_id, params = {}) ⇒ ResultSet<SendActivity>

Get sends for a given campaign

Parameters:

  • campaign_id (String) —

    • Campaign id

  • params (Hash) (defaults to: {}) —

    • query parameters to be appended to request

Returns:

  • (ResultSet<SendActivity>) —

    • Containing a results array of SendActivity



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/constantcontact/services/campaign_tracking_service.rb', line 100

def get_sends(campaign_id, params = {})
  url = Util::Config.get('endpoints.base_url') +
        sprintf(Util::Config.get('endpoints.campaign_tracking_sends'), campaign_id)
  url = build_url(url, params)

  response = RestClient.get(url, get_headers())
  body = JSON.parse(response.body)

  sends = []
  body['results'].each do |send_activity|
    sends << Components::SendActivity.create(send_activity)
  end

  Components::ResultSet.new(sends, body['meta'])
end

.get_summary(campaign_id) ⇒ TrackingSummary

Get a summary of reporting data for a given campaign

Parameters:

  • campaign_id (Integer) —

    • Campaign id

Returns:

  • (TrackingSummary) 


141
142
143
144
145
146
147
 
# File 'lib/constantcontact/services/campaign_tracking_service.rb', line 141

def get_summary(campaign_id)
  url = Util::Config.get('endpoints.base_url') +
        sprintf(Util::Config.get('endpoints.campaign_tracking_summary'), campaign_id)
  url = build_url(url)
  response = RestClient.get(url, get_headers())
  Components::TrackingSummary.create(JSON.parse(response.body))
end

.get_unsubscribes(campaign_id, params = {}) ⇒ ResultSet<UnsubscribeActivity>

Get unsubscribes for a given campaign

Parameters:

  • campaign_id (String) —

    • Campaign id

  • params (Hash) (defaults to: {}) —

    • query params to be appended to request

Returns:

  • (ResultSet<UnsubscribeActivity>) —

    • Containing a results array of UnsubscribeActivity



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/constantcontact/services/campaign_tracking_service.rb', line 121

def get_unsubscribes(campaign_id, params = {})
  url = Util::Config.get('endpoints.base_url') +
        sprintf(Util::Config.get('endpoints.campaign_tracking_unsubscribes'), campaign_id)
  url = build_url(url, params)

  response = RestClient.get(url, get_headers())
  body = JSON.parse(response.body)

  unsubscribes = []
  body['results'].each do |unsubscribe_activity|
    unsubscribes << Components::UnsubscribeActivity.create(unsubscribe_activity)
  end

  Components::ResultSet.new(unsubscribes, body['meta'])
end