/
bulk_campaign.py
469 lines (416 loc) · 18.6 KB
/
bulk_campaign.py
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
from bingads.service_client import _CAMPAIGN_OBJECT_FACTORY_V13
from bingads.v13.bulk.entities import QualityScoreData
from bingads.v13.internal.bulk.string_table import _StringTable
from bingads.v13.internal.bulk.entities.single_record_bulk_entity import _SingleRecordBulkEntity
from bingads.v13.internal.bulk.mappings import _SimpleBulkMapping, _ComplexBulkMapping
from bingads.v13.internal.extensions import *
_ShoppingSetting = type(_CAMPAIGN_OBJECT_FACTORY_V13.create('ShoppingSetting'))
_DsaSetting = type(_CAMPAIGN_OBJECT_FACTORY_V13.create('DynamicSearchAdsSetting'))
class BulkCampaign(_SingleRecordBulkEntity):
""" Represents a campaign that can be read or written in a bulk file.
This class exposes the :attr:`campaign` property that can be read and written as fields of the
Campaign record in a bulk file.
For more information, see Campaign at https://go.microsoft.com/fwlink/?linkid=846127.
*See also:*
* :class:`.BulkServiceManager`
* :class:`.BulkOperation`
* :class:`.BulkFileReader`
* :class:`.BulkFileWriter`
"""
def __init__(self, account_id=None, campaign=None):
super(BulkCampaign, self).__init__()
self._account_id = account_id
self._campaign = campaign
self._quality_score_data = None
self._performance_data = None
self._budget_name = None
@property
def account_id(self):
""" The identifier of the account that contains the campaign.
Corresponds to the 'Parent Id' field in the bulk file.
:rtype: int
"""
return self._account_id
@account_id.setter
def account_id(self, account_id):
self._account_id = account_id
@property
def budget_name(self):
"""
The budget name that the campaign associated, only for campaigns that use a shared budget
Corresponds to 'Budget Name' field in bulk file.
:rtype: str
"""
return self._budget_name
@budget_name.setter
def budget_name(self, value):
self._budget_name = value
@property
def campaign(self):
""" Defines a campaign within an account.
See Campaign at https://docs.microsoft.com/en-us/bingads/campaign-management-service/campaign?view=bingads-13
"""
return self._campaign
@campaign.setter
def campaign(self, campaign):
self._campaign = campaign
@property
def quality_score_data(self):
""" The quality score data for the campaign.
:rtype: QualityScoreData
"""
return self._quality_score_data
def _get_shopping_setting(self):
return self._get_setting(_ShoppingSetting, 'ShoppingSetting')
def _get_target_setting(self):
return self._get_setting(_ShoppingSetting, 'TargetSetting')
def _get_dsa_setting(self):
return self._get_setting(_DsaSetting, 'DynamicSearchAdsSetting')
def _get_setting(self, setting_type, setting_name):
if not self.campaign.Settings.Setting:
return None
settings = [setting for setting in self.campaign.Settings.Setting if
isinstance(setting, setting_type)]
if len(settings) != 1:
raise ValueError('Can only have 1 ' + setting_name + ' in Campaign Settings.')
return settings[0]
@staticmethod
def _write_campaign_type(c):
if not c.campaign.CampaignType:
return None
if len(c.campaign.CampaignType) != 1:
raise ValueError("Only 1 CampaignType can be set in Campaign")
return c.campaign.CampaignType[0]
@staticmethod
def _read_campaign_type(c, v):
if not v:
return []
campaign_type = v
c.campaign.CampaignType = [campaign_type]
if campaign_type.lower() == 'shopping' or campaign_type.lower() == 'audience':
BulkCampaign._create_campaign_setting(c.campaign, 'ShoppingSetting')
elif campaign_type.lower() == 'dynamicsearchads' or campaign_type.lower() == 'search':
BulkCampaign._create_campaign_setting(c.campaign, 'DynamicSearchAdsSetting')
@staticmethod
def _create_campaign_setting(campaign, setting_type):
campaign.Settings = _CAMPAIGN_OBJECT_FACTORY_V13.create('ArrayOfSetting')
setting = _CAMPAIGN_OBJECT_FACTORY_V13.create(setting_type)
setting.Type = setting_type
campaign.Settings.Setting = [setting]
@staticmethod
def _write_store_id(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
return bulk_str(shopping_setting.StoreId)
@staticmethod
def _read_store_id(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
shopping_setting.StoreId = int(v) if v else None
@staticmethod
def _write_priority(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
return bulk_str(shopping_setting.Priority)
@staticmethod
def _read_priority(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
shopping_setting.Priority = int(v) if v else None
@staticmethod
def _write_sales_country_code(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
return shopping_setting.SalesCountryCode
@staticmethod
def _read_sales_country_code(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
shopping_setting.SalesCountryCode = v
@staticmethod
def _write_local_inventory_ads_enabled(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
return shopping_setting.LocalInventoryAdsEnabled
@staticmethod
def _read_local_inventory_ads_enabled(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'shopping' in campgaign_types or 'audience' in campgaign_types:
shopping_setting = c._get_shopping_setting()
if not shopping_setting:
return None
shopping_setting.LocalInventoryAdsEnabled = v.lower() == 'true' if v else None
@staticmethod
def _read_source(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
dsa_setting.Source = v
@staticmethod
def _write_source(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
return bulk_str(dsa_setting.Source)
@staticmethod
def _read_domain_language(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
dsa_setting.Language = v
@staticmethod
def _write_domain_language(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
return bulk_str(dsa_setting.Language)
@staticmethod
def _read_page_feed_ids(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
dsa_setting.PageFeedIds.long = csv_to_field_PageFeedIds(v)
@staticmethod
def _write_page_feed_ids(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
return field_to_csv_Ids(dsa_setting.PageFeedIds, c.campaign.Id)
@staticmethod
def _read_website(c, v):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
dsa_setting.DomainName = v
@staticmethod
def _write_website(c):
if not c.campaign.CampaignType:
return None
campgaign_types = [campaign_type.lower() for campaign_type in c.campaign.CampaignType]
if 'dynamicsearchads' in campgaign_types:
dsa_setting = c._get_dsa_setting()
if not dsa_setting:
return None
return bulk_str(dsa_setting.DomainName)
_MAPPINGS = [
_SimpleBulkMapping(
header=_StringTable.CampaignType,
field_to_csv=lambda c: BulkCampaign._write_campaign_type(c),
csv_to_field=lambda c, v: BulkCampaign._read_campaign_type(c, v)
),
_SimpleBulkMapping(
header=_StringTable.Status,
field_to_csv=lambda c: bulk_str(c.campaign.Status),
csv_to_field=lambda c, v: setattr(
c.campaign,
'Status',
v if v else None
)
),
_SimpleBulkMapping(
header=_StringTable.Id,
field_to_csv=lambda c: bulk_str(c.campaign.Id),
csv_to_field=lambda c, v: setattr(
c.campaign,
'Id',
int(v) if v else None
)
),
_SimpleBulkMapping(
header=_StringTable.ParentId,
field_to_csv=lambda c: bulk_str(c.account_id),
csv_to_field=lambda c, v: setattr(c, '_account_id', int(v) if v else None)
),
_SimpleBulkMapping(
header=_StringTable.Campaign,
field_to_csv=lambda c: c.campaign.Name,
csv_to_field=lambda c, v: setattr(c.campaign, 'Name', v)
),
_SimpleBulkMapping(
header=_StringTable.TimeZone,
field_to_csv=lambda c: c.campaign.TimeZone,
csv_to_field=lambda c, v: setattr(c.campaign, 'TimeZone', v)
),
_SimpleBulkMapping(
header=_StringTable.Language,
field_to_csv=lambda c: field_to_csv_CampaignLanguages(c.campaign.Languages),
csv_to_field=lambda c, v: csv_to_field_CampaignLanguages(c.campaign.Languages, v)
),
_ComplexBulkMapping(budget_to_csv, csv_to_budget),
_SimpleBulkMapping(
header=_StringTable.BidAdjustment,
field_to_csv=lambda c: bulk_str(c.campaign.AudienceAdsBidAdjustment),
csv_to_field=lambda c, v: setattr(
c.campaign,
'AudienceAdsBidAdjustment',
int(v) if v else None
)
),
_SimpleBulkMapping(
header=_StringTable.BingMerchantCenterId,
field_to_csv=lambda c: BulkCampaign._write_store_id(c),
csv_to_field=lambda c, v: BulkCampaign._read_store_id(c, v)
),
_SimpleBulkMapping(
header=_StringTable.CampaignPriority,
field_to_csv=lambda c: BulkCampaign._write_priority(c),
csv_to_field=lambda c, v: BulkCampaign._read_priority(c, v)
),
_SimpleBulkMapping(
header=_StringTable.CountryCode,
field_to_csv=lambda c: BulkCampaign._write_sales_country_code(c),
csv_to_field=lambda c, v: BulkCampaign._read_sales_country_code(c, v)
),
_SimpleBulkMapping(
header=_StringTable.LocalInventoryAdsEnabled,
field_to_csv=lambda c: BulkCampaign._write_local_inventory_ads_enabled(c),
csv_to_field=lambda c, v: BulkCampaign._read_local_inventory_ads_enabled(c, v)
),
_SimpleBulkMapping(
header=_StringTable.TrackingTemplate,
field_to_csv=lambda c: bulk_str(c.campaign.TrackingUrlTemplate),
csv_to_field=lambda c, v: setattr(c.campaign, 'TrackingUrlTemplate', v if v else None)
),
_SimpleBulkMapping(
header=_StringTable.CustomParameter,
field_to_csv=lambda c: field_to_csv_UrlCustomParameters(c.campaign),
csv_to_field=lambda c, v: csv_to_field_UrlCustomParameters(c.campaign, v)
),
_ComplexBulkMapping(biddingscheme_to_csv, csv_to_biddingscheme),
_SimpleBulkMapping(
header=_StringTable.BudgetId,
field_to_csv=lambda c: bulk_str(c.campaign.BudgetId),
csv_to_field=lambda c, v: setattr(c.campaign, 'BudgetId', int(v) if v else None)
),
_SimpleBulkMapping(
header=_StringTable.BudgetType,
field_to_csv=lambda c: bulk_str(c.campaign.BudgetType),
csv_to_field=lambda c, v: csv_to_field_BudgetType(c.campaign, v)
),
_SimpleBulkMapping(
header=_StringTable.BudgetName,
field_to_csv=lambda c: bulk_str(c.budget_name),
csv_to_field=lambda c, v: setattr(c, 'budget_name', v if v else None)
),
_SimpleBulkMapping(
header=_StringTable.Website,
field_to_csv=lambda c: BulkCampaign._write_website(c),
csv_to_field=lambda c, v: BulkCampaign._read_website(c, v)
),
_SimpleBulkMapping(
header=_StringTable.DomainLanguage,
field_to_csv=lambda c: BulkCampaign._write_domain_language(c),
csv_to_field=lambda c, v: BulkCampaign._read_domain_language(c, v)
),
_SimpleBulkMapping(
header=_StringTable.Source,
field_to_csv=lambda c: BulkCampaign._write_source(c),
csv_to_field=lambda c, v: BulkCampaign._read_source(c, v)
),
_SimpleBulkMapping(
header=_StringTable.SubType,
field_to_csv=lambda c: c.campaign.SubType,
csv_to_field=lambda c, v: setattr(c.campaign, 'SubType', v)
),
_SimpleBulkMapping(
header=_StringTable.ExperimentId,
field_to_csv=lambda c: bulk_str(c.campaign.ExperimentId),
csv_to_field=lambda c, v: setattr(c.campaign, 'ExperimentId', int(v) if v else None)
),
_SimpleBulkMapping(
header=_StringTable.TargetSetting,
field_to_csv=lambda c: target_setting_to_csv(c.campaign),
csv_to_field=lambda c, v: csv_to_target_setting(c.campaign, v)
),
_SimpleBulkMapping(
header=_StringTable.FinalUrlSuffix,
field_to_csv=lambda c: bulk_optional_str(c.campaign.FinalUrlSuffix, c.campaign.Id),
csv_to_field=lambda c, v: setattr(c.campaign, 'FinalUrlSuffix', v)
),
_SimpleBulkMapping(
header=_StringTable.PageFeedIds,
field_to_csv=lambda c: BulkCampaign._write_page_feed_ids(c),
csv_to_field=lambda c, v: BulkCampaign._read_page_feed_ids(c, v)
),
_SimpleBulkMapping(
header=_StringTable.AdScheduleUseSearcherTimeZone,
field_to_csv=lambda c: field_to_csv_UseSearcherTimeZone(c.campaign.AdScheduleUseSearcherTimeZone, None),
csv_to_field=lambda c, v: setattr(c.campaign, 'AdScheduleUseSearcherTimeZone', parse_bool(v))
),
]
def read_additional_data(self, stream_reader):
super(BulkCampaign, self).read_additional_data(stream_reader)
def process_mappings_from_row_values(self, row_values):
self._campaign = _CAMPAIGN_OBJECT_FACTORY_V13.create('Campaign')
row_values.convert_to_entity(self, BulkCampaign._MAPPINGS)
self._quality_score_data = QualityScoreData.read_from_row_values_or_null(row_values)
def process_mappings_to_row_values(self, row_values, exclude_readonly_data):
self._validate_property_not_null(self.campaign, 'campaign')
self.convert_to_values(row_values, BulkCampaign._MAPPINGS)
if not exclude_readonly_data:
QualityScoreData.write_to_row_values_if_not_null(self.quality_score_data, row_values)