-
Notifications
You must be signed in to change notification settings - Fork 5
/
YapiService.cs
365 lines (279 loc) · 15 KB
/
YapiService.cs
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
using System;
using System.Collections.Generic;
using System.Diagnostics.Contracts;
using System.Linq;
using System.Net;
using Yandex.Direct.Serialization;
namespace Yandex.Direct
{
public partial class YapiService
{
#region Constructors and Properties
public YapiSettings Setting { get; private set; }
private YapiTransport YapiTransport { get; set; }
public YapiService(YapiSettings settings)
{
Contract.Requires(settings != null);
this.Setting = settings;
this.YapiTransport = new YapiTransport(settings);
ServicePointManager.ServerCertificateValidationCallback += (sender, cert, chain, errors) => true;
}
/// <summary>
/// Создать клиента для Яндекс-Директа, используя файл конфигурации (секция yandex.direct)
/// </summary>
public YapiService()
: this(YapiSettings.FromConfiguration())
{ }
/// <summary>
/// Создать клиента для Яндекс-Директа, указав путь к файлу сертификата и пароль
/// </summary>
public YapiService(string certificatePath, string certificatePassword)
: this(new YapiSettings(certificatePath, certificatePassword))
{ }
#endregion
#region PingApi
public int PingApi()
{
return YapiTransport.Request<int>(ApiCommand.PingAPI);
}
public void TestApiConnection()
{
if (PingApi() != 1)
throw new YapiServerException("Test API failed");
}
#endregion
#region Clients
public List<ShortClientInfo> GetClientLogins()
{
return YapiTransport.Request<List<ShortClientInfo>>(ApiCommand.GetClientsList);
}
public ClientUnitInfo[] GetClientsUnits(params string[] logins)
{
Contract.Requires<ArgumentException>(logins != null && logins.Any(), "logins");
return YapiTransport.Request<ClientUnitInfo[]>(ApiCommand.GetClientsUnits, logins);
}
#endregion
#region Campaigns
/*
* Not implemented:
- CreateOrUpdateCampaign
- GetBalance
- GetCampaignParams
- GetCampaignsList
- GetCampaignsListFilter
- GetCampaignsParams
*/
public List<ShortCampaignInfo> GetClientCampaigns(params string[] logins)
{
Contract.Requires<ArgumentException>(logins != null && logins.Any(), "logins");
return YapiTransport.Request<List<ShortCampaignInfo>>(ApiCommand.GetCampaignsList, logins);
}
#endregion
#region TransferMoney
public void TransferMoney(TransferInfo from, TransferInfo to)
{
TransferMoney(new[] { from }, new[] { to });
}
public void TransferMoney(TransferInfo[] from, TransferInfo[] to)
{
var request = new { FromCampaigns = from, ToCampaigns = to };
YapiTransport.Request<int>(ApiCommand.TransferMoney, request, true);
}
#endregion
#region Ads and phrases
public BannerInfo GetBanner(int bannerId)
{
return GetBanners(new[] { bannerId }).FirstOrDefault();
}
public BannerInfoWithPhrases<BannerPhraseInfo> GetBannerWithPhrases(BannerInfo banner)
{
Contract.Requires<ArgumentNullException>(banner != null, "banner");
return GetBannerWithPhrases(banner.BannerId);
}
public BannerInfoWithPhrases<BannerPhraseInfo> GetBannerWithPhrases(int bannerId)
{
return GetBannersWithPhrases(new[] { bannerId }).FirstOrDefault();
}
public BannerInfoWithPhrases<BannerPhraseInfoWithStats> GetBannerWithPhrasesAndStats(BannerInfo banner)
{
Contract.Requires<ArgumentNullException>(banner != null, "banner");
return GetBannerWithPhrasesAndStats(banner.BannerId);
}
public BannerInfoWithPhrases<BannerPhraseInfoWithStats> GetBannerWithPhrasesAndStats(int bannerId)
{
return GetBannersWithPhrasesAndStats(new[] { bannerId }).FirstOrDefault();
}
public List<BannerInfo> GetBanners(int[] bannerIds, BannersFilterInfo filter = null)
{
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
Contract.Requires<ArgumentOutOfRangeException>(bannerIds.Length <= 2000, "Maximum allowed number of identifiers per call is 2000.");
return GetBannersInternal<BannerInfo>(null, bannerIds, PhraseInfoType.No, filter);
}
public List<BannerInfoWithPhrases<BannerPhraseInfo>> GetBannersWithPhrases(int[] bannerIds, BannersFilterInfo filter = null)
{
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
Contract.Requires<ArgumentOutOfRangeException>(bannerIds.Length <= 2000, "Maximum allowed number of identifiers per call is 2000.");
return GetBannersInternal<BannerInfoWithPhrases<BannerPhraseInfo>>(null, bannerIds, PhraseInfoType.Yes, filter);
}
public List<BannerInfoWithPhrases<BannerPhraseInfoWithStats>> GetBannersWithPhrasesAndStats(int[] bannerIds, BannersFilterInfo filter = null)
{
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
Contract.Requires<ArgumentOutOfRangeException>(bannerIds.Length <= 2000, "Maximum allowed number of identifiers per call is 2000.");
return GetBannersInternal<BannerInfoWithPhrases<BannerPhraseInfoWithStats>>(null, bannerIds, PhraseInfoType.WithPrices, filter);
}
public List<BannerInfo> GetBannersForCampaign(int campaignId, BannersFilterInfo filter = null)
{
return GetBannersInternal<BannerInfo>(new[] { campaignId }, null, PhraseInfoType.No, filter);
}
public List<BannerInfoWithPhrases<BannerPhraseInfo>> GetBannersForCampaignWithPhrases(int campaignId, BannersFilterInfo filter = null)
{
return GetBannersInternal<BannerInfoWithPhrases<BannerPhraseInfo>>(new[] { campaignId }, null, PhraseInfoType.Yes, filter);
}
public List<BannerInfoWithPhrases<BannerPhraseInfoWithStats>> GetBannersForCampaignWithPhrasesAndStats(int campaignId, BannersFilterInfo filter = null)
{
return GetBannersInternal<BannerInfoWithPhrases<BannerPhraseInfoWithStats>>(new[] { campaignId }, null, PhraseInfoType.WithPrices, filter);
}
private List<T> GetBannersInternal<T>(int[] campaingIds, int[] bannerIds, PhraseInfoType phraseDetails, BannersFilterInfo filter)
where T : BannerInfo
{
var request = new { CampaignIDS = campaingIds, BannerIDS = bannerIds, GetPhrases = phraseDetails, Filter = filter };
return YapiTransport.Request<List<T>>(ApiCommand.GetBanners, request);
}
public List<BannerPhraseInfo> GetBannerPhrases(BannerInfo banner, bool considerTimeTarget = false)
{
Contract.Requires<ArgumentNullException>(banner != null, "banner");
return GetBannerPhrases(banner.BannerId, considerTimeTarget);
}
public List<BannerPhraseInfoWithStats> GetBannerPhrasesWithStats(BannerInfo banner, bool considerTimeTarget = false)
{
Contract.Requires<ArgumentNullException>(banner != null, "banner");
return GetBannerPhrasesWithStats(banner.BannerId, considerTimeTarget);
}
public List<BannerPhraseInfo> GetBannerPhrases(int bannerId, bool considerTimeTarget = false)
{
return GetBannerPhrases(new[] { bannerId }, considerTimeTarget);
}
public List<BannerPhraseInfoWithStats> GetBannerPhrasesWithStats(int bannerId, bool considerTimeTarget = false)
{
return GetBannerPhrasesWithStats(new[] { bannerId }, considerTimeTarget);
}
public List<BannerPhraseInfo> GetBannerPhrases(int[] bannerIds, bool considerTimeTarget = false)
{
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
Contract.Requires<ArgumentOutOfRangeException>(bannerIds.Length <= 1000, "Maximum allowed number of identifiers per call is 1000.");
var request = new { BannerIDS = bannerIds, RequestPrices = YesNo.No, ConsiderTimeTarget = (YesNo)considerTimeTarget };
return YapiTransport.Request<List<BannerPhraseInfo>>(ApiCommand.GetBannerPhrasesFilter, request);
}
public List<BannerPhraseInfoWithStats> GetBannerPhrasesWithStats(int[] bannerIds, bool considerTimeTarget = false)
{
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
Contract.Requires<ArgumentOutOfRangeException>(bannerIds.Length <= 1000, "Maximum allowed number of identifiers per call is 1000.");
var request = new { BannerIDS = bannerIds, RequestPrices = YesNo.Yes, ConsiderTimeTarget = (YesNo)considerTimeTarget };
return YapiTransport.Request<List<BannerPhraseInfoWithStats>>(ApiCommand.GetBannerPhrasesFilter, request);
}
public int CreateOrUpdateBanner(EditableBannerInfo banner)
{
Contract.Requires<ArgumentNullException>(banner != null, "banner");
return CreateOrUpdateBanners(new[] { banner }).FirstOrDefault();
}
public List<int> CreateOrUpdateBanners(IEnumerable<EditableBannerInfo> banners)
{
Contract.Requires<ArgumentNullException>(banners != null, "banner");
var bannersArray = banners.ToArray();
if (bannersArray.Contains(null))
throw new ArgumentNullException("banners", "One of the items is null.");
return YapiTransport.Request<List<int>>(ApiCommand.CreateOrUpdateBanners, bannersArray);
}
#endregion
#region Ad status
public bool ArchiveBanners(int campaignId, int[] bannerIds)
{
Contract.Requires<ArgumentException>(campaignId > 0);
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
return YapiTransport.Request<int>(ApiCommand.ArchiveBanners, new CampaignBidsInfo { CampaignId = campaignId, BannerIds = bannerIds }) == 1;
}
public bool DeleteBanners(int campaignId, int[] bannerIds)
{
Contract.Requires<ArgumentException>(campaignId > 0);
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
return YapiTransport.Request<int>(ApiCommand.DeleteBanners, new CampaignBidsInfo { CampaignId = campaignId, BannerIds = bannerIds }) == 1;
}
public bool ModerateBanners(int campaignId, int[] bannerIds)
{
Contract.Requires<ArgumentException>(campaignId > 0);
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
return YapiTransport.Request<int>(ApiCommand.ModerateBanners, new CampaignBidsInfo { CampaignId = campaignId, BannerIds = bannerIds }) == 1;
}
public bool ResumeBanners(int campaignId, int[] bannerIds)
{
Contract.Requires<ArgumentException>(campaignId > 0);
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
return YapiTransport.Request<int>(ApiCommand.ResumeBanners, new CampaignBidsInfo { CampaignId = campaignId, BannerIds = bannerIds }) == 1;
}
public bool StopBanners(int campaignId, int[] bannerIds)
{
Contract.Requires<ArgumentException>(campaignId > 0);
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
return YapiTransport.Request<int>(ApiCommand.StopBanners, new CampaignBidsInfo { CampaignId = campaignId, BannerIds = bannerIds }) == 1;
}
public bool UnArchiveBanners(int campaignId, int[] bannerIds)
{
Contract.Requires<ArgumentException>(campaignId > 0);
Contract.Requires<ArgumentException>(bannerIds != null && bannerIds.Any(), "bannerIds");
return YapiTransport.Request<int>(ApiCommand.UnArchiveBanners, new CampaignBidsInfo { CampaignId = campaignId, BannerIds = bannerIds }) == 1;
}
#endregion
#region Reporting
public int CreateReport(NewReportInfo reportInfo)
{
Contract.Requires<ArgumentNullException>(reportInfo != null, "reportInfo");
Contract.Requires<YapiException>(reportInfo.Limit.HasValue ^ reportInfo.Offset.HasValue, "Only one of \"Limit\" and \"Offset\" should be set");
return YapiTransport.Request<int>(ApiCommand.CreateNewReport, reportInfo);
}
public ReportInfo[] ListReports()
{
return YapiTransport.Request<ReportInfo[]>(ApiCommand.GetReportList);
}
public GoalInfo[] GetStatGoals(int campId)
{
Contract.Requires<ArgumentOutOfRangeException>(campId > 0, "campId");
return YapiTransport.Request<GoalInfo[]>(ApiCommand.GetStatGoals, new StatGoalRequestInfo(campId));
}
public void DeleteReport(int reportId)
{
Contract.Requires<ArgumentOutOfRangeException>(reportId > 0, "reportId");
var result = YapiTransport.Request<int>(ApiCommand.DeleteReport, reportId);
if (result != 1)
throw new YapiServerException(string.Format("Плохой ответ. Должен вернуть: 1. Вернул: {0}", result));
}
#endregion
#region Forecasts
public int CreateForecast(string[] phrases, int[] geoIds = null, int[] categories = null)
{
Contract.Requires<ArgumentException>(phrases != null && phrases.Any(), "phrases");
var reportInfo = new CreateForecastInfo
{
Categories = categories,
GeoIds = geoIds,
Phrases = phrases,
};
return YapiTransport.Request<int>(ApiCommand.CreateNewForecast, reportInfo);
}
public ForecastInfo GetForecast(int forecastId)
{
Contract.Requires<ArgumentOutOfRangeException>(forecastId > 0, "forecastId");
return YapiTransport.Request<ForecastInfo>(ApiCommand.GetForecast, forecastId);
}
public ForecastStatus[] ListForecasts()
{
return YapiTransport.Request<ForecastStatus[]>(ApiCommand.GetForecastList);
}
public void DeleteForecast(int forecastReportId)
{
var result = YapiTransport.Request<int>(ApiCommand.DeleteForecastReport, forecastReportId);
if (result != 1)
throw new YapiServerException(string.Format("Плохой ответ. Должен вернуть: 1. Вернул: {0}", result));
}
#endregion
}
}