Class: GoodDataMarketo::Leads

Inherits:
Object
  • Object
show all
Defined in:
lib/gooddata_marketo/models/leads.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = {}) ⇒ Leads

Returns a new instance of Leads.



10
11
12
13
14
 
# File 'lib/gooddata_marketo/models/leads.rb', line 10

def initialize config = {}

  @client = config[:client]

end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



8
9
10
 
# File 'lib/gooddata_marketo/models/leads.rb', line 8

def client
  @client
end

Instance Method Details

#[](a) ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/gooddata_marketo/models/leads.rb', line 16

def [](a)
  if a.include? '@'
    self.get_by_email(a)
  else
    self.get_by_id(a)
  end
end

#get_activities(config = {}) ⇒ Object Also known as: get_activity

developers.marketo.com/documentation/soap/getleadactivity/



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/gooddata_marketo/models/leads.rb', line 386

def get_activities config = {} # http://developers.marketo.com/documentation/soap/getleadactivity/

  # EXAMPLE HISTORY REQUEST
  # request = {
  #     :lead_selector => {
  #         :key_type => "IDNUM",
  #         :key_value => "[email protected]"},
  #     :activity_filter => {
  #         :include_types => {
  #             :activity_type => ["VisitWebpage", "FillOutForm"]
  #         }
  #     },
  #     :start_position => {
  #         :"last_created_at/" => "",
  #         :"offset/" => "" },
  #     :batch_size => "10"
  # }

  request = {
      :lead_key => {
          :key_type => config[:type] || "EMAIL",
          :key_value => config[:value]},
      :batch_size => config[:batch_size] || "1000"
  }

  activity_types = config[:activity_types] || config[:activity_type]

  if activity_types

    activity_types = [activity_types] if activity_types.is_a? String

    request[:activity_filter] = {}
    request[:activity_filter][:include_types] = {}
    request[:activity_filter][:include_types] = activity_types

  end

  # Check if any date options were added and if so add the date hash.
  if config[:last_created_at] || config[:activity_created_at] || config[:latest_created_at] || config[:oldest_created_at]
    request[:start_position] = {}
  end

  request[:start_position][:last_created_at] = StringWizard.time(config[:last_created_at]) if config[:last_created_at]
  request[:start_position][:activity_created_at] = StringWizard.time(config[:activity_created_at]) if config[:activity_created_at]
  request[:start_position][:latest_created_at] = StringWizard.time(config[:latest_created_at]) if config[:latest_created_at]
  request[:start_position][:oldest_created_at] = StringWizard.time(config[:oldest_created_at]) if config[:oldest_created_at]

  c = client.stream(:get_lead_activity, request)

  leads_from_activities_call = []
  begin
    c.storage.each do |request|
      request[:activity_record_list][:activity_record].each { |activity|
        l = GoodDataMarketo::Activity.new activity
        leads_from_activities_call << l
      }
    end
  rescue
    puts "#{Time.now} =>  Marketo (0) results for query. Adjust the configuration of the request or confirm there has not been changes to the structure of response from Marketo."
  end

  client.load.log('RESPONSE') if client.load

  leads_from_activities_call

end

#get_activity_by_email(email) ⇒ Object 



455
456
457
458
459
460
461
462
 
# File 'lib/gooddata_marketo/models/leads.rb', line 455

def get_activity_by_email email
  config = {}
  config[:type] = 'EMAIL'
  config[:value] = email

  self.get_activities config

end

#get_activity_by_id(id) ⇒ Object 



464
465
466
467
468
469
470
471
 
# File 'lib/gooddata_marketo/models/leads.rb', line 464

def get_activity_by_id id
  config = {}
  config[:type] = 'IDNUM'
  config[:value] = id

  self.get_activity config

end

#get_by_email(email) ⇒ Object

POSSIBLE KEY TYPES FOR LEAD QUERIES

