1
|
|
|
<?php |
2
|
|
|
namespace Werkspot\BingAdsApiBundle\Api; |
3
|
|
|
|
4
|
|
|
use BingAds\Proxy\ClientProxy; |
5
|
|
|
use BingAds\Reporting\PollGenerateReportRequest; |
6
|
|
|
use BingAds\Reporting\ReportRequest; |
7
|
|
|
use BingAds\Reporting\ReportTimePeriod; |
8
|
|
|
use BingAds\Reporting\SubmitGenerateReportRequest; |
9
|
|
|
use Exception; |
10
|
|
|
use SoapFault; |
11
|
|
|
use SoapVar; |
12
|
|
|
use Symfony\Component\Filesystem\Filesystem; |
13
|
|
|
use Symfony\Component\Finder\Finder; |
14
|
|
|
use Werkspot\BingAdsApiBundle\Api\Helper\Csv; |
15
|
|
|
use Werkspot\BingAdsApiBundle\Api\Helper\File; |
16
|
|
|
use Werkspot\BingAdsApiBundle\Api\Helper\Time; |
17
|
|
|
use Werkspot\BingAdsApiBundle\Api\Report\ReportInterface; |
18
|
|
|
use Werkspot\BingAdsApiBundle\Guzzle\OauthTokenService; |
19
|
|
|
use Werkspot\BingAdsApiBundle\Model\AccessToken; |
20
|
|
|
use Werkspot\BingAdsApiBundle\Model\ApiDetails; |
21
|
|
|
|
22
|
|
|
class Client |
23
|
|
|
{ |
24
|
|
|
/** |
25
|
|
|
* @var array |
26
|
|
|
*/ |
27
|
|
|
private $config = []; |
28
|
|
|
|
29
|
|
|
/** |
30
|
|
|
* @var string |
31
|
|
|
*/ |
32
|
|
|
private $fileName; |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* @var ClientProxy |
36
|
|
|
*/ |
37
|
|
|
private $proxy; |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* @var array |
41
|
|
|
*/ |
42
|
|
|
public $report; |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* @var string |
46
|
|
|
*/ |
47
|
|
|
private $files; |
48
|
|
|
|
49
|
|
|
/** |
50
|
|
|
* @var OauthTokenService |
51
|
|
|
*/ |
52
|
|
|
private $oauthTokenService; |
53
|
|
|
|
54
|
|
|
/** |
55
|
|
|
* @var ApiDetails |
56
|
|
|
*/ |
57
|
|
|
private $apiDetails; |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* @var ClientProxy |
61
|
|
|
*/ |
62
|
|
|
private $clientProxy; |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* @var File |
66
|
|
|
*/ |
67
|
|
|
private $fileHelper; |
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* @var Csv |
71
|
|
|
*/ |
72
|
|
|
private $csvHelper; |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* @var Time |
76
|
|
|
*/ |
77
|
|
|
private $timeHelper; |
78
|
|
|
|
79
|
|
|
/** |
80
|
|
|
* Client constructor. |
81
|
|
|
* |
82
|
|
|
* @param OauthTokenService $oauthTokenService |
83
|
|
|
* @param ApiDetails $apiDetails |
84
|
|
|
* @param ClientProxy $clientProxy |
85
|
|
|
* @param File $file |
86
|
|
|
* @param Csv $csv |
87
|
|
|
* @param Time $timeHelper |
88
|
|
|
*/ |
89
|
25 |
|
public function __construct(OauthTokenService $oauthTokenService, ApiDetails $apiDetails, ClientProxy $clientProxy, File $file, Csv $csv, Time $timeHelper) |
90
|
1 |
|
{ |
91
|
25 |
|
$this->oauthTokenService = $oauthTokenService; |
92
|
25 |
|
$this->apiDetails = $apiDetails; |
93
|
25 |
|
$this->clientProxy = $clientProxy; |
94
|
25 |
|
$this->fileHelper = $file; |
95
|
25 |
|
$this->csvHelper = $csv; |
96
|
25 |
|
$this->timeHelper = $timeHelper; |
97
|
|
|
|
98
|
25 |
|
ini_set('soap.wsdl_cache_enabled', '0'); |
99
|
25 |
|
ini_set('soap.wsdl_cache_ttl', '0'); |
100
|
|
|
|
101
|
25 |
|
$this->fileName = 'report.zip'; |
102
|
|
|
|
103
|
25 |
|
$this->report = [ |
104
|
25 |
|
'GeoLocationPerformanceReport' => new Report\GeoLocationPerformanceReport(), |
105
|
|
|
]; |
106
|
25 |
|
} |
107
|
|
|
|
108
|
1 |
|
public function setApiDetails(ApiDetails $apiDetails) |
109
|
|
|
{ |
110
|
1 |
|
$this->apiDetails = $apiDetails; |
111
|
1 |
|
} |
112
|
|
|
|
113
|
|
|
/** |
114
|
|
|
* Sets the configuration |
115
|
|
|
* |
116
|
|
|
* @param $config |
117
|
|
|
*/ |
118
|
24 |
|
public function setConfig($config) |
119
|
|
|
{ |
120
|
24 |
|
$this->config = $config; |
121
|
24 |
|
$this->config['cache_dir'] = $this->config['cache_dir'] . '/' . 'BingAdsApiBundle'; //<-- important for the cache clear function |
122
|
24 |
|
$this->config['csv']['fixHeader']['removeColumnHeader'] = true; //-- fix till i know how to do this |
123
|
24 |
|
} |
124
|
|
|
|
125
|
1 |
|
public function getRefreshToken() |
126
|
|
|
{ |
127
|
1 |
|
return $this->apiDetails->getRefreshToken(); |
128
|
|
|
} |
129
|
|
|
|
130
|
|
|
/** |
131
|
|
|
* @param array $columns |
132
|
|
|
* @param string $name |
133
|
|
|
* @param $timePeriod |
134
|
|
|
* @param null|string $fileLocation |
135
|
|
|
* |
136
|
|
|
* @return array|string |
137
|
|
|
*/ |
138
|
24 |
|
public function get(array $columns, $name = 'GeoLocationPerformanceReport', $timePeriod = ReportTimePeriod::LastWeek, $fileLocation = null) |
139
|
|
|
{ |
140
|
24 |
|
$tokens = $this->oauthTokenService->refreshToken( |
141
|
24 |
|
$this->apiDetails->getClientId(), |
142
|
24 |
|
$this->apiDetails->getSecret(), |
143
|
24 |
|
$this->apiDetails->getRedirectUri(), |
144
|
24 |
|
new AccessToken(null, $this->apiDetails->getRefreshToken()) |
145
|
24 |
|
); |
146
|
|
|
|
147
|
24 |
|
$accessToken = $tokens->getAccessToken(); |
148
|
24 |
|
$this->apiDetails->setRefreshToken($tokens->getRefreshToken()); |
149
|
|
|
|
150
|
24 |
|
$report = $this->report[$name]; |
151
|
24 |
|
$report->setTimePeriod($timePeriod); |
152
|
24 |
|
$report->setColumns($columns); |
153
|
24 |
|
$reportRequest = $report->getRequest(); |
154
|
24 |
|
$this->setProxy($report::WSDL, $accessToken); |
155
|
24 |
|
$files = $this->getFilesFromReportRequest($reportRequest, $name, "{$this->getCacheDir()}/{$this->fileName}", $report); |
|
|
|
|
156
|
|
|
|
157
|
3 |
|
if ($fileLocation !== null) { |
158
|
1 |
|
$this->moveFirstFile($fileLocation); |
159
|
|
|
|
160
|
1 |
|
return $fileLocation; |
161
|
|
|
} else { |
162
|
2 |
|
return $files; |
163
|
|
|
} |
164
|
|
|
} |
165
|
|
|
|
166
|
|
|
/** |
167
|
|
|
* @param string $wsdl |
168
|
|
|
* @param string $accessToken |
169
|
|
|
*/ |
170
|
24 |
|
private function setProxy($wsdl, $accessToken) |
171
|
|
|
{ |
172
|
24 |
|
$this->proxy = $this->clientProxy->ConstructWithCredentials($wsdl, null, null, $this->apiDetails->getDevToken(), $accessToken); |
173
|
24 |
|
} |
174
|
|
|
|
175
|
|
|
/** |
176
|
|
|
* @return string |
177
|
|
|
*/ |
178
|
24 |
|
private function getCacheDir() |
179
|
|
|
{ |
180
|
24 |
|
$fs = new Filesystem(); |
181
|
24 |
|
if (!$fs->exists($this->config['cache_dir'])) { |
182
|
1 |
|
$fs->mkdir($this->config['cache_dir'], 0700); |
183
|
1 |
|
} |
184
|
|
|
|
185
|
24 |
|
return $this->config['cache_dir']; |
186
|
|
|
} |
187
|
|
|
|
188
|
|
|
/** |
189
|
|
|
* @param ReportRequest $reportRequest |
190
|
|
|
* @param string $name |
191
|
|
|
* @param string $downloadFile |
192
|
|
|
* @param ReportInterface $report |
193
|
|
|
* |
194
|
|
|
* @throws Exception |
195
|
|
|
* |
196
|
|
|
* @return array|string |
197
|
|
|
*/ |
198
|
24 |
|
private function getFilesFromReportRequest(ReportRequest $reportRequest, $name, $downloadFile, ReportInterface $report) |
199
|
|
|
{ |
200
|
24 |
|
$reportRequestId = $this->submitGenerateReport($reportRequest, $name); |
201
|
6 |
|
$reportRequestStatus = $this->waitForStatus($reportRequestId); |
202
|
3 |
|
$reportDownloadUrl = $reportRequestStatus->ReportDownloadUrl; |
203
|
3 |
|
$zipFile = $this->fileHelper->getFile($reportDownloadUrl, $downloadFile); |
204
|
3 |
|
if ($zipFile !== false) { |
205
|
3 |
|
$this->files = $this->fileHelper->unZip($zipFile); |
206
|
3 |
|
$this->fixFile($report); |
207
|
3 |
|
} |
208
|
|
|
|
209
|
3 |
|
return $this->files; |
210
|
|
|
} |
211
|
|
|
|
212
|
|
|
/** |
213
|
|
|
* SubmitGenerateReport helper method calls the corresponding Bing Ads service operation |
214
|
|
|
* to request the report identifier. The identifier is used to check report generation status |
215
|
|
|
* before downloading the report. |
216
|
|
|
* |
217
|
|
|
* @param mixed $report |
218
|
|
|
* @param string $name |
219
|
|
|
* |
220
|
|
|
* @return string ReportRequestId |
221
|
|
|
*/ |
222
|
24 |
|
private function submitGenerateReport($report, $name) |
223
|
|
|
{ |
224
|
24 |
|
$request = new SubmitGenerateReportRequest(); |
225
|
|
|
try { |
226
|
24 |
|
$request->ReportRequest = $this->getReportRequest($report, $name); |
227
|
|
|
|
228
|
24 |
|
return $this->proxy->GetService()->SubmitGenerateReport($request)->ReportRequestId; |
229
|
18 |
|
} catch (SoapFault $e) { |
230
|
18 |
|
$this->parseSoapFault($e); |
231
|
|
|
} |
232
|
|
|
} |
233
|
|
|
|
234
|
|
|
/** |
235
|
|
|
* @param mixed $report |
236
|
|
|
* @param string $name |
237
|
|
|
* |
238
|
|
|
* @return SoapVar |
239
|
|
|
*/ |
240
|
24 |
|
private function getReportRequest($report, $name) |
241
|
|
|
{ |
242
|
24 |
|
$name = "{$name}Request"; |
243
|
|
|
|
244
|
24 |
|
return new SoapVar($report, SOAP_ENC_OBJECT, $name, $this->proxy->GetNamespace()); |
245
|
|
|
} |
246
|
|
|
|
247
|
|
|
/** |
248
|
|
|
* Check if the report is ready for download |
249
|
|
|
* if not wait 10 sec and retry. (up to 6,5 hour) |
250
|
|
|
* After 30 tries check every 1 minute |
251
|
|
|
* After 34 tries check every 5 minutes |
252
|
|
|
* After 39 tries check every 15 minutes |
253
|
|
|
* After 43 tries check every 30 minutes |
254
|
|
|
* |
255
|
|
|
* @param string $reportRequestId |
256
|
|
|
* @param int $count |
257
|
|
|
* @param int $maxCount |
258
|
|
|
* @param int $sleep |
259
|
|
|
* @param bool $incrementTime |
260
|
|
|
* |
261
|
|
|
* @throws Exceptions\ReportRequestErrorException |
262
|
|
|
* @throws Exceptions\RequestTimeoutException |
263
|
|
|
* |
264
|
|
|
* @return string |
265
|
|
|
*/ |
266
|
6 |
|
private function waitForStatus($reportRequestId, $count = 1, $maxCount = 48, $sleep = 10, $incrementTime = true) |
267
|
|
|
{ |
268
|
6 |
|
if ($count > $maxCount) { |
269
|
1 |
|
throw new Exceptions\RequestTimeoutException("The request is taking longer than expected.\nSave the report ID ({$reportRequestId}) and try again later."); |
|
|
|
|
270
|
|
|
} |
271
|
|
|
|
272
|
6 |
|
$reportRequestStatus = $this->pollGenerateReport($reportRequestId); |
273
|
5 |
|
if ($reportRequestStatus->Status == 'Pending') { |
274
|
1 |
|
++$count; |
275
|
1 |
|
$this->timeHelper->sleep($sleep); |
276
|
1 |
|
if ($incrementTime) { |
277
|
|
|
switch ($count) { |
278
|
1 |
|
case 31: // after 5 minutes |
279
|
1 |
|
$sleep = (1 * 60); |
280
|
1 |
|
break; |
281
|
1 |
|
case 35: // after 10 minutes |
282
|
1 |
|
$sleep = (5 * 60); |
283
|
1 |
|
break; |
284
|
1 |
|
case 40: // after 30 minutes |
285
|
1 |
|
$sleep = (15 * 60); |
286
|
1 |
|
break; |
287
|
1 |
|
case 44: // after 1,5 hours |
288
|
1 |
|
$sleep = (30 * 60); |
289
|
1 |
|
break; |
290
|
|
|
} |
291
|
1 |
|
} |
292
|
1 |
|
$reportRequestStatus = $this->waitForStatus($reportRequestId, $count, $maxCount, $sleep, $incrementTime); |
293
|
|
|
} |
294
|
|
|
|
295
|
4 |
|
if ($reportRequestStatus->Status == 'Error') { |
296
|
1 |
|
throw new Exceptions\ReportRequestErrorException("The request failed. Try requesting the report later.\nIf the request continues to fail, contact support.", $reportRequestStatus->Status, $reportRequestId); |
297
|
|
|
} |
298
|
|
|
|
299
|
3 |
|
return $reportRequestStatus; |
300
|
|
|
} |
301
|
|
|
|
302
|
|
|
/** |
303
|
|
|
* Check the status of the report request. The guidance of how often to poll |
304
|
|
|
* for status is from every five to 15 minutes depending on the amount |
305
|
|
|
* of data being requested. For smaller reports, you can poll every couple |
306
|
|
|
* of minutes. You should stop polling and try again later if the request |
307
|
|
|
* is taking longer than an hour. |
308
|
|
|
* |
309
|
|
|
* @param string $reportRequestId |
310
|
|
|
* |
311
|
|
|
* @return string ReportRequestStatus |
312
|
|
|
*/ |
313
|
6 |
|
private function pollGenerateReport($reportRequestId) |
314
|
|
|
{ |
315
|
6 |
|
$request = new PollGenerateReportRequest(); |
316
|
6 |
|
$request->ReportRequestId = $reportRequestId; |
317
|
|
|
try { |
318
|
6 |
|
return $this->proxy->GetService()->PollGenerateReport($request)->ReportRequestStatus; |
319
|
1 |
|
} catch (SoapFault $e) { |
320
|
1 |
|
$this->parseSoapFault($e); |
321
|
|
|
} |
322
|
|
|
} |
323
|
|
|
|
324
|
|
|
/** |
325
|
|
|
* @param array|null $files |
326
|
|
|
* |
327
|
|
|
* @return self |
328
|
|
|
*/ |
329
|
3 |
|
private function fixFile(ReportInterface $report, array $files = null) |
330
|
|
|
{ |
331
|
3 |
|
$files = (!$files) ? $this->files : $files; |
332
|
3 |
|
foreach ($files as $file) { |
|
|
|
|
333
|
3 |
|
$lines = file($file); |
334
|
3 |
|
$lines = $this->csvHelper->removeHeaders($lines, $this->config['csv']['fixHeader']['removeColumnHeader'], $report::FILE_HEADERS, $report::COLUMN_HEADERS); |
335
|
3 |
|
$lines = $this->csvHelper->removeLastLines($lines); |
336
|
3 |
|
$lines = $this->csvHelper->convertDateMDYtoYMD($lines); |
337
|
3 |
|
$fp = fopen($file, 'w'); |
338
|
3 |
|
fwrite($fp, implode('', $lines)); |
339
|
3 |
|
fclose($fp); |
340
|
3 |
|
} |
341
|
|
|
|
342
|
3 |
|
return $this; |
343
|
|
|
} |
344
|
|
|
|
345
|
|
|
/** |
346
|
|
|
* Move first file form array $this->files to the target location |
347
|
|
|
* |
348
|
|
|
* @param string $target |
349
|
|
|
* |
350
|
|
|
* @return self |
351
|
|
|
*/ |
352
|
1 |
|
private function moveFirstFile($target) |
353
|
|
|
{ |
354
|
1 |
|
$fs = new Filesystem(); |
355
|
1 |
|
$fs->rename($this->files[0], $target); |
356
|
|
|
|
357
|
1 |
|
return $this; |
358
|
|
|
} |
359
|
|
|
|
360
|
|
|
/** |
361
|
|
|
* Clear Bundle Cache directory |
362
|
|
|
* |
363
|
|
|
* @param bool $allFiles delete all files in bundles cache, if false deletes only extracted files ($this->files) |
364
|
|
|
* |
365
|
|
|
* @return self |
366
|
|
|
* |
367
|
|
|
* @codeCoverageIgnore |
368
|
|
|
*/ |
369
|
|
|
public function clearCache($allFiles = false) |
370
|
|
|
{ |
371
|
|
|
$fileSystem = new Filesystem(); |
372
|
|
|
|
373
|
|
|
if ($allFiles) { |
374
|
|
|
$finder = new Finder(); |
375
|
|
|
$files = $finder->files()->in($this->config['cache_dir']); |
376
|
|
|
} else { |
377
|
|
|
$files = $this->files; |
378
|
|
|
} |
379
|
|
|
|
380
|
|
|
foreach ($files as $file) { |
381
|
|
|
$fileSystem->remove($file); |
382
|
|
|
} |
383
|
|
|
|
384
|
|
|
return $this; |
385
|
|
|
} |
386
|
|
|
|
387
|
|
|
/** |
388
|
|
|
* @param SoapFault $e |
389
|
|
|
* |
390
|
|
|
* @throws Exceptions\SoapInternalErrorException |
391
|
|
|
* @throws Exceptions\SoapInvalidCredentialsException |
392
|
|
|
* @throws Exceptions\SoapNoCompleteDataAvailableException |
393
|
|
|
* @throws Exceptions\SoapReportingServiceInvalidReportIdException |
394
|
|
|
* @throws Exceptions\SoapUnknownErrorException |
395
|
|
|
* @throws Exceptions\SoapUserIsNotAuthorizedException |
396
|
|
|
*/ |
397
|
19 |
|
private function parseSoapFault(SoapFault $e) |
398
|
|
|
{ |
399
|
19 |
|
$error = null; |
400
|
19 |
|
if (isset($e->detail->AdApiFaultDetail)) { |
401
|
7 |
|
$error = $e->detail->AdApiFaultDetail->Errors->AdApiError; |
402
|
19 |
|
} elseif (isset($e->detail->ApiFaultDetail)) { |
403
|
12 |
|
if (!empty($e->detail->ApiFaultDetail->BatchErrors)) { |
404
|
6 |
|
$error = $error = $e->detail->ApiFaultDetail->BatchErrors->BatchError; |
405
|
12 |
|
} elseif (!empty($e->detail->ApiFaultDetail->OperationErrors)) { |
406
|
6 |
|
$error = $e->detail->ApiFaultDetail->OperationErrors->OperationError; |
407
|
6 |
|
} |
408
|
12 |
|
} |
409
|
19 |
|
$errors = is_array($error) ? $error : ['error' => $error]; |
410
|
19 |
|
foreach ($errors as $error) { |
411
|
19 |
|
switch ($error->Code) { |
412
|
19 |
|
case 0: |
413
|
4 |
|
throw new Exceptions\SoapInternalErrorException($error->Message, $error->Code); |
414
|
15 |
|
case 105: |
415
|
3 |
|
throw new Exceptions\SoapInvalidCredentialsException($error->Message, $error->Code); |
416
|
12 |
|
case 106: |
417
|
3 |
|
throw new Exceptions\SoapUserIsNotAuthorizedException($error->Message, $error->Code); |
418
|
9 |
|
case 2004: |
419
|
3 |
|
throw new Exceptions\SoapNoCompleteDataAvailableException($error->Message, $error->Code); |
420
|
6 |
|
case 2100: |
421
|
3 |
|
throw new Exceptions\SoapReportingServiceInvalidReportIdException($error->Message, $error->Code); |
422
|
3 |
|
default: |
423
|
3 |
|
$errorMessage = "[{$error->Code}]\n{$error->Message}"; |
|
|
|
|
424
|
3 |
|
throw new Exceptions\SoapUnknownErrorException($errorMessage, $error->Code); |
425
|
3 |
|
} |
426
|
|
|
} |
427
|
|
|
} |
428
|
|
|
} |
429
|
|
|
|
It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings.