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