IDNUM: The Marketo ID (e.g. 64) COOKIE: The value generated by the Munchkin Javascript. (e.g. id:561-HYG-937&token:_mch-marketo.com-1258067434006-50277) EMAIL: The email address associated with the lead. (e.g. [email protected]) SFDCLEADID: The lead ID from SalesForce LEADOWNEREMAIL: The Lead Owner Email SFDCACCOUNTID: The Account ID from SalesForce SFDCCONTACTID: The Contact ID from SalesForce SFDCLEADID: TheLead ID from SalesForce SFDCLEADOWNERID: The Lead owner ID from SalesForce SFDCOPPTYID: The Opportunity ID from SalesForce



37
38
39
40
41
42
43
44
 
# File 'lib/gooddata_marketo/models/leads.rb', line 37

def get_by_email email # http://developers.marketo.com/documentation/soap/getlead/
  type = 'EMAIL'
  request = { :lead_key => { :key_type => type,  :key_value => email } }
  response = client.call(:get_lead, request)
  # GoodDataMarketo::Lead.new response[:lead_record_list][:lead_record], :client => client (CLIENT REMOVED DUE TO PERFORMANCE ISSUE)
  GoodDataMarketo::Lead.new response[:lead_record_list][:lead_record]

end

#get_by_id(id) ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/gooddata_marketo/models/leads.rb', line 46

def get_by_id id
  type = 'IDNUM'
  request = { :lead_key => { :key_type => type,  :key_value => id } }
  response = client.call(:get_lead, request)
  # GoodDataMarketo::Lead.new response[:lead_record_list][:lead_record], :client => client (CLIENT REMOVED DUE TO PERFORMANCE ISSUE)
  GoodDataMarketo::Lead.new response[:lead_record_list][:lead_record]

end

#get_changes(config = {}) ⇒ Object

developers.marketo.com/documentation/soap/getleadchanges/



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/gooddata_marketo/models/leads.rb', line 230

def get_changes(config = {}) # http://developers.marketo.com/documentation/soap/getleadchanges/

  # EXAMPLE REQUEST
  # request = {
  #     :start_position => {
  #         :oldest_created_at => "2013-07-01 23:58:14 -0700",
  #     },
  #     :activity_name_filter => {
  #         :stringItem => ["Visit Webpage", "Click Link"] },
  #     :batch_size => "100"
  # }

  # OPTIONAL ACTIVITIES
  # NewLead
  # AssocWithOpprtntyInSales
  # DissocFromOpprtntyInSales
  # UpdateOpprtntyInSales
  # ChangeDataValue
  # MergeLeads
  # OpenEmail
  # SendEmail

  request = {
      :start_position => Hash.new,
      :batch_size => config[:batch_size] || '1000'
  }

  ###################
  # Activity Config #
  ###################

  query = config[:lead] || config[:email] || config[:values] || config[:value]

  if query
    query = [query] if query.is_a? String
    xsi_type = config[:xsi_type] || 'ns1:LeadKeySelector'

    request[:lead_selector] = {}
    request[:lead_selector][:key_values] = {}
    request[:lead_selector][:key_type] = config[:type] || 'EMAIL'
    request[:lead_selector][:key_values][:string_item] = query
    request[:attributes!] = { :lead_selector => { 'xsi:type' => xsi_type } }

  end

  inc = config[:include_attributes] || config[:include] || config[:types]
  if inc
    if inc.is_a? String
      inc = [inc]
    end
    request[:activity_filter][:include_attributes] = inc
  end

  exc = config[:exclude_attributes] || config[:exclude]
  if exc
    if exc.is_a? String
      exc = [exc]
    end
    request[:activity_filter][:exclude_attributes] = exc
  end

  activities = config[:filters] || config[:activity_name_filter] || config[:activities]
  if activities

    activities = [activities] if activities.is_a? String
    request[:activity_name_filter] = Hash.new
    request[:activity_name_filter][:string_item] = activities
  end

  # Ensure that the API call is not made with both.
  if inc && exc
    raise "Include and exclude attributes may not be used in the same call."
  end

  #########################
  # Start Position Config #
  #########################

  if config[:oldest_created_at]
    begin
      oca = StringWizard.time(config[:oldest_created_at])
      request[:start_position][:oldest_created_at] = oca
    rescue Exception => e
      puts e if GoodDataMarketo.logging
    end

  end

  if config[:latest_created_at]
    begin
      lca = StringWizard.time(config[:latest_created_at])
      request[:start_position][:latest_created_at] = lca
    rescue Exception => e
      puts e if GoodDataMarketo.logging
    end

  end

  if config[:activity_created_at]
    begin
      aca = StringWizard.time(config[:activity_created_at])
      request[:start_position][:activity_created_at] = aca
    rescue Exception => e
      puts e if GoodDataMarketo.logging
    end
  end

  o = config[:offset]
  request[:start_position][:offset] = o if o

  raise 'A start position type is required (:oldest_created_at, :offset, :activity_created_at)' unless oca || aca || o

  c = client.stream(:get_lead_changes, request)

  # Load all of the leads from the stream into an array for processes from a load or direct call.
  # If it is a direct call, build an object, if not move the item as raw json.
  
  leads_from_changes_call = []
  begin

    c.storage.pmap do |request|

      stored_item = request[:lead_change_record_list][:lead_change_record]

      if stored_item.is_a? Array
        stored_item.each { |activity|
          if client.load
            l = activity.to_json
          else
            l = GoodDataMarketo::Activity.new activity
          end

          leads_from_changes_call << l
        }
      else
        if client.load
          l = stored_item.to_json
        else
          l = GoodDataMarketo::Activity.new activity
        end
        leads_from_changes_call << l
      end
    end

  rescue

    puts "#{Time.now} => 0 results for Marketo query."
  end

  client.load.log('RESPONSE') if client.load
  client.load.storage = leads_from_changes_call if client.load

  leads_from_changes_call

