001// Generated by delombok at Fri Oct 04 16:05:59 CEST 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/ad-creative-object-story-spec/">
030 * AdCreativeObjectStorySpec</a> Marketing API type.
031 */
032public class AdCreativeObjectStorySpec extends AbstractFacebookType {
033  /**
034   * The Instagram user account that the story will be posted to
035   */
036  @Facebook("instagram_actor_id")
037  private String instagramActorId;
038  /**
039   * The spec for a link page post or carousel ad
040   */
041  @Facebook("link_data")
042  private AdCreativeLinkData linkData;
043  /**
044   * The spec for an offer page post.
045   */
046  @Facebook("offer_data")
047  private AdCreativeOfferData offerData;
048  /**
049   * ID of a Facebook page.
050   *
051   * An unpublished page post will be created on this page. User must have Admin or Editor role for this page.
052   */
053  @Facebook("page_id")
054  private String pageId;
055  /**
056   * The spec for a photo page post.
057   */
058  @Facebook("photo_data")
059  private AdCreativePhotoData photoData;
060  /**
061   * The spec for a template link page post as used in Dynamic Product Ads.
062   */
063  @Facebook("template_data")
064  private AdCreativeLinkData templateData;
065  /**
066   * The spec for a text page post.
067   */
068  @Facebook("text_data")
069  private AdCreativeTextData textData;
070  /**
071   * The spec for a video page post.
072   */
073  @Facebook("video_data")
074  private AdCreativeVideoData videoData;
075
076  /**
077   * @return The Instagram user account that the story will be posted to
078   */
079  @java.lang.SuppressWarnings("all")
080  public String getInstagramActorId() {
081    return this.instagramActorId;
082  }
083
084  /**
085   * The Instagram user account that the story will be posted to
086   */
087  @java.lang.SuppressWarnings("all")
088  public void setInstagramActorId(final String instagramActorId) {
089    this.instagramActorId = instagramActorId;
090  }
091
092  /**
093   * @return The spec for a link page post or carousel ad
094   */
095  @java.lang.SuppressWarnings("all")
096  public AdCreativeLinkData getLinkData() {
097    return this.linkData;
098  }
099
100  /**
101   * The spec for a link page post or carousel ad
102   */
103  @java.lang.SuppressWarnings("all")
104  public void setLinkData(final AdCreativeLinkData linkData) {
105    this.linkData = linkData;
106  }
107
108  /**
109   * @return The spec for an offer page post.
110   */
111  @java.lang.SuppressWarnings("all")
112  public AdCreativeOfferData getOfferData() {
113    return this.offerData;
114  }
115
116  /**
117   * The spec for an offer page post.
118   */
119  @java.lang.SuppressWarnings("all")
120  public void setOfferData(final AdCreativeOfferData offerData) {
121    this.offerData = offerData;
122  }
123
124  /**
125   * @return ID of a Facebook page.
126   */
127  @java.lang.SuppressWarnings("all")
128  public String getPageId() {
129    return this.pageId;
130  }
131
132  /**
133   * ID of a Facebook page.
134   *
135   * An unpublished page post will be created on this page. User must have Admin or Editor role for this page.
136   */
137  @java.lang.SuppressWarnings("all")
138  public void setPageId(final String pageId) {
139    this.pageId = pageId;
140  }
141
142  /**
143   * @return The spec for a photo page post.
144   */
145  @java.lang.SuppressWarnings("all")
146  public AdCreativePhotoData getPhotoData() {
147    return this.photoData;
148  }
149
150  /**
151   * The spec for a photo page post.
152   */
153  @java.lang.SuppressWarnings("all")
154  public void setPhotoData(final AdCreativePhotoData photoData) {
155    this.photoData = photoData;
156  }
157
158  /**
159   * @return The spec for a template link page post as used in Dynamic Product Ads.
160   */
161  @java.lang.SuppressWarnings("all")
162  public AdCreativeLinkData getTemplateData() {
163    return this.templateData;
164  }
165
166  /**
167   * The spec for a template link page post as used in Dynamic Product Ads.
168   */
169  @java.lang.SuppressWarnings("all")
170  public void setTemplateData(final AdCreativeLinkData templateData) {
171    this.templateData = templateData;
172  }
173
174  /**
175   * @return The spec for a text page post.
176   */
177  @java.lang.SuppressWarnings("all")
178  public AdCreativeTextData getTextData() {
179    return this.textData;
180  }
181
182  /**
183   * The spec for a text page post.
184   */
185  @java.lang.SuppressWarnings("all")
186  public void setTextData(final AdCreativeTextData textData) {
187    this.textData = textData;
188  }
189
190  /**
191   * @return The spec for a video page post.
192   */
193  @java.lang.SuppressWarnings("all")
194  public AdCreativeVideoData getVideoData() {
195    return this.videoData;
196  }
197
198  /**
199   * The spec for a video page post.
200   */
201  @java.lang.SuppressWarnings("all")
202  public void setVideoData(final AdCreativeVideoData videoData) {
203    this.videoData = videoData;
204  }
205}