001// Generated by delombok at Tue Dec 10 13:42:03 UTC 2024
002/*
003 * Copyright (c) 2010-2024 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 com.restfb.Facebook;
026import com.restfb.types.AbstractFacebookType;
027
028/**
029 * Represents the <a href="https://developers.facebook.com/docs/marketing-api/reference/ads-action-stats/">Ads action
030 * stats type</a>
031 */
032public class AdsActionStats extends AbstractFacebookType {
033  /**
034   * The ID of the specific carousel card that people engaged with when they saw your ad.
035   */
036  @Facebook("action_carousel_card_id")
037  private String actionCarouselCardId;
038  /**
039   * The specific carousel card that people engaged with when they saw your ad. The cards are identified by their
040   * headlines.
041   */
042  @Facebook("action_carousel_card_name")
043  private String actionCarouselCardName;
044  /**
045   * The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for
046   * your conversion pixel or an app configured with the software development kit (SDK).
047   */
048  @Facebook("action_destination")
049  private String actionDestination;
050  /**
051   * The device on which the conversion event you are tracking occurred. For example, "Desktop" if someone converted on
052   * a desktop computer.
053   */
054  @Facebook("action_device")
055  private String actionDevice;
056  /**
057   * The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for
058   * your conversion pixel or an app configured with the software development kit (SDK).
059   */
060  @Facebook("action_target_id")
061  private String actionTargetId;
062  /**
063   * The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't
064   * click on it. Action types include Page likes, app installs, conversions, event responses and more.
065   */
066  @Facebook("action_type")
067  private String actionType;
068  /**
069   * Video metrics breakdown.
070   */
071  @Facebook("action_video_type")
072  private String actionVideoType;
073  /**
074   * Metric value of default attribution window
075   */
076  @Facebook
077  private Double value;
078  /**
079   * Metric value of attribution window "1d_view"
080   */
081  @Facebook("1d_view")
082  private Double view1d;
083  /**
084   * Metric value of attribution window "7d_view"
085   */
086  @Facebook("7d_view")
087  private Double view7d;
088  /**
089   * Metric value of attribution window "28d_view"
090   */
091  @Facebook("28d_view")
092  private Double view28d;
093  /**
094   * Metric value of attribution window "1d_click"
095   */
096  @Facebook("1d_click")
097  private Double click1d;
098  /**
099   * Metric value of attribution window "7d_click"
100   */
101  @Facebook("7d_click")
102  private Double click7d;
103  /**
104   * Metric value of attribution window "28d_click"
105   */
106  @Facebook("28d_click")
107  private Double click28d;
108
109  /**
110   * The ID of the specific carousel card that people engaged with when they saw your ad.
111   */
112  @java.lang.SuppressWarnings("all")
113  public String getActionCarouselCardId() {
114    return this.actionCarouselCardId;
115  }
116
117  /**
118   * The ID of the specific carousel card that people engaged with when they saw your ad.
119   */
120  @java.lang.SuppressWarnings("all")
121  public void setActionCarouselCardId(final String actionCarouselCardId) {
122    this.actionCarouselCardId = actionCarouselCardId;
123  }
124
125  /**
126   * The specific carousel card that people engaged with when they saw your ad. The cards are identified by their
127   * headlines.
128   */
129  @java.lang.SuppressWarnings("all")
130  public String getActionCarouselCardName() {
131    return this.actionCarouselCardName;
132  }
133
134  /**
135   * The specific carousel card that people engaged with when they saw your ad. The cards are identified by their
136   * headlines.
137   */
138  @java.lang.SuppressWarnings("all")
139  public void setActionCarouselCardName(final String actionCarouselCardName) {
140    this.actionCarouselCardName = actionCarouselCardName;
141  }
142
143  /**
144   * The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for
145   * your conversion pixel or an app configured with the software development kit (SDK).
146   */
147  @java.lang.SuppressWarnings("all")
148  public String getActionDestination() {
149    return this.actionDestination;
150  }
151
152  /**
153   * The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for
154   * your conversion pixel or an app configured with the software development kit (SDK).
155   */
156  @java.lang.SuppressWarnings("all")
157  public void setActionDestination(final String actionDestination) {
158    this.actionDestination = actionDestination;
159  }
160
161  /**
162   * The device on which the conversion event you are tracking occurred. For example, "Desktop" if someone converted on
163   * a desktop computer.
164   */
165  @java.lang.SuppressWarnings("all")
166  public String getActionDevice() {
167    return this.actionDevice;
168  }
169
170  /**
171   * The device on which the conversion event you are tracking occurred. For example, "Desktop" if someone converted on
172   * a desktop computer.
173   */
174  @java.lang.SuppressWarnings("all")
175  public void setActionDevice(final String actionDevice) {
176    this.actionDevice = actionDevice;
177  }
178
179  /**
180   * The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for
181   * your conversion pixel or an app configured with the software development kit (SDK).
182   */
183  @java.lang.SuppressWarnings("all")
184  public String getActionTargetId() {
185    return this.actionTargetId;
186  }
187
188  /**
189   * The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for
190   * your conversion pixel or an app configured with the software development kit (SDK).
191   */
192  @java.lang.SuppressWarnings("all")
193  public void setActionTargetId(final String actionTargetId) {
194    this.actionTargetId = actionTargetId;
195  }
196
197  /**
198   * The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't
199   * click on it. Action types include Page likes, app installs, conversions, event responses and more.
200   */
201  @java.lang.SuppressWarnings("all")
202  public String getActionType() {
203    return this.actionType;
204  }
205
206  /**
207   * The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't
208   * click on it. Action types include Page likes, app installs, conversions, event responses and more.
209   */
210  @java.lang.SuppressWarnings("all")
211  public void setActionType(final String actionType) {
212    this.actionType = actionType;
213  }
214
215  /**
216   * Video metrics breakdown.
217   */
218  @java.lang.SuppressWarnings("all")
219  public String getActionVideoType() {
220    return this.actionVideoType;
221  }
222
223  /**
224   * Video metrics breakdown.
225   */
226  @java.lang.SuppressWarnings("all")
227  public void setActionVideoType(final String actionVideoType) {
228    this.actionVideoType = actionVideoType;
229  }
230
231  /**
232   * Metric value of default attribution window
233   */
234  @java.lang.SuppressWarnings("all")
235  public Double getValue() {
236    return this.value;
237  }
238
239  /**
240   * Metric value of default attribution window
241   */
242  @java.lang.SuppressWarnings("all")
243  public void setValue(final Double value) {
244    this.value = value;
245  }
246
247  /**
248   * Metric value of attribution window "1d_view"
249   */
250  @java.lang.SuppressWarnings("all")
251  public Double getView1d() {
252    return this.view1d;
253  }
254
255  /**
256   * Metric value of attribution window "1d_view"
257   */
258  @java.lang.SuppressWarnings("all")
259  public void setView1d(final Double view1d) {
260    this.view1d = view1d;
261  }
262
263  /**
264   * Metric value of attribution window "7d_view"
265   */
266  @java.lang.SuppressWarnings("all")
267  public Double getView7d() {
268    return this.view7d;
269  }
270
271  /**
272   * Metric value of attribution window "7d_view"
273   */
274  @java.lang.SuppressWarnings("all")
275  public void setView7d(final Double view7d) {
276    this.view7d = view7d;
277  }
278
279  /**
280   * Metric value of attribution window "28d_view"
281   */
282  @java.lang.SuppressWarnings("all")
283  public Double getView28d() {
284    return this.view28d;
285  }
286
287  /**
288   * Metric value of attribution window "28d_view"
289   */
290  @java.lang.SuppressWarnings("all")
291  public void setView28d(final Double view28d) {
292    this.view28d = view28d;
293  }
294
295  /**
296   * Metric value of attribution window "1d_click"
297   */
298  @java.lang.SuppressWarnings("all")
299  public Double getClick1d() {
300    return this.click1d;
301  }
302
303  /**
304   * Metric value of attribution window "1d_click"
305   */
306  @java.lang.SuppressWarnings("all")
307  public void setClick1d(final Double click1d) {
308    this.click1d = click1d;
309  }
310
311  /**
312   * Metric value of attribution window "7d_click"
313   */
314  @java.lang.SuppressWarnings("all")
315  public Double getClick7d() {
316    return this.click7d;
317  }
318
319  /**
320   * Metric value of attribution window "7d_click"
321   */
322  @java.lang.SuppressWarnings("all")
323  public void setClick7d(final Double click7d) {
324    this.click7d = click7d;
325  }
326
327  /**
328   * Metric value of attribution window "28d_click"
329   */
330  @java.lang.SuppressWarnings("all")
331  public Double getClick28d() {
332    return this.click28d;
333  }
334
335  /**
336   * Metric value of attribution window "28d_click"
337   */
338  @java.lang.SuppressWarnings("all")
339  public void setClick28d(final Double click28d) {
340    this.click28d = click28d;
341  }
342}