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