end

#get_multiple(config = {}) ⇒ Object

developers.marketo.com/documentation/soap/getmultipleleads/



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/gooddata_marketo/models/leads.rb', line 55

def get_multiple config = {} # http://developers.marketo.com/documentation/soap/getmultipleleads/

  values_array = config[:ids] || config[:values]

  @leads_from_call = []

  # Possible types
  # IDNUM, COOKIE, EMAIL, LEADOWNEREMAIL, SFDCACCOUNTID, SFDCCONTACTID, SFDCLEADID, SFDCLEADOWNERID, SFDCOPPTYID.

  type = config[:type] || 'IDNUM'
  xsi_type = config[:xsi_type] || 'ns1:LeadKeySelector'

  if values_array.is_a? String
    values_array = [values_array]
  end

  segments = values_array.each_slice(100).to_a

  segments.each { |values|

    request = {
        :lead_selector => {
            :key_type => type,
            :key_values => {
                :string_item => values
            }
        },
        :batch_size => config[:batch_size] || "100", # Unable to determine timeout rate at the 1000 so moved to 200.
        :attributes! => { :lead_selector => { 'xsi:type' => xsi_type } }
    }

    inc = config[:include_attributes] || config[:include] || config[:types]
    if inc
      if inc.is_a? String
        inc = [inc]
      end
      request[:activity_filter][:include_attributes] = inc
    end

    exc = config[:exclude_attributes] || config[:exclude]
    if exc
      if exc.is_a? String
        exc = [exc]
      end
      request[:activity_filter][:exclude_attributes] = exc
    end

    activities = config[:filters] || config[:activity_name_filter] || config[:activities]
    if activities
      activities = [activities] if activities.is_a? String
      request[:activity_name_filter] = Hash.new
      request[:activity_name_filter][:string_item] = activities
    end

    # Ensure that the API call is not made with both.
    if inc && exc
      raise "Include and exclude attributes may not be used in the same call."
    end

    request[:start_position] = Hash.new if config[:oldest_created_at] || config[:activity_created_at] || config[:offset]

    if config[:oldest_created_at]
      begin
        oca = StringWizard.time(config[:oldest_created_at]).to_s
        request[:start_position][:oldest_created_at] = oca
      rescue Exception => e
        puts e if GoodDataMarketo.logging
      end

    end

    if config[:activity_created_at]
      begin
        aca = StringWizard.time(config[:activity_created_at]).to_s
        request[:start_position][:activity_created_at] = aca
      rescue Exception => e
        puts e if GoodDataMarketo.logging
      end
    end

    if config[:latest_created_at]
      begin
        lca = StringWizard.time(config[:latest_created_at]).to_s
        request[:start_position][:latest_created_at] = lca
      rescue Exception => e
        puts e if GoodDataMarketo.logging
      end
    end

    offset_date = config[:offset]

    request[:start_position][:offset] = offset_date if offset_date

    # Execute a stream unless the number of leads is less than the batch limit of 100
    begin

      if values.length < 101 && values.length > 1

        c = client.call(:get_multiple_leads, request)
        c[:lead_record_list][:lead_record].each { |lead|
          # l = GoodDataMarketo::Lead.new lead, :client => client (CLIENT REMOVED DUE TO PERFORMANCE ISSUE)
          if client.load
            l = lead.to_json
          else
            l = GoodDataMarketo::Lead.new lead
          end

          @leads_from_call << l
        }

        if client.load
          ids = client.load.arguments[:ids].drop(values.length)
          client.load.arguments[:ids] = ids
          client.load.save

        end


      elsif values.length == 1
        c = client.call(:get_multiple_leads, request)

        # l = GoodDataMarketo::Lead.new c[:lead_record_list][:lead_record], :client => client (CLIENT REMOVED DUE TO PERFORMANCE ISSUE)
        if client.load
          l = c[:lead_record_list][:lead_record].to_json
        else
          l = GoodDataMarketo::Lead.new c[:lead_record_list][:lead_record]
        end

        @leads_from_call << l

      else

        c = client.stream(:get_multiple_leads, request)

        if client.load

          ids = client.load.arguments[:ids].drop(values.length)

          client.load.arguments[:ids] = ids

          client.load.save

        end

        puts "#{Time.now} => Marketo:Leads:#{c.storage.length}" if GoodDataMarketo.logging
        c.storage.each do |request|
          request[:lead_record_list][:lead_record].each { |lead|
            # l = GoodDataMarketo::Lead.new lead, :client => client (CLIENT REMOVED DUE TO PERFORMANCE ISSUE)

            # To conserve memory on large batches sent the raw file to load storage.
            if client.load
              l = lead.to_json
            else
              l = GoodDataMarketo::Lead.new lead
            end

            @leads_from_call << l
          }
        end

      end
    rescue Exception => exp
      puts exp if GoodDataMarketo.logging
      puts "#{Time.now} => 0 results for Marketo query."
    end

    puts "#{Time.now} => Marketo:Leads:Queue:#{@leads_from_call.length}"

  }
  client.load.log('RESPONSE') if client.load
  client.load.storage = @leads_from_call if client.load
  @leads_from_call

end

#get_multiple_by_email(emails, config = {}) ⇒ Object 



473
474
475
476
477
 
# File 'lib/gooddata_marketo/models/leads.rb', line 473

def get_multiple_by_email emails, config = {}
  config[:type] = 'EMAIL'
  config[:ids] = emails
  self.get_multiple config
end

#get_multiple_by_id(ids, config = {}) ⇒ Object 



479
480
481
482
483
 
# File 'lib/gooddata_marketo/models/leads.rb', line 479

def get_multiple_by_id ids, config = {}
  config[:type] = 'IDNUM'
  config[:ids] = ids
  self.get_multiple config
end

#types ⇒ Object 



485
486
487
488
489
 
# File 'lib/gooddata_marketo/models/leads.rb', line 485

def types
  m = self.methods - Object.methods
  m.delete(:types)
  m
end