-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnrSearchQueryAutomator.js
3737 lines (3095 loc) · 135 KB
/
nrSearchQueryAutomator.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
229
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
385
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* New features Bergzeit June 2019
- Query cleaning layer to remove typos
- rewrite adgroup build logic to sort entities
*/
/**
* [nrSearchqueryAutomator description]
* @return {[type]} [description]
*/
function nrSearchqueryAutomator() {
// 0. Load queries
var queryFetcher = new QueryFetcher();
var queriesNew = queryFetcher.getNewPaidQueries();
if (NEW_ORGANIC_QUERY_CONFIG.loadOrganicQueries === 1) queriesNew.concat(queryFetcher.getNewOrganicQueries(queriesNew));
//queriesNew.concat
// 1. Fetch entities
if (COLUMN_SEPARATOR !== ",") throw new Error("ColumnSeparatorError: Your current column separator value '" + COLUMN_SEPARATOR + " MUST be ',' (or COMMA) to work as an AdWords business data feed. Please update your feed separator (and make sure strings are enclosed with quotes).");
var feed = Utilities.parseCsv(UrlFetchApp.fetch(FEED_URL), COLUMN_SEPARATOR);
var columnMapper = new FeedColumnValidator(feed, SQA_REQUIRED_COLUMNS, SQA_EXTRA_COLUMNS).getColumnMapper();
var entityDataFetcher = new EntityDataFetcher(columnMapper);
var entitiesObject = {};
entitiesObject.brands = entityDataFetcher.getBrands();
entitiesObject.categories = entityDataFetcher.getCategories();
entitiesObject.titles = entityDataFetcher.getTitles();
entitiesObject.genders = entityDataFetcher.getGenders(); // ["damen", "herren", "mädchen", "jungen", "kinder", "baby"];
entitiesObject.colors = entityDataFetcher.getColors();
entitiesObject.sizes = entityDataFetcher.getSizes();
entitiesObject.custom_attributes = {};
for (var custom_attribute in CUSTOM_WORDS) {
entitiesObject.custom_attributes[custom_attribute] = CUSTOM_WORDS[custom_attribute];
}
// 2. Match entities to queries
var queryToEntityMatcher = new QueryToEntityMatcher(queriesNew, entitiesObject);
var entityMatches = queryToEntityMatcher.calculateEntityMatches();
// 3. Look for search results for the specific query
if (INSTOCK_CHECKER_CONFIG.active == 1) {
var instockchecker = new InStockChecker(entityMatches);
instockchecker.addInStockInfo();
}
// 4. For title match, enhance parent entities
var parentEntityEnhancer = new ParentEntityEnhancer();
var enhancedEntityMatches = parentEntityEnhancer.addBrandsAndCategories(entityMatches, entityDataFetcher);
// 5. Execute upload or print to sheet: Decide if existing adgroup or new
var matchedStructureEnhancer = new MatchedStructureEnhancer(enhancedEntityMatches);
var fullDataEntityMatches = matchedStructureEnhancer.addStructureMatches();
var fedMatches_Sliced = fullDataEntityMatches.slice(0, 49);
Logger.log(fullDataEntityMatches.length + " fullDataEntityMatches found. First 50 entries : " + JSON.stringify(fedMatches_Sliced));
// Early return if no new queries
if (fullDataEntityMatches.length === 0) return Logger.log("No new queries to be added --- Have a nice Google Ads day!");
// 5. Set up sync wiring via feed campaigns or search updates > use link checker deluxe
// 6. Get AG object for feed campaign upload
var adGroupObjectConverter = new AdGroupObjectConverter(fullDataEntityMatches);
var adGroupObject = adGroupObjectConverter.getAdGroupObjects();
Logger.log("%s validated entitityDataMatches found.", adGroupObject.length);
if (DEBUG_MODE === 1) Logger.log("Adgroup Object: " + JSON.stringify(adGroupObject));
var feed_content = [];
feed_content.push([
"aggregation_type (text)", "brand (text)", "category (text)", "discount (number)", "gender (text)",
"headline (text)", "keyword_full (text)", "price_min (number)", "sale_item_count (number)", "Target ad group", "Target campaign", "urlsuffix (text)", "matchAccuracy (number)"
]);
for (var i = 0; i < adGroupObject.length; i++) {
feed_content.push([
adGroupObject[i].aggregationType,
adGroupObject[i].brand,
adGroupObject[i].category,
"",
adGroupObject[i].gender,
adGroupObject[i].headline,
adGroupObject[i].kwWithUnderscore,
"",
"",
adGroupObject[i].adGroup,
adGroupObject[i].campaign,
adGroupObject[i].urlSuffix,
adGroupObject[i].matchAccuracy
]);
}
if (DEBUG_MODE === 1) Logger.log(feed_content);
if (feed_content.length === 1) {
Logger.log(" ");
Logger.log("*****");
Logger.log("nrSQA returned no new queries that passed the InStockChecker and TermSimilarity.");
Logger.log(">> Please check your NEW_PAID_QUERY_CONFIG and your IN_STOCK_CHECKER configuration results.");
Logger.log("Until then, have a nice Google Ads Day! ");
Logger.log("*****");
return;
}
// MCC Compatibility
if (typeof MULTI_ACCOUNT_QUERY_TRANSFER !== "undefined" && typeof MccApp !== "undefined") {
var targetAccount = MccApp.accounts().withIds([MULTI_ACCOUNT_QUERY_TRANSFER.targetAccountId]).get().next();
MccApp.select(targetAccount);
Logger.log("MCC Mode | target-account : " + targetAccount.getName());
}
nrCampaignBuilder(feed_content);
if(typeof STRUCTURE_IDENTIFIER.newadgroups.setExactAndBmmAdGroups != "undefined" && STRUCTURE_IDENTIFIER.newadgroups.setExactAndBmmAdGroups && STRUCTURE_IDENTIFIER.newadgroups.bmmAdgroupSuffix != "undefined" && STRUCTURE_IDENTIFIER.newadgroups.bmmAdgroupPrefix != "undefined"){
Logger.log("Second nrCampaignBuilder call for bmm adgroups.");
var adgroup_suffix = STRUCTURE_IDENTIFIER.newadgroups.newAdgroupSuffix;
var adgroup_prefix = STRUCTURE_IDENTIFIER.newadgroups.newAdgroupPrefix;
// change name of adgroup and campaign
for(var z = 1; z < feed_content.length; z++){
feed_content[z][9] = feed_content[z][9].replace(adgroup_suffix,"").replace(adgroup_prefix,"");
feed_content[z][9] = STRUCTURE_IDENTIFIER.newadgroups.bmmAdgroupPrefix + feed_content[z][9] + STRUCTURE_IDENTIFIER.newadgroups.bmmAdgroupSuffix;
if(typeof NEW_CAMPAIGN_CONFIG.setExtraBMMCampaign != "undefined" && typeof NEW_CAMPAIGN_CONFIG.extraBMMCampaignSuffix != "undefined" && NEW_CAMPAIGN_CONFIG.setExtraBMMCampaign === 1 && NEW_CAMPAIGN_CONFIG.extraBMMCampaignSuffix.length > 0){
feed_content[z][10] = feed_content[z][10] + NEW_CAMPAIGN_CONFIG.extraBMMCampaignSuffix;
}
}
// set global variables for correct keyword matchtype creation
NEW_CAMPAIGN_CONFIG.allowedMatchTypes = "nonExact";
NEW_KEYWORD_CONFIG.NonExact_Phrase_or_MobBroad = "MB";
Logger.log(feed_content[0]);
Logger.log(feed_content[1]);
Logger.log(feed_content[2]);
// second call to nrCampaignBuilder with modified adgroup and campaign names and different matchtype variables
nrCampaignBuilder(feed_content);
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////// PROTOTYPES & METHODS /////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// 0. FEEDCOLUMNVALIDATOR @prototype
//
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
function FeedColumnValidator(feedContent,requiredColums,extraColumns){
this.requiredKeyArray = requiredColums;
this.feedContent = feedContent;
this.columnSeparator = COLUMN_SEPARATOR;
this.extraKeyArray = extraColumns;
}
/*
* @return object columnMapper
* @throws exception NoExtraColumnInfo
* @throws error ColumnSeparatorError
* @throws error MissingRequiredColumnError
*/
FeedColumnValidator.prototype.getColumnMapper = function() {
var headerColumn = this.feedContent[0];
var columnMapper = {};
// add extra key to required array
try{
if(this.extraKeyArray) {
var extraKeyArray = this.extraKeyArray;
for(var i=0; i<extraKeyArray.length; i++){
this.requiredKeyArray.push(extraKeyArray[i].toLowerCase());
}
}
} catch(e){Logger.log("NoExtraColumnInfo: No additional, account-specfic columns were added to feed.");}
for(var k=0; k<headerColumn.length; k++){
columnMapper[headerColumn[k].toLowerCase()] = k;
}
for(var j=0; j<this.requiredKeyArray.length; j++) {
if(!columnMapper.hasOwnProperty(this.requiredKeyArray[j].toLowerCase())){
Logger.log(this.requiredKeyArray);
throw new Error("MissingRequiredColumnError : " + this.requiredKeyArray[j] + " does not exist in feed. Please make sure all these columns exist");
}
}
Logger.log("Validated columnMapper : " + JSON.stringify(columnMapper));
return columnMapper;
};
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// 0. QUERYFETCHER @prototype
//
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* [QueryFetcher description]
*/
function QueryFetcher() {
this.newPaidQueryConfig = NEW_PAID_QUERY_CONFIG;
this.newOrganicQueryConfig = NEW_ORGANIC_QUERY_CONFIG;
}
/**
* [getNewPaidQueries description]
* @return {array} queries
* @throws {error} SearchQuerySelectException
*/
QueryFetcher.prototype.getNewPaidQueries = function() {
Logger.log(" ");
Logger.log("******");
Logger.log("Starting new paid query fetch with filters: time_span " + NEW_PAID_QUERY_CONFIG.timeSpan + " | " + NEW_PAID_QUERY_CONFIG.kpiThresholds[0].metric + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[0].operator + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[0].value);
Logger.log(" ");
if (DEBUG_MODE === 1) Logger.log(JSON.stringify(NEW_PAID_QUERY_CONFIG));
Logger.log(" ");
var queries = [];
var sqReport;
try {
var selectQuery =
"SELECT Query,KeywordTextMatchingQuery,QueryMatchTypeWithVariant,CampaignName,AdGroupName,Clicks,Cost,Ctr,Conversions,CostPerConversion,ConversionValue " +
"FROM SEARCH_QUERY_PERFORMANCE_REPORT " +
"WHERE " + NEW_PAID_QUERY_CONFIG.kpiThresholds[0].metric + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[0].operator + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[0].value + " AND " +
NEW_PAID_QUERY_CONFIG.kpiThresholds[1].metric + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[1].operator + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[1].value + " AND " +
NEW_PAID_QUERY_CONFIG.kpiThresholds[2].metric + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[2].operator + " " + NEW_PAID_QUERY_CONFIG.kpiThresholds[2].value + " AND " +
"AdNetworkType2 = 'SEARCH' AND " +
"CampaignName DOES_NOT_CONTAIN " + NEW_PAID_QUERY_CONFIG.campaignExclude + " " +
"DURING " + NEW_PAID_QUERY_CONFIG.timeSpan;
sqReport = AdWordsApp.report(selectQuery);
} catch (e) {
throw new Error("SearchQuerySelectException: " + e + ". Stacktrace: " + e.stack);
}
var sqReportRows = sqReport.rows();
try {
sqReportRows.next();
} catch (e) {
Logger.log("EmptyResponseException: Please recheck your filters, your query returned zero results. " + e + " . stack : " + e.stack);
}
try {
while (sqReportRows.hasNext()) {
var row = sqReportRows.next();
var queryString = row["Query"];
var allQueryStrings = [];
if (row["Query"] === row["KeywordTextMatchingQuery"].toLowerCase()) continue;
if (allQueryStrings.indexOf(queryString) != -1) continue;
// Skip if contains excluded word
if (typeof NEW_PAID_QUERY_CONFIG.queryExclude != "undefined") {
for (var k = 0; k < NEW_PAID_QUERY_CONFIG.queryExclude.length; k++) {
var excludedString = NEW_PAID_QUERY_CONFIG.queryExclude[k].toLowerCase();
if (row["Query"].indexOf(excludedString) != -1) continue;
}
}
// Skip if minROAS levels are not matched
var roas = row["ConversionValue"] / row["Cost"];
if (roas < NEW_PAID_QUERY_CONFIG.kpiThresholds[3].minRoas) continue;
if (typeof NEW_PAID_QUERY_CONFIG.kpiThresholds[3].maxRoas !== "undefined") {
if(roas >= NEW_PAID_QUERY_CONFIG.kpiThresholds[3].maxRoas) continue;
}
var cpo = row["Cost"] / row["Conversions"];
if (typeof NEW_PAID_QUERY_CONFIG.kpiThresholds[3].maxCPO !== "undefined") {
if (NEW_PAID_QUERY_CONFIG.kpiThresholds[3].maxCPO !== 0 && cpo > NEW_PAID_QUERY_CONFIG.kpiThresholds[3].maxCPO) continue;
}
// If query is not common (as classified by Google Suggest), check for typo via Custom Search Engine
if(this.queryFoundInSuggest(queryString) === false) queryString = this.cleanQuery(queryString);
if (this.queryExistsAsKeyword(queryString)) continue;
var query = {
"queryString": queryString,
"keywordTextMatchingQuery": row["KeywordTextMatchingQuery"],
"campaign": row["CampaignName"],
"adgroup": row["AdGroupName"]
};
allQueryStrings.push(queryString);
queries.push(query);
var maxAmount = 50;
if(STRUCTURE_IDENTIFIER.newadgroups.setExactAndBmmAdGroups === true) {
maxAmount = maxAmount / 2;
}
if (queries.length > maxAmount) {
break;
}
} // END WHILE report rows
} catch (e) {
Logger.log("KeywordLookupException: " + e + ". Stacktrace: " + e.stack);
}
Logger.log("Number of newPaidQueries in Total : " + queries.length + "."); if(queries.length > 50) Logger.log("Slicing and taking first 50...");
return queries;
};
/**
* [queryExistsAsKeyword description]
* @param {string} query
* @return {bool} hasNext
*/
QueryFetcher.prototype.queryExistsAsKeyword = function(query) {
// 0. MCC Compatibility: Search queries in target account
if (typeof MULTI_ACCOUNT_QUERY_TRANSFER !== "undefined" && typeof MccApp !== "undefined") {
var targetAccount = MccApp.accounts().withIds([MULTI_ACCOUNT_QUERY_TRANSFER.targetAccountId]).get().next();
MccApp.select(targetAccount);
}
// 1. Determining relevant matchtypes
var matchTypes = ["EXACT"];
if (typeof NEW_PAID_QUERY_CONFIG.checkAgainst_Matchtypes != "undefined") {
if (NEW_PAID_QUERY_CONFIG.checkAgainst_Matchtypes === "all") matchTypes = ["EXACT", "PHRASE", "BROAD", "BROAD"];
}
// 2. Determining campaign statuses
var campaignStatusCondition = "CampaignStatus != REMOVED";
if (typeof NEW_PAID_QUERY_CONFIG.checkAgainst_CampaignStatus != "undefined") {
if (NEW_PAID_QUERY_CONFIG.checkAgainst_CampaignStatus === "enabledOnly") campaignStatusCondition = "CampaignStatus = ENABLED";
}
// 3. Determining adGroup status
var adGroupStatusCondition = "AdGroupStatus != REMOVED";
if (typeof NEW_PAID_QUERY_CONFIG.checkAgainst_AdGroupStatus != "undefined") {
if (NEW_PAID_QUERY_CONFIG.checkAgainst_AdGroupStatus === "enabledOnly") adGroupStatusCondition = "AdGroupStatus = ENABLED";
}
// 4. Determining keyword status
var keywordStatusCondition = "Status != REMOVED";
if (typeof NEW_PAID_QUERY_CONFIG.checkAgainst_KeywordStatus != "undefined") {
if (NEW_PAID_QUERY_CONFIG.checkAgainst_KeywordStatus === "enabledOnly") keywordStatusCondition = "Status = ENABLED";
}
// 5. Running keyword iterator
var keywordExists = false;
for (var i = 0; i < matchTypes.length; i++) {
if (matchTypes.length === 4 && i === 3) query = "+" + query.replace(/ /g, " +");
// 5.1 Search for lowercase keyword
var keywordIteratorLc = AdWordsApp.keywords().withCondition('Text = "' + query + '"')
.withCondition("KeywordMatchType = " + matchTypes[i])
.withCondition(campaignStatusCondition).withCondition(adGroupStatusCondition).withCondition(keywordStatusCondition).get();
if (keywordIteratorLc.totalNumEntities() > 0) keywordExists = true;
// 5.2 Search for First letter uppercase keyword
if (keywordExists === false) {
var queryUpperCaseFirstLetter = query.charAt(0).toUpperCase() + query.slice(1);
var keywordIteratorFlUc = AdWordsApp.keywords().withCondition('Text = "' + queryUpperCaseFirstLetter + '"')
.withCondition("KeywordMatchType = " + matchTypes[i])
.withCondition(campaignStatusCondition).withCondition(adGroupStatusCondition).withCondition(keywordStatusCondition).get();
if (keywordIteratorFlUc.totalNumEntities() > 0) keywordExists = true;
}
// 5.3 Search for keyword version with all first letters uppercase
if (query.split(" ").length === 1) continue;
if (keywordExists === false) {
var queryUcAllFirstLetterArray = query.split(" ");
var queryUpperCaseAllFirstLetters = [];
for (var j = 0; j < queryUcAllFirstLetterArray.length; j++) {
var queryTempString = queryUcAllFirstLetterArray[j].charAt(0).toUpperCase() + queryUcAllFirstLetterArray[j].slice(1);
queryUpperCaseAllFirstLetters.push(queryTempString);
}
queryUpperCaseAllFirstLetters = queryUpperCaseAllFirstLetters.join(" ");
var keywordIteratorAllFlUc = AdWordsApp.keywords().withCondition('Text = "' + queryUpperCaseAllFirstLetters + '"')
.withCondition("KeywordMatchType = " + matchTypes[i])
.withCondition(campaignStatusCondition).withCondition(adGroupStatusCondition).withCondition(keywordStatusCondition).get();
if (keywordIteratorAllFlUc.totalNumEntities() > 0) keywordExists = true;
}
// 5.4 Search for min 3word keyword with Starts_with_ignore case version with all first letters uppercase
var queryWordCount = query.split(" ");
if (keywordExists === false && queryWordCount.length > 1) {
var keywordIteratorMin3Word = AdWordsApp.keywords().withCondition('Text STARTS_WITH_IGNORE_CASE "' + query + '"')
.withCondition("KeywordMatchType = " + matchTypes[i])
.withCondition(campaignStatusCondition).withCondition(adGroupStatusCondition).withCondition(keywordStatusCondition).get();
if (keywordIteratorMin3Word.totalNumEntities() > 0) {
while (keywordIteratorMin3Word.hasNext()) {
var keyword = keywordIteratorMin3Word.next().getText().toLowerCase();
if (matchTypes.length === 1 && i === 0) keyword = keyword.replace('[', '').replace(']', '');
if (matchTypes.length === 4 && i === 1) keyword = keyword.replace('"', '').replace('"', '');
if (keyword === query) keywordExists = true;
}
}
} // END if 5.4 min 3word
} // END FOR Loop matchtypes
// 0. MCC Compatibility: Switch back to soure account
if (typeof MULTI_ACCOUNT_QUERY_TRANSFER !== "undefined" && typeof MccApp !== "undefined") {
var sourceAccount = MccApp.accounts().withIds([MULTI_ACCOUNT_QUERY_TRANSFER.sourceAccountId]).get().next();
MccApp.select(sourceAccount);
}
return keywordExists;
};
/**
* @param {string} keyword, a keyword with pluses instead of spaces
* @return {bool} keywordFoundInSuggestList, if the query is contained in the list
**/
QueryFetcher.prototype.queryFoundInSuggest = function (keyword) {
var firstEntry;
var xmlRequestUrl = "https://suggestqueries.google.com/complete/search?output=toolbar&hl=de&q=" + keyword;
var xmlDocument = XmlService.parse(UrlFetchApp.fetch(xmlRequestUrl).getContentText());
try {
var keywordFoundInSuggestList = false;
var suggestions = xmlDocument.getRootElement().getChildren('CompleteSuggestion');
for(var i=0; i < suggestions.length; i++) {
var singleEntry = suggestions[i].getChild('suggestion').getAttribute('data').getValue();
Logger.log(singleEntry)
if(singleEntry == keyword) keywordFoundInSuggestList = true;
}
} catch(e) {if(DEBUG_MODE === 1) Logger.log("No Google suggest entry found for : " + keyword);}
return keywordFoundInSuggestList;
}
/**
* @param {string} query
* @return {string} correctedQuery
*/
QueryFetcher.prototype.cleanQuery = function(query) {
var correctedQuery, response, url;
// Retrieve the CSE id from your project console: https://cse.google.com/cse/all
var cx = "011253106589242236363:g6cntpa1c7s";
// Create an API after here after selecting your project: https://developers.google.com/custom-search/v1/introduction
var api_key = 'AIzaSyA5dKxNMaFoHDbEeukFQkiMUTJTuvzoteg';
var api_endPoint_free = 'https://www.googleapis.com/customsearch/v1';
try{
url = api_endPoint_free + '?cx=' + cx + '&key=' + api_key + '&googlehost=de&gl=de&q=' + query + '&alt=json&num=1';
response = JSON.parse(UrlFetchApp.fetch(url).getContentText());
}
catch(e) {
try{
// Fallback to restricted & paid CSE
if(DEBUG_MODE === 1) Logger.log("Free daily API Limit reached. Moving to restricted search API...");
var api_endPoint_paid = 'https://www.googleapis.com/customsearch/v1/siterestrict';
url = api_endPoint_paid + '?cx=' + cx + '&key=' + api_key + '&googlehost=de&gl=de&q=' + query + '&alt=json&num=1';
response = JSON.parse(UrlFetchApp.fetch(url).getContentText());
} catch(e2) {
Logger.log(e2 + " . stack : " + e2.stack);
return correctedQuery;
}
}
if(typeof response.spelling !== "undefined") correctedQuery = response.spelling.correctedQuery.replace(',',' ').replace('.',' ');
return correctedQuery;
}
/**
* [getNewOrganicQueries description]
* @param {array} queriesNew [description]
* @return {array} newOrganicQueries
* @throws {error} SearchQuerySelectException
*/
QueryFetcher.prototype.getNewOrganicQueries = function(queriesNew) {
Logger.log(" ");
Logger.log("******");
Logger.log("Starting new organic query fetch");
Logger.log(" ");
if (DEBUG_MODE === 1) Logger.log(JSON.stringify(NEW_ORGANIC_QUERY_CONFIG));
Logger.log(" ");
var newOrganicQueries = [];
var organicQueryReport;
try {
var selectQuery =
"SELECT SearchQuery , KeywordTextMatchingQuery , AverageCpc , Clicks , OrganicClicks , CombinedAdsOrganicClicks , AveragePosition , OrganicAveragePosition , Impressions , OrganicImpressions , Ctr " +
"FROM PAID_ORGANIC_QUERY_REPORT " +
"WHERE " + NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[0].metric + " " + NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[0].operator + " " + NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[0].value + " AND " +
NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[1].metric + " " + NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[1].operator + " " + NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[1].value + " AND " +
NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[2].metric + " " + NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[2].operator + " " + NEW_ORGANIC_QUERY_CONFIG.kpiThresholds[2].value + " AND " +
"CampaignName DOES_NOT_CONTAIN " + NEW_ORGANIC_QUERY_CONFIG.campaignExclude + " AND CampaignStatus != REMOVED " +
"DURING " + NEW_ORGANIC_QUERY_CONFIG.timeSpan + " ";
organicQueryReport = AdWordsApp.report(selectQuery);
} catch (e) {
throw new Error("SearchQuerySelectException: " + e + ". Stacktrace: " + e.stack);
}
var oQReportRows = organicQueryReport.rows();
try {
oQReportRows.next();
} catch (e) {
Logger.log("EmtpyResponeException: Please recheck your filters, your query returned zero results. " + e + " . stack : " + e.stack);
}
try {
while (oQReportRows.hasNext()) {
var row = oQReportRows.next();
var queryString = row["SearchQuery"];
if (row["SearchQuery"] === row["KeywordTextMatchingQuery"]) continue;
if (this.queryExistsAsKeyword(queryString)) continue;
for (var i = 0; i < queriesNew.length; i++) {
if (row["SearchQuery"] === queriesNew[i].queryString) continue;
}
var query = {
"queryString": row["SearchQuery"],
"keywordTextMatchingQuery": row["KeywordTextMatchingQuery"],
"campaign": "___source_organic",
"adgroup": "___source_organic"
};
newOrganicQueries.push(query);
}
} catch (e) {
Logger.log("KeywordLookupException: " + e + ". Stacktrace: " + e.stack);
}
if (DEBUG_MODE == 1) Logger.log("newOrganicQueries : " + JSON.stringify(newOrganicQueries));
return newOrganicQueries;
};
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// 1. ENTITYDATAFETCHER @prototype
//
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* [EntityDataFetcher description]
* @param {[type]} columnMapper [description]
*/
function EntityDataFetcher(columnMapper) {
this.columnMapper = columnMapper;
this.feedContent = this.getFeedContent();
}
/**
* [getFeedContent description]
* @return {array} feedContent, two-dimensional array of feed content
*/
EntityDataFetcher.prototype.getFeedContent = function() {
var response = UrlFetchApp.fetch(FEED_URL);
var feedContent = Utilities.parseCsv(response, COLUMN_SEPARATOR);
return feedContent;
};
/**
* [getCategories description]
* @return {array} categoriesArray
*/
EntityDataFetcher.prototype.getCategories = function() {
var catsArray = [];
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
// Add category to catsArray
var productCat = product[this.columnMapper["product_type"]];
var productCat_split = productCat.split(">");
var final_productCatArray = [];
for (var p = 0; p < productCat_split.length; p++) {
var tempSplit = productCat_split[p].replace(/^\s|\s$/, "").replace(/-/g, " ").toLowerCase().split(/\s/g);
for (var z = 0; z < tempSplit.length; z++) {
if (tempSplit[z] && tempSplit[z].length > 2) {
final_productCatArray.push(tempSplit[z].replace(/^\s|\s$/, "").toLowerCase());
}
}
}
for (var k = 0; k < final_productCatArray.length; k++) {
var splitCat = final_productCatArray[k].toLowerCase().replace(/^\s|\s$/, "");
var nonSplitCat;
for (var j = 0; j < CORECAT_ARRAY_PLURAL.length; j++) {
if (final_productCatArray[k].indexOf(CORECAT_ARRAY_PLURAL[j]) != -1) {
var regexString = new RegExp(CORECAT_ARRAY_PLURAL[j], "g");
var replaceTerm = CORECAT_ARRAY_SINGULAR[j] ? CORECAT_ARRAY_SINGULAR[j] : CORECAT_ARRAY_PLURAL[j];
splitCat = final_productCatArray[k].replace(regexString, " " + replaceTerm).toLowerCase().replace(/ae/g, "ä").replace(/ue/g, "ü").replace(/oe/g, "ö").replace(/^\s|\s$/, "");
nonSplitCat = final_productCatArray[k].replace(regexString, replaceTerm).toLowerCase().replace(/ae/g, "ä").replace(/ue/g, "ü").replace(/oe/g, "ö");
break;
}
}
if (nonSplitCat) {
catsArray.push(nonSplitCat);
}
catsArray.push(splitCat); //catsArray.push(final_productCatArray[k].toLowerCase().replace(/-/g," "));
}
} // END Feed content LOOP
catsArray = this.deduplicateArrayValues(catsArray);
return catsArray;
};
/**
* [getTitles description]
* @return {array} titlesArray
*/
EntityDataFetcher.prototype.getTitles = function() {
var titlesArray = [];
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
var splitTitle = product[this.columnMapper["title"]].toLowerCase().replace(/-/g, " ");
for (var j = 0; j < CORECAT_ARRAY_SINGULAR.length; j++) {
if (product[this.columnMapper["title"]].indexOf(CORECAT_ARRAY_SINGULAR[j]) != -1) {
var regexString = new RegExp(CORECAT_ARRAY_SINGULAR[j], "g");
splitTitle = product[this.columnMapper["title"]].replace(regexString, " " + CORECAT_ARRAY_SINGULAR[j]).replace(" ", " ");
}
}
titlesArray.push(splitTitle.replace(/-/g, " ").replace(/ /g, " "));
}
titlesArray = this.deduplicateArrayValues(titlesArray);
return titlesArray;
};
/**
* [getBrands description]
* @return {array} brandsArray
*/
EntityDataFetcher.prototype.getBrands = function() {
var brandsArray = [];
for (var i = 1; i < this.feedContent.length; i++) {
try {
var product = this.feedContent[i];
if (product[this.columnMapper["brand"]].length > 3) {
var cleanedBrandString = product[this.columnMapper["brand"]].toLowerCase().replace(".", "").replace("!", "").replace("©", "").replace("?", "").replace(";", "").replace("|", "").replace("*", "").replace("\\", "").replace(/-/g, " ");
brandsArray.push(cleanedBrandString);
if (cleanedBrandString.toLowerCase().indexOf(" ") != -1) brandsArray.push(cleanedBrandString.replace(" ", ""));
}
} catch (e) {
Logger.log("BrandFetchException: " + e + " . stack : " + e.stack);
}
}
var dedup_brandsArray = this.deduplicateArrayValues(brandsArray);
return dedup_brandsArray;
};
/**
* [getGenders description]
* @return {array} gendersArray
*/
EntityDataFetcher.prototype.getGenders = function() {
var genderArray = [];
genderArray.push("mädchen", "jungen", "girls", "boys", "children", "kids");
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
var gender = product[this.columnMapper["gender"]].toLowerCase();
if (gender.length > 1) {
genderArray.push(gender);
}
}
var dedup_genderArray = this.deduplicateArrayValues(genderArray);
return dedup_genderArray;
};
/**
* [getCustomAttribute description]
* @param {string} attributeName [description]
* @return {array} attributeArray
*/
EntityDataFetcher.prototype.getCustomAttribute = function(attributeName) {
var attributeArray = [];
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
var attribute = product[this.columnMapper[attributeName]].toLowerCase();
if (attribute.length > 3) {
attributeArray.push(attribute);
}
}
attributeArray = this.deduplicateArrayValues(attributeArray);
return attributeArray;
};
/**
* [getColors description]
* @return {array} colorArray
* @exception {exception} MissingOptionalColumnException
*/
EntityDataFetcher.prototype.getColors = function() {
var colorArray = [];
try {
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
var color = product[this.columnMapper["color"]].toLowerCase();
if (color.length > 2) {
colorArray.push(color);
}
}
colorArray = this.deduplicateArrayValues(colorArray);
} catch (e) {
Logger.log("MissingOptionalColumnException: Column 'color' is missing in column spec.");
}
return colorArray;
};
/**
* [getSizes description]
* @return {array} colorArray
* @exception {exception} MissingOptionalColumnException
*/
EntityDataFetcher.prototype.getSizes = function() {
var sizeArray = [];
try {
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
var size = product[this.columnMapper["size"]].toLowerCase();
if (size.length > 0) {
sizeArray.push(size);
}
}
sizeArray = this.deduplicateArrayValues(sizeArray);
} catch (e) {
Logger.log("MissingOptionalColumnException: Column 'size' is missing in column spec.");
}
return sizeArray;
};
/**
* [deduplicateArrayValues description]
* @param {string} array [description]
* @return {array} deduplicated_array
*/
EntityDataFetcher.prototype.deduplicateArrayValues = function(array) {
var cache = {};
var deduplicated_array = [];
for (var i = 0; i < array.length; i++) {
if (!cache[array[i]]) {
cache[array[i]] = array[i];
deduplicated_array.push(array[i]);
} else {
continue;
}
}
return deduplicated_array;
};
/**
* [getBrandByTitle description]
* @param {string} title [description]
* @return {string} brand
*/
EntityDataFetcher.prototype.getBrandByTitle = function(title) {
var brand;
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
if (product[this.columnMapper["title"]].toLowerCase() == title.toLowerCase()) {
brand = product[this.columnMapper["brand"]];
break;
}
}
return brand;
};
/**
* [getLowestCategoryByTitle description]
* @param {string} title [description]
* @return {string} categoryPath
*/
EntityDataFetcher.prototype.getLowestCategoryByTitle = function(title) {
var categoryPath;
var lowestCategory = "";
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
if (product[this.columnMapper["title"]].toLowerCase() == title.toLowerCase()) {
categoryPath = product[this.columnMapper["product_type"]];
var catArray = categoryPath.split(" > ");
lowestCategory = catArray[catArray.length - 1];
break;
}
}
return lowestCategory;
};
/**
* [getGenderByTitle description]
* @param {string} title
* @return {string} gender
*/
EntityDataFetcher.prototype.getGenderByTitle = function(title) {
var gender = "";
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
if (product[this.columnMapper["title"]].toLowerCase() == title.toLowerCase()) {
gender = product[this.columnMapper["gender"]];
break;
}
}
return gender;
};
/**
* [getColorsByTitle description]
* @param {string} title
* @return {Array} colors
*/
EntityDataFetcher.prototype.getColorsByTitle = function(title) {
var colors = [];
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
if (product[this.columnMapper["title"]].toLowerCase() == title.toLowerCase()) {
colors.push(product[this.columnMapper["color"]]);
}
}
return colors;
};
/**
* [getSizesByTitle description]
* @param {string} title
* @return {Array} sizes
*/
EntityDataFetcher.prototype.getSizesByTitle = function(title) {
var sizes = [];
for (var i = 1; i < this.feedContent.length; i++) {
var product = this.feedContent[i];
if (product[this.columnMapper["title"]].toLowerCase() == title.toLowerCase()) {
sizes.push(product[this.columnMapper["size"]]);
}
}
return sizes;
};
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// 2. QUERY_TO_ENTITY_MATCHER @prototype
//
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* [QueryToEntityMatcher description]
* @param {[type]} queries [description]
* @param {[type]} entitiesObject [description]
*/
function QueryToEntityMatcher(queries, entitiesObject) {
this.queries = queries;
this.entitiesObject = entitiesObject;
this.queryObjectEntities = {};
}
/**
* [calculateEntityMatches description]
* @return {object} entityMatches
*/
QueryToEntityMatcher.prototype.calculateEntityMatches = function() {
var entityMatches = [{
"overallModelSummary": {
"instances": 0,
"totalMatchValue": 0
}
}];
for (var i = 0; i < this.queries.length; i++) {
var queryObjectEntities = {
"_overallMatchValue": 0,
"_overallMatchedLetters": 0,
"query": this.queries[i].queryString,
"brand": {},
"category": {},
"gender": {},
"titles": {},
"sizes": {},
"colors": {},
"custom_attributes": {},
"querySource": {
"campaign": this.queries[i].campaign,
"adgroup": this.queries[i].adgroup,
"keywordTextMatchingQuery": this.queries[i].keywordTextMatchingQuery
}
};
var query = this.queries[i].queryString;
try {
var result = this.extractFullBrands(query, queryObjectEntities);
result = this.extractPartialBrands(result.query, result.queryObjectEntities);
result = this.extractGender(result.query, result.queryObjectEntities);
result = this.extractFullCategories(result.query, result.queryObjectEntities);
result = this.extractPartialCategories(result.query, result.queryObjectEntities);
result = this.extractFullTitles(result.query, result.queryObjectEntities);
result = this.extractColor(result.query, result.queryObjectEntities);
result = this.extractSize(result.query, result.queryObjectEntities);
result = this.extractPartialTitles(result.query, result.queryObjectEntities);
//result = this.getKeywordSuggestions(result.query, result.queryObjectEntities);
for (var prop in this.entitiesObject.custom_attributes) {
result = this.extractCustomAttribute(result.query, result.queryObjectEntities, prop);
queryObjectEntities = result.queryObjectEntities;
query = result.query;
}
} catch (e) {
Logger.log(e.stack);
throw e;
}
if (queryObjectEntities._overallMatchValue > 1) queryObjectEntities._overallMatchValue = 1; //queObEnt_all_Extracted
entityMatches.push(queryObjectEntities);
entityMatches[0].overallModelSummary.instances += 1;
entityMatches[0].overallModelSummary.totalMatchValue += queryObjectEntities._overallMatchValue;
} // END FOR LOOP QUERIES
entityMatches[0].overallModelSummary.entityExtractionAccuracy = (entityMatches[0].overallModelSummary.totalMatchValue / entityMatches[0].overallModelSummary.instances).toFixed(2);
entityMatches[0].overallModelSummary.totalMatchValue.toFixed(2);
// if(DEBUG_MODE === 1) Logger.log("entityMatches : " + JSON.stringify(entityMatches));
return entityMatches;
};
/////////////////////////////////////////////////
//
// 2.1. MATCH BRANDS
//
/////////////////////////////////////////////////
/**
* [extractFullBrands description]
* @param {string} query [description]