001// Generated by delombok at Fri Oct 11 21:56:29 CEST 2019
002/**
003 * Copyright (c) 2010-2019 Mark Allen, Norbert Bartels.
004 *
005 * Permission is hereby granted, free of charge, to any person obtaining a copy
006 * of this software and associated documentation files (the "Software"), to deal
007 * in the Software without restriction, including without limitation the rights
008 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009 * copies of the Software, and to permit persons to whom the Software is
010 * furnished to do so, subject to the following conditions:
011 *
012 * The above copyright notice and this permission notice shall be included in
013 * all copies or substantial portions of the Software.
014 *
015 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021 * THE SOFTWARE.
022 */
023package com.restfb.types.ads;
024
025import java.util.*;
026import com.restfb.Facebook;
027import com.restfb.annotation.GraphAPI;
028import com.restfb.json.JsonObject;
029
030/**
031 * Represents the <a href="https://developers.facebook.com/docs/marketing-api/reference/ad-campaign">AdGroup Set
032 * type</a>.
033 * 
034 * Note: AdGroup Set vs AdGroup Campaign Prior to July 2014 ad sets were referred to as 'campaigns'. When using ad sets
035 * in API calls the parameter may be referred to as 'adcampaign'. A campaign contains one or more ad sets.
036 */
037public class AdSet extends NamedAdsObject {
038  private static final long serialVersionUID = 1L;
039  @Facebook("account_id")
040  private String accountId;
041  @Facebook("ad_keywords")
042  private AdKeywords adKeywords;
043  @Facebook("adcampaign_group")
044  private AdCampaignGroup adcampaignGroup;
045  @Facebook("adlabels")
046  private List<AdLabel> adLabels = new ArrayList<>();
047  @Facebook("adset_schedule")
048  private List<DayPart> adsetSchedule = new ArrayList<>();
049  @Facebook("asset_feed_id")
050  private String assetFeedId;
051  @Facebook("attribution_spec")
052  private List<JsonObject> attributionSpec = new ArrayList<>();
053  @Facebook("best_creative")
054  private AdDynamicCreative bestCreative;
055  @Facebook("bid_adjustments")
056  private AdBidAdjustments bidAdjustments;
057  @Facebook("bid_amount")
058  private Long bidAmount;
059  @Facebook("bid_info")
060  private Map<String, Long> bidInfo = new HashMap<>();
061  @Facebook("bid_constraints")
062  private AdCampaignBidConstraint bidConstraints;
063  @Facebook("bid_info")
064  private Map<String, Long> mBidInfo = new HashMap<>();
065  @Facebook("bid_strategy")
066  private BidStrategyEnum bidStrategy;
067  @Facebook("billing_event")
068  private String billingEvent;
069  @Facebook("budget_remaining")
070  private String budgetRemaining;
071  @Facebook
072  private Campaign campaign;
073  @Facebook("campaign_id")
074  private String campaignId;
075  @Facebook("configured_status")
076  private String configuredStatus;
077  @Facebook("created_time")
078  private Date createdTime;
079  @Facebook("creative_sequence")
080  private List<String> creativeSequence = new ArrayList<>();
081  @Facebook("daily_budget")
082  private String dailyBudget;
083  @Facebook("daily_min_spend_target")
084  private String dailyMinSpendTarget;
085  @Facebook("daily_spend_cap")
086  private String dailySpendCap;
087  @Facebook("destination_type")
088  private String destinationType;
089  @Facebook("effective_status")
090  private String effectiveStatus;
091  @Facebook("end_time")
092  private Date endTime;
093  @Facebook("frequency_cap")
094  private Long frequencyCap;
095  @Facebook("frequency_cap_reset_period")
096  private Long frequencyCapResetPeriod;
097  @Facebook("frequency_control_specs")
098  private List<AdCampaignFrequencyControlSpecs> frequencyControlSpecs = new ArrayList<>();
099  @Facebook("is_autobid")
100  private Boolean isAutobid;
101  @Facebook("issues_info")
102  @GraphAPI(since = "3.2")
103  private List<AdCampaignIssuesInfo> issuesInfo = new ArrayList<>();
104  @Facebook("lifetime_budget")
105  private String lifetimeBudget;
106  @Facebook("lifetime_frequency_cap")
107  private Long lifetimeFrequencyCap;
108  @Facebook("lifetime_imps")
109  private Long lifetimeImps;
110  @Facebook("optimization_goal")
111  private String optimizationGoal;
112  @Facebook("pacing_type")
113  private List<String> pacingType = new ArrayList<>();
114  @Facebook("promoted_object")
115  private AdPromotedObject promotedObject;
116  @Facebook("recommendations")
117  private List<AdRecommendation> recommendations = new ArrayList<>();
118  @Facebook("rf_prediction_id")
119  private String rfPredictionId;
120  @Facebook("rtb_flag")
121  private Boolean rtbFlag;
122  @Facebook("start_time")
123  private Date startTime;
124  @Facebook("status")
125  private String mStatus;
126  @Facebook("targeting")
127  private Targeting targeting;
128  @Facebook("updated_time")
129  private Date updatedTime;
130  @Facebook("use_new_app_click")
131  private Boolean useNewAppClick;
132
133  public boolean addAdLabel(AdLabel adLabel) {
134    return adLabels.add(adLabel);
135  }
136
137  public boolean removeAdLabel(AdLabel adLabel) {
138    return adLabels.remove(adLabel);
139  }
140
141  public List<AdLabel> getAdlabels() {
142    return Collections.unmodifiableList(adLabels);
143  }
144
145  @java.lang.SuppressWarnings("all")
146  public String getAccountId() {
147    return this.accountId;
148  }
149
150  @java.lang.SuppressWarnings("all")
151  public void setAccountId(final String accountId) {
152    this.accountId = accountId;
153  }
154
155  @java.lang.SuppressWarnings("all")
156  public AdKeywords getAdKeywords() {
157    return this.adKeywords;
158  }
159
160  @java.lang.SuppressWarnings("all")
161  public void setAdKeywords(final AdKeywords adKeywords) {
162    this.adKeywords = adKeywords;
163  }
164
165  @java.lang.SuppressWarnings("all")
166  public AdCampaignGroup getAdcampaignGroup() {
167    return this.adcampaignGroup;
168  }
169
170  @java.lang.SuppressWarnings("all")
171  public void setAdcampaignGroup(final AdCampaignGroup adcampaignGroup) {
172    this.adcampaignGroup = adcampaignGroup;
173  }
174
175  @java.lang.SuppressWarnings("all")
176  public List<DayPart> getAdsetSchedule() {
177    return this.adsetSchedule;
178  }
179
180  @java.lang.SuppressWarnings("all")
181  public void setAdsetSchedule(final List<DayPart> adsetSchedule) {
182    this.adsetSchedule = adsetSchedule;
183  }
184
185  @java.lang.SuppressWarnings("all")
186  public String getAssetFeedId() {
187    return this.assetFeedId;
188  }
189
190  @java.lang.SuppressWarnings("all")
191  public void setAssetFeedId(final String assetFeedId) {
192    this.assetFeedId = assetFeedId;
193  }
194
195  @java.lang.SuppressWarnings("all")
196  public List<JsonObject> getAttributionSpec() {
197    return this.attributionSpec;
198  }
199
200  @java.lang.SuppressWarnings("all")
201  public void setAttributionSpec(final List<JsonObject> attributionSpec) {
202    this.attributionSpec = attributionSpec;
203  }
204
205  @java.lang.SuppressWarnings("all")
206  public AdDynamicCreative getBestCreative() {
207    return this.bestCreative;
208  }
209
210  @java.lang.SuppressWarnings("all")
211  public void setBestCreative(final AdDynamicCreative bestCreative) {
212    this.bestCreative = bestCreative;
213  }
214
215  @java.lang.SuppressWarnings("all")
216  public AdBidAdjustments getBidAdjustments() {
217    return this.bidAdjustments;
218  }
219
220  @java.lang.SuppressWarnings("all")
221  public void setBidAdjustments(final AdBidAdjustments bidAdjustments) {
222    this.bidAdjustments = bidAdjustments;
223  }
224
225  @java.lang.SuppressWarnings("all")
226  public Long getBidAmount() {
227    return this.bidAmount;
228  }
229
230  @java.lang.SuppressWarnings("all")
231  public void setBidAmount(final Long bidAmount) {
232    this.bidAmount = bidAmount;
233  }
234
235  @java.lang.SuppressWarnings("all")
236  public Map<String, Long> getBidInfo() {
237    return this.bidInfo;
238  }
239
240  @java.lang.SuppressWarnings("all")
241  public void setBidInfo(final Map<String, Long> bidInfo) {
242    this.bidInfo = bidInfo;
243  }
244
245  @java.lang.SuppressWarnings("all")
246  public AdCampaignBidConstraint getBidConstraints() {
247    return this.bidConstraints;
248  }
249
250  @java.lang.SuppressWarnings("all")
251  public void setBidConstraints(final AdCampaignBidConstraint bidConstraints) {
252    this.bidConstraints = bidConstraints;
253  }
254
255  @java.lang.SuppressWarnings("all")
256  public Map<String, Long> getMBidInfo() {
257    return this.mBidInfo;
258  }
259
260  @java.lang.SuppressWarnings("all")
261  public void setMBidInfo(final Map<String, Long> mBidInfo) {
262    this.mBidInfo = mBidInfo;
263  }
264
265  @java.lang.SuppressWarnings("all")
266  public BidStrategyEnum getBidStrategy() {
267    return this.bidStrategy;
268  }
269
270  @java.lang.SuppressWarnings("all")
271  public void setBidStrategy(final BidStrategyEnum bidStrategy) {
272    this.bidStrategy = bidStrategy;
273  }
274
275  @java.lang.SuppressWarnings("all")
276  public String getBillingEvent() {
277    return this.billingEvent;
278  }
279
280  @java.lang.SuppressWarnings("all")
281  public void setBillingEvent(final String billingEvent) {
282    this.billingEvent = billingEvent;
283  }
284
285  @java.lang.SuppressWarnings("all")
286  public String getBudgetRemaining() {
287    return this.budgetRemaining;
288  }
289
290  @java.lang.SuppressWarnings("all")
291  public void setBudgetRemaining(final String budgetRemaining) {
292    this.budgetRemaining = budgetRemaining;
293  }
294
295  @java.lang.SuppressWarnings("all")
296  public Campaign getCampaign() {
297    return this.campaign;
298  }
299
300  @java.lang.SuppressWarnings("all")
301  public void setCampaign(final Campaign campaign) {
302    this.campaign = campaign;
303  }
304
305  @java.lang.SuppressWarnings("all")
306  public String getCampaignId() {
307    return this.campaignId;
308  }
309
310  @java.lang.SuppressWarnings("all")
311  public void setCampaignId(final String campaignId) {
312    this.campaignId = campaignId;
313  }
314
315  @java.lang.SuppressWarnings("all")
316  public String getConfiguredStatus() {
317    return this.configuredStatus;
318  }
319
320  @java.lang.SuppressWarnings("all")
321  public void setConfiguredStatus(final String configuredStatus) {
322    this.configuredStatus = configuredStatus;
323  }
324
325  @java.lang.SuppressWarnings("all")
326  public Date getCreatedTime() {
327    return this.createdTime;
328  }
329
330  @java.lang.SuppressWarnings("all")
331  public void setCreatedTime(final Date createdTime) {
332    this.createdTime = createdTime;
333  }
334
335  @java.lang.SuppressWarnings("all")
336  public List<String> getCreativeSequence() {
337    return this.creativeSequence;
338  }
339
340  @java.lang.SuppressWarnings("all")
341  public void setCreativeSequence(final List<String> creativeSequence) {
342    this.creativeSequence = creativeSequence;
343  }
344
345  @java.lang.SuppressWarnings("all")
346  public String getDailyBudget() {
347    return this.dailyBudget;
348  }
349
350  @java.lang.SuppressWarnings("all")
351  public void setDailyBudget(final String dailyBudget) {
352    this.dailyBudget = dailyBudget;
353  }
354
355  @java.lang.SuppressWarnings("all")
356  public String getDailyMinSpendTarget() {
357    return this.dailyMinSpendTarget;
358  }
359
360  @java.lang.SuppressWarnings("all")
361  public void setDailyMinSpendTarget(final String dailyMinSpendTarget) {
362    this.dailyMinSpendTarget = dailyMinSpendTarget;
363  }
364
365  @java.lang.SuppressWarnings("all")
366  public String getDailySpendCap() {
367    return this.dailySpendCap;
368  }
369
370  @java.lang.SuppressWarnings("all")
371  public void setDailySpendCap(final String dailySpendCap) {
372    this.dailySpendCap = dailySpendCap;
373  }
374
375  @java.lang.SuppressWarnings("all")
376  public String getDestinationType() {
377    return this.destinationType;
378  }
379
380  @java.lang.SuppressWarnings("all")
381  public void setDestinationType(final String destinationType) {
382    this.destinationType = destinationType;
383  }
384
385  @java.lang.SuppressWarnings("all")
386  public String getEffectiveStatus() {
387    return this.effectiveStatus;
388  }
389
390  @java.lang.SuppressWarnings("all")
391  public void setEffectiveStatus(final String effectiveStatus) {
392    this.effectiveStatus = effectiveStatus;
393  }
394
395  @java.lang.SuppressWarnings("all")
396  public Date getEndTime() {
397    return this.endTime;
398  }
399
400  @java.lang.SuppressWarnings("all")
401  public void setEndTime(final Date endTime) {
402    this.endTime = endTime;
403  }
404
405  @java.lang.SuppressWarnings("all")
406  public Long getFrequencyCap() {
407    return this.frequencyCap;
408  }
409
410  @java.lang.SuppressWarnings("all")
411  public void setFrequencyCap(final Long frequencyCap) {
412    this.frequencyCap = frequencyCap;
413  }
414
415  @java.lang.SuppressWarnings("all")
416  public Long getFrequencyCapResetPeriod() {
417    return this.frequencyCapResetPeriod;
418  }
419
420  @java.lang.SuppressWarnings("all")
421  public void setFrequencyCapResetPeriod(final Long frequencyCapResetPeriod) {
422    this.frequencyCapResetPeriod = frequencyCapResetPeriod;
423  }
424
425  @java.lang.SuppressWarnings("all")
426  public List<AdCampaignFrequencyControlSpecs> getFrequencyControlSpecs() {
427    return this.frequencyControlSpecs;
428  }
429
430  @java.lang.SuppressWarnings("all")
431  public void setFrequencyControlSpecs(final List<AdCampaignFrequencyControlSpecs> frequencyControlSpecs) {
432    this.frequencyControlSpecs = frequencyControlSpecs;
433  }
434
435  @java.lang.SuppressWarnings("all")
436  public Boolean getIsAutobid() {
437    return this.isAutobid;
438  }
439
440  @java.lang.SuppressWarnings("all")
441  public void setIsAutobid(final Boolean isAutobid) {
442    this.isAutobid = isAutobid;
443  }
444
445  @GraphAPI(since = "3.2")
446  @java.lang.SuppressWarnings("all")
447  public List<AdCampaignIssuesInfo> getIssuesInfo() {
448    return this.issuesInfo;
449  }
450
451  @java.lang.SuppressWarnings("all")
452  public void setIssuesInfo(final List<AdCampaignIssuesInfo> issuesInfo) {
453    this.issuesInfo = issuesInfo;
454  }
455
456  @java.lang.SuppressWarnings("all")
457  public String getLifetimeBudget() {
458    return this.lifetimeBudget;
459  }
460
461  @java.lang.SuppressWarnings("all")
462  public void setLifetimeBudget(final String lifetimeBudget) {
463    this.lifetimeBudget = lifetimeBudget;
464  }
465
466  @java.lang.SuppressWarnings("all")
467  public Long getLifetimeFrequencyCap() {
468    return this.lifetimeFrequencyCap;
469  }
470
471  @java.lang.SuppressWarnings("all")
472  public void setLifetimeFrequencyCap(final Long lifetimeFrequencyCap) {
473    this.lifetimeFrequencyCap = lifetimeFrequencyCap;
474  }
475
476  @java.lang.SuppressWarnings("all")
477  public Long getLifetimeImps() {
478    return this.lifetimeImps;
479  }
480
481  @java.lang.SuppressWarnings("all")
482  public void setLifetimeImps(final Long lifetimeImps) {
483    this.lifetimeImps = lifetimeImps;
484  }
485
486  @java.lang.SuppressWarnings("all")
487  public String getOptimizationGoal() {
488    return this.optimizationGoal;
489  }
490
491  @java.lang.SuppressWarnings("all")
492  public void setOptimizationGoal(final String optimizationGoal) {
493    this.optimizationGoal = optimizationGoal;
494  }
495
496  @java.lang.SuppressWarnings("all")
497  public List<String> getPacingType() {
498    return this.pacingType;
499  }
500
501  @java.lang.SuppressWarnings("all")
502  public void setPacingType(final List<String> pacingType) {
503    this.pacingType = pacingType;
504  }
505
506  @java.lang.SuppressWarnings("all")
507  public AdPromotedObject getPromotedObject() {
508    return this.promotedObject;
509  }
510
511  @java.lang.SuppressWarnings("all")
512  public void setPromotedObject(final AdPromotedObject promotedObject) {
513    this.promotedObject = promotedObject;
514  }
515
516  @java.lang.SuppressWarnings("all")
517  public List<AdRecommendation> getRecommendations() {
518    return this.recommendations;
519  }
520
521  @java.lang.SuppressWarnings("all")
522  public void setRecommendations(final List<AdRecommendation> recommendations) {
523    this.recommendations = recommendations;
524  }
525
526  @java.lang.SuppressWarnings("all")
527  public String getRfPredictionId() {
528    return this.rfPredictionId;
529  }
530
531  @java.lang.SuppressWarnings("all")
532  public void setRfPredictionId(final String rfPredictionId) {
533    this.rfPredictionId = rfPredictionId;
534  }
535
536  @java.lang.SuppressWarnings("all")
537  public Boolean getRtbFlag() {
538    return this.rtbFlag;
539  }
540
541  @java.lang.SuppressWarnings("all")
542  public void setRtbFlag(final Boolean rtbFlag) {
543    this.rtbFlag = rtbFlag;
544  }
545
546  @java.lang.SuppressWarnings("all")
547  public Date getStartTime() {
548    return this.startTime;
549  }
550
551  @java.lang.SuppressWarnings("all")
552  public void setStartTime(final Date startTime) {
553    this.startTime = startTime;
554  }
555
556  @java.lang.SuppressWarnings("all")
557  public String getMStatus() {
558    return this.mStatus;
559  }
560
561  @java.lang.SuppressWarnings("all")
562  public void setMStatus(final String mStatus) {
563    this.mStatus = mStatus;
564  }
565
566  @java.lang.SuppressWarnings("all")
567  public Targeting getTargeting() {
568    return this.targeting;
569  }
570
571  @java.lang.SuppressWarnings("all")
572  public void setTargeting(final Targeting targeting) {
573    this.targeting = targeting;
574  }
575
576  @java.lang.SuppressWarnings("all")
577  public Date getUpdatedTime() {
578    return this.updatedTime;
579  }
580
581  @java.lang.SuppressWarnings("all")
582  public void setUpdatedTime(final Date updatedTime) {
583    this.updatedTime = updatedTime;
584  }
585
586  @java.lang.SuppressWarnings("all")
587  public Boolean getUseNewAppClick() {
588    return this.useNewAppClick;
589  }
590
591  @java.lang.SuppressWarnings("all")
592  public void setUseNewAppClick(final Boolean useNewAppClick) {
593    this.useNewAppClick = useNewAppClick;
594  }
595}