class ConstantContact::Services::CampaignTrackingService

Public Instance Methods

get_bounces(campaign_id, params = {}) click to toggle source

Get bounces for a given campaign @param [String] campaign_id - Campaign id @param [Hash] params - query parameters to be appended to request @return [ResultSet<BounceActivity>] - Containing a results array of BounceActivity

# File lib/constantcontact/services/campaign_tracking_service.rb, line 15
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 = {}) click to toggle source

Get clicks for a given campaign @param [String] campaign_id - Campaign id @param [Hash] params - query parameters to be appended to request @return [ResultSet<ClickActivity>] - Containing a results array of ClickActivity

# File lib/constantcontact/services/campaign_tracking_service.rb, line 36
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 = {}) click to toggle source

Get forwards for a given campaign @param [String] campaign_id - Campaign id @param [Hash] params - query parameters to be appended to request @return [ResultSet<ForwardActivity>] - Containing a results array of ForwardActivity

# File lib/constantcontact/services/campaign_tracking_service.rb, line 57
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 = {}) click to toggle source

Get opens for a given campaign @param [String] campaign_id - Campaign id @param [Hash] params - query parameters to be appended to request @return [ResultSet<OpenActivity>] - Containing a results array of OpenActivity

# File lib/constantcontact/services/campaign_tracking_service.rb, line 78
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 = {}) click to toggle source

Get sends for a given campaign @param [String] campaign_id - Campaign id @param [Hash] params - query parameters to be appended to request @return [ResultSet<SendActivity>] - Containing a results array of SendActivity

# File lib/constantcontact/services/campaign_tracking_service.rb, line 99
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) click to toggle source

Get a summary of reporting data for a given campaign @param [Integer] campaign_id - Campaign id @return [TrackingSummary]

# File lib/constantcontact/services/campaign_tracking_service.rb, line 140
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 = {}) click to toggle source

Get unsubscribes for a given campaign @param [String] campaign_id - Campaign id @param [Hash] params - query params to be appended to request @return [ResultSet<UnsubscribeActivity>] - Containing a results array of UnsubscribeActivity

# File lib/constantcontact/services/campaign_tracking_service.rb, line 120
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