001// Generated by delombok at Wed Nov 11 21:20:25 CET 2020
002/*
003 * Copyright (c) 2010-2020 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.ArrayList;
026import java.util.Collections;
027import java.util.Date;
028import java.util.List;
029import com.restfb.Facebook;
030import com.restfb.types.features.HasCreatedTime;
031
032/**
033 * @deprecated use {@link Ad} instead
034 */
035@Deprecated
036public class AdGroup extends NamedAdsObject implements HasCreatedTime {
037  private static final long serialVersionUID = 1L;
038  /**
039   * The ID of the ad account that this ad belongs to.
040   */
041  @Facebook("account_id")
042  private String accountId;
043  /**
044   * AdGroup set that contains this ad
045   */
046  @Facebook
047  private AdSet adset;
048  /**
049   * AdGroup campaign that contains this ad
050   */
051  @Facebook
052  private AdCampaignGroup campaign;
053  /**
054   * ID of the ad set that contains the ad
055   */
056  @Facebook("adset_id")
057  private String adsetId;
058  /**
059   * Bid amount for this ad
060   */
061  @Facebook("bid_amount")
062  private Integer bidAmount;
063  /**
064   * Bid type
065   */
066  @Facebook("bid_type")
067  private String bidType;
068  /**
069   * The configured status of the ad. Possible values are ACTIVE, PAUSED, ARCHIVED, DELETED.
070   */
071  @Facebook("configured_status")
072  private String configuredStatus;
073  /**
074   * Created time
075   */
076  @Facebook("created_time")
077  private Date createdTime;
078  /**
079   * This field is required for create. The ID of the ad creative to be used by this ad.
080   */
081  @Facebook
082  private AdCreative creative;
083  /**
084   * The effective status of the ad. Possible values are ACTIVE, PAUSED, ARCHIVED, DELETED, CAMPAIGN_PAUSED,
085   * ADSET_PAUSED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO.
086   */
087  @Facebook("effective_status")
088  private String effectiveStatus;
089  /**
090   * Last Updated By App ID
091   */
092  @Facebook("last_updated_by_app_id")
093  private String lastUpdatedByAppId;
094  /**
095   * ID of the ad campaign that contains this ad
096   */
097  @Facebook("campaign_id")
098  private String campaignId;
099  /**
100   * Updated time
101   */
102  @Facebook("updated_time")
103  private Date updatedTime;
104  /**
105   * Review feedback for this ad. Look here for more information:
106   * https://developers.facebook.com/docs/marketing-api/adgroup/feedback
107   */
108  @Facebook("ad_review_feedback")
109  private String adReviewFeedback;
110  @Facebook("tracking_specs")
111  private List<ConversionActionQuery> trackingSpecs = new ArrayList<>();
112
113  public List<ConversionActionQuery> getTrackingSpecs() {
114    return Collections.unmodifiableList(trackingSpecs);
115  }
116
117  public boolean addTrackingSpec(ConversionActionQuery action) {
118    return trackingSpecs.add(action);
119  }
120
121  public boolean removeTrackingSpec(ConversionActionQuery action) {
122    return trackingSpecs.remove(action);
123  }
124
125  @Facebook("conversion_specs")
126  private List<ConversionActionQuery> conversionSpecs = new ArrayList<>();
127
128  public List<ConversionActionQuery> getConversionSpecs() {
129    return Collections.unmodifiableList(conversionSpecs);
130  }
131
132  public boolean addConversionSpec(ConversionActionQuery action) {
133    return conversionSpecs.add(action);
134  }
135
136  public boolean removeConversionSpec(ConversionActionQuery action) {
137    return conversionSpecs.remove(action);
138  }
139
140  @Facebook
141  private List<AdLabel> adlabels = new ArrayList<>();
142
143  public List<AdLabel> getAdLabels() {
144    return Collections.unmodifiableList(adlabels);
145  }
146
147  public boolean addAdLabel(AdLabel action) {
148    return adlabels.add(action);
149  }
150
151  public boolean removeAdLabel(AdLabel action) {
152    return adlabels.remove(action);
153  }
154
155  /**
156   * The ID of the ad account that this ad belongs to.
157   */
158  @java.lang.SuppressWarnings("all")
159  public String getAccountId() {
160    return this.accountId;
161  }
162
163  /**
164   * The ID of the ad account that this ad belongs to.
165   */
166  @java.lang.SuppressWarnings("all")
167  public void setAccountId(final String accountId) {
168    this.accountId = accountId;
169  }
170
171  /**
172   * AdGroup set that contains this ad
173   */
174  @java.lang.SuppressWarnings("all")
175  public AdSet getAdset() {
176    return this.adset;
177  }
178
179  /**
180   * AdGroup set that contains this ad
181   */
182  @java.lang.SuppressWarnings("all")
183  public void setAdset(final AdSet adset) {
184    this.adset = adset;
185  }
186
187  /**
188   * AdGroup campaign that contains this ad
189   */
190  @java.lang.SuppressWarnings("all")
191  public AdCampaignGroup getCampaign() {
192    return this.campaign;
193  }
194
195  /**
196   * AdGroup campaign that contains this ad
197   */
198  @java.lang.SuppressWarnings("all")
199  public void setCampaign(final AdCampaignGroup campaign) {
200    this.campaign = campaign;
201  }
202
203  /**
204   * ID of the ad set that contains the ad
205   */
206  @java.lang.SuppressWarnings("all")
207  public String getAdsetId() {
208    return this.adsetId;
209  }
210
211  /**
212   * ID of the ad set that contains the ad
213   */
214  @java.lang.SuppressWarnings("all")
215  public void setAdsetId(final String adsetId) {
216    this.adsetId = adsetId;
217  }
218
219  /**
220   * Bid amount for this ad
221   */
222  @java.lang.SuppressWarnings("all")
223  public Integer getBidAmount() {
224    return this.bidAmount;
225  }
226
227  /**
228   * Bid amount for this ad
229   */
230  @java.lang.SuppressWarnings("all")
231  public void setBidAmount(final Integer bidAmount) {
232    this.bidAmount = bidAmount;
233  }
234
235  /**
236   * Bid type
237   */
238  @java.lang.SuppressWarnings("all")
239  public String getBidType() {
240    return this.bidType;
241  }
242
243  /**
244   * Bid type
245   */
246  @java.lang.SuppressWarnings("all")
247  public void setBidType(final String bidType) {
248    this.bidType = bidType;
249  }
250
251  /**
252   * The configured status of the ad. Possible values are ACTIVE, PAUSED, ARCHIVED, DELETED.
253   */
254  @java.lang.SuppressWarnings("all")
255  public String getConfiguredStatus() {
256    return this.configuredStatus;
257  }
258
259  /**
260   * The configured status of the ad. Possible values are ACTIVE, PAUSED, ARCHIVED, DELETED.
261   */
262  @java.lang.SuppressWarnings("all")
263  public void setConfiguredStatus(final String configuredStatus) {
264    this.configuredStatus = configuredStatus;
265  }
266
267  /**
268   * Created time
269   */
270  @java.lang.SuppressWarnings("all")
271  public void setCreatedTime(final Date createdTime) {
272    this.createdTime = createdTime;
273  }
274
275  /**
276   * Created time
277   */
278  @Override
279  @java.lang.SuppressWarnings("all")
280  public Date getCreatedTime() {
281    return this.createdTime;
282  }
283
284  /**
285   * This field is required for create. The ID of the ad creative to be used by this ad.
286   */
287  @java.lang.SuppressWarnings("all")
288  public AdCreative getCreative() {
289    return this.creative;
290  }
291
292  /**
293   * This field is required for create. The ID of the ad creative to be used by this ad.
294   */
295  @java.lang.SuppressWarnings("all")
296  public void setCreative(final AdCreative creative) {
297    this.creative = creative;
298  }
299
300  /**
301   * The effective status of the ad. Possible values are ACTIVE, PAUSED, ARCHIVED, DELETED, CAMPAIGN_PAUSED,
302   * ADSET_PAUSED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO.
303   */
304  @java.lang.SuppressWarnings("all")
305  public String getEffectiveStatus() {
306    return this.effectiveStatus;
307  }
308
309  /**
310   * The effective status of the ad. Possible values are ACTIVE, PAUSED, ARCHIVED, DELETED, CAMPAIGN_PAUSED,
311   * ADSET_PAUSED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO.
312   */
313  @java.lang.SuppressWarnings("all")
314  public void setEffectiveStatus(final String effectiveStatus) {
315    this.effectiveStatus = effectiveStatus;
316  }
317
318  /**
319   * Last Updated By App ID
320   */
321  @java.lang.SuppressWarnings("all")
322  public String getLastUpdatedByAppId() {
323    return this.lastUpdatedByAppId;
324  }
325
326  /**
327   * Last Updated By App ID
328   */
329  @java.lang.SuppressWarnings("all")
330  public void setLastUpdatedByAppId(final String lastUpdatedByAppId) {
331    this.lastUpdatedByAppId = lastUpdatedByAppId;
332  }
333
334  /**
335   * ID of the ad campaign that contains this ad
336   */
337  @java.lang.SuppressWarnings("all")
338  public String getCampaignId() {
339    return this.campaignId;
340  }
341
342  /**
343   * ID of the ad campaign that contains this ad
344   */
345  @java.lang.SuppressWarnings("all")
346  public void setCampaignId(final String campaignId) {
347    this.campaignId = campaignId;
348  }
349
350  /**
351   * Updated time
352   */
353  @java.lang.SuppressWarnings("all")
354  public Date getUpdatedTime() {
355    return this.updatedTime;
356  }
357
358  /**
359   * Updated time
360   */
361  @java.lang.SuppressWarnings("all")
362  public void setUpdatedTime(final Date updatedTime) {
363    this.updatedTime = updatedTime;
364  }
365
366  /**
367   * Review feedback for this ad. Look here for more information:
368   * https://developers.facebook.com/docs/marketing-api/adgroup/feedback
369   */
370  @java.lang.SuppressWarnings("all")
371  public String getAdReviewFeedback() {
372    return this.adReviewFeedback;
373  }
374
375  /**
376   * Review feedback for this ad. Look here for more information:
377   * https://developers.facebook.com/docs/marketing-api/adgroup/feedback
378   */
379  @java.lang.SuppressWarnings("all")
380  public void setAdReviewFeedback(final String adReviewFeedback) {
381    this.adReviewFeedback = adReviewFeedback;
382  }
383}